diff --git a/equinix-openapi-fabric-tests/src/test/java/com/equinix/openapi/fabric/tests/CloudRoutersApiTest.java b/equinix-openapi-fabric-tests/src/test/java/com/equinix/openapi/fabric/tests/CloudRoutersApiTest.java index 9ae4acfc..2fe16d2c 100644 --- a/equinix-openapi-fabric-tests/src/test/java/com/equinix/openapi/fabric/tests/CloudRoutersApiTest.java +++ b/equinix-openapi-fabric-tests/src/test/java/com/equinix/openapi/fabric/tests/CloudRoutersApiTest.java @@ -8,6 +8,7 @@ import org.junit.BeforeClass; import org.junit.Test; +import java.util.Arrays; import java.util.UUID; import static com.equinix.openapi.fabric.tests.helpers.Apis.*; @@ -155,8 +156,8 @@ public void getCloudRouterByUuid() throws ApiException { @Test public void getCloudRouterPackageByCode() throws ApiException { Code routerPackageCode = Code.STANDARD; - CloudRouterPackage cloudRouterPackage = cloudRoutersApi.getCloudRouterPackageByCode(RouterPackageCode.STANDARD); - assertEquals(200, cloudRoutersApi.getApiClient().getStatusCode()); + CloudRouterPackage cloudRouterPackage = cloudRouterPackagesApi.getCloudRouterPackageByCode(RouterPackageCode.STANDARD); + assertEquals(200, cloudRouterPackagesApi.getApiClient().getStatusCode()); assertEquals(cloudRouterPackage.getCode(), routerPackageCode); } @@ -165,8 +166,8 @@ public void getCloudRouterPackageByCode() throws ApiException { */ @Test public void getCloudRouterPackages() throws ApiException { - PackageResponse packageResponse = cloudRoutersApi.getCloudRouterPackages(10, 10); - assertEquals(200, cloudRoutersApi.getApiClient().getStatusCode()); + PackageResponse packageResponse = cloudRouterPackagesApi.getCloudRouterPackages(10, 10); + assertEquals(200, cloudRouterPackagesApi.getApiClient().getStatusCode()); assertNotNull(packageResponse.getData()); } @@ -203,21 +204,18 @@ public void searchCloudRouterRoutes() throws ApiException { public void searchCloudRouters() throws ApiException { CloudRouterReadResponse cloudRouter = createRouter(); - CloudRouterSimpleExpression cloudRouterSimpleExpression = new CloudRouterSimpleExpression(); - cloudRouterSimpleExpression.setOperator(SearchExpression.OperatorEnum.EQUAL.getValue()); - cloudRouterSimpleExpression.setProperty(CloudRouterSortBy.NAME.getValue()); - cloudRouterSimpleExpression.values(singletonList(cloudRouter.getName())); - - CloudRouterSimpleExpression cloudRouterSimpleExpression2 = new CloudRouterSimpleExpression(); - cloudRouterSimpleExpression2.setOperator(SearchExpression.OperatorEnum.EQUAL.getValue()); - cloudRouterSimpleExpression2.setProperty(CloudRouterSortBy.STATE.getValue()); - cloudRouterSimpleExpression2.values(singletonList(cloudRouter.getState().getValue())); - - CloudRouterFilters cloudRouterFilters = new CloudRouterFilters(); - CloudRouterFilter cloudRouterFilter = new CloudRouterFilter(cloudRouterSimpleExpression); - CloudRouterFilter cloudRouterFilter2 = new CloudRouterFilter(cloudRouterSimpleExpression2); - cloudRouterFilters.addAndItem(cloudRouterFilter); - cloudRouterFilters.addAndItem(cloudRouterFilter2); + CloudRouterExpression nameExpression = new CloudRouterExpression() + .operator(SearchExpression.OperatorEnum.EQUAL.getValue()) + .property(CloudRouterSortBy.NAME.getValue()) + .values(singletonList(cloudRouter.getName())); + + CloudRouterExpression stateExpression = new CloudRouterExpression() + .operator(SearchExpression.OperatorEnum.EQUAL.getValue()) + .property(CloudRouterSortBy.STATE.getValue()) + .values(singletonList(cloudRouter.getState().getValue())); + + CloudRouterExpression cloudRouterFilters = new CloudRouterExpression() + .and(Arrays.asList(nameExpression, stateExpression)); CloudRouterSearchRequest cloudRouterSearchRequest = new CloudRouterSearchRequest() .filter(cloudRouterFilters) diff --git a/equinix-openapi-fabric-tests/src/test/java/com/equinix/openapi/fabric/tests/ServiceProfilesApiTest.java b/equinix-openapi-fabric-tests/src/test/java/com/equinix/openapi/fabric/tests/ServiceProfilesApiTest.java index 408747b4..4922380d 100644 --- a/equinix-openapi-fabric-tests/src/test/java/com/equinix/openapi/fabric/tests/ServiceProfilesApiTest.java +++ b/equinix-openapi-fabric-tests/src/test/java/com/equinix/openapi/fabric/tests/ServiceProfilesApiTest.java @@ -134,7 +134,7 @@ public void searchServiceProfiles() throws ApiException { } public ServiceProfiles getServiceProfilesByQueryResponse(String viewPointQuery) throws ApiException { - return serviceProfilesApi.getServiceProfiles(1, 10, viewPointQuery); + return serviceProfilesApi.listServiceProfiles(1, 10, viewPointQuery); } /** diff --git a/equinix-openapi-fabric-tests/src/test/java/com/equinix/openapi/fabric/tests/helpers/Apis.java b/equinix-openapi-fabric-tests/src/test/java/com/equinix/openapi/fabric/tests/helpers/Apis.java index cc5f9b7a..78881fa8 100644 --- a/equinix-openapi-fabric-tests/src/test/java/com/equinix/openapi/fabric/tests/helpers/Apis.java +++ b/equinix-openapi-fabric-tests/src/test/java/com/equinix/openapi/fabric/tests/helpers/Apis.java @@ -6,13 +6,15 @@ import static com.equinix.openapi.fabric.tests.helpers.TokenGenerator.generate; public class Apis { + public static CloudRouterPackagesApi cloudRouterPackagesApi; public static CloudRoutersApi cloudRoutersApi; public static ConnectionsApi connectionsApi; public static HealthApi healthApi; public static MetrosApi metrosApi; public static NetworksApi networksApi; public static PortsApi portsApi; - public static PrecisionTimeApi precisionTimeApi; + public static PrecisionTimePackagesApi precisionTimePackagesApi; + public static PrecisionTimeServicesApi precisionTimeServicesApi; public static PricesApi pricesApi; public static RouteFilterRulesApi routeFilterRulesApi; public static RouteFiltersApi routeFiltersApi; @@ -40,13 +42,15 @@ public static UsersItem.UserName getCurrentUser() { } private static void setApis() { + cloudRouterPackagesApi = new CloudRouterPackagesApi(TokenGenerator.getApiClient(currentUser)); cloudRoutersApi = new CloudRoutersApi(TokenGenerator.getApiClient(currentUser)); connectionsApi = new ConnectionsApi(TokenGenerator.getApiClient(currentUser)); healthApi = new HealthApi(TokenGenerator.getApiClient(currentUser)); metrosApi = new MetrosApi(TokenGenerator.getApiClient(currentUser)); networksApi = new NetworksApi(TokenGenerator.getApiClient(currentUser)); portsApi = new PortsApi(TokenGenerator.getApiClient(currentUser)); - precisionTimeApi = new PrecisionTimeApi(TokenGenerator.getApiClient(currentUser)); + precisionTimePackagesApi = new PrecisionTimePackagesApi(TokenGenerator.getApiClient(currentUser)); + precisionTimeServicesApi = new PrecisionTimeServicesApi(TokenGenerator.getApiClient(currentUser)); pricesApi = new PricesApi(TokenGenerator.getApiClient(currentUser)); routeFiltersApi = new RouteFiltersApi(TokenGenerator.getApiClient(currentUser)); routeFilterRulesApi = new RouteFilterRulesApi(TokenGenerator.getApiClient(currentUser)); diff --git a/services/fabricv4/README.md b/services/fabricv4/README.md index cb85b9a4..167995cc 100644 --- a/services/fabricv4/README.md +++ b/services/fabricv4/README.md @@ -162,6 +162,11 @@ Class | Method | HTTP request | Description *ApplicationSubscriptionsApi* | [**getAppSubscriptionByUuid**](docs/ApplicationSubscriptionsApi.md#getAppSubscriptionByUuid) | **GET** /fabric/v4/appSubscriptions/{appSubscriptionId} | Get Subscription *ApplicationSubscriptionsApi* | [**searchAppSubscriptions**](docs/ApplicationSubscriptionsApi.md#searchAppSubscriptions) | **POST** /fabric/v4/appSubscriptions/search | Search Subscriptions *ApplicationSubscriptionsApi* | [**updateAppSubscriptionByUuid**](docs/ApplicationSubscriptionsApi.md#updateAppSubscriptionByUuid) | **PATCH** /fabric/v4/appSubscriptions/{appSubscriptionId} | Update Subscription +*AsnsApi* | [**createAsn**](docs/AsnsApi.md#createAsn) | **POST** /fabric/v4/asns | Create ASN +*AsnsApi* | [**deleteAsnById**](docs/AsnsApi.md#deleteAsnById) | **DELETE** /fabric/v4/asns/{asnId} | Delete ASN +*AsnsApi* | [**getAsnById**](docs/AsnsApi.md#getAsnById) | **GET** /fabric/v4/asns/{asnId} | Get ASN +*AsnsApi* | [**patchAsnById**](docs/AsnsApi.md#patchAsnById) | **PATCH** /fabric/v4/asns/{asnId} | Update ASN +*AsnsApi* | [**searchAsns**](docs/AsnsApi.md#searchAsns) | **POST** /fabric/v4/asns/search | Search ASNs *CloudRouterPackagesApi* | [**getCloudRouterPackageByCode**](docs/CloudRouterPackagesApi.md#getCloudRouterPackageByCode) | **GET** /fabric/v4/routerPackages/{routerPackageCode} | Get Package Details *CloudRouterPackagesApi* | [**getCloudRouterPackages**](docs/CloudRouterPackagesApi.md#getCloudRouterPackages) | **GET** /fabric/v4/routerPackages | List Packages *CloudRoutersApi* | [**createCloudRouter**](docs/CloudRoutersApi.md#createCloudRouter) | **POST** /fabric/v4/routers | Create Router @@ -539,10 +544,22 @@ Class | Method | HTTP request | Description - [AppSubscriptionTargetRequest](docs/AppSubscriptionTargetRequest.md) - [AppSubscriptionTargetRequestAppService](docs/AppSubscriptionTargetRequestAppService.md) - [AppSubscriptionType](docs/AppSubscriptionType.md) + - [Asn](docs/Asn.md) + - [AsnAsset](docs/AsnAsset.md) + - [AsnAssetIpBlockRef](docs/AsnAssetIpBlockRef.md) + - [AsnAssetService](docs/AsnAssetService.md) + - [AsnChange](docs/AsnChange.md) - [AsnOwnershipChallengeDetails](docs/AsnOwnershipChallengeDetails.md) - [AsnOwnershipChallengeLoa](docs/AsnOwnershipChallengeLoa.md) - [AsnOwnershipChallengeRpki](docs/AsnOwnershipChallengeRpki.md) - [AsnOwnershipChallengeType](docs/AsnOwnershipChallengeType.md) + - [AsnPatchOperation](docs/AsnPatchOperation.md) + - [AsnRange](docs/AsnRange.md) + - [AsnRirRegion](docs/AsnRirRegion.md) + - [AsnSearchRequestBody](docs/AsnSearchRequestBody.md) + - [AsnSearchResponseBody](docs/AsnSearchResponseBody.md) + - [AsnSearchSortCriteria](docs/AsnSearchSortCriteria.md) + - [AsnState](docs/AsnState.md) - [Asset](docs/Asset.md) - [AttachPrivateServiceResponse](docs/AttachPrivateServiceResponse.md) - [AttachServiceProfileResponse](docs/AttachServiceProfileResponse.md) @@ -640,10 +657,9 @@ Class | Method | HTTP request | Description - [CompanyProfileChange](docs/CompanyProfileChange.md) - [CompanyProfileChangeItem](docs/CompanyProfileChangeItem.md) - [CompanyProfileContact](docs/CompanyProfileContact.md) - - [CompanyProfileContactContacts](docs/CompanyProfileContactContacts.md) + - [CompanyProfileContactContactsInner](docs/CompanyProfileContactContactsInner.md) - [CompanyProfileRequest](docs/CompanyProfileRequest.md) - [CompanyProfileResponse](docs/CompanyProfileResponse.md) - - [CompanyProfileResponseAccount](docs/CompanyProfileResponseAccount.md) - [CompanyProfileSearchFieldName](docs/CompanyProfileSearchFieldName.md) - [CompanyProfileSearchFilter](docs/CompanyProfileSearchFilter.md) - [CompanyProfileSearchFilters](docs/CompanyProfileSearchFilters.md) @@ -660,7 +676,6 @@ Class | Method | HTTP request | Description - [ConnectionActionRequest](docs/ConnectionActionRequest.md) - [ConnectionChangeOperation](docs/ConnectionChangeOperation.md) - [ConnectionDirection](docs/ConnectionDirection.md) - - [ConnectionInvitation](docs/ConnectionInvitation.md) - [ConnectionLink](docs/ConnectionLink.md) - [ConnectionOperation](docs/ConnectionOperation.md) - [ConnectionPostRequest](docs/ConnectionPostRequest.md) @@ -685,17 +700,16 @@ Class | Method | HTTP request | Description - [ConnectionSearchResponse](docs/ConnectionSearchResponse.md) - [ConnectionSide](docs/ConnectionSide.md) - [ConnectionSideAdditionalInfo](docs/ConnectionSideAdditionalInfo.md) - - [ConnectionState](docs/ConnectionState.md) - [ConnectionType](docs/ConnectionType.md) - [ConnectivitySource](docs/ConnectivitySource.md) - [ConnectivitySourceType](docs/ConnectivitySourceType.md) - [ContactPreference](docs/ContactPreference.md) + - [CreateAsnRequest](docs/CreateAsnRequest.md) - [CreateCrossConnect](docs/CreateCrossConnect.md) - [CreateLoa](docs/CreateLoa.md) - [CreateLoaNote](docs/CreateLoaNote.md) - [CrossConnectASideDemarcationPoint](docs/CrossConnectASideDemarcationPoint.md) - [CrossConnectASideRequest](docs/CrossConnectASideRequest.md) - - [CrossConnectASideRequestDemarcationPoint](docs/CrossConnectASideRequestDemarcationPoint.md) - [CrossConnectASideResponse](docs/CrossConnectASideResponse.md) - [CrossConnectAccount](docs/CrossConnectAccount.md) - [CrossConnectActionAttachmentResponse](docs/CrossConnectActionAttachmentResponse.md) @@ -723,7 +737,6 @@ Class | Method | HTTP request | Description - [CrossConnectContactPreference](docs/CrossConnectContactPreference.md) - [CrossConnectDemarcationPoint](docs/CrossConnectDemarcationPoint.md) - [CrossConnectDiverse](docs/CrossConnectDiverse.md) - - [CrossConnectEndCustomer](docs/CrossConnectEndCustomer.md) - [CrossConnectFieldName](docs/CrossConnectFieldName.md) - [CrossConnectFilter](docs/CrossConnectFilter.md) - [CrossConnectLink](docs/CrossConnectLink.md) @@ -736,11 +749,9 @@ Class | Method | HTTP request | Description - [CrossConnectOrFilter](docs/CrossConnectOrFilter.md) - [CrossConnectParentNote](docs/CrossConnectParentNote.md) - [CrossConnectPhone](docs/CrossConnectPhone.md) - - [CrossConnectProject](docs/CrossConnectProject.md) - - [CrossConnectProvider](docs/CrossConnectProvider.md) - [CrossConnectRedundancy](docs/CrossConnectRedundancy.md) - [CrossConnectResponse](docs/CrossConnectResponse.md) - - [CrossConnectResponseAllowedActions](docs/CrossConnectResponseAllowedActions.md) + - [CrossConnectResponseAllowedActionsInner](docs/CrossConnectResponseAllowedActionsInner.md) - [CrossConnectScheduleAvailability](docs/CrossConnectScheduleAvailability.md) - [CrossConnectScheduleAvailabilityASide](docs/CrossConnectScheduleAvailabilityASide.md) - [CrossConnectScheduleAvailabilityZSide](docs/CrossConnectScheduleAvailabilityZSide.md) @@ -769,20 +780,19 @@ Class | Method | HTTP request | Description - [CrossConnectZSideResponseDemarcationPoint](docs/CrossConnectZSideResponseDemarcationPoint.md) - [CustomField](docs/CustomField.md) - [DeinstallScheduleRequest](docs/DeinstallScheduleRequest.md) - - [DeleteCrossConnect](docs/DeleteCrossConnect.md) - [DetectionMethod](docs/DetectionMethod.md) - [DetectionMethodResponse](docs/DetectionMethodResponse.md) - [DirectConnectionIpv4](docs/DirectConnectionIpv4.md) - [DirectConnectionIpv6](docs/DirectConnectionIpv6.md) - [Direction](docs/Direction.md) - [DiverseCrossConnectRequest](docs/DiverseCrossConnectRequest.md) - - [EndCustomer](docs/EndCustomer.md) - [EnvironmentActionRequest](docs/EnvironmentActionRequest.md) - [EnvironmentActionResponse](docs/EnvironmentActionResponse.md) - [EnvironmentActionStateEnum](docs/EnvironmentActionStateEnum.md) - [EnvironmentActionTypeEnum](docs/EnvironmentActionTypeEnum.md) - [EquinixStatus](docs/EquinixStatus.md) - [Error](docs/Error.md) + - [ErrorAdditionalInfoInner](docs/ErrorAdditionalInfoInner.md) - [ExchangeServiceActionRequest](docs/ExchangeServiceActionRequest.md) - [ExchangeServiceActionResponse](docs/ExchangeServiceActionResponse.md) - [ExchangeServiceAdditionalInfo](docs/ExchangeServiceAdditionalInfo.md) @@ -806,14 +816,6 @@ Class | Method | HTTP request | Description - [FabricCloudRouterPackages](docs/FabricCloudRouterPackages.md) - [FabricCloudRouterPrice](docs/FabricCloudRouterPrice.md) - [FilterBody](docs/FilterBody.md) - - [GatewayIpv4](docs/GatewayIpv4.md) - - [GatewayPackageCode](docs/GatewayPackageCode.md) - - [GatewaySearchRequest](docs/GatewaySearchRequest.md) - - [GatewaySortCriteria](docs/GatewaySortCriteria.md) - - [GatewaySortDirection](docs/GatewaySortDirection.md) - - [GatewayTunnelSearchRequest](docs/GatewayTunnelSearchRequest.md) - - [GatewayTunnelSortCriteria](docs/GatewayTunnelSortCriteria.md) - - [GatewayTunnelSortDirection](docs/GatewayTunnelSortDirection.md) - [GeoCoordinates](docs/GeoCoordinates.md) - [GeoScopeType](docs/GeoScopeType.md) - [GeoZone](docs/GeoZone.md) @@ -833,8 +835,7 @@ Class | Method | HTTP request | Description - [GetRouteFilterRulesResponse](docs/GetRouteFilterRulesResponse.md) - [HealthResponse](docs/HealthResponse.md) - [Hop](docs/Hop.md) - - [HopProbes](docs/HopProbes.md) - - [InternetAccess](docs/InternetAccess.md) + - [HopProbesInner](docs/HopProbesInner.md) - [InternetAccessAccount](docs/InternetAccessAccount.md) - [InternetAccessBgpAuthType](docs/InternetAccessBgpAuthType.md) - [InternetAccessBilling](docs/InternetAccessBilling.md) @@ -863,9 +864,9 @@ Class | Method | HTTP request | Description - [InternetAccessPostRequestBilling](docs/InternetAccessPostRequestBilling.md) - [InternetAccessRoutingProtocol](docs/InternetAccessRoutingProtocol.md) - [InternetAccessRoutingProtocolBgp](docs/InternetAccessRoutingProtocolBgp.md) - - [InternetAccessRoutingProtocolBgpAsn](docs/InternetAccessRoutingProtocolBgpAsn.md) + - [InternetAccessRoutingProtocolBgpAllOfAsn](docs/InternetAccessRoutingProtocolBgpAllOfAsn.md) - [InternetAccessRoutingProtocolBgpRequest](docs/InternetAccessRoutingProtocolBgpRequest.md) - - [InternetAccessRoutingProtocolBgpRequestAsn](docs/InternetAccessRoutingProtocolBgpRequestAsn.md) + - [InternetAccessRoutingProtocolBgpRequestAllOfAsn](docs/InternetAccessRoutingProtocolBgpRequestAllOfAsn.md) - [InternetAccessRoutingProtocolDirect](docs/InternetAccessRoutingProtocolDirect.md) - [InternetAccessRoutingProtocolDirectRequest](docs/InternetAccessRoutingProtocolDirectRequest.md) - [InternetAccessRoutingProtocolRequest](docs/InternetAccessRoutingProtocolRequest.md) @@ -961,7 +962,7 @@ Class | Method | HTTP request | Description - [MetalInterconnection](docs/MetalInterconnection.md) - [Metric](docs/Metric.md) - [MetricAssetType](docs/MetricAssetType.md) - - [MetricDatapoints](docs/MetricDatapoints.md) + - [MetricDatapointsInner](docs/MetricDatapointsInner.md) - [MetricFilters](docs/MetricFilters.md) - [MetricResource](docs/MetricResource.md) - [MetricSelector](docs/MetricSelector.md) @@ -1048,7 +1049,6 @@ Class | Method | HTTP request | Description - [PeeringType](docs/PeeringType.md) - [Phone](docs/Phone.md) - [PhysicalPort](docs/PhysicalPort.md) - - [PhysicalPortSettings](docs/PhysicalPortSettings.md) - [PhysicalPortType](docs/PhysicalPortType.md) - [PlatformChangelog](docs/PlatformChangelog.md) - [Port](docs/Port.md) @@ -1089,7 +1089,6 @@ Class | Method | HTTP request | Description - [PrecisionTimePackagePostResponse](docs/PrecisionTimePackagePostResponse.md) - [PrecisionTimePackageRequest](docs/PrecisionTimePackageRequest.md) - [PrecisionTimePackageResponse](docs/PrecisionTimePackageResponse.md) - - [PrecisionTimePrice](docs/PrecisionTimePrice.md) - [PrecisionTimeServiceConnectionsResponse](docs/PrecisionTimeServiceConnectionsResponse.md) - [PrecisionTimeServicePackagesResponse](docs/PrecisionTimeServicePackagesResponse.md) - [PrecisionTimeServiceRequest](docs/PrecisionTimeServiceRequest.md) @@ -1099,7 +1098,6 @@ Class | Method | HTTP request | Description - [PriceCategory](docs/PriceCategory.md) - [PriceCharge](docs/PriceCharge.md) - [PriceError](docs/PriceError.md) - - [PriceErrorAdditionalInfo](docs/PriceErrorAdditionalInfo.md) - [PriceLocation](docs/PriceLocation.md) - [PriceSearchResponse](docs/PriceSearchResponse.md) - [PrivateService](docs/PrivateService.md) @@ -1123,9 +1121,6 @@ Class | Method | HTTP request | Description - [ResourceData](docs/ResourceData.md) - [ResourceSelector](docs/ResourceSelector.md) - [ResourceSelectorResponse](docs/ResourceSelectorResponse.md) - - [ResponseIncompleteDetails](docs/ResponseIncompleteDetails.md) - - [ResponseUsageInputTokensDetails](docs/ResponseUsageInputTokensDetails.md) - - [ResponseUsageOutputTokensDetails](docs/ResponseUsageOutputTokensDetails.md) - [RfAttachmentSortItem](docs/RfAttachmentSortItem.md) - [RouteAggregationChangeData](docs/RouteAggregationChangeData.md) - [RouteAggregationChangeDataResponse](docs/RouteAggregationChangeDataResponse.md) @@ -1152,7 +1147,6 @@ Class | Method | HTTP request | Description - [RouteAggregationSortBy](docs/RouteAggregationSortBy.md) - [RouteAggregationSortCriteria](docs/RouteAggregationSortCriteria.md) - [RouteAggregationSortDirection](docs/RouteAggregationSortDirection.md) - - [RouteAggregationState](docs/RouteAggregationState.md) - [RouteAggregationsBase](docs/RouteAggregationsBase.md) - [RouteAggregationsChange](docs/RouteAggregationsChange.md) - [RouteAggregationsChangeOperation](docs/RouteAggregationsChangeOperation.md) @@ -1187,7 +1181,6 @@ Class | Method | HTTP request | Description - [RouteFilterSortBy](docs/RouteFilterSortBy.md) - [RouteFilterSortCriteria](docs/RouteFilterSortCriteria.md) - [RouteFilterSortDirection](docs/RouteFilterSortDirection.md) - - [RouteFilterState](docs/RouteFilterState.md) - [RouteFiltersBase](docs/RouteFiltersBase.md) - [RouteFiltersChange](docs/RouteFiltersChange.md) - [RouteFiltersChangeOperation](docs/RouteFiltersChangeOperation.md) @@ -1210,7 +1203,6 @@ Class | Method | HTTP request | Description - [RouteTableEntrySortDirection](docs/RouteTableEntrySortDirection.md) - [RouteTableEntryState](docs/RouteTableEntryState.md) - [RouteTableEntryType](docs/RouteTableEntryType.md) - - [Router](docs/Router.md) - [RouterActionsConnection](docs/RouterActionsConnection.md) - [RouterActionsRouter](docs/RouterActionsRouter.md) - [RouterPackageCode](docs/RouterPackageCode.md) @@ -1264,7 +1256,6 @@ Class | Method | HTTP request | Description - [ServiceProfileFilter](docs/ServiceProfileFilter.md) - [ServiceProfileLastMileApiIntegration](docs/ServiceProfileLastMileApiIntegration.md) - [ServiceProfileLastMileConfig](docs/ServiceProfileLastMileConfig.md) - - [ServiceProfileLastMileContactInfoItem](docs/ServiceProfileLastMileContactInfoItem.md) - [ServiceProfileLastMileDeliveryDateRange](docs/ServiceProfileLastMileDeliveryDateRange.md) - [ServiceProfileLastMileOffering](docs/ServiceProfileLastMileOffering.md) - [ServiceProfileLastMilePriceRange](docs/ServiceProfileLastMilePriceRange.md) @@ -1297,8 +1288,6 @@ Class | Method | HTTP request | Description - [ServiceTokenType](docs/ServiceTokenType.md) - [ServiceTokens](docs/ServiceTokens.md) - [Services](docs/Services.md) - - [SignatureRequest](docs/SignatureRequest.md) - - [SignatureType](docs/SignatureType.md) - [SimplifiedAccount](docs/SimplifiedAccount.md) - [SimplifiedAccountRequest](docs/SimplifiedAccountRequest.md) - [SimplifiedLinkProtocol](docs/SimplifiedLinkProtocol.md) @@ -1324,7 +1313,6 @@ Class | Method | HTTP request | Description - [StreamAsset](docs/StreamAsset.md) - [StreamAssetFilter](docs/StreamAssetFilter.md) - [StreamAssetFilters](docs/StreamAssetFilters.md) - - [StreamAssetInterface](docs/StreamAssetInterface.md) - [StreamAssetOrFilter](docs/StreamAssetOrFilter.md) - [StreamAssetPutRequest](docs/StreamAssetPutRequest.md) - [StreamAssetSearchRequest](docs/StreamAssetSearchRequest.md) @@ -1393,13 +1381,11 @@ Class | Method | HTTP request | Description - [TimeServiceSortCriteria](docs/TimeServiceSortCriteria.md) - [TimeServiceSortDirection](docs/TimeServiceSortDirection.md) - [TimeServicesSearchRequest](docs/TimeServicesSearchRequest.md) - - [TunnelRoutingProtocolIpv4](docs/TunnelRoutingProtocolIpv4.md) - - [TunnelRoutingProtocolPostRequestIpv4](docs/TunnelRoutingProtocolPostRequestIpv4.md) - [TypeOfIpBlockProduct](docs/TypeOfIpBlockProduct.md) - [ValidateConnectionResponse](docs/ValidateConnectionResponse.md) - [ValidateRequest](docs/ValidateRequest.md) - [ValidateRequestFilter](docs/ValidateRequestFilter.md) - - [ValidateRequestFilterAnd](docs/ValidateRequestFilterAnd.md) + - [ValidateRequestFilterAndInner](docs/ValidateRequestFilterAndInner.md) - [ValidateSubnetResponse](docs/ValidateSubnetResponse.md) - [ViewPoint](docs/ViewPoint.md) - [VirtualConnectionBridgePackageCode](docs/VirtualConnectionBridgePackageCode.md) @@ -1428,7 +1414,6 @@ Class | Method | HTTP request | Description - [VirtualPortRedundancy](docs/VirtualPortRedundancy.md) - [VirtualPortServiceType](docs/VirtualPortServiceType.md) - [VirtualPortType](docs/VirtualPortType.md) - - [VpicInterface](docs/VpicInterface.md) diff --git a/services/fabricv4/docs/ApplicationDomainsApi.md b/services/fabricv4/docs/ApplicationDomainsApi.md index a8cb3603..bd5be517 100644 --- a/services/fabricv4/docs/ApplicationDomainsApi.md +++ b/services/fabricv4/docs/ApplicationDomainsApi.md @@ -112,7 +112,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationDomainsApi apiInstance = new ApplicationDomainsApi(defaultClient); - UUID appDomainId = UUID.randomUUID(); // UUID | App Domain UUID + UUID appDomainId = UUID.fromString("20f3ef8e-d670-4236-86fa-bb0038adcfc3"); // UUID | App Domain UUID try { AppDomain result = apiInstance.deleteAppDomainByUuid(appDomainId); System.out.println(result); @@ -184,7 +184,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationDomainsApi apiInstance = new ApplicationDomainsApi(defaultClient); - UUID appDomainId = UUID.randomUUID(); // UUID | App Domain UUID + UUID appDomainId = UUID.fromString("20f3ef8e-d670-4236-86fa-bb0038adcfc3"); // UUID | App Domain UUID try { AppDomain result = apiInstance.getAppDomainByUuid(appDomainId); System.out.println(result); @@ -255,7 +255,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationDomainsApi apiInstance = new ApplicationDomainsApi(defaultClient); - UUID appDomainId = UUID.randomUUID(); // UUID | App Domain UUID + UUID appDomainId = UUID.fromString("20f3ef8e-d670-4236-86fa-bb0038adcfc3"); // UUID | App Domain UUID Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch List state = Arrays.asList(); // List | Filter attached App Links by one or more lifecycle states. @@ -409,7 +409,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationDomainsApi apiInstance = new ApplicationDomainsApi(defaultClient); - UUID appDomainId = UUID.randomUUID(); // UUID | App Domain UUID + UUID appDomainId = UUID.fromString("20f3ef8e-d670-4236-86fa-bb0038adcfc3"); // UUID | App Domain UUID List appDomainChangeOperation = Arrays.asList(); // List | try { AppDomain result = apiInstance.updateAppDomainByUuid(appDomainId, appDomainChangeOperation); diff --git a/services/fabricv4/docs/ApplicationLinksApi.md b/services/fabricv4/docs/ApplicationLinksApi.md index 271a4db3..cb799ce4 100644 --- a/services/fabricv4/docs/ApplicationLinksApi.md +++ b/services/fabricv4/docs/ApplicationLinksApi.md @@ -55,8 +55,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID - UUID appDomainId = UUID.randomUUID(); // UUID | App Domain UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID + UUID appDomainId = UUID.fromString("20f3ef8e-d670-4236-86fa-bb0038adcfc3"); // UUID | App Domain UUID try { AppLinkAppDomainAttachment result = apiInstance.attachAppDomainToAppLink(appLinkId, appDomainId); System.out.println(result); @@ -129,8 +129,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID - UUID appProcessorId = UUID.randomUUID(); // UUID | App Processor UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID + UUID appProcessorId = UUID.fromString("90ee425c-9988-454c-96d9-1128bc16350f"); // UUID | App Processor UUID AppLinkAttachProcessorRequest appLinkAttachProcessorRequest = new AppLinkAttachProcessorRequest(); // AppLinkAttachProcessorRequest | try { AppLinkAppProcessorAttachment result = apiInstance.attachAppProcessorToAppLink(appLinkId, appProcessorId, appLinkAttachProcessorRequest); @@ -206,8 +206,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID - UUID appServiceId = UUID.randomUUID(); // UUID | App Service UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID + UUID appServiceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | App Service UUID AppLinkAttachServiceRequest appLinkAttachServiceRequest = new AppLinkAttachServiceRequest(); // AppLinkAttachServiceRequest | try { AppLinkAppServiceAttachment result = apiInstance.attachAppServiceToAppLink(appLinkId, appServiceId, appLinkAttachServiceRequest); @@ -353,7 +353,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID try { AppLink result = apiInstance.deleteAppLinkByUuid(appLinkId); System.out.println(result); @@ -425,8 +425,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID - UUID appDomainId = UUID.randomUUID(); // UUID | App Domain UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID + UUID appDomainId = UUID.fromString("20f3ef8e-d670-4236-86fa-bb0038adcfc3"); // UUID | App Domain UUID try { AppLinkAppDomainAttachment result = apiInstance.detachAppDomainFromAppLink(appLinkId, appDomainId); System.out.println(result); @@ -499,8 +499,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID - UUID appProcessorId = UUID.randomUUID(); // UUID | App Processor UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID + UUID appProcessorId = UUID.fromString("90ee425c-9988-454c-96d9-1128bc16350f"); // UUID | App Processor UUID try { AppLinkAppProcessorAttachment result = apiInstance.detachAppProcessorFromAppLink(appLinkId, appProcessorId); System.out.println(result); @@ -573,8 +573,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID - UUID appServiceId = UUID.randomUUID(); // UUID | App Service UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID + UUID appServiceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | App Service UUID try { AppLinkAppServiceAttachment result = apiInstance.detachAppServiceFromAppLink(appLinkId, appServiceId); System.out.println(result); @@ -647,7 +647,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID try { AppLink result = apiInstance.getAppLinkByUuid(appLinkId); System.out.println(result); @@ -718,8 +718,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID - UUID appDomainId = UUID.randomUUID(); // UUID | App Domain UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID + UUID appDomainId = UUID.fromString("20f3ef8e-d670-4236-86fa-bb0038adcfc3"); // UUID | App Domain UUID try { AppLinkAppDomainAttachment result = apiInstance.getAttachedAppDomainByUuid(appLinkId, appDomainId); System.out.println(result); @@ -791,7 +791,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch List attachmentStatus = Arrays.asList(); // List | Filter attached App Domains by one or more attachment lifecycle states. @@ -873,8 +873,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID - UUID appProcessorId = UUID.randomUUID(); // UUID | App Processor UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID + UUID appProcessorId = UUID.fromString("90ee425c-9988-454c-96d9-1128bc16350f"); // UUID | App Processor UUID try { AppLinkAppProcessorAttachment result = apiInstance.getAttachedAppProcessor(appLinkId, appProcessorId); System.out.println(result); @@ -946,7 +946,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch List attachmentStatus = Arrays.asList(); // List | Filter attached App Processors by one or more attachment lifecycle states. @@ -1028,8 +1028,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID - UUID appServiceId = UUID.randomUUID(); // UUID | App Service UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID + UUID appServiceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | App Service UUID try { AppLinkAppServiceAttachment result = apiInstance.getAttachedAppServiceByUuid(appLinkId, appServiceId); System.out.println(result); @@ -1101,7 +1101,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch List attachmentStatus = Arrays.asList(); // List | Filter attached App Services by one or more attachment lifecycle states. @@ -1255,7 +1255,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID AppLinkAttachDomainSearchRequest appLinkAttachDomainSearchRequest = new AppLinkAttachDomainSearchRequest(); // AppLinkAttachDomainSearchRequest | try { AppLinkAttachDomainSearchResponse result = apiInstance.searchAttachedAppDomains(appLinkId, appLinkAttachDomainSearchRequest); @@ -1329,7 +1329,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID AppLinkAttachProcessorSearchRequest appLinkAttachProcessorSearchRequest = new AppLinkAttachProcessorSearchRequest(); // AppLinkAttachProcessorSearchRequest | try { AppLinkAttachProcessorSearchResponse result = apiInstance.searchAttachedAppProcessors(appLinkId, appLinkAttachProcessorSearchRequest); @@ -1403,7 +1403,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID AppLinkAttachServiceSearchRequest appLinkAttachServiceSearchRequest = new AppLinkAttachServiceSearchRequest(); // AppLinkAttachServiceSearchRequest | try { AppLinkAttachServiceSearchResponse result = apiInstance.searchAttachedAppServices(appLinkId, appLinkAttachServiceSearchRequest); @@ -1477,7 +1477,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID List appLinkChangeOperation = Arrays.asList(); // List | try { AppLink result = apiInstance.updateAppLinkByUuid(appLinkId, appLinkChangeOperation); @@ -1552,8 +1552,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationLinksApi apiInstance = new ApplicationLinksApi(defaultClient); - UUID appLinkId = UUID.randomUUID(); // UUID | App Link UUID - UUID appServiceId = UUID.randomUUID(); // UUID | App Service UUID + UUID appLinkId = UUID.fromString("23cd19ab-d3bb-478b-9f25-bd12a3af1914"); // UUID | App Link UUID + UUID appServiceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | App Service UUID List appLinkAppServiceAttachmentChangeOperation = Arrays.asList(); // List | try { AppLinkAppServiceAttachment result = apiInstance.updateAppServiceAttachmentToAppLink(appLinkId, appServiceId, appLinkAppServiceAttachmentChangeOperation); diff --git a/services/fabricv4/docs/ApplicationProcessorsApi.md b/services/fabricv4/docs/ApplicationProcessorsApi.md index d85327ca..032b9c31 100644 --- a/services/fabricv4/docs/ApplicationProcessorsApi.md +++ b/services/fabricv4/docs/ApplicationProcessorsApi.md @@ -36,7 +36,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationProcessorsApi apiInstance = new ApplicationProcessorsApi(defaultClient); - UUID appProcessorId = UUID.randomUUID(); // UUID | App Processor UUID + UUID appProcessorId = UUID.fromString("90ee425c-9988-454c-96d9-1128bc16350f"); // UUID | App Processor UUID try { AppProcessor result = apiInstance.getAppProcessorByUuid(appProcessorId); System.out.println(result); diff --git a/services/fabricv4/docs/ApplicationServicesApi.md b/services/fabricv4/docs/ApplicationServicesApi.md index 85ebe303..d9b27117 100644 --- a/services/fabricv4/docs/ApplicationServicesApi.md +++ b/services/fabricv4/docs/ApplicationServicesApi.md @@ -114,7 +114,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationServicesApi apiInstance = new ApplicationServicesApi(defaultClient); - UUID appServiceId = UUID.randomUUID(); // UUID | App Service UUID + UUID appServiceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | App Service UUID try { AppService result = apiInstance.deleteAppServiceByUuid(appServiceId); System.out.println(result); @@ -186,7 +186,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationServicesApi apiInstance = new ApplicationServicesApi(defaultClient); - UUID appServiceId = UUID.randomUUID(); // UUID | App Service UUID + UUID appServiceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | App Service UUID try { AppService result = apiInstance.getAppServiceByUuid(appServiceId); System.out.println(result); @@ -257,7 +257,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationServicesApi apiInstance = new ApplicationServicesApi(defaultClient); - UUID appServiceId = UUID.randomUUID(); // UUID | App Service UUID + UUID appServiceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | App Service UUID Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch List state = Arrays.asList(); // List | Filter attached App Links by one or more lifecycle states. @@ -339,7 +339,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationServicesApi apiInstance = new ApplicationServicesApi(defaultClient); - UUID appServiceId = UUID.randomUUID(); // UUID | App Service UUID + UUID appServiceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | App Service UUID Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch List state = Arrays.asList(); // List | Filter attached App Subscriptions by one or more lifecycle states. @@ -493,7 +493,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationServicesApi apiInstance = new ApplicationServicesApi(defaultClient); - UUID appServiceId = UUID.randomUUID(); // UUID | App Service UUID + UUID appServiceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | App Service UUID AppServiceAttachedAppSubscriptionSearchRequest appServiceAttachedAppSubscriptionSearchRequest = new AppServiceAttachedAppSubscriptionSearchRequest(); // AppServiceAttachedAppSubscriptionSearchRequest | try { AppServiceAttachedAppSubscriptionSearchResponse result = apiInstance.searchAttachedAppSubscriptionsByAppServiceId(appServiceId, appServiceAttachedAppSubscriptionSearchRequest); @@ -567,7 +567,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationServicesApi apiInstance = new ApplicationServicesApi(defaultClient); - UUID appServiceId = UUID.randomUUID(); // UUID | App Service UUID + UUID appServiceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | App Service UUID List appServiceChangeOperation = Arrays.asList(); // List | try { AppService result = apiInstance.updateAppServiceByUuid(appServiceId, appServiceChangeOperation); diff --git a/services/fabricv4/docs/ApplicationSubscriptionsApi.md b/services/fabricv4/docs/ApplicationSubscriptionsApi.md index 4af378c4..ab743d7e 100644 --- a/services/fabricv4/docs/ApplicationSubscriptionsApi.md +++ b/services/fabricv4/docs/ApplicationSubscriptionsApi.md @@ -110,7 +110,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationSubscriptionsApi apiInstance = new ApplicationSubscriptionsApi(defaultClient); - UUID appSubscriptionId = UUID.randomUUID(); // UUID | App Subscription UUID + UUID appSubscriptionId = UUID.fromString("20f3ef8e-d670-4236-86fa-bb0038adcfc3"); // UUID | App Subscription UUID try { AppSubscription result = apiInstance.deleteAppSubscriptionByUuid(appSubscriptionId); System.out.println(result); @@ -182,7 +182,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationSubscriptionsApi apiInstance = new ApplicationSubscriptionsApi(defaultClient); - UUID appSubscriptionId = UUID.randomUUID(); // UUID | App Subscription UUID + UUID appSubscriptionId = UUID.fromString("20f3ef8e-d670-4236-86fa-bb0038adcfc3"); // UUID | App Subscription UUID try { AppSubscription result = apiInstance.getAppSubscriptionByUuid(appSubscriptionId); System.out.println(result); @@ -325,7 +325,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ApplicationSubscriptionsApi apiInstance = new ApplicationSubscriptionsApi(defaultClient); - UUID appSubscriptionId = UUID.randomUUID(); // UUID | App Subscription UUID + UUID appSubscriptionId = UUID.fromString("20f3ef8e-d670-4236-86fa-bb0038adcfc3"); // UUID | App Subscription UUID List appSubscriptionChangeOperation = Arrays.asList(); // List | try { AppSubscription result = apiInstance.updateAppSubscriptionByUuid(appSubscriptionId, appSubscriptionChangeOperation); diff --git a/services/fabricv4/docs/Asn.md b/services/fabricv4/docs/Asn.md new file mode 100644 index 00000000..2d0d2299 --- /dev/null +++ b/services/fabricv4/docs/Asn.md @@ -0,0 +1,26 @@ + + +# Asn + +ASN Record + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**href** | **String** | | [optional] | +|**uuid** | **UUID** | Unique identifier for the ASN record | [optional] | +|**state** | **AsnState** | | [optional] | +|**project** | [**Project**](Project.md) | | [optional] | +|**number** | **Long** | Autonomous System Number | [optional] | +|**rirRegion** | **AsnRirRegion** | | [optional] | +|**location** | [**SimplifiedLocation**](SimplifiedLocation.md) | | [optional] | +|**range** | **AsnRange** | | [optional] | +|**ownershipChallengeDetails** | [**AsnOwnershipChallengeDetails**](AsnOwnershipChallengeDetails.md) | | [optional] | +|**change** | [**AsnChange**](AsnChange.md) | | [optional] | +|**assets** | [**List<AsnAsset>**](AsnAsset.md) | | [optional] | +|**errors** | [**List<Error>**](Error.md) | List of errors | [optional] | +|**changeLog** | [**Changelog**](Changelog.md) | | [optional] | + + + diff --git a/services/fabricv4/docs/AsnAsset.md b/services/fabricv4/docs/AsnAsset.md new file mode 100644 index 00000000..627758fe --- /dev/null +++ b/services/fabricv4/docs/AsnAsset.md @@ -0,0 +1,18 @@ + + +# AsnAsset + +Asset associated with ASN + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**uuid** | **String** | | [optional] | +|**service** | [**AsnAssetService**](AsnAssetService.md) | | [optional] | +|**announcingMetro** | **String** | | [optional] | +|**ipBlocks** | [**List<AsnAssetIpBlockRef>**](AsnAssetIpBlockRef.md) | | [optional] | +|**changeLog** | [**Changelog**](Changelog.md) | | [optional] | + + + diff --git a/services/fabricv4/docs/AsnAssetIpBlockRef.md b/services/fabricv4/docs/AsnAssetIpBlockRef.md new file mode 100644 index 00000000..e5e4331e --- /dev/null +++ b/services/fabricv4/docs/AsnAssetIpBlockRef.md @@ -0,0 +1,24 @@ + + +# AsnAssetIpBlockRef + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**href** | **String** | | [optional] | +|**type** | [**TypeEnum**](#TypeEnum) | | [optional] | +|**uuid** | **String** | | [optional] | + + + +## Enum: TypeEnum + +| Name | Value | +|---- | -----| +| IPV4_IP_BLOCK | "IPV4_IP_BLOCK" | +| IPV6_IP_BLOCK | "IPV6_IP_BLOCK" | + + + diff --git a/services/fabricv4/docs/Router.md b/services/fabricv4/docs/AsnAssetService.md similarity index 56% rename from services/fabricv4/docs/Router.md rename to services/fabricv4/docs/AsnAssetService.md index 1796b7c4..30c9a0d2 100644 --- a/services/fabricv4/docs/Router.md +++ b/services/fabricv4/docs/AsnAssetService.md @@ -1,15 +1,16 @@ -# Router +# AsnAssetService +Associated Internet Access Service reference ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**href** | **URI** | Fabric Cloud Router URI | [optional] [readonly] | -|**uuid** | **UUID** | Cloud Router UUID | [optional] | +|**href** | **String** | | [optional] | |**type** | [**TypeEnum**](#TypeEnum) | | [optional] | +|**uuid** | **String** | | [optional] | @@ -17,7 +18,7 @@ | Name | Value | |---- | -----| -| XF_ROUTER | "XF_ROUTER" | +| IA | "IA" | diff --git a/services/fabricv4/docs/CompanyProfileResponseAccount.md b/services/fabricv4/docs/AsnChange.md similarity index 53% rename from services/fabricv4/docs/CompanyProfileResponseAccount.md rename to services/fabricv4/docs/AsnChange.md index cd74b1ba..4ac5d647 100644 --- a/services/fabricv4/docs/CompanyProfileResponseAccount.md +++ b/services/fabricv4/docs/AsnChange.md @@ -1,13 +1,14 @@ -# CompanyProfileResponseAccount +# AsnChange +Change reference for ASN ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**rootOrgId** | **String** | | [optional] | +|**href** | **String** | URL path to the change event | [optional] | diff --git a/services/fabricv4/docs/AsnPatchOperation.md b/services/fabricv4/docs/AsnPatchOperation.md new file mode 100644 index 00000000..5f31cd55 --- /dev/null +++ b/services/fabricv4/docs/AsnPatchOperation.md @@ -0,0 +1,25 @@ + + +# AsnPatchOperation + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**op** | [**OpEnum**](#OpEnum) | JSON Patch operation | | +|**path** | **String** | JSON Pointer to the field to update | | +|**value** | **Object** | New value for add or replace operations | | + + + +## Enum: OpEnum + +| Name | Value | +|---- | -----| +| ADD | "add" | +| REMOVE | "remove" | +| REPLACE | "replace" | + + + diff --git a/services/fabricv4/docs/AsnRange.md b/services/fabricv4/docs/AsnRange.md new file mode 100644 index 00000000..79dfcdf8 --- /dev/null +++ b/services/fabricv4/docs/AsnRange.md @@ -0,0 +1,13 @@ + + +# AsnRange + +## Enum + + +* `_16_BIT` (value: `"16_BIT"`) + +* `_32_BIT` (value: `"32_BIT"`) + + + diff --git a/services/fabricv4/docs/AsnRirRegion.md b/services/fabricv4/docs/AsnRirRegion.md new file mode 100644 index 00000000..1d7cd2e0 --- /dev/null +++ b/services/fabricv4/docs/AsnRirRegion.md @@ -0,0 +1,19 @@ + + +# AsnRirRegion + +## Enum + + +* `AFRINIC` (value: `"AFRINIC"`) + +* `APNIC` (value: `"APNIC"`) + +* `ARIN` (value: `"ARIN"`) + +* `LACNIC` (value: `"LACNIC"`) + +* `RIPE_NCC` (value: `"RIPE_NCC"`) + + + diff --git a/services/fabricv4/docs/GatewaySearchRequest.md b/services/fabricv4/docs/AsnSearchRequestBody.md similarity index 50% rename from services/fabricv4/docs/GatewaySearchRequest.md rename to services/fabricv4/docs/AsnSearchRequestBody.md index 6ab603ca..32db23a2 100644 --- a/services/fabricv4/docs/GatewaySearchRequest.md +++ b/services/fabricv4/docs/AsnSearchRequestBody.md @@ -1,16 +1,15 @@ -# GatewaySearchRequest +# AsnSearchRequestBody -Search gateways ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**filter** | [**SearchFilter**](SearchFilter.md) | | [optional] | |**pagination** | [**PaginationRequest**](PaginationRequest.md) | | [optional] | -|**sort** | [**List<GatewaySortCriteria>**](GatewaySortCriteria.md) | | [optional] | +|**filter** | [**SearchExpression**](SearchExpression.md) | | [optional] | +|**sort** | [**List<AsnSearchSortCriteria>**](AsnSearchSortCriteria.md) | | [optional] | diff --git a/services/fabricv4/docs/AsnSearchResponseBody.md b/services/fabricv4/docs/AsnSearchResponseBody.md new file mode 100644 index 00000000..dfd65adc --- /dev/null +++ b/services/fabricv4/docs/AsnSearchResponseBody.md @@ -0,0 +1,15 @@ + + +# AsnSearchResponseBody + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**pagination** | [**Pagination**](Pagination.md) | | | +|**sort** | [**List<AsnSearchSortCriteria>**](AsnSearchSortCriteria.md) | | [optional] | +|**data** | [**List<Asn>**](Asn.md) | | | + + + diff --git a/services/fabricv4/docs/AsnSearchSortCriteria.md b/services/fabricv4/docs/AsnSearchSortCriteria.md new file mode 100644 index 00000000..4c68488d --- /dev/null +++ b/services/fabricv4/docs/AsnSearchSortCriteria.md @@ -0,0 +1,23 @@ + + +# AsnSearchSortCriteria + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**direction** | [**DirectionEnum**](#DirectionEnum) | Sorting direction | [optional] | +|**property** | **String** | Possible field names to use on sorting | [optional] | + + + +## Enum: DirectionEnum + +| Name | Value | +|---- | -----| +| DESC | "DESC" | +| ASC | "ASC" | + + + diff --git a/services/fabricv4/docs/AsnState.md b/services/fabricv4/docs/AsnState.md new file mode 100644 index 00000000..13e17327 --- /dev/null +++ b/services/fabricv4/docs/AsnState.md @@ -0,0 +1,29 @@ + + +# AsnState + +## Enum + + +* `REQUESTED` (value: `"REQUESTED"`) + +* `PROVISIONING` (value: `"PROVISIONING"`) + +* `PENDING` (value: `"PENDING"`) + +* `PROVISIONED` (value: `"PROVISIONED"`) + +* `ATTACHED` (value: `"ATTACHED"`) + +* `FAILED` (value: `"FAILED"`) + +* `PROVISIONING_FAILED` (value: `"PROVISIONING_FAILED"`) + +* `DEPROVISIONING` (value: `"DEPROVISIONING"`) + +* `DEPROVISIONING_FAILED` (value: `"DEPROVISIONING_FAILED"`) + +* `DEPROVISIONED` (value: `"DEPROVISIONED"`) + + + diff --git a/services/fabricv4/docs/AsnsApi.md b/services/fabricv4/docs/AsnsApi.md new file mode 100644 index 00000000..cd763ba6 --- /dev/null +++ b/services/fabricv4/docs/AsnsApi.md @@ -0,0 +1,372 @@ +# AsnsApi + +All URIs are relative to *https://api.equinix.com* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +| [**createAsn**](AsnsApi.md#createAsn) | **POST** /fabric/v4/asns | Create ASN | +| [**deleteAsnById**](AsnsApi.md#deleteAsnById) | **DELETE** /fabric/v4/asns/{asnId} | Delete ASN | +| [**getAsnById**](AsnsApi.md#getAsnById) | **GET** /fabric/v4/asns/{asnId} | Get ASN | +| [**patchAsnById**](AsnsApi.md#patchAsnById) | **PATCH** /fabric/v4/asns/{asnId} | Update ASN | +| [**searchAsns**](AsnsApi.md#searchAsns) | **POST** /fabric/v4/asns/search | Search ASNs | + + + +# **createAsn** +> Asn createAsn(createAsnRequest) + +Create ASN + +Create a new Public or Private ASN record + +### Example +```java +// Import classes: +import com.equinix.sdk.fabricv4.ApiClient; +import com.equinix.sdk.fabricv4.ApiException; +import com.equinix.sdk.fabricv4.Configuration; +import com.equinix.sdk.fabricv4.auth.*; +import com.equinix.sdk.fabricv4.models.*; +import com.equinix.sdk.fabricv4.api.AsnsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.equinix.com"); + + // Configure HTTP bearer authorization: BearerAuth + HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth"); + BearerAuth.setBearerToken("BEARER TOKEN"); + + AsnsApi apiInstance = new AsnsApi(defaultClient); + CreateAsnRequest createAsnRequest = new CreateAsnRequest(); // CreateAsnRequest | + try { + Asn result = apiInstance.createAsn(createAsnRequest); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AsnsApi#createAsn"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **createAsnRequest** | [**CreateAsnRequest**](CreateAsnRequest.md)| | | + +### Return type + +[**Asn**](Asn.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **202** | ASN request accepted | - | +| **400** | Bad request | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | +| **500** | Internal server error | - | + + +# **deleteAsnById** +> Asn deleteAsnById(asnId) + +Delete ASN + +Deprovision ASN record by UUID + +### Example +```java +// Import classes: +import com.equinix.sdk.fabricv4.ApiClient; +import com.equinix.sdk.fabricv4.ApiException; +import com.equinix.sdk.fabricv4.Configuration; +import com.equinix.sdk.fabricv4.auth.*; +import com.equinix.sdk.fabricv4.models.*; +import com.equinix.sdk.fabricv4.api.AsnsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.equinix.com"); + + // Configure HTTP bearer authorization: BearerAuth + HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth"); + BearerAuth.setBearerToken("BEARER TOKEN"); + + AsnsApi apiInstance = new AsnsApi(defaultClient); + UUID asnId = UUID.randomUUID(); // UUID | UUID of the ASN record + try { + Asn result = apiInstance.deleteAsnById(asnId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AsnsApi#deleteAsnById"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **asnId** | **UUID**| UUID of the ASN record | | + +### Return type + +[**Asn**](Asn.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **202** | ASN request accepted | - | +| **400** | Bad request | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | +| **404** | Not Found | - | +| **500** | Internal server error | - | + + +# **getAsnById** +> Asn getAsnById(asnId) + +Get ASN + +Retrieve ASN record by UUID + +### Example +```java +// Import classes: +import com.equinix.sdk.fabricv4.ApiClient; +import com.equinix.sdk.fabricv4.ApiException; +import com.equinix.sdk.fabricv4.Configuration; +import com.equinix.sdk.fabricv4.auth.*; +import com.equinix.sdk.fabricv4.models.*; +import com.equinix.sdk.fabricv4.api.AsnsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.equinix.com"); + + // Configure HTTP bearer authorization: BearerAuth + HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth"); + BearerAuth.setBearerToken("BEARER TOKEN"); + + AsnsApi apiInstance = new AsnsApi(defaultClient); + UUID asnId = UUID.randomUUID(); // UUID | UUID of the ASN record + try { + Asn result = apiInstance.getAsnById(asnId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AsnsApi#getAsnById"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **asnId** | **UUID**| UUID of the ASN record | | + +### Return type + +[**Asn**](Asn.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | ASN retrieved successfully | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | +| **404** | Not Found | - | +| **500** | Internal server error | - | + + +# **patchAsnById** +> Asn patchAsnById(asnId, asnPatchOperation) + +Update ASN + +Update ASN record + +### Example +```java +// Import classes: +import com.equinix.sdk.fabricv4.ApiClient; +import com.equinix.sdk.fabricv4.ApiException; +import com.equinix.sdk.fabricv4.Configuration; +import com.equinix.sdk.fabricv4.auth.*; +import com.equinix.sdk.fabricv4.models.*; +import com.equinix.sdk.fabricv4.api.AsnsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.equinix.com"); + + // Configure HTTP bearer authorization: BearerAuth + HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth"); + BearerAuth.setBearerToken("BEARER TOKEN"); + + AsnsApi apiInstance = new AsnsApi(defaultClient); + UUID asnId = UUID.randomUUID(); // UUID | UUID of the ASN record + List asnPatchOperation = Arrays.asList(); // List | + try { + Asn result = apiInstance.patchAsnById(asnId, asnPatchOperation); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AsnsApi#patchAsnById"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **asnId** | **UUID**| UUID of the ASN record | | +| **asnPatchOperation** | [**List<AsnPatchOperation>**](AsnPatchOperation.md)| | | + +### Return type + +[**Asn**](Asn.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **202** | ASN request accepted | - | +| **400** | Bad request | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | +| **404** | Not Found | - | +| **500** | Internal server error | - | + + +# **searchAsns** +> AsnSearchResponseBody searchAsns(asnSearchRequestBody) + +Search ASNs + +Search for ASN records based on criteria + +### Example +```java +// Import classes: +import com.equinix.sdk.fabricv4.ApiClient; +import com.equinix.sdk.fabricv4.ApiException; +import com.equinix.sdk.fabricv4.Configuration; +import com.equinix.sdk.fabricv4.auth.*; +import com.equinix.sdk.fabricv4.models.*; +import com.equinix.sdk.fabricv4.api.AsnsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.equinix.com"); + + // Configure HTTP bearer authorization: BearerAuth + HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth"); + BearerAuth.setBearerToken("BEARER TOKEN"); + + AsnsApi apiInstance = new AsnsApi(defaultClient); + AsnSearchRequestBody asnSearchRequestBody = new AsnSearchRequestBody(); // AsnSearchRequestBody | + try { + AsnSearchResponseBody result = apiInstance.searchAsns(asnSearchRequestBody); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AsnsApi#searchAsns"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **asnSearchRequestBody** | [**AsnSearchRequestBody**](AsnSearchRequestBody.md)| | | + +### Return type + +[**AsnSearchResponseBody**](AsnSearchResponseBody.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | ASN records found successfully | - | +| **400** | Bad request | - | +| **401** | Unauthorized | - | +| **403** | Forbidden | - | +| **500** | Internal server error | - | + diff --git a/services/fabricv4/docs/CloudRoutersApi.md b/services/fabricv4/docs/CloudRoutersApi.md index 38046aa6..97808d64 100644 --- a/services/fabricv4/docs/CloudRoutersApi.md +++ b/services/fabricv4/docs/CloudRoutersApi.md @@ -125,7 +125,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Router UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Router UUID CloudRouterActionRequest cloudRouterActionRequest = new CloudRouterActionRequest(); // CloudRouterActionRequest | try { CloudRouterActionResponse result = apiInstance.createCloudRouterAction(routerId, cloudRouterActionRequest); @@ -200,7 +200,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Router UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Router UUID CloudRouterCommandPostRequest cloudRouterCommandPostRequest = new CloudRouterCommandPostRequest(); // CloudRouterCommandPostRequest | try { CloudRouterCommand result = apiInstance.createCloudRouterCommand(routerId, cloudRouterCommandPostRequest); @@ -275,7 +275,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Cloud Router UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Cloud Router UUID try { apiInstance.deleteCloudRouterByUuid(routerId); } catch (ApiException e) { @@ -346,8 +346,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Router UUID - UUID commandId = UUID.randomUUID(); // UUID | Command UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Router UUID + UUID commandId = UUID.fromString("37c10edc-ba2e-4240-a850-8a48f9c47d00"); // UUID | Command UUID try { apiInstance.deleteCloudRouterCommandByUuid(routerId, commandId); } catch (ApiException e) { @@ -419,7 +419,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Router UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Router UUID try { GetAllCloudRouterCommands result = apiInstance.getAllCloudRouterCommands(routerId); System.out.println(result); @@ -492,7 +492,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Router UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Router UUID CloudRouterActionState state = CloudRouterActionState.fromValue("SUCCEEDED"); // CloudRouterActionState | Action state try { CloudRouterActionsSearchResponse result = apiInstance.getCloudRouterActions(routerId, state); @@ -567,8 +567,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Router UUID - UUID actionId = UUID.randomUUID(); // UUID | Action UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Router UUID + UUID actionId = UUID.fromString("457400f8-d360-11e9-bb65-2a2ae2dbcced"); // UUID | Action UUID CloudRouterActionState state = CloudRouterActionState.fromValue("SUCCEEDED"); // CloudRouterActionState | Action state try { CloudRouterActionResponse result = apiInstance.getCloudRouterActionsByUuid(routerId, actionId, state); @@ -644,7 +644,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Cloud Router UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Cloud Router UUID try { CloudRouterReadResponse result = apiInstance.getCloudRouterByUuid(routerId); System.out.println(result); @@ -715,8 +715,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Router UUID - UUID commandId = UUID.randomUUID(); // UUID | Command UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Router UUID + UUID commandId = UUID.fromString("37c10edc-ba2e-4240-a850-8a48f9c47d00"); // UUID | Command UUID try { CloudRouterCommand result = apiInstance.getCloudRouterCommand(routerId, commandId); System.out.println(result); @@ -790,7 +790,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Router UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Router UUID CloudRouterCommandSearchRequest cloudRouterCommandSearchRequest = new CloudRouterCommandSearchRequest(); // CloudRouterCommandSearchRequest | try { CloudRouterCommandSearchResponse result = apiInstance.searchCloudRouterCommands(routerId, cloudRouterCommandSearchRequest); @@ -865,7 +865,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Router UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Router UUID RouteTableEntrySearchRequest routeTableEntrySearchRequest = new RouteTableEntrySearchRequest(); // RouteTableEntrySearchRequest | try { RouteTableEntrySearchResponse result = apiInstance.searchCloudRouterRoutes(routerId, routeTableEntrySearchRequest); @@ -1012,7 +1012,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - String connectionId = "connectionId_example"; // String | Connection Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id ConnectionRouteSearchRequest connectionRouteSearchRequest = new ConnectionRouteSearchRequest(); // ConnectionRouteSearchRequest | try { ConnectionRouteTableEntrySearchResponse result = apiInstance.searchConnectionAdvertisedRoutes(connectionId, connectionRouteSearchRequest); @@ -1085,7 +1085,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - String connectionId = "connectionId_example"; // String | Connection Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id ConnectionRouteSearchRequest connectionRouteSearchRequest = new ConnectionRouteSearchRequest(); // ConnectionRouteSearchRequest | try { ConnectionRouteTableEntrySearchResponse result = apiInstance.searchConnectionReceivedRoutes(connectionId, connectionRouteSearchRequest); @@ -1158,7 +1158,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Router UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Router UUID CloudRouterActionsSearchRequest cloudRouterActionsSearchRequest = new CloudRouterActionsSearchRequest(); // CloudRouterActionsSearchRequest | try { CloudRouterActionsSearchResponse result = apiInstance.searchRouterActions(routerId, cloudRouterActionsSearchRequest); @@ -1233,7 +1233,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CloudRoutersApi apiInstance = new CloudRoutersApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Cloud Router UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Cloud Router UUID List cloudRouterChangeOperation = Arrays.asList(); // List | try { CloudRouter result = apiInstance.updateCloudRouterByUuid(routerId, cloudRouterChangeOperation); diff --git a/services/fabricv4/docs/CompanyProfileContact.md b/services/fabricv4/docs/CompanyProfileContact.md index 2d714d3f..32b87fc3 100644 --- a/services/fabricv4/docs/CompanyProfileContact.md +++ b/services/fabricv4/docs/CompanyProfileContact.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| |**type** | [**TypeEnum**](#TypeEnum) | Contact Type | [optional] | -|**contacts** | [**List<CompanyProfileContactContacts>**](CompanyProfileContactContacts.md) | | [optional] | +|**contacts** | [**List<CompanyProfileContactContactsInner>**](CompanyProfileContactContactsInner.md) | | [optional] | diff --git a/services/fabricv4/docs/CompanyProfileContactContacts.md b/services/fabricv4/docs/CompanyProfileContactContactsInner.md similarity index 86% rename from services/fabricv4/docs/CompanyProfileContactContacts.md rename to services/fabricv4/docs/CompanyProfileContactContactsInner.md index cd2d8a6e..5539e098 100644 --- a/services/fabricv4/docs/CompanyProfileContactContacts.md +++ b/services/fabricv4/docs/CompanyProfileContactContactsInner.md @@ -1,6 +1,6 @@ -# CompanyProfileContactContacts +# CompanyProfileContactContactsInner ## Properties diff --git a/services/fabricv4/docs/CompanyProfileResponse.md b/services/fabricv4/docs/CompanyProfileResponse.md index 6d0d48b1..a3b25e99 100644 --- a/services/fabricv4/docs/CompanyProfileResponse.md +++ b/services/fabricv4/docs/CompanyProfileResponse.md @@ -14,7 +14,6 @@ |**summary** | **String** | | [optional] | |**description** | **String** | | [optional] | |**state** | **String** | Company Profile State | [optional] | -|**account** | [**CompanyProfileResponseAccount**](CompanyProfileResponseAccount.md) | | [optional] | |**metros** | [**List<CompanyMetro>**](CompanyMetro.md) | | [optional] | |**logo** | [**CompanyLogo**](CompanyLogo.md) | | [optional] | |**tags** | [**List<TagResponse>**](TagResponse.md) | | [optional] | diff --git a/services/fabricv4/docs/Connection.md b/services/fabricv4/docs/Connection.md index aaec8ced..99ac0d29 100644 --- a/services/fabricv4/docs/Connection.md +++ b/services/fabricv4/docs/Connection.md @@ -13,7 +13,6 @@ Connection specification |**uuid** | **String** | Equinix-assigned connection identifier | [optional] | |**name** | **String** | Customer-provided connection name | | |**description** | **String** | Customer-provided connection description | [optional] | -|**state** | **ConnectionState** | | [optional] | |**change** | [**Change**](Change.md) | | [optional] | |**operation** | [**ConnectionOperation**](ConnectionOperation.md) | | [optional] | |**order** | [**Order**](Order.md) | | [optional] | diff --git a/services/fabricv4/docs/ConnectionInvitation.md b/services/fabricv4/docs/ConnectionInvitation.md deleted file mode 100644 index 4a510452..00000000 --- a/services/fabricv4/docs/ConnectionInvitation.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# ConnectionInvitation - -Connection Invitation Details - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**email** | **String** | invitee email | [optional] | -|**message** | **String** | invitation message | [optional] | -|**ctrDraftOrderId** | **String** | draft order id for invitation | [optional] | - - - diff --git a/services/fabricv4/docs/ConnectionPostRequest.md b/services/fabricv4/docs/ConnectionPostRequest.md index 7ccd6720..82b1558d 100644 --- a/services/fabricv4/docs/ConnectionPostRequest.md +++ b/services/fabricv4/docs/ConnectionPostRequest.md @@ -20,7 +20,6 @@ Create connection post request |**project** | [**Project**](Project.md) | | [optional] | |**additionalInfo** | [**List<ConnectionSideAdditionalInfo>**](ConnectionSideAdditionalInfo.md) | Connection additional information | [optional] | |**marketplaceSubscription** | [**MarketplaceSubscription**](MarketplaceSubscription.md) | | [optional] | -|**endCustomer** | [**EndCustomer**](EndCustomer.md) | | [optional] | diff --git a/services/fabricv4/docs/ConnectionState.md b/services/fabricv4/docs/ConnectionState.md deleted file mode 100644 index ebef3ccd..00000000 --- a/services/fabricv4/docs/ConnectionState.md +++ /dev/null @@ -1,27 +0,0 @@ - - -# ConnectionState - -## Enum - - -* `ACTIVE` (value: `"ACTIVE"`) - -* `CANCELLED` (value: `"CANCELLED"`) - -* `DEPROVISIONED` (value: `"DEPROVISIONED"`) - -* `DEPROVISIONING` (value: `"DEPROVISIONING"`) - -* `DRAFT` (value: `"DRAFT"`) - -* `FAILED` (value: `"FAILED"`) - -* `PENDING` (value: `"PENDING"`) - -* `PROVISIONING` (value: `"PROVISIONING"`) - -* `EMPTY` (value: `""`) - - - diff --git a/services/fabricv4/docs/ConnectionsApi.md b/services/fabricv4/docs/ConnectionsApi.md index 37fba877..9163172b 100644 --- a/services/fabricv4/docs/ConnectionsApi.md +++ b/services/fabricv4/docs/ConnectionsApi.md @@ -115,7 +115,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ConnectionsApi apiInstance = new ConnectionsApi(defaultClient); - String connectionId = "connectionId_example"; // String | Connection Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id ConnectionActionRequest connectionActionRequest = new ConnectionActionRequest(); // ConnectionActionRequest | try { ConnectionAction result = apiInstance.createConnectionAction(connectionId, connectionActionRequest); @@ -260,7 +260,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ConnectionsApi apiInstance = new ConnectionsApi(defaultClient); - String connectionId = "connectionId_example"; // String | Connection Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id ConnectionDirection direction = ConnectionDirection.fromValue("INTERNAL"); // ConnectionDirection | Connection Direction try { Connection result = apiInstance.getConnectionByUuid(connectionId, direction); @@ -403,7 +403,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); ConnectionsApi apiInstance = new ConnectionsApi(defaultClient); - String connectionId = "connectionId_example"; // String | Connection Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id List connectionChangeOperation = Arrays.asList(); // List | Boolean dryRun = false; // Boolean | option to verify that API calls will succeed try { diff --git a/services/fabricv4/docs/CreateAsnRequest.md b/services/fabricv4/docs/CreateAsnRequest.md new file mode 100644 index 00000000..57059938 --- /dev/null +++ b/services/fabricv4/docs/CreateAsnRequest.md @@ -0,0 +1,19 @@ + + +# CreateAsnRequest + +Create ASN request body + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**project** | [**Project**](Project.md) | | | +|**number** | **Long** | ASN number used for public ASN creation. | [optional] | +|**rirRegion** | **AsnRirRegion** | | [optional] | +|**ownershipChallengeDetails** | [**AsnOwnershipChallengeDetails**](AsnOwnershipChallengeDetails.md) | | [optional] | +|**location** | [**SimplifiedLocation**](SimplifiedLocation.md) | | [optional] | +|**range** | **AsnRange** | | [optional] | + + + diff --git a/services/fabricv4/docs/CrossConnectASideRequest.md b/services/fabricv4/docs/CrossConnectASideRequest.md index 46aa7705..6406b61b 100644 --- a/services/fabricv4/docs/CrossConnectASideRequest.md +++ b/services/fabricv4/docs/CrossConnectASideRequest.md @@ -8,7 +8,7 @@ A-Side connection details. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**demarcationPoint** | [**CrossConnectASideRequestDemarcationPoint**](CrossConnectASideRequestDemarcationPoint.md) | | [optional] | +|**demarcationPoint** | [**CrossConnectDemarcationPoint**](CrossConnectDemarcationPoint.md) | | [optional] | diff --git a/services/fabricv4/docs/CrossConnectASideRequestDemarcationPoint.md b/services/fabricv4/docs/CrossConnectASideRequestDemarcationPoint.md deleted file mode 100644 index a6b622b8..00000000 --- a/services/fabricv4/docs/CrossConnectASideRequestDemarcationPoint.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# CrossConnectASideRequestDemarcationPoint - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**patchPanelId** | **String** | Patch Panel Identifier. | | -|**patchPanelPortA** | **Integer** | Specify the desired port number. When ports are not provided, next available ports will be used. | [optional] | -|**patchPanelPortB** | **Integer** | Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only. | [optional] | -|**connectorType** | **String** | Connector Type. | | - - - diff --git a/services/fabricv4/docs/CrossConnectEndCustomer.md b/services/fabricv4/docs/CrossConnectEndCustomer.md deleted file mode 100644 index 8f2c8dd9..00000000 --- a/services/fabricv4/docs/CrossConnectEndCustomer.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# CrossConnectEndCustomer - -End customer details for the Cross Connect. - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**isDisclosed** | **Boolean** | Indicates if the end customer is disclosed. | [optional] | -|**name** | **String** | End customer name. | [optional] | -|**mdmId** | **String** | Master Data Management identifier of the end customer, as held by Equinix. | [optional] | - - - diff --git a/services/fabricv4/docs/CrossConnectProject.md b/services/fabricv4/docs/CrossConnectProject.md deleted file mode 100644 index e74533a3..00000000 --- a/services/fabricv4/docs/CrossConnectProject.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# CrossConnectProject - -Cross Connect Project. - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**projectId** | **UUID** | Project Identifier. | | - - - diff --git a/services/fabricv4/docs/CrossConnectProvider.md b/services/fabricv4/docs/CrossConnectProvider.md deleted file mode 100644 index c1d01346..00000000 --- a/services/fabricv4/docs/CrossConnectProvider.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# CrossConnectProvider - -Provider at the Z-Side. - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**name** | **String** | Name of the provider at the Z-Side. | [optional] | - - - diff --git a/services/fabricv4/docs/CrossConnectResponse.md b/services/fabricv4/docs/CrossConnectResponse.md index 8bb83626..5be00a4b 100644 --- a/services/fabricv4/docs/CrossConnectResponse.md +++ b/services/fabricv4/docs/CrossConnectResponse.md @@ -13,7 +13,7 @@ Cross Connect Response. |**uuid** | **UUID** | Cross Connect Identifier. | [optional] | |**name** | **String** | A short, descriptive name for this Cross Connect. | [optional] | |**state** | **CrossConnectState** | | [optional] | -|**allowedActions** | [**List<CrossConnectResponseAllowedActions>**](CrossConnectResponseAllowedActions.md) | List of actions that can be performed on the Cross Connect based on its current state. Use these values to determine which action types are valid to submit to the actions endpoint. | [optional] [readonly] | +|**allowedActions** | [**List<CrossConnectResponseAllowedActionsInner>**](CrossConnectResponseAllowedActionsInner.md) | List of actions that can be performed on the Cross Connect based on its current state. Use these values to determine which action types are valid to submit to the actions endpoint. | [optional] [readonly] | |**bmmrType** | **BmmrType** | | [optional] | |**mediaType** | **String** | Media type of the Cross Connect. | [optional] | |**mediaSubType** | **String** | Media sub-type of the Cross Connect. | [optional] | diff --git a/services/fabricv4/docs/CrossConnectResponseAllowedActions.md b/services/fabricv4/docs/CrossConnectResponseAllowedActionsInner.md similarity index 81% rename from services/fabricv4/docs/CrossConnectResponseAllowedActions.md rename to services/fabricv4/docs/CrossConnectResponseAllowedActionsInner.md index 81c6de51..6ce45354 100644 --- a/services/fabricv4/docs/CrossConnectResponseAllowedActions.md +++ b/services/fabricv4/docs/CrossConnectResponseAllowedActionsInner.md @@ -1,6 +1,6 @@ -# CrossConnectResponseAllowedActions +# CrossConnectResponseAllowedActionsInner ## Properties diff --git a/services/fabricv4/docs/CrossConnectsApi.md b/services/fabricv4/docs/CrossConnectsApi.md index 288c19c8..256f88bf 100644 --- a/services/fabricv4/docs/CrossConnectsApi.md +++ b/services/fabricv4/docs/CrossConnectsApi.md @@ -190,8 +190,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CrossConnectsApi apiInstance = new CrossConnectsApi(defaultClient); - UUID crossConnectId = UUID.randomUUID(); // UUID | Cross Connect UUID. - UUID actionId = UUID.randomUUID(); // UUID | Cross Connect Action UUID. + UUID crossConnectId = UUID.fromString("46bb1a31-c28f-4197-8b10-06e0e03d0743"); // UUID | Cross Connect UUID. + UUID actionId = UUID.fromString("30cc7878-54e3-4e1a-8651-87a61354bad4"); // UUID | Cross Connect Action UUID. try { CrossConnectActionResponse result = apiInstance.getCrossConnectActionByUuid(crossConnectId, actionId); System.out.println(result); @@ -264,7 +264,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CrossConnectsApi apiInstance = new CrossConnectsApi(defaultClient); - UUID crossConnectId = UUID.randomUUID(); // UUID | Cross Connect UUID. + UUID crossConnectId = UUID.fromString("46bb1a31-c28f-4197-8b10-06e0e03d0743"); // UUID | Cross Connect UUID. try { CrossConnectAttachmentsResponse result = apiInstance.getCrossConnectAttachmentsByUuid(crossConnectId); System.out.println(result); @@ -336,7 +336,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CrossConnectsApi apiInstance = new CrossConnectsApi(defaultClient); - UUID crossConnectId = UUID.randomUUID(); // UUID | Cross Connect UUID. + UUID crossConnectId = UUID.fromString("46bb1a31-c28f-4197-8b10-06e0e03d0743"); // UUID | Cross Connect UUID. try { CrossConnectResponse result = apiInstance.getCrossConnectByUuid(crossConnectId); System.out.println(result); @@ -408,7 +408,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CrossConnectsApi apiInstance = new CrossConnectsApi(defaultClient); - UUID crossConnectId = UUID.randomUUID(); // UUID | Cross Connect UUID. + UUID crossConnectId = UUID.fromString("46bb1a31-c28f-4197-8b10-06e0e03d0743"); // UUID | Cross Connect UUID. Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch try { @@ -484,7 +484,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CrossConnectsApi apiInstance = new CrossConnectsApi(defaultClient); - UUID crossConnectId = UUID.randomUUID(); // UUID | Cross Connect UUID. + UUID crossConnectId = UUID.fromString("46bb1a31-c28f-4197-8b10-06e0e03d0743"); // UUID | Cross Connect UUID. try { SchedulesResponse result = apiInstance.getCrossConnectSchedulesByUuid(crossConnectId); System.out.println(result); @@ -556,7 +556,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CrossConnectsApi apiInstance = new CrossConnectsApi(defaultClient); - UUID crossConnectId = UUID.randomUUID(); // UUID | Cross Connect UUID. + UUID crossConnectId = UUID.fromString("46bb1a31-c28f-4197-8b10-06e0e03d0743"); // UUID | Cross Connect UUID. try { CrossConnectServicesResponse result = apiInstance.getCrossConnectServicesByUuid(crossConnectId); System.out.println(result); @@ -628,7 +628,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CrossConnectsApi apiInstance = new CrossConnectsApi(defaultClient); - UUID crossConnectId = UUID.randomUUID(); // UUID | Cross Connect UUID. + UUID crossConnectId = UUID.fromString("46bb1a31-c28f-4197-8b10-06e0e03d0743"); // UUID | Cross Connect UUID. CrossConnectActionRequest crossConnectActionRequest = new CrossConnectActionRequest(); // CrossConnectActionRequest | try { CrossConnectActionResponse result = apiInstance.performCrossConnectAction(crossConnectId, crossConnectActionRequest); @@ -702,7 +702,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); CrossConnectsApi apiInstance = new CrossConnectsApi(defaultClient); - UUID crossConnectId = UUID.randomUUID(); // UUID | Cross Connect UUID. + UUID crossConnectId = UUID.fromString("46bb1a31-c28f-4197-8b10-06e0e03d0743"); // UUID | Cross Connect UUID. CrossConnectActionSearchRequest crossConnectActionSearchRequest = new CrossConnectActionSearchRequest(); // CrossConnectActionSearchRequest | try { CrossConnectActionSearchResponse result = apiInstance.searchCrossConnectAction(crossConnectId, crossConnectActionSearchRequest); diff --git a/services/fabricv4/docs/DeleteCrossConnect.md b/services/fabricv4/docs/DeleteCrossConnect.md deleted file mode 100644 index 08030811..00000000 --- a/services/fabricv4/docs/DeleteCrossConnect.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# DeleteCrossConnect - -Delete Cross Connect request. Carries the removal schedule together with the notification and order details to apply to the removal order. - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**schedule** | [**DeinstallScheduleRequest**](DeinstallScheduleRequest.md) | Removal schedule. The requestedDateTime is mandatory. Only the STANDARD schedule type is supported for a removal. | | -|**notifications** | [**List<CrossConnectNotification>**](CrossConnectNotification.md) | Optional. The contacts are appended to the ones already held on the Cross Connect. | [optional] | -|**order** | [**OrderRequest**](OrderRequest.md) | Optional. The purchase order and the customer reference identifier replace the ones already held on the Cross Connect. | [optional] | - - - diff --git a/services/fabricv4/docs/EndCustomer.md b/services/fabricv4/docs/EndCustomer.md deleted file mode 100644 index 9a4f418a..00000000 --- a/services/fabricv4/docs/EndCustomer.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# EndCustomer - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**isDisclosed** | **Boolean** | Indicate if endCustomer info should be disclosed or not | [optional] | -|**name** | **String** | | [optional] | -|**mdmId** | **String** | | [optional] | - - - diff --git a/services/fabricv4/docs/Error.md b/services/fabricv4/docs/Error.md index 3ae12913..a34fc99f 100644 --- a/services/fabricv4/docs/Error.md +++ b/services/fabricv4/docs/Error.md @@ -13,7 +13,7 @@ Error Response with details |**correlationId** | **String** | | [optional] | |**details** | **String** | | [optional] | |**help** | **String** | | [optional] | -|**additionalInfo** | [**List<PriceErrorAdditionalInfo>**](PriceErrorAdditionalInfo.md) | | [optional] | +|**additionalInfo** | [**List<ErrorAdditionalInfoInner>**](ErrorAdditionalInfoInner.md) | | [optional] | diff --git a/services/fabricv4/docs/PriceErrorAdditionalInfo.md b/services/fabricv4/docs/ErrorAdditionalInfoInner.md similarity index 88% rename from services/fabricv4/docs/PriceErrorAdditionalInfo.md rename to services/fabricv4/docs/ErrorAdditionalInfoInner.md index e7793396..b273ae60 100644 --- a/services/fabricv4/docs/PriceErrorAdditionalInfo.md +++ b/services/fabricv4/docs/ErrorAdditionalInfoInner.md @@ -1,6 +1,6 @@ -# PriceErrorAdditionalInfo +# ErrorAdditionalInfoInner ## Properties diff --git a/services/fabricv4/docs/EventsApi.md b/services/fabricv4/docs/EventsApi.md index 8c7ce5ba..6ae36ff9 100644 --- a/services/fabricv4/docs/EventsApi.md +++ b/services/fabricv4/docs/EventsApi.md @@ -38,7 +38,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); EventsApi apiInstance = new EventsApi(defaultClient); - UUID cloudEventId = UUID.randomUUID(); // UUID | Cloud Event UUID + UUID cloudEventId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Cloud Event UUID try { CloudEvent result = apiInstance.getCloudEvent(cloudEventId); System.out.println(result); @@ -110,7 +110,7 @@ public class Example { EventsApi apiInstance = new EventsApi(defaultClient); CloudEventAssetType asset = CloudEventAssetType.fromValue("ports"); // CloudEventAssetType | asset - UUID assetId = UUID.randomUUID(); // UUID | asset UUID + UUID assetId = UUID.fromString("757400f8-d360-11e9-bb65-2a2ae2dbcce6"); // UUID | asset UUID OffsetDateTime fromDateTime = OffsetDateTime.now(); // OffsetDateTime | Start date and time OffsetDateTime toDateTime = OffsetDateTime.now(); // OffsetDateTime | End date and time Integer offset = 0; // Integer | offset diff --git a/services/fabricv4/docs/GatewayIpv4.md b/services/fabricv4/docs/GatewayIpv4.md deleted file mode 100644 index d6491fc4..00000000 --- a/services/fabricv4/docs/GatewayIpv4.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# GatewayIpv4 - -Gateway IPv4 address - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**primaryIp** | **String** | | [optional] | -|**secondaryIp** | **String** | | [optional] | - - - diff --git a/services/fabricv4/docs/GatewayPackageCode.md b/services/fabricv4/docs/GatewayPackageCode.md deleted file mode 100644 index ac46b30c..00000000 --- a/services/fabricv4/docs/GatewayPackageCode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -# GatewayPackageCode - -## Enum - - -* `LAB` (value: `"LAB"`) - - - diff --git a/services/fabricv4/docs/GatewaySortCriteria.md b/services/fabricv4/docs/GatewaySortCriteria.md deleted file mode 100644 index f185026a..00000000 --- a/services/fabricv4/docs/GatewaySortCriteria.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# GatewaySortCriteria - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**direction** | **GatewaySortDirection** | | [optional] | -|**property** | **String** | Possible field names to use on sorting: * `/name` - Gateway name * `/uuid` - Gateway uuid * `/state` - Gateway status * `/changeLog/createdDateTime` - Date and time when change flow starts * `/changeLog/updatedDateTime` - Date and time when change object is updated | [optional] | - - - diff --git a/services/fabricv4/docs/GatewaySortDirection.md b/services/fabricv4/docs/GatewaySortDirection.md deleted file mode 100644 index aa39c5a8..00000000 --- a/services/fabricv4/docs/GatewaySortDirection.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# GatewaySortDirection - -## Enum - - -* `DESC` (value: `"DESC"`) - -* `ASC` (value: `"ASC"`) - - - diff --git a/services/fabricv4/docs/GatewayTunnelSearchRequest.md b/services/fabricv4/docs/GatewayTunnelSearchRequest.md deleted file mode 100644 index 23a96c7f..00000000 --- a/services/fabricv4/docs/GatewayTunnelSearchRequest.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# GatewayTunnelSearchRequest - -Search Gateway Tunnels - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**filter** | [**SearchFilter**](SearchFilter.md) | | [optional] | -|**pagination** | [**PaginationRequest**](PaginationRequest.md) | | [optional] | -|**sort** | [**List<GatewayTunnelSortCriteria>**](GatewayTunnelSortCriteria.md) | | [optional] | - - - diff --git a/services/fabricv4/docs/GatewayTunnelSortCriteria.md b/services/fabricv4/docs/GatewayTunnelSortCriteria.md deleted file mode 100644 index d4d069c7..00000000 --- a/services/fabricv4/docs/GatewayTunnelSortCriteria.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# GatewayTunnelSortCriteria - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**direction** | **GatewayTunnelSortDirection** | | [optional] | -|**property** | **String** | Possible field names to use on sorting: * `/name` - Gateway Tunnel name * `/uuid` - Gateway Tunnel uuid * `/state` - Gateway Tunnel status * `/changeLog/createdDateTime` - Date and time when change flow starts * `/changeLog/updatedDateTime` - Date and time when change object is updated | [optional] | - - - diff --git a/services/fabricv4/docs/GatewayTunnelSortDirection.md b/services/fabricv4/docs/GatewayTunnelSortDirection.md deleted file mode 100644 index d3e01828..00000000 --- a/services/fabricv4/docs/GatewayTunnelSortDirection.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# GatewayTunnelSortDirection - -## Enum - - -* `DESC` (value: `"DESC"`) - -* `ASC` (value: `"ASC"`) - - - diff --git a/services/fabricv4/docs/Hop.md b/services/fabricv4/docs/Hop.md index 2c5d4470..b0839780 100644 --- a/services/fabricv4/docs/Hop.md +++ b/services/fabricv4/docs/Hop.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| |**hop** | **Integer** | | [optional] | -|**probes** | [**List<HopProbes>**](HopProbes.md) | | [optional] | +|**probes** | [**List<HopProbesInner>**](HopProbesInner.md) | | [optional] | diff --git a/services/fabricv4/docs/HopProbes.md b/services/fabricv4/docs/HopProbesInner.md similarity index 95% rename from services/fabricv4/docs/HopProbes.md rename to services/fabricv4/docs/HopProbesInner.md index 3c308b69..b2bf195b 100644 --- a/services/fabricv4/docs/HopProbes.md +++ b/services/fabricv4/docs/HopProbesInner.md @@ -1,6 +1,6 @@ -# HopProbes +# HopProbesInner ## Properties diff --git a/services/fabricv4/docs/InternetAccess.md b/services/fabricv4/docs/InternetAccess.md deleted file mode 100644 index 1654a088..00000000 --- a/services/fabricv4/docs/InternetAccess.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# InternetAccess - -Internet Access Details - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uuid** | **UUID** | Internet Access Service Identifier | [optional] | - - - diff --git a/services/fabricv4/docs/InternetAccessRoutingProtocolBgp.md b/services/fabricv4/docs/InternetAccessRoutingProtocolBgp.md index b5892511..6ec51146 100644 --- a/services/fabricv4/docs/InternetAccessRoutingProtocolBgp.md +++ b/services/fabricv4/docs/InternetAccessRoutingProtocolBgp.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| |**exportPolicy** | **InternetAccessExportPolicy** | | | -|**asn** | [**InternetAccessRoutingProtocolBgpAsn**](InternetAccessRoutingProtocolBgpAsn.md) | | [optional] | +|**asn** | [**InternetAccessRoutingProtocolBgpAllOfAsn**](InternetAccessRoutingProtocolBgpAllOfAsn.md) | | [optional] | |**customerAsn** | **Long** | Customer ASN. Valid range is 1-64495 or 131072-4199999999. Currently this option is only available for EIA over dedicated port. | [optional] | |**bgpAuthKey** | **String** | BGP authentication key. This field is deprecated and will be removed in future releases. Please use bgpAuthType instead to determine if a BGP authentication key is configured. | [optional] | |**bgpAuthType** | **InternetAccessBgpAuthType** | | [optional] | diff --git a/services/fabricv4/docs/InternetAccessRoutingProtocolBgpAsn.md b/services/fabricv4/docs/InternetAccessRoutingProtocolBgpAllOfAsn.md similarity index 85% rename from services/fabricv4/docs/InternetAccessRoutingProtocolBgpAsn.md rename to services/fabricv4/docs/InternetAccessRoutingProtocolBgpAllOfAsn.md index d2ece3a3..6b27ccbe 100644 --- a/services/fabricv4/docs/InternetAccessRoutingProtocolBgpAsn.md +++ b/services/fabricv4/docs/InternetAccessRoutingProtocolBgpAllOfAsn.md @@ -1,6 +1,6 @@ -# InternetAccessRoutingProtocolBgpAsn +# InternetAccessRoutingProtocolBgpAllOfAsn ## Properties diff --git a/services/fabricv4/docs/InternetAccessRoutingProtocolBgpRequest.md b/services/fabricv4/docs/InternetAccessRoutingProtocolBgpRequest.md index 86266f8c..3c32195a 100644 --- a/services/fabricv4/docs/InternetAccessRoutingProtocolBgpRequest.md +++ b/services/fabricv4/docs/InternetAccessRoutingProtocolBgpRequest.md @@ -9,7 +9,7 @@ |------------ | ------------- | ------------- | -------------| |**connections** | [**List<InternetAccessConnectionBgpRequest>**](InternetAccessConnectionBgpRequest.md) | | | |**exportPolicy** | **InternetAccessExportPolicy** | | | -|**asn** | [**InternetAccessRoutingProtocolBgpRequestAsn**](InternetAccessRoutingProtocolBgpRequestAsn.md) | | [optional] | +|**asn** | [**InternetAccessRoutingProtocolBgpRequestAllOfAsn**](InternetAccessRoutingProtocolBgpRequestAllOfAsn.md) | | [optional] | |**customerAsn** | **Long** | Customer ASN. Valid range is 1-64495 or 65536-4199999999. | [optional] | |**bgpAuthKey** | **String** | BGP authentication key | [optional] | |**customerAsnRange** | **InternetAccessCustomerAsnRange** | | [optional] | diff --git a/services/fabricv4/docs/InternetAccessRoutingProtocolBgpRequestAsn.md b/services/fabricv4/docs/InternetAccessRoutingProtocolBgpRequestAllOfAsn.md similarity index 78% rename from services/fabricv4/docs/InternetAccessRoutingProtocolBgpRequestAsn.md rename to services/fabricv4/docs/InternetAccessRoutingProtocolBgpRequestAllOfAsn.md index 502dc5f8..b7657de2 100644 --- a/services/fabricv4/docs/InternetAccessRoutingProtocolBgpRequestAsn.md +++ b/services/fabricv4/docs/InternetAccessRoutingProtocolBgpRequestAllOfAsn.md @@ -1,6 +1,6 @@ -# InternetAccessRoutingProtocolBgpRequestAsn +# InternetAccessRoutingProtocolBgpRequestAllOfAsn ## Properties diff --git a/services/fabricv4/docs/InternetExchangeServicesApi.md b/services/fabricv4/docs/InternetExchangeServicesApi.md index 05979671..0b94df2d 100644 --- a/services/fabricv4/docs/InternetExchangeServicesApi.md +++ b/services/fabricv4/docs/InternetExchangeServicesApi.md @@ -111,7 +111,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); InternetExchangeServicesApi apiInstance = new InternetExchangeServicesApi(defaultClient); - UUID exchangeServiceId = UUID.randomUUID(); // UUID | Internet Exchange Service Id + UUID exchangeServiceId = UUID.fromString("a8ba52de-faae-43b5-b0b1-6904d37ee011"); // UUID | Internet Exchange Service Id ExchangeServiceActionRequest exchangeServiceActionRequest = new ExchangeServiceActionRequest(); // ExchangeServiceActionRequest | try { ExchangeServiceActionResponse result = apiInstance.createExchangeServiceAction(exchangeServiceId, exchangeServiceActionRequest); @@ -185,7 +185,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); InternetExchangeServicesApi apiInstance = new InternetExchangeServicesApi(defaultClient); - UUID exchangeServiceId = UUID.randomUUID(); // UUID | Internet Exchange Service Id + UUID exchangeServiceId = UUID.fromString("a8ba52de-faae-43b5-b0b1-6904d37ee011"); // UUID | Internet Exchange Service Id try { ExchangeServiceResponse result = apiInstance.getExchangeServiceById(exchangeServiceId); System.out.println(result); @@ -328,7 +328,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); InternetExchangeServicesApi apiInstance = new InternetExchangeServicesApi(defaultClient); - UUID exchangeServiceId = UUID.randomUUID(); // UUID | Internet Exchange Service Id + UUID exchangeServiceId = UUID.fromString("a8ba52de-faae-43b5-b0b1-6904d37ee011"); // UUID | Internet Exchange Service Id List exchangeServiceReplaceOperation = Arrays.asList(); // List | try { ExchangeServiceResponse result = apiInstance.updateExchangeServiceById(exchangeServiceId, exchangeServiceReplaceOperation); diff --git a/services/fabricv4/docs/LoasApi.md b/services/fabricv4/docs/LoasApi.md index e2d68b35..709abadb 100644 --- a/services/fabricv4/docs/LoasApi.md +++ b/services/fabricv4/docs/LoasApi.md @@ -116,7 +116,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); LoasApi apiInstance = new LoasApi(defaultClient); - UUID loaId = UUID.randomUUID(); // UUID | Loa UUID + UUID loaId = UUID.fromString("29cc7878-54e3-4e1a-8651-87a61354bac2"); // UUID | Loa UUID CreateLoaNote createLoaNote = new CreateLoaNote(); // CreateLoaNote | try { LoaNoteDetails result = apiInstance.createLoaNoteByLoaId(loaId, createLoaNote); @@ -190,8 +190,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); LoasApi apiInstance = new LoasApi(defaultClient); - UUID loaId = UUID.randomUUID(); // UUID | Loa UUID - UUID actionId = UUID.randomUUID(); // UUID | Action UUID + UUID loaId = UUID.fromString("29cc7878-54e3-4e1a-8651-87a61354bac2"); // UUID | Loa UUID + UUID actionId = UUID.fromString("30cc7878-54e3-4e1a-8651-87a61354bad4"); // UUID | Action UUID try { LoaActionResponse result = apiInstance.getLoaActionsByUuid(loaId, actionId); System.out.println(result); @@ -264,7 +264,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); LoasApi apiInstance = new LoasApi(defaultClient); - UUID loaId = UUID.randomUUID(); // UUID | Loa UUID + UUID loaId = UUID.fromString("29cc7878-54e3-4e1a-8651-87a61354bac2"); // UUID | Loa UUID try { LoaResponse result = apiInstance.getLoaByUuid(loaId); System.out.println(result); @@ -336,7 +336,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); LoasApi apiInstance = new LoasApi(defaultClient); - UUID loaId = UUID.randomUUID(); // UUID | Loa UUID + UUID loaId = UUID.fromString("29cc7878-54e3-4e1a-8651-87a61354bac2"); // UUID | Loa UUID try { LoaConsumersResponse result = apiInstance.getLoaConsumersByLoaId(loaId); System.out.println(result); @@ -408,7 +408,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); LoasApi apiInstance = new LoasApi(defaultClient); - UUID loaId = UUID.randomUUID(); // UUID | Loa UUID + UUID loaId = UUID.fromString("29cc7878-54e3-4e1a-8651-87a61354bac2"); // UUID | Loa UUID try { LoaNotesResponse result = apiInstance.getLoaNotesByUuid(loaId); System.out.println(result); @@ -480,7 +480,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); LoasApi apiInstance = new LoasApi(defaultClient); - UUID loaId = UUID.randomUUID(); // UUID | Loa UUID + UUID loaId = UUID.fromString("29cc7878-54e3-4e1a-8651-87a61354bac2"); // UUID | Loa UUID LoaActionRequest loaActionRequest = new LoaActionRequest(); // LoaActionRequest | try { LoaActionResponse result = apiInstance.performLoaAction(loaId, loaActionRequest); @@ -626,7 +626,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); LoasApi apiInstance = new LoasApi(defaultClient); - UUID loaId = UUID.randomUUID(); // UUID | Loa UUID + UUID loaId = UUID.fromString("29cc7878-54e3-4e1a-8651-87a61354bac2"); // UUID | Loa UUID LoaActionSearchRequest loaActionSearchRequest = new LoaActionSearchRequest(); // LoaActionSearchRequest | try { LoaActionSearchResponse result = apiInstance.searchLoaAction(loaId, loaActionSearchRequest); @@ -700,7 +700,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); LoasApi apiInstance = new LoasApi(defaultClient); - UUID loaId = UUID.randomUUID(); // UUID | Loa UUID + UUID loaId = UUID.fromString("29cc7878-54e3-4e1a-8651-87a61354bac2"); // UUID | Loa UUID List loaReplaceOperation = Arrays.asList(); // List | try { LoaResponse result = apiInstance.updateLoaByUuid(loaId, loaReplaceOperation); diff --git a/services/fabricv4/docs/MarketplaceSubscriptionsApi.md b/services/fabricv4/docs/MarketplaceSubscriptionsApi.md index ddd4dde1..9002adc7 100644 --- a/services/fabricv4/docs/MarketplaceSubscriptionsApi.md +++ b/services/fabricv4/docs/MarketplaceSubscriptionsApi.md @@ -35,7 +35,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); MarketplaceSubscriptionsApi apiInstance = new MarketplaceSubscriptionsApi(defaultClient); - UUID subscriptionId = UUID.randomUUID(); // UUID | Subscription UUID + UUID subscriptionId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Subscription UUID try { SubscriptionResponse result = apiInstance.getSubscriptionById(subscriptionId); System.out.println(result); diff --git a/services/fabricv4/docs/Metric.md b/services/fabricv4/docs/Metric.md index 563e5dc6..e5ed3ebe 100644 --- a/services/fabricv4/docs/Metric.md +++ b/services/fabricv4/docs/Metric.md @@ -14,7 +14,7 @@ Metric object |**interval** | **String** | Metric interval (set automatically based on search range) | [optional] | |**resource** | [**MetricResource**](MetricResource.md) | | [optional] | |**summary** | **String** | Metric summary | [optional] | -|**datapoints** | [**List<MetricDatapoints>**](MetricDatapoints.md) | Metric data points | [optional] | +|**datapoints** | [**List<MetricDatapointsInner>**](MetricDatapointsInner.md) | Metric data points | [optional] | diff --git a/services/fabricv4/docs/MetricDatapoints.md b/services/fabricv4/docs/MetricDatapointsInner.md similarity index 93% rename from services/fabricv4/docs/MetricDatapoints.md rename to services/fabricv4/docs/MetricDatapointsInner.md index cb5a48cb..c8f418fa 100644 --- a/services/fabricv4/docs/MetricDatapoints.md +++ b/services/fabricv4/docs/MetricDatapointsInner.md @@ -1,6 +1,6 @@ -# MetricDatapoints +# MetricDatapointsInner ## Properties diff --git a/services/fabricv4/docs/MetricsApi.md b/services/fabricv4/docs/MetricsApi.md index 8fe6b9cf..5451f362 100644 --- a/services/fabricv4/docs/MetricsApi.md +++ b/services/fabricv4/docs/MetricsApi.md @@ -38,7 +38,7 @@ public class Example { MetricsApi apiInstance = new MetricsApi(defaultClient); MetricAssetType asset = MetricAssetType.fromValue("ports"); // MetricAssetType | asset - UUID assetId = UUID.randomUUID(); // UUID | asset UUID + UUID assetId = UUID.fromString("757400f8-d360-11e9-bb65-2a2ae2dbcce6"); // UUID | asset UUID String name = "equinix.fabric.connection.bandwidth_rx.usage"; // String | Name of the metric types: - `equinix.fabric.connection.bandwidth_rx.usage` - `equinix.fabric.connection.bandwidth_tx.usage` - `equinix.fabric.connection.packets_dropped_rx_aside_rateexceeded.count` - `equinix.fabric.connection.packets_dropped_tx_aside_rateexceeded.count` - `equinix.fabric.connection.packets_dropped_rx_zside_rateexceeded.count` - `equinix.fabric.connection.packets_dropped_tx_zside_rateexceeded.count` - `equinix.fabric.connection.byte_rx.count` - `equinix.fabric.connection.byte_tx.count` - `equinix.fabric.connection.bandwidth_rx.usage_summary` - `equinix.fabric.connection.bandwidth_tx.usage_summary` - `equinix.fabric.port.bandwidth_rx.usage` - `equinix.fabric.port.bandwidth_tx.usage` - `equinix.fabric.port.packets_dropped_rx.count` - `equinix.fabric.port.packets_dropped_tx.count` - `equinix.fabric.port.packets_erred_rx.count` - `equinix.fabric.port.packets_erred_tx.count` - `equinix.fabric.metro.{SOURCE_METRO_CODE}_{DESTINATION_METRO_CODE}.latency` - `equinix.fabric.metro.{SOURCE_METRO_CODE}_{DESTINATION_METRO_CODE}.jitter_avg` OffsetDateTime fromDateTime = OffsetDateTime.now(); // OffsetDateTime | Start date and time OffsetDateTime toDateTime = OffsetDateTime.now(); // OffsetDateTime | End date and time diff --git a/services/fabricv4/docs/MetroError.md b/services/fabricv4/docs/MetroError.md index 999d590d..d204d4ad 100644 --- a/services/fabricv4/docs/MetroError.md +++ b/services/fabricv4/docs/MetroError.md @@ -13,7 +13,7 @@ Error with details |**correlationId** | **String** | | [optional] | |**details** | **String** | | [optional] | |**help** | **String** | | [optional] | -|**additionalInfo** | [**List<PriceErrorAdditionalInfo>**](PriceErrorAdditionalInfo.md) | | [optional] | +|**additionalInfo** | [**List<ErrorAdditionalInfoInner>**](ErrorAdditionalInfoInner.md) | | [optional] | diff --git a/services/fabricv4/docs/NetworksApi.md b/services/fabricv4/docs/NetworksApi.md index fb630683..6ff967fb 100644 --- a/services/fabricv4/docs/NetworksApi.md +++ b/services/fabricv4/docs/NetworksApi.md @@ -117,7 +117,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); NetworksApi apiInstance = new NetworksApi(defaultClient); - UUID networkId = UUID.randomUUID(); // UUID | Network UUID + UUID networkId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Network UUID try { Network result = apiInstance.deleteNetworkByUuid(networkId); System.out.println(result); @@ -188,7 +188,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); NetworksApi apiInstance = new NetworksApi(defaultClient); - UUID networkId = UUID.randomUUID(); // UUID | Network UUID + UUID networkId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Network UUID try { NetworkConnections result = apiInstance.getConnectionsByNetworkUuid(networkId); System.out.println(result); @@ -259,7 +259,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); NetworksApi apiInstance = new NetworksApi(defaultClient); - UUID networkId = UUID.randomUUID(); // UUID | Network UUID + UUID networkId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Network UUID try { Network result = apiInstance.getNetworkByUuid(networkId); System.out.println(result); @@ -329,8 +329,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); NetworksApi apiInstance = new NetworksApi(defaultClient); - UUID networkId = UUID.randomUUID(); // UUID | Network UUID - UUID changeId = UUID.randomUUID(); // UUID | Network Change UUID + UUID networkId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Network UUID + UUID changeId = UUID.fromString("6d500177-9404-41f2-99e8-2bf1a84d8db5"); // UUID | Network Change UUID try { NetworkChange result = apiInstance.getNetworkChangeByUuid(networkId, changeId); System.out.println(result); @@ -402,7 +402,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); NetworksApi apiInstance = new NetworksApi(defaultClient); - UUID networkId = UUID.randomUUID(); // UUID | Network UUID + UUID networkId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Network UUID try { NetworkChangeResponse result = apiInstance.getNetworkChanges(networkId); System.out.println(result); @@ -544,7 +544,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); NetworksApi apiInstance = new NetworksApi(defaultClient); - UUID networkId = UUID.randomUUID(); // UUID | Network UUID + UUID networkId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Network UUID List networkChangeOperation = Arrays.asList(); // List | try { Network result = apiInstance.updateNetworkByUuid(networkId, networkChangeOperation); diff --git a/services/fabricv4/docs/OpticalMetroConnectsApi.md b/services/fabricv4/docs/OpticalMetroConnectsApi.md index ae8e4564..f69e187f 100644 --- a/services/fabricv4/docs/OpticalMetroConnectsApi.md +++ b/services/fabricv4/docs/OpticalMetroConnectsApi.md @@ -180,7 +180,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); OpticalMetroConnectsApi apiInstance = new OpticalMetroConnectsApi(defaultClient); - UUID opticalConnectId = UUID.randomUUID(); // UUID | Unique identifier of an Optical Connect. + UUID opticalConnectId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Unique identifier of an Optical Connect. try { OpticalConnectResponse result = apiInstance.getOpticalConnectByUuid(opticalConnectId); System.out.println(result); diff --git a/services/fabricv4/docs/PhysicalPort.md b/services/fabricv4/docs/PhysicalPort.md index 9050479a..4f02cb5a 100644 --- a/services/fabricv4/docs/PhysicalPort.md +++ b/services/fabricv4/docs/PhysicalPort.md @@ -18,8 +18,6 @@ Physical Port specification |**uuid** | **UUID** | Equinix assigned response attribute for physical port identifier | [optional] | |**tether** | [**PortTether**](PortTether.md) | | [optional] | |**demarcationPoint** | [**PortDemarcationPoint**](PortDemarcationPoint.md) | | [optional] | -|**settings** | [**PhysicalPortSettings**](PhysicalPortSettings.md) | | [optional] | -|**_interface** | [**PortInterface**](PortInterface.md) | | [optional] | |**notifications** | [**List<PortNotification>**](PortNotification.md) | Notification preferences | [optional] | |**additionalInfo** | [**List<PortAdditionalInfo>**](PortAdditionalInfo.md) | Physical Port additional information | [optional] | |**order** | [**PortOrder**](PortOrder.md) | | [optional] | diff --git a/services/fabricv4/docs/PhysicalPortSettings.md b/services/fabricv4/docs/PhysicalPortSettings.md deleted file mode 100644 index f8888c75..00000000 --- a/services/fabricv4/docs/PhysicalPortSettings.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# PhysicalPortSettings - -Physical Port configuration settings - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**errorMessage** | **String** | | [optional] | -|**packageType** | **String** | | [optional] | - - - diff --git a/services/fabricv4/docs/Port.md b/services/fabricv4/docs/Port.md index 456893b3..cc911cc2 100644 --- a/services/fabricv4/docs/Port.md +++ b/services/fabricv4/docs/Port.md @@ -47,7 +47,6 @@ Port specification |**physicalPortQuantity** | **Integer** | Number of physical ports | [optional] | |**notifications** | [**List<PortNotification>**](PortNotification.md) | Notification preferences | [optional] | |**additionalInfo** | [**List<PortAdditionalInfo>**](PortAdditionalInfo.md) | Port additional information | [optional] | -|**endCustomer** | [**EndCustomer**](EndCustomer.md) | | [optional] | |**physicalPorts** | [**List<PhysicalPort>**](PhysicalPort.md) | Physical ports that implement this port | [optional] | |**loas** | [**List<PortLoa>**](PortLoa.md) | Port Loas | [optional] | |**marketplaceSubscription** | [**MarketplaceSubscription**](MarketplaceSubscription.md) | | [optional] | diff --git a/services/fabricv4/docs/PortRequest.md b/services/fabricv4/docs/PortRequest.md index f9861082..63df2180 100644 --- a/services/fabricv4/docs/PortRequest.md +++ b/services/fabricv4/docs/PortRequest.md @@ -28,7 +28,6 @@ PortRequest is the Request Object for creating single and bulk fabric ports |**encapsulation** | [**PortEncapsulation**](PortEncapsulation.md) | | | |**lagEnabled** | **Boolean** | Indicates whether Link Aggregation Group (LAG) is enabled on this port | [optional] | |**_package** | [**ModelPackage**](ModelPackage.md) | | [optional] | -|**settings** | [**PortSettings**](PortSettings.md) | | [optional] | |**notifications** | [**List<PortNotification>**](PortNotification.md) | Notification preferences | [optional] | |**physicalPorts** | [**List<PhysicalPort>**](PhysicalPort.md) | Physical ports that implement this port | [optional] | |**loas** | [**List<PortLoa>**](PortLoa.md) | Port Loas | [optional] | diff --git a/services/fabricv4/docs/PortsApi.md b/services/fabricv4/docs/PortsApi.md index d7d3c7c8..08651a9d 100644 --- a/services/fabricv4/docs/PortsApi.md +++ b/services/fabricv4/docs/PortsApi.md @@ -402,7 +402,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); PortsApi apiInstance = new PortsApi(defaultClient); - UUID portUuid = UUID.randomUUID(); // UUID | Port UUID + UUID portUuid = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Port UUID Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch try { diff --git a/services/fabricv4/docs/PrecisionTimePrice.md b/services/fabricv4/docs/PrecisionTimePrice.md deleted file mode 100644 index d772bb1d..00000000 --- a/services/fabricv4/docs/PrecisionTimePrice.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# PrecisionTimePrice - -Precision Time Price - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**currency** | **String** | offering price currency | [optional] | -|**charges** | [**List<PriceCharge>**](PriceCharge.md) | | [optional] | - - - diff --git a/services/fabricv4/docs/PrecisionTimeServiceResponse.md b/services/fabricv4/docs/PrecisionTimeServiceResponse.md index 08daaa38..a1ac008e 100644 --- a/services/fabricv4/docs/PrecisionTimeServiceResponse.md +++ b/services/fabricv4/docs/PrecisionTimeServiceResponse.md @@ -22,7 +22,6 @@ Precision Time Service Response Schema. |**project** | [**Project**](Project.md) | | [optional] | |**account** | [**SimplifiedAccount**](SimplifiedAccount.md) | | [optional] | |**order** | [**PrecisionTimeOrder**](PrecisionTimeOrder.md) | | [optional] | -|**pricing** | [**PrecisionTimePrice**](PrecisionTimePrice.md) | | [optional] | |**changeLog** | [**Changelog**](Changelog.md) | | [optional] | diff --git a/services/fabricv4/docs/PrecisionTimeServicesApi.md b/services/fabricv4/docs/PrecisionTimeServicesApi.md index a68a533a..d37abfce 100644 --- a/services/fabricv4/docs/PrecisionTimeServicesApi.md +++ b/services/fabricv4/docs/PrecisionTimeServicesApi.md @@ -113,7 +113,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); PrecisionTimeServicesApi apiInstance = new PrecisionTimeServicesApi(defaultClient); - UUID serviceId = UUID.randomUUID(); // UUID | Service UUID + UUID serviceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Service UUID try { PrecisionTimeServiceResponse result = apiInstance.deleteTimeServiceById(serviceId); System.out.println(result); @@ -185,7 +185,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); PrecisionTimeServicesApi apiInstance = new PrecisionTimeServicesApi(defaultClient); - UUID serviceId = UUID.randomUUID(); // UUID | Service UUID + UUID serviceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Service UUID PrecisionTimeServiceRequest precisionTimeServiceRequest = new PrecisionTimeServiceRequest(); // PrecisionTimeServiceRequest | try { PrecisionTimeServiceResponse result = apiInstance.fulfillTimeServices(serviceId, precisionTimeServiceRequest); @@ -260,7 +260,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); PrecisionTimeServicesApi apiInstance = new PrecisionTimeServicesApi(defaultClient); - UUID serviceId = UUID.randomUUID(); // UUID | Service UUID + UUID serviceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Service UUID try { PrecisionTimeServiceResponse result = apiInstance.getTimeServicesById(serviceId); System.out.println(result); @@ -333,7 +333,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); PrecisionTimeServicesApi apiInstance = new PrecisionTimeServicesApi(defaultClient); - UUID serviceId = UUID.randomUUID(); // UUID | Service UUID + UUID serviceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Service UUID try { PrecisionTimeServiceConnectionsResponse result = apiInstance.getTimeServicesConnectionsByServiceId(serviceId); System.out.println(result); @@ -476,7 +476,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); PrecisionTimeServicesApi apiInstance = new PrecisionTimeServicesApi(defaultClient); - UUID serviceId = UUID.randomUUID(); // UUID | Service UUID + UUID serviceId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Service UUID List precisionTimeChangeOperation = Arrays.asList(); // List | try { PrecisionTimeServiceResponse result = apiInstance.updateTimeServicesById(serviceId, precisionTimeChangeOperation); diff --git a/services/fabricv4/docs/PriceError.md b/services/fabricv4/docs/PriceError.md index c7981cd0..e21cf285 100644 --- a/services/fabricv4/docs/PriceError.md +++ b/services/fabricv4/docs/PriceError.md @@ -13,7 +13,7 @@ Error with details |**correlationId** | **String** | | [optional] | |**details** | **String** | | [optional] | |**help** | **String** | | [optional] | -|**additionalInfo** | [**List<PriceErrorAdditionalInfo>**](PriceErrorAdditionalInfo.md) | | [optional] | +|**additionalInfo** | [**List<ErrorAdditionalInfoInner>**](ErrorAdditionalInfoInner.md) | | [optional] | diff --git a/services/fabricv4/docs/ResponseIncompleteDetails.md b/services/fabricv4/docs/ResponseIncompleteDetails.md deleted file mode 100644 index 10bf9796..00000000 --- a/services/fabricv4/docs/ResponseIncompleteDetails.md +++ /dev/null @@ -1,23 +0,0 @@ - - -# ResponseIncompleteDetails - -Details about why the response is incomplete. - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**reason** | [**ReasonEnum**](#ReasonEnum) | The reason why the response is incomplete. | [optional] | - - - -## Enum: ReasonEnum - -| Name | Value | -|---- | -----| -| MAX_OUTPUT_TOKENS | "max_output_tokens" | -| CONTENT_FILTER | "content_filter" | - - - diff --git a/services/fabricv4/docs/ResponseUsageInputTokensDetails.md b/services/fabricv4/docs/ResponseUsageInputTokensDetails.md deleted file mode 100644 index 555cc3a7..00000000 --- a/services/fabricv4/docs/ResponseUsageInputTokensDetails.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# ResponseUsageInputTokensDetails - -A detailed breakdown of the input tokens. - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**cachedTokens** | **Integer** | The number of tokens that were retrieved from the cache. [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). | | - - - diff --git a/services/fabricv4/docs/ResponseUsageOutputTokensDetails.md b/services/fabricv4/docs/ResponseUsageOutputTokensDetails.md deleted file mode 100644 index 3e6458e9..00000000 --- a/services/fabricv4/docs/ResponseUsageOutputTokensDetails.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# ResponseUsageOutputTokensDetails - -A detailed breakdown of the output tokens. - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**reasoningTokens** | **Integer** | The number of reasoning tokens. | | - - - diff --git a/services/fabricv4/docs/RouteAggregationRulesApi.md b/services/fabricv4/docs/RouteAggregationRulesApi.md index caa152fa..ea13e438 100644 --- a/services/fabricv4/docs/RouteAggregationRulesApi.md +++ b/services/fabricv4/docs/RouteAggregationRulesApi.md @@ -44,7 +44,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationRulesApi apiInstance = new RouteAggregationRulesApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id RouteAggregationRulesBase routeAggregationRulesBase = new RouteAggregationRulesBase(); // RouteAggregationRulesBase | try { RouteAggregationRulesData result = apiInstance.createRouteAggregationRule(routeAggregationId, routeAggregationRulesBase); @@ -119,7 +119,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationRulesApi apiInstance = new RouteAggregationRulesApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id RouteAggregationRulesPostRequest routeAggregationRulesPostRequest = new RouteAggregationRulesPostRequest(); // RouteAggregationRulesPostRequest | try { GetRouteAggregationRulesResponse result = apiInstance.createRouteAggregationRulesInBulk(routeAggregationId, routeAggregationRulesPostRequest); @@ -194,8 +194,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationRulesApi apiInstance = new RouteAggregationRulesApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id - String routeAggregationRuleId = "routeAggregationRuleId_example"; // String | Route Aggregation Rules Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id + String routeAggregationRuleId = "65b025ef-022b-4180-85cf-82cfc1ab655b"; // String | Route Aggregation Rules Id try { RouteAggregationRulesData result = apiInstance.deleteRouteAggregationRuleByUuid(routeAggregationId, routeAggregationRuleId); System.out.println(result); @@ -269,8 +269,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationRulesApi apiInstance = new RouteAggregationRulesApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id - String routeAggregationRuleId = "routeAggregationRuleId_example"; // String | Route Aggregation Rules Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id + String routeAggregationRuleId = "65b025ef-022b-4180-85cf-82cfc1ab655b"; // String | Route Aggregation Rules Id try { RouteAggregationRulesData result = apiInstance.getRouteAggregationRuleByUuid(routeAggregationId, routeAggregationRuleId); System.out.println(result); @@ -344,9 +344,9 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationRulesApi apiInstance = new RouteAggregationRulesApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id - String routeAggregationRuleId = "routeAggregationRuleId_example"; // String | Route Aggregation Rules Id - UUID changeId = UUID.randomUUID(); // UUID | Route Aggregation Rule Change UUID + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id + String routeAggregationRuleId = "65b025ef-022b-4180-85cf-82cfc1ab655b"; // String | Route Aggregation Rules Id + UUID changeId = UUID.fromString("6d500177-9404-41f2-99e8-2bf1a84d8db5"); // UUID | Route Aggregation Rule Change UUID try { RouteAggregationRulesChangeData result = apiInstance.getRouteAggregationRuleChangeByUuid(routeAggregationId, routeAggregationRuleId, changeId); System.out.println(result); @@ -420,8 +420,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationRulesApi apiInstance = new RouteAggregationRulesApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id - String routeAggregationRuleId = "routeAggregationRuleId_example"; // String | Route Aggregation Rules Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id + String routeAggregationRuleId = "65b025ef-022b-4180-85cf-82cfc1ab655b"; // String | Route Aggregation Rules Id Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch try { @@ -498,7 +498,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationRulesApi apiInstance = new RouteAggregationRulesApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch try { @@ -574,8 +574,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationRulesApi apiInstance = new RouteAggregationRulesApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id - String routeAggregationRuleId = "routeAggregationRuleId_example"; // String | Route Aggregation Rules Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id + String routeAggregationRuleId = "65b025ef-022b-4180-85cf-82cfc1ab655b"; // String | Route Aggregation Rules Id List routeAggregationRulesPatchRequestItem = Arrays.asList(); // List | try { RouteAggregationRulesData result = apiInstance.patchRouteAggregationRuleByUuid(routeAggregationId, routeAggregationRuleId, routeAggregationRulesPatchRequestItem); @@ -651,8 +651,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationRulesApi apiInstance = new RouteAggregationRulesApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id - String routeAggregationRuleId = "routeAggregationRuleId_example"; // String | Route Aggregation Rules Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id + String routeAggregationRuleId = "65b025ef-022b-4180-85cf-82cfc1ab655b"; // String | Route Aggregation Rules Id RouteAggregationRulesBase routeAggregationRulesBase = new RouteAggregationRulesBase(); // RouteAggregationRulesBase | try { RouteAggregationRulesData result = apiInstance.replaceRouteAggregationRuleByUuid(routeAggregationId, routeAggregationRuleId, routeAggregationRulesBase); @@ -728,7 +728,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationRulesApi apiInstance = new RouteAggregationRulesApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id RouteAggregationRulesSearchRequest routeAggregationRulesSearchRequest = new RouteAggregationRulesSearchRequest(); // RouteAggregationRulesSearchRequest | try { RouteAggregationRulesSearchResponse result = apiInstance.searchRouteAggregationRules(routeAggregationId, routeAggregationRulesSearchRequest); diff --git a/services/fabricv4/docs/RouteAggregationState.md b/services/fabricv4/docs/RouteAggregationState.md deleted file mode 100644 index eefb5e37..00000000 --- a/services/fabricv4/docs/RouteAggregationState.md +++ /dev/null @@ -1,23 +0,0 @@ - - -# RouteAggregationState - -## Enum - - -* `PROVISIONING` (value: `"PROVISIONING"`) - -* `REPROVISIONING` (value: `"REPROVISIONING"`) - -* `DEPROVISIONING` (value: `"DEPROVISIONING"`) - -* `PROVISIONED` (value: `"PROVISIONED"`) - -* `DEPROVISIONED` (value: `"DEPROVISIONED"`) - -* `NOT_PROVISIONED` (value: `"NOT_PROVISIONED"`) - -* `NOT_DEPROVISIONED` (value: `"NOT_DEPROVISIONED"`) - - - diff --git a/services/fabricv4/docs/RouteAggregationsApi.md b/services/fabricv4/docs/RouteAggregationsApi.md index 88b14748..6cabb7d6 100644 --- a/services/fabricv4/docs/RouteAggregationsApi.md +++ b/services/fabricv4/docs/RouteAggregationsApi.md @@ -47,8 +47,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationsApi apiInstance = new RouteAggregationsApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id - String connectionId = "connectionId_example"; // String | Connection Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id try { ConnectionRouteAggregationData result = apiInstance.attachConnectionRouteAggregation(routeAggregationId, connectionId); System.out.println(result); @@ -195,7 +195,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationsApi apiInstance = new RouteAggregationsApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id try { RouteAggregationsData result = apiInstance.deleteRouteAggregationByUuid(routeAggregationId); System.out.println(result); @@ -268,8 +268,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationsApi apiInstance = new RouteAggregationsApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id - String connectionId = "connectionId_example"; // String | Connection Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id try { ConnectionRouteAggregationData result = apiInstance.detachConnectionRouteAggregation(routeAggregationId, connectionId); System.out.println(result); @@ -343,8 +343,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationsApi apiInstance = new RouteAggregationsApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id - String connectionId = "connectionId_example"; // String | Connection Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id try { ConnectionRouteAggregationData result = apiInstance.getConnectionRouteAggregationByUuid(routeAggregationId, connectionId); System.out.println(result); @@ -418,7 +418,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationsApi apiInstance = new RouteAggregationsApi(defaultClient); - String connectionId = "connectionId_example"; // String | Connection Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id try { GetAllConnectionRouteAggregationsResponse result = apiInstance.getConnectionRouteAggregations(connectionId); System.out.println(result); @@ -491,7 +491,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationsApi apiInstance = new RouteAggregationsApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id try { RouteAggregationsData result = apiInstance.getRouteAggregationByUuid(routeAggregationId); System.out.println(result); @@ -564,8 +564,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationsApi apiInstance = new RouteAggregationsApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id - UUID changeId = UUID.randomUUID(); // UUID | Routing Protocol Change UUID + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id + UUID changeId = UUID.fromString("6d500177-9404-41f2-99e8-2bf1a84d8db5"); // UUID | Routing Protocol Change UUID try { RouteAggregationChangeData result = apiInstance.getRouteAggregationChangeByUuid(routeAggregationId, changeId); System.out.println(result); @@ -638,7 +638,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationsApi apiInstance = new RouteAggregationsApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch try { @@ -714,7 +714,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationsApi apiInstance = new RouteAggregationsApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id try { GetRouteAggregationGetConnectionsResponse result = apiInstance.getRouteAggregationConnections(routeAggregationId); System.out.println(result); @@ -787,7 +787,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationsApi apiInstance = new RouteAggregationsApi(defaultClient); - String routeAggregationId = "routeAggregationId_example"; // String | Route Aggregations Id + String routeAggregationId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Aggregations Id List routeAggregationsPatchRequestItem = Arrays.asList(); // List | try { RouteAggregationsData result = apiInstance.patchRouteAggregationByUuid(routeAggregationId, routeAggregationsPatchRequestItem); @@ -862,7 +862,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteAggregationsApi apiInstance = new RouteAggregationsApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Cloud Router UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Cloud Router UUID CloudRouterRouteAggregationsSearchBase cloudRouterRouteAggregationsSearchBase = new CloudRouterRouteAggregationsSearchBase(); // CloudRouterRouteAggregationsSearchBase | try { CloudRouterRouteAggregationsSearchResponse result = apiInstance.searchCloudRouterRouteAggregationAttachments(routerId, cloudRouterRouteAggregationsSearchBase); diff --git a/services/fabricv4/docs/RouteAggregationsData.md b/services/fabricv4/docs/RouteAggregationsData.md index 99cee46c..ea485a71 100644 --- a/services/fabricv4/docs/RouteAggregationsData.md +++ b/services/fabricv4/docs/RouteAggregationsData.md @@ -12,7 +12,6 @@ |**uuid** | **UUID** | Route Aggregation identifier | [optional] | |**name** | **String** | | [optional] | |**description** | **String** | Customer-provided connection description | [optional] | -|**state** | **RouteAggregationState** | | [optional] | |**change** | [**RouteAggregationsChange**](RouteAggregationsChange.md) | | [optional] | |**connectionsCount** | **Integer** | | [optional] | |**rulesCount** | **Integer** | | [optional] | diff --git a/services/fabricv4/docs/RouteFilterRulesApi.md b/services/fabricv4/docs/RouteFilterRulesApi.md index d1e4d952..c0e8004d 100644 --- a/services/fabricv4/docs/RouteFilterRulesApi.md +++ b/services/fabricv4/docs/RouteFilterRulesApi.md @@ -44,7 +44,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFilterRulesApi apiInstance = new RouteFilterRulesApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id RouteFilterRulesBase routeFilterRulesBase = new RouteFilterRulesBase(); // RouteFilterRulesBase | try { RouteFilterRulesData result = apiInstance.createRouteFilterRule(routeFilterId, routeFilterRulesBase); @@ -119,7 +119,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFilterRulesApi apiInstance = new RouteFilterRulesApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id RouteFilterRulesPostRequest routeFilterRulesPostRequest = new RouteFilterRulesPostRequest(); // RouteFilterRulesPostRequest | try { GetRouteFilterRulesResponse result = apiInstance.createRouteFilterRulesInBulk(routeFilterId, routeFilterRulesPostRequest); @@ -194,8 +194,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFilterRulesApi apiInstance = new RouteFilterRulesApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id - String routeFilterRuleId = "routeFilterRuleId_example"; // String | Route Filter Rules Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id + String routeFilterRuleId = "65b025ef-022b-4180-85cf-82cfc1ab655b"; // String | Route Filter Rules Id try { RouteFilterRulesData result = apiInstance.deleteRouteFilterRuleByUuid(routeFilterId, routeFilterRuleId); System.out.println(result); @@ -269,8 +269,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFilterRulesApi apiInstance = new RouteFilterRulesApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id - String routeFilterRuleId = "routeFilterRuleId_example"; // String | Route Filter Rules Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id + String routeFilterRuleId = "65b025ef-022b-4180-85cf-82cfc1ab655b"; // String | Route Filter Rules Id try { RouteFilterRulesData result = apiInstance.getRouteFilterRuleByUuid(routeFilterId, routeFilterRuleId); System.out.println(result); @@ -344,9 +344,9 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFilterRulesApi apiInstance = new RouteFilterRulesApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id - String routeFilterRuleId = "routeFilterRuleId_example"; // String | Route Filter Rules Id - UUID changeId = UUID.randomUUID(); // UUID | Route Filter Rule Change UUID + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id + String routeFilterRuleId = "65b025ef-022b-4180-85cf-82cfc1ab655b"; // String | Route Filter Rules Id + UUID changeId = UUID.fromString("6d500177-9404-41f2-99e8-2bf1a84d8db5"); // UUID | Route Filter Rule Change UUID try { RouteFilterRulesChangeData result = apiInstance.getRouteFilterRuleChangeByUuid(routeFilterId, routeFilterRuleId, changeId); System.out.println(result); @@ -420,8 +420,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFilterRulesApi apiInstance = new RouteFilterRulesApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id - String routeFilterRuleId = "routeFilterRuleId_example"; // String | Route Filter Rules Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id + String routeFilterRuleId = "65b025ef-022b-4180-85cf-82cfc1ab655b"; // String | Route Filter Rules Id Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch try { @@ -498,7 +498,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFilterRulesApi apiInstance = new RouteFilterRulesApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch try { @@ -574,8 +574,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFilterRulesApi apiInstance = new RouteFilterRulesApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id - String routeFilterRuleId = "routeFilterRuleId_example"; // String | Route Filter Rules Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id + String routeFilterRuleId = "65b025ef-022b-4180-85cf-82cfc1ab655b"; // String | Route Filter Rules Id List routeFilterRulesPatchRequestItem = Arrays.asList(); // List | try { RouteFilterRulesData result = apiInstance.patchRouteFilterRuleByUuid(routeFilterId, routeFilterRuleId, routeFilterRulesPatchRequestItem); @@ -651,8 +651,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFilterRulesApi apiInstance = new RouteFilterRulesApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id - String routeFilterRuleId = "routeFilterRuleId_example"; // String | Route Filter Rules Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id + String routeFilterRuleId = "65b025ef-022b-4180-85cf-82cfc1ab655b"; // String | Route Filter Rules Id RouteFilterRulesBase routeFilterRulesBase = new RouteFilterRulesBase(); // RouteFilterRulesBase | try { RouteFilterRulesData result = apiInstance.replaceRouteFilterRuleByUuid(routeFilterId, routeFilterRuleId, routeFilterRulesBase); @@ -728,7 +728,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFilterRulesApi apiInstance = new RouteFilterRulesApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id RouteFilterRulesSearchRequest routeFilterRulesSearchRequest = new RouteFilterRulesSearchRequest(); // RouteFilterRulesSearchRequest | try { RouteFilterRulesSearchResponse result = apiInstance.searchRouteFilterRules(routeFilterId, routeFilterRulesSearchRequest); diff --git a/services/fabricv4/docs/RouteFilterState.md b/services/fabricv4/docs/RouteFilterState.md deleted file mode 100644 index 0ce46dd6..00000000 --- a/services/fabricv4/docs/RouteFilterState.md +++ /dev/null @@ -1,23 +0,0 @@ - - -# RouteFilterState - -## Enum - - -* `PROVISIONING` (value: `"PROVISIONING"`) - -* `REPROVISIONING` (value: `"REPROVISIONING"`) - -* `DEPROVISIONING` (value: `"DEPROVISIONING"`) - -* `PROVISIONED` (value: `"PROVISIONED"`) - -* `DEPROVISIONED` (value: `"DEPROVISIONED"`) - -* `NOT_PROVISIONED` (value: `"NOT_PROVISIONED"`) - -* `NOT_DEPROVISIONED` (value: `"NOT_DEPROVISIONED"`) - - - diff --git a/services/fabricv4/docs/RouteFiltersApi.md b/services/fabricv4/docs/RouteFiltersApi.md index 37abc49d..9fa7b3c6 100644 --- a/services/fabricv4/docs/RouteFiltersApi.md +++ b/services/fabricv4/docs/RouteFiltersApi.md @@ -47,8 +47,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFiltersApi apiInstance = new RouteFiltersApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id - String connectionId = "connectionId_example"; // String | Connection Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id ConnectionRouteFiltersBase connectionRouteFiltersBase = new ConnectionRouteFiltersBase(); // ConnectionRouteFiltersBase | try { ConnectionRouteFilterData result = apiInstance.attachConnectionRouteFilter(routeFilterId, connectionId, connectionRouteFiltersBase); @@ -197,7 +197,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFiltersApi apiInstance = new RouteFiltersApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id try { RouteFiltersData result = apiInstance.deleteRouteFilterByUuid(routeFilterId); System.out.println(result); @@ -270,8 +270,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFiltersApi apiInstance = new RouteFiltersApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id - String connectionId = "connectionId_example"; // String | Connection Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id try { ConnectionRouteFilterData result = apiInstance.detachConnectionRouteFilter(routeFilterId, connectionId); System.out.println(result); @@ -345,8 +345,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFiltersApi apiInstance = new RouteFiltersApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id - String connectionId = "connectionId_example"; // String | Connection Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id try { ConnectionRouteFilterData result = apiInstance.getConnectionRouteFilterByUuid(routeFilterId, connectionId); System.out.println(result); @@ -420,7 +420,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFiltersApi apiInstance = new RouteFiltersApi(defaultClient); - String connectionId = "connectionId_example"; // String | Connection Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id try { GetAllConnectionRouteFiltersResponse result = apiInstance.getConnectionRouteFilters(connectionId); System.out.println(result); @@ -493,7 +493,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFiltersApi apiInstance = new RouteFiltersApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id try { RouteFiltersData result = apiInstance.getRouteFilterByUuid(routeFilterId); System.out.println(result); @@ -566,8 +566,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFiltersApi apiInstance = new RouteFiltersApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id - UUID changeId = UUID.randomUUID(); // UUID | Routing Protocol Change UUID + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id + UUID changeId = UUID.fromString("6d500177-9404-41f2-99e8-2bf1a84d8db5"); // UUID | Routing Protocol Change UUID try { RouteFilterChangeData result = apiInstance.getRouteFilterChangeByUuid(routeFilterId, changeId); System.out.println(result); @@ -640,7 +640,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFiltersApi apiInstance = new RouteFiltersApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch try { @@ -716,7 +716,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFiltersApi apiInstance = new RouteFiltersApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id try { GetRouteFilterGetConnectionsResponse result = apiInstance.getRouteFilterConnections(routeFilterId); System.out.println(result); @@ -789,7 +789,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFiltersApi apiInstance = new RouteFiltersApi(defaultClient); - String routeFilterId = "routeFilterId_example"; // String | Route Filters Id + String routeFilterId = "695a8471-6595-4ac6-a2f4-b3d96ed3a59d"; // String | Route Filters Id List routeFiltersPatchRequestItem = Arrays.asList(); // List | try { RouteFiltersData result = apiInstance.patchRouteFilterByUuid(routeFilterId, routeFiltersPatchRequestItem); @@ -864,7 +864,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RouteFiltersApi apiInstance = new RouteFiltersApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Cloud Router UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Cloud Router UUID CloudRouterRouteFiltersSearchBase cloudRouterRouteFiltersSearchBase = new CloudRouterRouteFiltersSearchBase(); // CloudRouterRouteFiltersSearchBase | try { CloudRouterRouteFiltersSearchResponse result = apiInstance.searchCloudRouterRouteFilterAttachments(routerId, cloudRouterRouteFiltersSearchBase); diff --git a/services/fabricv4/docs/RouteFiltersData.md b/services/fabricv4/docs/RouteFiltersData.md index c85313ab..deac49d4 100644 --- a/services/fabricv4/docs/RouteFiltersData.md +++ b/services/fabricv4/docs/RouteFiltersData.md @@ -12,7 +12,6 @@ |**uuid** | **UUID** | Route filter identifier | [optional] | |**name** | **String** | | [optional] | |**description** | **String** | Customer-provided connection description | [optional] | -|**state** | **RouteFilterState** | | [optional] | |**change** | [**RouteFiltersChange**](RouteFiltersChange.md) | | [optional] | |**notMatchedRuleAction** | [**NotMatchedRuleActionEnum**](#NotMatchedRuleActionEnum) | | [optional] | |**connectionsCount** | **Integer** | | [optional] | diff --git a/services/fabricv4/docs/RoutingProtocolsApi.md b/services/fabricv4/docs/RoutingProtocolsApi.md index 7fd8ae88..937ba637 100644 --- a/services/fabricv4/docs/RoutingProtocolsApi.md +++ b/services/fabricv4/docs/RoutingProtocolsApi.md @@ -47,7 +47,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RoutingProtocolsApi apiInstance = new RoutingProtocolsApi(defaultClient); - String connectionId = "connectionId_example"; // String | Connection Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id RoutingProtocolBase routingProtocolBase = new RoutingProtocolBase(); // RoutingProtocolBase | try { RoutingProtocolData result = apiInstance.createConnectionRoutingProtocol(connectionId, routingProtocolBase); @@ -122,7 +122,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RoutingProtocolsApi apiInstance = new RoutingProtocolsApi(defaultClient); - String connectionId = "connectionId_example"; // String | Connection Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id ConnectionRoutingProtocolPostRequest connectionRoutingProtocolPostRequest = new ConnectionRoutingProtocolPostRequest(); // ConnectionRoutingProtocolPostRequest | try { GetResponse result = apiInstance.createConnectionRoutingProtocolsInBulk(connectionId, connectionRoutingProtocolPostRequest); @@ -197,8 +197,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RoutingProtocolsApi apiInstance = new RoutingProtocolsApi(defaultClient); - UUID routingProtocolId = UUID.randomUUID(); // UUID | Routing Protocol Id - String connectionId = "connectionId_example"; // String | Connection Id + UUID routingProtocolId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Routing Protocol Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id try { RoutingProtocolData result = apiInstance.deleteConnectionRoutingProtocolByUuid(routingProtocolId, connectionId); System.out.println(result); @@ -272,8 +272,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RoutingProtocolsApi apiInstance = new RoutingProtocolsApi(defaultClient); - UUID routingProtocolId = UUID.randomUUID(); // UUID | Routing Protocol Id - String connectionId = "connectionId_example"; // String | Connection Id + UUID routingProtocolId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Routing Protocol Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch try { @@ -351,8 +351,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RoutingProtocolsApi apiInstance = new RoutingProtocolsApi(defaultClient); - UUID routingProtocolId = UUID.randomUUID(); // UUID | Routing Protocol Id - String connectionId = "connectionId_example"; // String | Connection Id + UUID routingProtocolId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Routing Protocol Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id try { RoutingProtocolData result = apiInstance.getConnectionRoutingProtocolByUuid(routingProtocolId, connectionId); System.out.println(result); @@ -426,7 +426,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RoutingProtocolsApi apiInstance = new RoutingProtocolsApi(defaultClient); - String connectionId = "connectionId_example"; // String | Connection Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch try { @@ -502,9 +502,9 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RoutingProtocolsApi apiInstance = new RoutingProtocolsApi(defaultClient); - String connectionId = "connectionId_example"; // String | Connection Id - UUID routingProtocolId = UUID.randomUUID(); // UUID | Routing Protocol Id - UUID actionId = UUID.randomUUID(); // UUID | BGP Action UUID + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id + UUID routingProtocolId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Routing Protocol Id + UUID actionId = UUID.fromString("86534014-34b4-53f6-45d6-4b94a92d8623"); // UUID | BGP Action UUID try { BGPActionData result = apiInstance.getConnectionRoutingProtocolsBgpActionByUuid(connectionId, routingProtocolId, actionId); System.out.println(result); @@ -578,9 +578,9 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RoutingProtocolsApi apiInstance = new RoutingProtocolsApi(defaultClient); - String connectionId = "connectionId_example"; // String | Connection Id - UUID routingProtocolId = UUID.randomUUID(); // UUID | Routing Protocol Id - UUID changeId = UUID.randomUUID(); // UUID | Routing Protocol Change UUID + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id + UUID routingProtocolId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Routing Protocol Id + UUID changeId = UUID.fromString("6d500177-9404-41f2-99e8-2bf1a84d8db5"); // UUID | Routing Protocol Change UUID try { RoutingProtocolChangeData result = apiInstance.getConnectionRoutingProtocolsChangeByUuid(connectionId, routingProtocolId, changeId); System.out.println(result); @@ -654,8 +654,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RoutingProtocolsApi apiInstance = new RoutingProtocolsApi(defaultClient); - String connectionId = "connectionId_example"; // String | Connection Id - UUID routingProtocolId = UUID.randomUUID(); // UUID | Routing Protocol Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id + UUID routingProtocolId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Routing Protocol Id Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch try { @@ -732,8 +732,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RoutingProtocolsApi apiInstance = new RoutingProtocolsApi(defaultClient); - UUID routingProtocolId = UUID.randomUUID(); // UUID | Routing Protocol Id - String connectionId = "connectionId_example"; // String | Connection Id + UUID routingProtocolId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Routing Protocol Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id List connectionChangeOperation = Arrays.asList(); // List | try { RoutingProtocolData result = apiInstance.patchConnectionRoutingProtocolByUuid(routingProtocolId, connectionId, connectionChangeOperation); @@ -809,8 +809,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RoutingProtocolsApi apiInstance = new RoutingProtocolsApi(defaultClient); - UUID routingProtocolId = UUID.randomUUID(); // UUID | Routing Protocol Id - String connectionId = "connectionId_example"; // String | Connection Id + UUID routingProtocolId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Routing Protocol Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id BGPActionRequest bgPActionRequest = new BGPActionRequest(); // BGPActionRequest | try { BGPActionData result = apiInstance.postConnectionRoutingProtocolBgpActionByUuid(routingProtocolId, connectionId, bgPActionRequest); @@ -886,8 +886,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RoutingProtocolsApi apiInstance = new RoutingProtocolsApi(defaultClient); - UUID routingProtocolId = UUID.randomUUID(); // UUID | Routing Protocol Id - String connectionId = "connectionId_example"; // String | Connection Id + UUID routingProtocolId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Routing Protocol Id + String connectionId = "557400f8-d360-11e9-bb65-2a2ae2dbcce4"; // String | Connection Id RoutingProtocolBase routingProtocolBase = new RoutingProtocolBase(); // RoutingProtocolBase | try { RoutingProtocolData result = apiInstance.replaceConnectionRoutingProtocolByUuid(routingProtocolId, connectionId, routingProtocolBase); @@ -963,7 +963,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); RoutingProtocolsApi apiInstance = new RoutingProtocolsApi(defaultClient); - UUID routerId = UUID.randomUUID(); // UUID | Cloud Router UUID + UUID routerId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Cloud Router UUID ValidateRequest validateRequest = new ValidateRequest(); // ValidateRequest | try { ValidateSubnetResponse result = apiInstance.validateRoutingProtocol(routerId, validateRequest); diff --git a/services/fabricv4/docs/ServiceProfile.md b/services/fabricv4/docs/ServiceProfile.md index 4bad5530..6942c4c3 100644 --- a/services/fabricv4/docs/ServiceProfile.md +++ b/services/fabricv4/docs/ServiceProfile.md @@ -31,7 +31,7 @@ Service Profile is a software definition for a named provider service and it's n |**environments** | [**List<ProviderEnvironment>**](ProviderEnvironment.md) | Provider environments associated with this IC_PROFILE service profile. <font color=\"red\"> <sup color='red'>Beta</sup></font> | [optional] | |**selfProfile** | **Boolean** | response attribute indicates whether the profile belongs to the same organization as the api-invoker. | [optional] [readonly] | |**projectId** | **String** | | [optional] | -|**lastMileConfig** | [**ServiceProfileLastMileConfig**](ServiceProfileLastMileConfig.md) | | [optional] | +|**lastMileConfig** | **ServiceProfileLastMileConfig** | | [optional] | diff --git a/services/fabricv4/docs/ServiceProfileLastMileConfig.md b/services/fabricv4/docs/ServiceProfileLastMileConfig.md index aedaeeff..a9773317 100644 --- a/services/fabricv4/docs/ServiceProfileLastMileConfig.md +++ b/services/fabricv4/docs/ServiceProfileLastMileConfig.md @@ -8,7 +8,7 @@ Last-mile configuration for the service profile. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**apiIntegration** | [**ServiceProfileLastMileApiIntegration**](ServiceProfileLastMileApiIntegration.md) | | [optional] | +|**apiIntegration** | **ServiceProfileLastMileApiIntegration** | | [optional] | |**productCatalogs** | [**List<ServiceProfileLastMileProductCatalog>**](ServiceProfileLastMileProductCatalog.md) | Last-mile provider catalogs. | [optional] | diff --git a/services/fabricv4/docs/ServiceProfileLastMileContactInfoItem.md b/services/fabricv4/docs/ServiceProfileLastMileContactInfoItem.md deleted file mode 100644 index a4fe8ec8..00000000 --- a/services/fabricv4/docs/ServiceProfileLastMileContactInfoItem.md +++ /dev/null @@ -1,26 +0,0 @@ - - -# ServiceProfileLastMileContactInfoItem - -Last-mile provider contact information item. - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**type** | [**TypeEnum**](#TypeEnum) | Contact type. | [optional] | -|**url** | **String** | Contact URL. | [optional] | -|**emails** | **List<String>** | List of contact emails. | [optional] | - - - -## Enum: TypeEnum - -| Name | Value | -|---- | -----| -| SUPPORT_URL | "SUPPORT_URL" | -| DOCUMENTATION_URL | "DOCUMENTATION_URL" | -| SUPPORT_EMAIL | "SUPPORT_EMAIL" | - - - diff --git a/services/fabricv4/docs/ServiceProfileRequest.md b/services/fabricv4/docs/ServiceProfileRequest.md index 41dfb7a4..ecad0df0 100644 --- a/services/fabricv4/docs/ServiceProfileRequest.md +++ b/services/fabricv4/docs/ServiceProfileRequest.md @@ -27,7 +27,7 @@ Service Profile is a software definition for a named provider service and it's n |**environments** | [**List<ProviderEnvironment>**](ProviderEnvironment.md) | Provider environments associated with this IC_PROFILE service profile. <font color=\"red\"> <sup color='red'>Beta</sup></font> | [optional] | |**selfProfile** | **Boolean** | response attribute indicates whether the profile belongs to the same organization as the api-invoker. | [optional] [readonly] | |**projectId** | **String** | | [optional] | -|**lastMileConfig** | [**ServiceProfileLastMileConfig**](ServiceProfileLastMileConfig.md) | | [optional] | +|**lastMileConfig** | **ServiceProfileLastMileConfig** | | [optional] | diff --git a/services/fabricv4/docs/SignatureRequest.md b/services/fabricv4/docs/SignatureRequest.md deleted file mode 100644 index 235bf469..00000000 --- a/services/fabricv4/docs/SignatureRequest.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# SignatureRequest - -Cross Connect Order Signature. - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**type** | **SignatureType** | | | -|**email** | **String** | Signatory email address. | [optional] | - - - diff --git a/services/fabricv4/docs/SignatureType.md b/services/fabricv4/docs/SignatureType.md deleted file mode 100644 index 20ff994d..00000000 --- a/services/fabricv4/docs/SignatureType.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# SignatureType - -## Enum - - -* `DELEGATE` (value: `"DELEGATE"`) - -* `SELF` (value: `"SELF"`) - -* `ACCOUNT_SUPPORT` (value: `"ACCOUNT_SUPPORT"`) - - - diff --git a/services/fabricv4/docs/SimplifiedServiceProfile.md b/services/fabricv4/docs/SimplifiedServiceProfile.md index dbf8d437..41f07490 100644 --- a/services/fabricv4/docs/SimplifiedServiceProfile.md +++ b/services/fabricv4/docs/SimplifiedServiceProfile.md @@ -26,7 +26,7 @@ Service Profile is a software definition for a named provider service and it's n |**environments** | [**List<ProviderEnvironment>**](ProviderEnvironment.md) | Provider environments associated with this IC_PROFILE service profile. <font color=\"red\"> <sup color='red'>Beta</sup></font> | [optional] | |**selfProfile** | **Boolean** | response attribute indicates whether the profile belongs to the same organization as the api-invoker. | [optional] [readonly] | |**projectId** | **String** | | [optional] | -|**lastMileConfig** | [**ServiceProfileLastMileConfig**](ServiceProfileLastMileConfig.md) | | [optional] | +|**lastMileConfig** | **ServiceProfileLastMileConfig** | | [optional] | diff --git a/services/fabricv4/docs/StreamAlertRulesApi.md b/services/fabricv4/docs/StreamAlertRulesApi.md index e9cab89e..f089987f 100644 --- a/services/fabricv4/docs/StreamAlertRulesApi.md +++ b/services/fabricv4/docs/StreamAlertRulesApi.md @@ -39,7 +39,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamAlertRulesApi apiInstance = new StreamAlertRulesApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID AlertRulePostRequest alertRulePostRequest = new AlertRulePostRequest(); // AlertRulePostRequest | try { StreamAlertRule result = apiInstance.createStreamAlertRules(streamId, alertRulePostRequest); @@ -113,8 +113,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamAlertRulesApi apiInstance = new StreamAlertRulesApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID - UUID alertRuleId = UUID.randomUUID(); // UUID | alert rule UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID + UUID alertRuleId = UUID.fromString("0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15"); // UUID | alert rule UUID try { StreamAlertRule result = apiInstance.deleteStreamAlertRuleByUuid(streamId, alertRuleId); System.out.println(result); @@ -187,8 +187,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamAlertRulesApi apiInstance = new StreamAlertRulesApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID - UUID alertRuleId = UUID.randomUUID(); // UUID | alert rule UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID + UUID alertRuleId = UUID.fromString("0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15"); // UUID | alert rule UUID try { StreamAlertRule result = apiInstance.getStreamAlertRuleByUuid(streamId, alertRuleId); System.out.println(result); @@ -261,7 +261,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamAlertRulesApi apiInstance = new StreamAlertRulesApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch try { @@ -336,8 +336,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamAlertRulesApi apiInstance = new StreamAlertRulesApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID - UUID alertRuleId = UUID.randomUUID(); // UUID | alert rule UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID + UUID alertRuleId = UUID.fromString("0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15"); // UUID | alert rule UUID AlertRulePutRequest alertRulePutRequest = new AlertRulePutRequest(); // AlertRulePutRequest | try { StreamAlertRule result = apiInstance.updateStreamAlertRuleByUuid(streamId, alertRuleId, alertRulePutRequest); diff --git a/services/fabricv4/docs/StreamAssetInterface.md b/services/fabricv4/docs/StreamAssetInterface.md deleted file mode 100644 index 7496010c..00000000 --- a/services/fabricv4/docs/StreamAssetInterface.md +++ /dev/null @@ -1,43 +0,0 @@ - - -# StreamAssetInterface - -Network Edge Device interface attached to a stream - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**href** | **URI** | Network Edge Device interface URI | [optional] [readonly] | -|**id** | **Integer** | Network Edge Device interface identifier | [optional] | -|**uuid** | **UUID** | Network Edge Device interface UUID | [optional] | -|**type** | [**TypeEnum**](#TypeEnum) | Network Edge Device interface type | [optional] | -|**state** | **String** | Network Edge Device interface usage status | [optional] | -|**attachmentStatus** | [**AttachmentStatusEnum**](#AttachmentStatusEnum) | interface attachment status | [optional] | - - - -## Enum: TypeEnum - -| Name | Value | -|---- | -----| -| DATA | "DATA" | -| MGMT | "MGMT" | -| SSH | "SSH" | -| FAB | "FAB" | -| CTRL | "CTRL" | - - - -## Enum: AttachmentStatusEnum - -| Name | Value | -|---- | -----| -| ATTACHING | "ATTACHING" | -| ATTACHED | "ATTACHED" | -| DETACHED | "DETACHED" | -| DETACHING | "DETACHING" | -| FAILED | "FAILED" | - - - diff --git a/services/fabricv4/docs/StreamSubscriptionsApi.md b/services/fabricv4/docs/StreamSubscriptionsApi.md index 64f5763c..318e62a2 100644 --- a/services/fabricv4/docs/StreamSubscriptionsApi.md +++ b/services/fabricv4/docs/StreamSubscriptionsApi.md @@ -40,7 +40,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamSubscriptionsApi apiInstance = new StreamSubscriptionsApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID StreamSubscriptionPostRequest streamSubscriptionPostRequest = new StreamSubscriptionPostRequest(); // StreamSubscriptionPostRequest | try { StreamSubscription result = apiInstance.createStreamSubscriptions(streamId, streamSubscriptionPostRequest); @@ -114,8 +114,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamSubscriptionsApi apiInstance = new StreamSubscriptionsApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID - UUID subscriptionId = UUID.randomUUID(); // UUID | Stream Subscription UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID + UUID subscriptionId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Stream Subscription UUID try { StreamSubscription result = apiInstance.deleteStreamSubscriptionByUuid(streamId, subscriptionId); System.out.println(result); @@ -188,8 +188,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamSubscriptionsApi apiInstance = new StreamSubscriptionsApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID - UUID subscriptionId = UUID.randomUUID(); // UUID | Stream Subscription UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID + UUID subscriptionId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Stream Subscription UUID try { StreamSubscription result = apiInstance.getStreamSubscriptionByUuid(streamId, subscriptionId); System.out.println(result); @@ -262,7 +262,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamSubscriptionsApi apiInstance = new StreamSubscriptionsApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID Integer offset = 1; // Integer | offset Integer limit = 10; // Integer | number of records to fetch try { @@ -409,8 +409,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamSubscriptionsApi apiInstance = new StreamSubscriptionsApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID - UUID subscriptionId = UUID.randomUUID(); // UUID | Stream Subscription UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID + UUID subscriptionId = UUID.fromString("557400f8-d360-11e9-bb65-2a2ae2dbcce4"); // UUID | Stream Subscription UUID StreamSubscriptionPutRequest streamSubscriptionPutRequest = new StreamSubscriptionPutRequest(); // StreamSubscriptionPutRequest | try { StreamSubscription result = apiInstance.updateStreamSubscriptionByUuid(streamId, subscriptionId, streamSubscriptionPutRequest); diff --git a/services/fabricv4/docs/StreamsApi.md b/services/fabricv4/docs/StreamsApi.md index a66305fb..cabc29fa 100644 --- a/services/fabricv4/docs/StreamsApi.md +++ b/services/fabricv4/docs/StreamsApi.md @@ -119,9 +119,9 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamsApi apiInstance = new StreamsApi(defaultClient); - UUID assetId = UUID.randomUUID(); // UUID | asset UUID + UUID assetId = UUID.fromString("757400f8-d360-11e9-bb65-2a2ae2dbcce6"); // UUID | asset UUID Asset asset = Asset.fromValue("ports"); // Asset | asset - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID try { StreamAsset result = apiInstance.deleteStreamAssetByUuid(assetId, asset, streamId); System.out.println(result); @@ -195,7 +195,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamsApi apiInstance = new StreamsApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID try { Stream result = apiInstance.deleteStreamByUuid(streamId); System.out.println(result); @@ -267,8 +267,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamsApi apiInstance = new StreamsApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID - UUID deviceId = UUID.randomUUID(); // UUID | Network Edge Device UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID + UUID deviceId = UUID.fromString("8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d"); // UUID | Network Edge Device UUID try { StreamAsset result = apiInstance.deleteStreamDevice(streamId, deviceId); System.out.println(result); @@ -341,9 +341,9 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamsApi apiInstance = new StreamsApi(defaultClient); - UUID assetId = UUID.randomUUID(); // UUID | asset UUID + UUID assetId = UUID.fromString("757400f8-d360-11e9-bb65-2a2ae2dbcce6"); // UUID | asset UUID Asset asset = Asset.fromValue("ports"); // Asset | asset - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID try { StreamAsset result = apiInstance.getStreamAssetByUuid(assetId, asset, streamId); System.out.println(result); @@ -417,7 +417,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamsApi apiInstance = new StreamsApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID try { Stream result = apiInstance.getStreamByUuid(streamId); System.out.println(result); @@ -489,8 +489,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamsApi apiInstance = new StreamsApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID - UUID deviceId = UUID.randomUUID(); // UUID | Network Edge Device UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID + UUID deviceId = UUID.fromString("8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d"); // UUID | Network Edge Device UUID try { StreamAsset result = apiInstance.getStreamDevice(streamId, deviceId); System.out.println(result); @@ -779,9 +779,9 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamsApi apiInstance = new StreamsApi(defaultClient); - UUID assetId = UUID.randomUUID(); // UUID | asset UUID + UUID assetId = UUID.fromString("757400f8-d360-11e9-bb65-2a2ae2dbcce6"); // UUID | asset UUID Asset asset = Asset.fromValue("ports"); // Asset | asset - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID StreamAssetPutRequest streamAssetPutRequest = new StreamAssetPutRequest(); // StreamAssetPutRequest | try { StreamAsset result = apiInstance.updateStreamAssetByUuid(assetId, asset, streamId, streamAssetPutRequest); @@ -858,7 +858,7 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamsApi apiInstance = new StreamsApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID StreamPutRequest streamPutRequest = new StreamPutRequest(); // StreamPutRequest | try { Stream result = apiInstance.updateStreamByUuid(streamId, streamPutRequest); @@ -933,8 +933,8 @@ public class Example { BearerAuth.setBearerToken("BEARER TOKEN"); StreamsApi apiInstance = new StreamsApi(defaultClient); - UUID streamId = UUID.randomUUID(); // UUID | Stream UUID - UUID deviceId = UUID.randomUUID(); // UUID | Network Edge Device UUID + UUID streamId = UUID.fromString("657400f8-d360-11e9-bb65-2a2ae2dbcce5"); // UUID | Stream UUID + UUID deviceId = UUID.fromString("8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d"); // UUID | Network Edge Device UUID StreamDevicePutRequest streamDevicePutRequest = new StreamDevicePutRequest(); // StreamDevicePutRequest | try { StreamAsset result = apiInstance.updateStreamDevice(streamId, deviceId, streamDevicePutRequest); diff --git a/services/fabricv4/docs/TunnelRoutingProtocolIpv4.md b/services/fabricv4/docs/TunnelRoutingProtocolIpv4.md deleted file mode 100644 index 2dd09ca4..00000000 --- a/services/fabricv4/docs/TunnelRoutingProtocolIpv4.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# TunnelRoutingProtocolIpv4 - -IPv4 configuration for the Routing Protocol - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**enabled** | **Boolean** | Enable or disable the Routing Protocol on IPv4 | [optional] | -|**localPeerIp** | **String** | The local IP address | [optional] | -|**remotePeerIp** | **String** | The remote peer's IP address | [optional] | - - - diff --git a/services/fabricv4/docs/TunnelRoutingProtocolPostRequestIpv4.md b/services/fabricv4/docs/TunnelRoutingProtocolPostRequestIpv4.md deleted file mode 100644 index c6bbf510..00000000 --- a/services/fabricv4/docs/TunnelRoutingProtocolPostRequestIpv4.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# TunnelRoutingProtocolPostRequestIpv4 - -IPv4 configuration for the Routing Protocol - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**enabled** | **Boolean** | Enable or disable the Routing Protocol on IPv4 | [optional] | - - - diff --git a/services/fabricv4/docs/ValidateRequestFilter.md b/services/fabricv4/docs/ValidateRequestFilter.md index 12b97dec..1b70eae8 100644 --- a/services/fabricv4/docs/ValidateRequestFilter.md +++ b/services/fabricv4/docs/ValidateRequestFilter.md @@ -8,7 +8,7 @@ Filters | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**and** | [**List<ValidateRequestFilterAnd>**](ValidateRequestFilterAnd.md) | | [optional] | +|**and** | [**List<ValidateRequestFilterAndInner>**](ValidateRequestFilterAndInner.md) | | [optional] | diff --git a/services/fabricv4/docs/ValidateRequestFilterAnd.md b/services/fabricv4/docs/ValidateRequestFilterAndInner.md similarity index 91% rename from services/fabricv4/docs/ValidateRequestFilterAnd.md rename to services/fabricv4/docs/ValidateRequestFilterAndInner.md index 1184dc66..56c8a9bd 100644 --- a/services/fabricv4/docs/ValidateRequestFilterAnd.md +++ b/services/fabricv4/docs/ValidateRequestFilterAndInner.md @@ -1,6 +1,6 @@ -# ValidateRequestFilterAnd +# ValidateRequestFilterAndInner ## Properties diff --git a/services/fabricv4/docs/VpicInterface.md b/services/fabricv4/docs/VpicInterface.md deleted file mode 100644 index b2950858..00000000 --- a/services/fabricv4/docs/VpicInterface.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# VpicInterface - -MCN VPIC Interface Information - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**href** | **URI** | The Canonical URL at which the resource resides. | [optional] [readonly] | -|**uuid** | **UUID** | MCN assigned VPIC Interface Identifier | [optional] | - - - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/JSON.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/JSON.java index bf930ebe..749b21dd 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/JSON.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/JSON.java @@ -299,8 +299,17 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AppSubscriptionTargetAppService.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AppSubscriptionTargetRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AppSubscriptionTargetRequestAppService.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.Asn.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AsnAsset.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AsnAssetIpBlockRef.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AsnAssetService.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AsnChange.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AsnOwnershipChallengeLoa.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AsnOwnershipChallengeRpki.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AsnPatchOperation.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AsnSearchRequestBody.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AsnSearchResponseBody.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AsnSearchSortCriteria.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AttachPrivateServiceResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AttachServiceProfileResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.AttachTagResponse.CustomTypeAdapterFactory()); @@ -376,10 +385,9 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CompanyProfileChange.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CompanyProfileChangeItem.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CompanyProfileContact.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CompanyProfileContactContacts.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CompanyProfileContactContactsInner.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CompanyProfileRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CompanyProfileResponse.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CompanyProfileResponseAccount.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CompanyProfileSearchFilter.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CompanyProfileSearchFilters.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CompanyProfileSearchOrFilter.CustomTypeAdapterFactory()); @@ -393,7 +401,6 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ConnectionAction.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ConnectionActionRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ConnectionChangeOperation.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ConnectionInvitation.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ConnectionLink.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ConnectionOperation.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ConnectionPostRequest.CustomTypeAdapterFactory()); @@ -417,12 +424,12 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ConnectionSideAdditionalInfo.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ConnectivitySource.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ContactPreference.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CreateAsnRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CreateCrossConnect.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CreateLoa.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CreateLoaNote.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectASideDemarcationPoint.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectASideRequest.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectASideRequestDemarcationPoint.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectASideResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectAccount.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectActionAttachmentResponse.CustomTypeAdapterFactory()); @@ -446,7 +453,6 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectContactPreference.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectDemarcationPoint.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectDiverse.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectEndCustomer.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectFilter.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectLink.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectLoaRef.CustomTypeAdapterFactory()); @@ -458,11 +464,9 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectOrFilter.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectParentNote.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectPhone.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectProject.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectProvider.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectRedundancy.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectResponse.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectResponseAllowedActions.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectResponseAllowedActionsInner.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectScheduleAvailability.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectScheduleAvailabilityASide.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectScheduleAvailabilityZSide.CustomTypeAdapterFactory()); @@ -485,17 +489,16 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CrossConnectZSideResponseDemarcationPoint.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.CustomField.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.DeinstallScheduleRequest.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.DeleteCrossConnect.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.DetectionMethod.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.DetectionMethodResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.DirectConnectionIpv4.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.DirectConnectionIpv6.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.Direction.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.DiverseCrossConnectRequest.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.EndCustomer.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.EnvironmentActionRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.EnvironmentActionResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.Error.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ErrorAdditionalInfoInner.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ExchangeServiceActionRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ExchangeServiceActionResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ExchangeServiceAdditionalInfo.CustomTypeAdapterFactory()); @@ -517,11 +520,6 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.FabricCloudRouterPackages.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.FabricCloudRouterPrice.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.FilterBody.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.GatewayIpv4.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.GatewaySearchRequest.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.GatewaySortCriteria.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.GatewayTunnelSearchRequest.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.GatewayTunnelSortCriteria.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.GeoCoordinates.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.GeoZone.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.GetAllCloudRouterCommands.CustomTypeAdapterFactory()); @@ -540,8 +538,7 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.GetRouteFilterRulesResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.HealthResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.Hop.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.HopProbes.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccess.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.HopProbesInner.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccessAccount.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccessBilling.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccessChange.CustomTypeAdapterFactory()); @@ -564,9 +561,9 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccessPostRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccessPostRequestBilling.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolBgp.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolBgpAsn.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolBgpAllOfAsn.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolBgpRequest.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolBgpRequestAsn.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolBgpRequestAllOfAsn.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolDirect.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolDirectRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolStatic.CustomTypeAdapterFactory()); @@ -639,7 +636,7 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.Md5.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.MetalInterconnection.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.Metric.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.MetricDatapoints.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.MetricDatapointsInner.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.MetricFilters.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.MetricResource.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.MetricSelector.CustomTypeAdapterFactory()); @@ -707,7 +704,6 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PatchIpBlockRequestBodyItemValue.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.Phone.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PhysicalPort.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PhysicalPortSettings.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PlatformChangelog.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.Port.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PortAdditionalInfo.CustomTypeAdapterFactory()); @@ -739,7 +735,6 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PrecisionTimePackagePostResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PrecisionTimePackageRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PrecisionTimePackageResponse.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PrecisionTimePrice.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PrecisionTimeServiceConnectionsResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PrecisionTimeServicePackagesResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PrecisionTimeServiceRequest.CustomTypeAdapterFactory()); @@ -747,7 +742,6 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.Price.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PriceCharge.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PriceError.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PriceErrorAdditionalInfo.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PriceLocation.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PriceSearchResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.PrivateService.CustomTypeAdapterFactory()); @@ -768,9 +762,6 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ResourceData.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ResourceSelector.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ResourceSelectorResponse.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ResponseIncompleteDetails.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ResponseUsageInputTokensDetails.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ResponseUsageOutputTokensDetails.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.RfAttachmentSortItem.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.RouteAggregationChangeData.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.RouteAggregationChangeDataResponse.CustomTypeAdapterFactory()); @@ -838,7 +829,6 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.RouteTableEntrySearchResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.RouteTableEntrySimpleExpression.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.RouteTableEntrySortCriteria.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.Router.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.RouterActionsConnection.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.RouterActionsRouter.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.RoutingProtocolBFD.CustomTypeAdapterFactory()); @@ -888,7 +878,6 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ServiceProfileFilter.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ServiceProfileLastMileApiIntegration.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ServiceProfileLastMileConfig.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ServiceProfileLastMileContactInfoItem.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ServiceProfileLastMileDeliveryDateRange.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ServiceProfileLastMileOffering.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ServiceProfileLastMilePriceRange.CustomTypeAdapterFactory()); @@ -912,7 +901,6 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ServiceTokenSide.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ServiceTokens.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.Services.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.SignatureRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.SimplifiedAccount.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.SimplifiedAccountRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.SimplifiedLinkProtocol.CustomTypeAdapterFactory()); @@ -936,7 +924,6 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.StreamAsset.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.StreamAssetFilter.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.StreamAssetFilters.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.StreamAssetInterface.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.StreamAssetOrFilter.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.StreamAssetPutRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.StreamAssetSearchRequest.CustomTypeAdapterFactory()); @@ -995,12 +982,10 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.TimeServiceSimpleExpression.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.TimeServiceSortCriteria.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.TimeServicesSearchRequest.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.TunnelRoutingProtocolIpv4.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.TunnelRoutingProtocolPostRequestIpv4.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ValidateConnectionResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ValidateRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ValidateRequestFilter.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ValidateRequestFilterAnd.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ValidateRequestFilterAndInner.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.ValidateSubnetResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.VirtualConnectionPrice.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.VirtualConnectionPriceASide.CustomTypeAdapterFactory()); @@ -1023,7 +1008,6 @@ public Enum deserialize(JsonElement json, java.lang.reflect.Type type, JsonDeser gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.VirtualPortPackage.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.VirtualPortPrice.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.VirtualPortRedundancy.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.equinix.sdk.fabricv4.model.VpicInterface.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapter(PortEncapsulation.TypeEnum.class,new UppercaseEnumAdapter()); gsonBuilder.registerTypeAdapter(PortDeviceRedundancy.PriorityEnum.class,new UppercaseEnumAdapter()); gsonBuilder.registerTypeAdapter(PortPriority.class, new UppercaseEnumAdapter()); diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/api/AsnsApi.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/api/AsnsApi.java new file mode 100644 index 00000000..fce21c9c --- /dev/null +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/api/AsnsApi.java @@ -0,0 +1,812 @@ +/* + * Equinix Fabric API v4 + * + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.equinix.sdk.fabricv4.api; + +import com.equinix.sdk.fabricv4.ApiCallback; +import com.equinix.sdk.fabricv4.ApiClient; +import com.equinix.sdk.fabricv4.ApiException; +import com.equinix.sdk.fabricv4.ApiResponse; +import com.equinix.sdk.fabricv4.Configuration; +import com.equinix.sdk.fabricv4.Pair; +import com.equinix.sdk.fabricv4.ProgressRequestBody; +import com.equinix.sdk.fabricv4.ProgressResponseBody; + +import com.google.gson.reflect.TypeToken; + +import java.io.IOException; + + +import com.equinix.sdk.fabricv4.model.Asn; +import com.equinix.sdk.fabricv4.model.AsnPatchOperation; +import com.equinix.sdk.fabricv4.model.AsnSearchRequestBody; +import com.equinix.sdk.fabricv4.model.AsnSearchResponseBody; +import com.equinix.sdk.fabricv4.model.CreateAsnRequest; +import com.equinix.sdk.fabricv4.model.Error; +import java.util.UUID; + +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class AsnsApi { + private ApiClient localVarApiClient; + private int localHostIndex; + private String localCustomBaseUrl; + + public AsnsApi() { + this(Configuration.getDefaultApiClient()); + } + + public AsnsApi(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public ApiClient getApiClient() { + return localVarApiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public int getHostIndex() { + return localHostIndex; + } + + public void setHostIndex(int hostIndex) { + this.localHostIndex = hostIndex; + } + + public String getCustomBaseUrl() { + return localCustomBaseUrl; + } + + public void setCustomBaseUrl(String customBaseUrl) { + this.localCustomBaseUrl = customBaseUrl; + } + + /** + * Build call for createAsn + * @param createAsnRequest (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
202 ASN request accepted -
400 Bad request -
401 Unauthorized -
403 Forbidden -
500 Internal server error -
+ */ + public okhttp3.Call createAsnCall(@javax.annotation.Nonnull CreateAsnRequest createAsnRequest, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = createAsnRequest; + + // create path and map variables + String localVarPath = "/fabric/v4/asns"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "BearerAuth" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call createAsnValidateBeforeCall(@javax.annotation.Nonnull CreateAsnRequest createAsnRequest, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'createAsnRequest' is set + if (createAsnRequest == null) { + throw new ApiException("Missing the required parameter 'createAsnRequest' when calling createAsn(Async)"); + } + + return createAsnCall(createAsnRequest, _callback); + + } + + /** + * Create ASN + * Create a new Public or Private ASN record + * @param createAsnRequest (required) + * @return Asn + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
202 ASN request accepted -
400 Bad request -
401 Unauthorized -
403 Forbidden -
500 Internal server error -
+ */ + public Asn createAsn(@javax.annotation.Nonnull CreateAsnRequest createAsnRequest) throws ApiException { + ApiResponse localVarResp = createAsnWithHttpInfo(createAsnRequest); + return localVarResp.getData(); + } + + /** + * Create ASN + * Create a new Public or Private ASN record + * @param createAsnRequest (required) + * @return ApiResponse<Asn> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
202 ASN request accepted -
400 Bad request -
401 Unauthorized -
403 Forbidden -
500 Internal server error -
+ */ + public ApiResponse createAsnWithHttpInfo(@javax.annotation.Nonnull CreateAsnRequest createAsnRequest) throws ApiException { + okhttp3.Call localVarCall = createAsnValidateBeforeCall(createAsnRequest, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Create ASN (asynchronously) + * Create a new Public or Private ASN record + * @param createAsnRequest (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
202 ASN request accepted -
400 Bad request -
401 Unauthorized -
403 Forbidden -
500 Internal server error -
+ */ + public okhttp3.Call createAsnAsync(@javax.annotation.Nonnull CreateAsnRequest createAsnRequest, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = createAsnValidateBeforeCall(createAsnRequest, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for deleteAsnById + * @param asnId UUID of the ASN record (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + + + +
Response Details
Status Code Description Response Headers
202 ASN request accepted -
400 Bad request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
500 Internal server error -
+ */ + public okhttp3.Call deleteAsnByIdCall(@javax.annotation.Nonnull UUID asnId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/fabric/v4/asns/{asnId}" + .replace("{" + "asnId" + "}", localVarApiClient.escapeString(asnId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "BearerAuth" }; + return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call deleteAsnByIdValidateBeforeCall(@javax.annotation.Nonnull UUID asnId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'asnId' is set + if (asnId == null) { + throw new ApiException("Missing the required parameter 'asnId' when calling deleteAsnById(Async)"); + } + + return deleteAsnByIdCall(asnId, _callback); + + } + + /** + * Delete ASN + * Deprovision ASN record by UUID + * @param asnId UUID of the ASN record (required) + * @return Asn + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + + +
Response Details
Status Code Description Response Headers
202 ASN request accepted -
400 Bad request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
500 Internal server error -
+ */ + public Asn deleteAsnById(@javax.annotation.Nonnull UUID asnId) throws ApiException { + ApiResponse localVarResp = deleteAsnByIdWithHttpInfo(asnId); + return localVarResp.getData(); + } + + /** + * Delete ASN + * Deprovision ASN record by UUID + * @param asnId UUID of the ASN record (required) + * @return ApiResponse<Asn> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + + +
Response Details
Status Code Description Response Headers
202 ASN request accepted -
400 Bad request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
500 Internal server error -
+ */ + public ApiResponse deleteAsnByIdWithHttpInfo(@javax.annotation.Nonnull UUID asnId) throws ApiException { + okhttp3.Call localVarCall = deleteAsnByIdValidateBeforeCall(asnId, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Delete ASN (asynchronously) + * Deprovision ASN record by UUID + * @param asnId UUID of the ASN record (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + + + +
Response Details
Status Code Description Response Headers
202 ASN request accepted -
400 Bad request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
500 Internal server error -
+ */ + public okhttp3.Call deleteAsnByIdAsync(@javax.annotation.Nonnull UUID asnId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = deleteAsnByIdValidateBeforeCall(asnId, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for getAsnById + * @param asnId UUID of the ASN record (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
200 ASN retrieved successfully -
401 Unauthorized -
403 Forbidden -
404 Not Found -
500 Internal server error -
+ */ + public okhttp3.Call getAsnByIdCall(@javax.annotation.Nonnull UUID asnId, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/fabric/v4/asns/{asnId}" + .replace("{" + "asnId" + "}", localVarApiClient.escapeString(asnId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "BearerAuth" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getAsnByIdValidateBeforeCall(@javax.annotation.Nonnull UUID asnId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'asnId' is set + if (asnId == null) { + throw new ApiException("Missing the required parameter 'asnId' when calling getAsnById(Async)"); + } + + return getAsnByIdCall(asnId, _callback); + + } + + /** + * Get ASN + * Retrieve ASN record by UUID + * @param asnId UUID of the ASN record (required) + * @return Asn + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
200 ASN retrieved successfully -
401 Unauthorized -
403 Forbidden -
404 Not Found -
500 Internal server error -
+ */ + public Asn getAsnById(@javax.annotation.Nonnull UUID asnId) throws ApiException { + ApiResponse localVarResp = getAsnByIdWithHttpInfo(asnId); + return localVarResp.getData(); + } + + /** + * Get ASN + * Retrieve ASN record by UUID + * @param asnId UUID of the ASN record (required) + * @return ApiResponse<Asn> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
200 ASN retrieved successfully -
401 Unauthorized -
403 Forbidden -
404 Not Found -
500 Internal server error -
+ */ + public ApiResponse getAsnByIdWithHttpInfo(@javax.annotation.Nonnull UUID asnId) throws ApiException { + okhttp3.Call localVarCall = getAsnByIdValidateBeforeCall(asnId, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Get ASN (asynchronously) + * Retrieve ASN record by UUID + * @param asnId UUID of the ASN record (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
200 ASN retrieved successfully -
401 Unauthorized -
403 Forbidden -
404 Not Found -
500 Internal server error -
+ */ + public okhttp3.Call getAsnByIdAsync(@javax.annotation.Nonnull UUID asnId, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getAsnByIdValidateBeforeCall(asnId, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for patchAsnById + * @param asnId UUID of the ASN record (required) + * @param asnPatchOperation (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + + + +
Response Details
Status Code Description Response Headers
202 ASN request accepted -
400 Bad request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
500 Internal server error -
+ */ + public okhttp3.Call patchAsnByIdCall(@javax.annotation.Nonnull UUID asnId, @javax.annotation.Nonnull List asnPatchOperation, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = asnPatchOperation; + + // create path and map variables + String localVarPath = "/fabric/v4/asns/{asnId}" + .replace("{" + "asnId" + "}", localVarApiClient.escapeString(asnId.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "BearerAuth" }; + return localVarApiClient.buildCall(basePath, localVarPath, "PATCH", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call patchAsnByIdValidateBeforeCall(@javax.annotation.Nonnull UUID asnId, @javax.annotation.Nonnull List asnPatchOperation, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'asnId' is set + if (asnId == null) { + throw new ApiException("Missing the required parameter 'asnId' when calling patchAsnById(Async)"); + } + + // verify the required parameter 'asnPatchOperation' is set + if (asnPatchOperation == null) { + throw new ApiException("Missing the required parameter 'asnPatchOperation' when calling patchAsnById(Async)"); + } + + return patchAsnByIdCall(asnId, asnPatchOperation, _callback); + + } + + /** + * Update ASN + * Update ASN record + * @param asnId UUID of the ASN record (required) + * @param asnPatchOperation (required) + * @return Asn + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + + +
Response Details
Status Code Description Response Headers
202 ASN request accepted -
400 Bad request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
500 Internal server error -
+ */ + public Asn patchAsnById(@javax.annotation.Nonnull UUID asnId, @javax.annotation.Nonnull List asnPatchOperation) throws ApiException { + ApiResponse localVarResp = patchAsnByIdWithHttpInfo(asnId, asnPatchOperation); + return localVarResp.getData(); + } + + /** + * Update ASN + * Update ASN record + * @param asnId UUID of the ASN record (required) + * @param asnPatchOperation (required) + * @return ApiResponse<Asn> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + + +
Response Details
Status Code Description Response Headers
202 ASN request accepted -
400 Bad request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
500 Internal server error -
+ */ + public ApiResponse patchAsnByIdWithHttpInfo(@javax.annotation.Nonnull UUID asnId, @javax.annotation.Nonnull List asnPatchOperation) throws ApiException { + okhttp3.Call localVarCall = patchAsnByIdValidateBeforeCall(asnId, asnPatchOperation, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Update ASN (asynchronously) + * Update ASN record + * @param asnId UUID of the ASN record (required) + * @param asnPatchOperation (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + + + +
Response Details
Status Code Description Response Headers
202 ASN request accepted -
400 Bad request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
500 Internal server error -
+ */ + public okhttp3.Call patchAsnByIdAsync(@javax.annotation.Nonnull UUID asnId, @javax.annotation.Nonnull List asnPatchOperation, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = patchAsnByIdValidateBeforeCall(asnId, asnPatchOperation, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for searchAsns + * @param asnSearchRequestBody (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
200 ASN records found successfully -
400 Bad request -
401 Unauthorized -
403 Forbidden -
500 Internal server error -
+ */ + public okhttp3.Call searchAsnsCall(@javax.annotation.Nonnull AsnSearchRequestBody asnSearchRequestBody, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = asnSearchRequestBody; + + // create path and map variables + String localVarPath = "/fabric/v4/asns/search"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "BearerAuth" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call searchAsnsValidateBeforeCall(@javax.annotation.Nonnull AsnSearchRequestBody asnSearchRequestBody, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'asnSearchRequestBody' is set + if (asnSearchRequestBody == null) { + throw new ApiException("Missing the required parameter 'asnSearchRequestBody' when calling searchAsns(Async)"); + } + + return searchAsnsCall(asnSearchRequestBody, _callback); + + } + + /** + * Search ASNs + * Search for ASN records based on criteria + * @param asnSearchRequestBody (required) + * @return AsnSearchResponseBody + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
200 ASN records found successfully -
400 Bad request -
401 Unauthorized -
403 Forbidden -
500 Internal server error -
+ */ + public AsnSearchResponseBody searchAsns(@javax.annotation.Nonnull AsnSearchRequestBody asnSearchRequestBody) throws ApiException { + ApiResponse localVarResp = searchAsnsWithHttpInfo(asnSearchRequestBody); + return localVarResp.getData(); + } + + /** + * Search ASNs + * Search for ASN records based on criteria + * @param asnSearchRequestBody (required) + * @return ApiResponse<AsnSearchResponseBody> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
200 ASN records found successfully -
400 Bad request -
401 Unauthorized -
403 Forbidden -
500 Internal server error -
+ */ + public ApiResponse searchAsnsWithHttpInfo(@javax.annotation.Nonnull AsnSearchRequestBody asnSearchRequestBody) throws ApiException { + okhttp3.Call localVarCall = searchAsnsValidateBeforeCall(asnSearchRequestBody, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Search ASNs (asynchronously) + * Search for ASN records based on criteria + * @param asnSearchRequestBody (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + + +
Response Details
Status Code Description Response Headers
200 ASN records found successfully -
400 Bad request -
401 Unauthorized -
403 Forbidden -
500 Internal server error -
+ */ + public okhttp3.Call searchAsnsAsync(@javax.annotation.Nonnull AsnSearchRequestBody asnSearchRequestBody, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = searchAsnsValidateBeforeCall(asnSearchRequestBody, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } +} diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppDomainChangeOperation.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppDomainChangeOperation.java index 014fc98e..b48bb259 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppDomainChangeOperation.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppDomainChangeOperation.java @@ -166,8 +166,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public AppDomainChangeOperation() { } @@ -210,7 +210,7 @@ public void setPath(@javax.annotation.Nonnull PathEnum path) { } - public AppDomainChangeOperation value(@javax.annotation.Nonnull Object value) { + public AppDomainChangeOperation value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -219,12 +219,12 @@ public AppDomainChangeOperation value(@javax.annotation.Nonnull Object value) { * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppLinkAppServiceAttachmentChangeOperation.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppLinkAppServiceAttachmentChangeOperation.java index eb7957b7..93f7e355 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppLinkAppServiceAttachmentChangeOperation.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppLinkAppServiceAttachmentChangeOperation.java @@ -166,8 +166,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public AppLinkAppServiceAttachmentChangeOperation() { } @@ -210,7 +210,7 @@ public void setPath(@javax.annotation.Nonnull PathEnum path) { } - public AppLinkAppServiceAttachmentChangeOperation value(@javax.annotation.Nonnull Object value) { + public AppLinkAppServiceAttachmentChangeOperation value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -219,12 +219,12 @@ public AppLinkAppServiceAttachmentChangeOperation value(@javax.annotation.Nonnul * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppLinkChangeOperation.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppLinkChangeOperation.java index 2a082c43..44d78e7c 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppLinkChangeOperation.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppLinkChangeOperation.java @@ -172,8 +172,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public AppLinkChangeOperation() { } @@ -216,7 +216,7 @@ public void setPath(@javax.annotation.Nonnull PathEnum path) { } - public AppLinkChangeOperation value(@javax.annotation.Nonnull Object value) { + public AppLinkChangeOperation value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -225,12 +225,12 @@ public AppLinkChangeOperation value(@javax.annotation.Nonnull Object value) { * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppProcessorChangeOperation.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppProcessorChangeOperation.java index 587a7af9..61af8d40 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppProcessorChangeOperation.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppProcessorChangeOperation.java @@ -166,8 +166,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public AppProcessorChangeOperation() { } @@ -210,7 +210,7 @@ public void setPath(@javax.annotation.Nonnull PathEnum path) { } - public AppProcessorChangeOperation value(@javax.annotation.Nonnull Object value) { + public AppProcessorChangeOperation value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -219,12 +219,12 @@ public AppProcessorChangeOperation value(@javax.annotation.Nonnull Object value) * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppServiceChangeOperation.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppServiceChangeOperation.java index 1cd92e35..4397cd0c 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppServiceChangeOperation.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppServiceChangeOperation.java @@ -170,8 +170,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public AppServiceChangeOperation() { } @@ -214,7 +214,7 @@ public void setPath(@javax.annotation.Nonnull PathEnum path) { } - public AppServiceChangeOperation value(@javax.annotation.Nonnull Object value) { + public AppServiceChangeOperation value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -223,12 +223,12 @@ public AppServiceChangeOperation value(@javax.annotation.Nonnull Object value) { * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppSubscriptionChangeOperation.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppSubscriptionChangeOperation.java index a94078d0..3e340a28 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppSubscriptionChangeOperation.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AppSubscriptionChangeOperation.java @@ -116,8 +116,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public AppSubscriptionChangeOperation() { } @@ -160,7 +160,7 @@ public void setPath(@javax.annotation.Nonnull String path) { } - public AppSubscriptionChangeOperation value(@javax.annotation.Nonnull Object value) { + public AppSubscriptionChangeOperation value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -169,12 +169,12 @@ public AppSubscriptionChangeOperation value(@javax.annotation.Nonnull Object val * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Asn.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Asn.java new file mode 100644 index 00000000..3df0839d --- /dev/null +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Asn.java @@ -0,0 +1,690 @@ +/* + * Equinix Fabric API v4 + * + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.equinix.sdk.fabricv4.model; + +import java.util.Objects; +import java.util.Locale; +import com.equinix.sdk.fabricv4.model.AsnAsset; +import com.equinix.sdk.fabricv4.model.AsnChange; +import com.equinix.sdk.fabricv4.model.AsnOwnershipChallengeDetails; +import com.equinix.sdk.fabricv4.model.AsnRange; +import com.equinix.sdk.fabricv4.model.AsnRirRegion; +import com.equinix.sdk.fabricv4.model.AsnState; +import com.equinix.sdk.fabricv4.model.Changelog; +import com.equinix.sdk.fabricv4.model.Error; +import com.equinix.sdk.fabricv4.model.Project; +import com.equinix.sdk.fabricv4.model.SimplifiedLocation; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.UUID; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonDeserializationContext; +import com.google.gson.JsonDeserializer; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.reflect.TypeToken; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.Locale; + +import com.equinix.sdk.fabricv4.JSON; + +/** + * ASN Record + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") +public class Asn { + public static final String SERIALIZED_NAME_HREF = "href"; + @SerializedName(SERIALIZED_NAME_HREF) + @javax.annotation.Nullable + private String href; + + public static final String SERIALIZED_NAME_UUID = "uuid"; + @SerializedName(SERIALIZED_NAME_UUID) + @javax.annotation.Nullable + private UUID uuid; + + public static final String SERIALIZED_NAME_STATE = "state"; + @SerializedName(SERIALIZED_NAME_STATE) + @javax.annotation.Nullable + private AsnState state; + + public static final String SERIALIZED_NAME_PROJECT = "project"; + @SerializedName(SERIALIZED_NAME_PROJECT) + @javax.annotation.Nullable + private Project project; + + public static final String SERIALIZED_NAME_NUMBER = "number"; + @SerializedName(SERIALIZED_NAME_NUMBER) + @javax.annotation.Nullable + private Long number; + + public static final String SERIALIZED_NAME_RIR_REGION = "rirRegion"; + @SerializedName(SERIALIZED_NAME_RIR_REGION) + @javax.annotation.Nullable + private AsnRirRegion rirRegion; + + public static final String SERIALIZED_NAME_LOCATION = "location"; + @SerializedName(SERIALIZED_NAME_LOCATION) + @javax.annotation.Nullable + private SimplifiedLocation location; + + public static final String SERIALIZED_NAME_RANGE = "range"; + @SerializedName(SERIALIZED_NAME_RANGE) + @javax.annotation.Nullable + private AsnRange range; + + public static final String SERIALIZED_NAME_OWNERSHIP_CHALLENGE_DETAILS = "ownershipChallengeDetails"; + @SerializedName(SERIALIZED_NAME_OWNERSHIP_CHALLENGE_DETAILS) + @javax.annotation.Nullable + private AsnOwnershipChallengeDetails ownershipChallengeDetails; + + public static final String SERIALIZED_NAME_CHANGE = "change"; + @SerializedName(SERIALIZED_NAME_CHANGE) + @javax.annotation.Nullable + private AsnChange change; + + public static final String SERIALIZED_NAME_ASSETS = "assets"; + @SerializedName(SERIALIZED_NAME_ASSETS) + @javax.annotation.Nullable + private List assets = new ArrayList<>(); + + public static final String SERIALIZED_NAME_ERRORS = "errors"; + @SerializedName(SERIALIZED_NAME_ERRORS) + @javax.annotation.Nullable + private List errors = new ArrayList<>(); + + public static final String SERIALIZED_NAME_CHANGE_LOG = "changeLog"; + @SerializedName(SERIALIZED_NAME_CHANGE_LOG) + @javax.annotation.Nullable + private Changelog changeLog; + + public Asn() { + } + + public Asn href(@javax.annotation.Nullable String href) { + this.href = href; + return this; + } + + /** + * Get href + * @return href + */ + @javax.annotation.Nullable + public String getHref() { + return href; + } + + public void setHref(@javax.annotation.Nullable String href) { + this.href = href; + } + + + public Asn uuid(@javax.annotation.Nullable UUID uuid) { + this.uuid = uuid; + return this; + } + + /** + * Unique identifier for the ASN record + * @return uuid + */ + @javax.annotation.Nullable + public UUID getUuid() { + return uuid; + } + + public void setUuid(@javax.annotation.Nullable UUID uuid) { + this.uuid = uuid; + } + + + public Asn state(@javax.annotation.Nullable AsnState state) { + this.state = state; + return this; + } + + /** + * Get state + * @return state + */ + @javax.annotation.Nullable + public AsnState getState() { + return state; + } + + public void setState(@javax.annotation.Nullable AsnState state) { + this.state = state; + } + + + public Asn project(@javax.annotation.Nullable Project project) { + this.project = project; + return this; + } + + /** + * Get project + * @return project + */ + @javax.annotation.Nullable + public Project getProject() { + return project; + } + + public void setProject(@javax.annotation.Nullable Project project) { + this.project = project; + } + + + public Asn number(@javax.annotation.Nullable Long number) { + this.number = number; + return this; + } + + /** + * Autonomous System Number + * @return number + */ + @javax.annotation.Nullable + public Long getNumber() { + return number; + } + + public void setNumber(@javax.annotation.Nullable Long number) { + this.number = number; + } + + + public Asn rirRegion(@javax.annotation.Nullable AsnRirRegion rirRegion) { + this.rirRegion = rirRegion; + return this; + } + + /** + * Get rirRegion + * @return rirRegion + */ + @javax.annotation.Nullable + public AsnRirRegion getRirRegion() { + return rirRegion; + } + + public void setRirRegion(@javax.annotation.Nullable AsnRirRegion rirRegion) { + this.rirRegion = rirRegion; + } + + + public Asn location(@javax.annotation.Nullable SimplifiedLocation location) { + this.location = location; + return this; + } + + /** + * Get location + * @return location + */ + @javax.annotation.Nullable + public SimplifiedLocation getLocation() { + return location; + } + + public void setLocation(@javax.annotation.Nullable SimplifiedLocation location) { + this.location = location; + } + + + public Asn range(@javax.annotation.Nullable AsnRange range) { + this.range = range; + return this; + } + + /** + * Get range + * @return range + */ + @javax.annotation.Nullable + public AsnRange getRange() { + return range; + } + + public void setRange(@javax.annotation.Nullable AsnRange range) { + this.range = range; + } + + + public Asn ownershipChallengeDetails(@javax.annotation.Nullable AsnOwnershipChallengeDetails ownershipChallengeDetails) { + this.ownershipChallengeDetails = ownershipChallengeDetails; + return this; + } + + /** + * Get ownershipChallengeDetails + * @return ownershipChallengeDetails + */ + @javax.annotation.Nullable + public AsnOwnershipChallengeDetails getOwnershipChallengeDetails() { + return ownershipChallengeDetails; + } + + public void setOwnershipChallengeDetails(@javax.annotation.Nullable AsnOwnershipChallengeDetails ownershipChallengeDetails) { + this.ownershipChallengeDetails = ownershipChallengeDetails; + } + + + public Asn change(@javax.annotation.Nullable AsnChange change) { + this.change = change; + return this; + } + + /** + * Get change + * @return change + */ + @javax.annotation.Nullable + public AsnChange getChange() { + return change; + } + + public void setChange(@javax.annotation.Nullable AsnChange change) { + this.change = change; + } + + + public Asn assets(@javax.annotation.Nullable List assets) { + this.assets = assets; + return this; + } + + public Asn addAssetsItem(AsnAsset assetsItem) { + if (this.assets == null) { + this.assets = new ArrayList<>(); + } + this.assets.add(assetsItem); + return this; + } + + /** + * Get assets + * @return assets + */ + @javax.annotation.Nullable + public List getAssets() { + return assets; + } + + public void setAssets(@javax.annotation.Nullable List assets) { + this.assets = assets; + } + + + public Asn errors(@javax.annotation.Nullable List errors) { + this.errors = errors; + return this; + } + + public Asn addErrorsItem(Error errorsItem) { + if (this.errors == null) { + this.errors = new ArrayList<>(); + } + this.errors.add(errorsItem); + return this; + } + + /** + * List of errors + * @return errors + */ + @javax.annotation.Nullable + public List getErrors() { + return errors; + } + + public void setErrors(@javax.annotation.Nullable List errors) { + this.errors = errors; + } + + + public Asn changeLog(@javax.annotation.Nullable Changelog changeLog) { + this.changeLog = changeLog; + return this; + } + + /** + * Get changeLog + * @return changeLog + */ + @javax.annotation.Nullable + public Changelog getChangeLog() { + return changeLog; + } + + public void setChangeLog(@javax.annotation.Nullable Changelog changeLog) { + this.changeLog = changeLog; + } + + /** + * A container for additional, undeclared properties. + * This is a holder for any undeclared properties as specified with + * the 'additionalProperties' keyword in the OAS document. + */ + private Map additionalProperties; + + /** + * Set the additional (undeclared) property with the specified name and value. + * If the property does not already exist, create it otherwise replace it. + * + * @param key name of the property + * @param value value of the property + * @return the Asn instance itself + */ + public Asn putAdditionalProperty(String key, Object value) { + if (this.additionalProperties == null) { + this.additionalProperties = new HashMap(); + } + this.additionalProperties.put(key, value); + return this; + } + + /** + * Return the additional (undeclared) property. + * + * @return a map of objects + */ + public Map getAdditionalProperties() { + return additionalProperties; + } + + /** + * Return the additional (undeclared) property with the specified name. + * + * @param key name of the property + * @return an object + */ + public Object getAdditionalProperty(String key) { + if (this.additionalProperties == null) { + return null; + } + return this.additionalProperties.get(key); + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Asn asn = (Asn) o; + return Objects.equals(this.href, asn.href) && + Objects.equals(this.uuid, asn.uuid) && + Objects.equals(this.state, asn.state) && + Objects.equals(this.project, asn.project) && + Objects.equals(this.number, asn.number) && + Objects.equals(this.rirRegion, asn.rirRegion) && + Objects.equals(this.location, asn.location) && + Objects.equals(this.range, asn.range) && + Objects.equals(this.ownershipChallengeDetails, asn.ownershipChallengeDetails) && + Objects.equals(this.change, asn.change) && + Objects.equals(this.assets, asn.assets) && + Objects.equals(this.errors, asn.errors) && + Objects.equals(this.changeLog, asn.changeLog)&& + Objects.equals(this.additionalProperties, asn.additionalProperties); + } + + @Override + public int hashCode() { + return Objects.hash(href, uuid, state, project, number, rirRegion, location, range, ownershipChallengeDetails, change, assets, errors, changeLog, additionalProperties); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Asn {\n"); + sb.append(" href: ").append(toIndentedString(href)).append("\n"); + sb.append(" uuid: ").append(toIndentedString(uuid)).append("\n"); + sb.append(" state: ").append(toIndentedString(state)).append("\n"); + sb.append(" project: ").append(toIndentedString(project)).append("\n"); + sb.append(" number: ").append(toIndentedString(number)).append("\n"); + sb.append(" rirRegion: ").append(toIndentedString(rirRegion)).append("\n"); + sb.append(" location: ").append(toIndentedString(location)).append("\n"); + sb.append(" range: ").append(toIndentedString(range)).append("\n"); + sb.append(" ownershipChallengeDetails: ").append(toIndentedString(ownershipChallengeDetails)).append("\n"); + sb.append(" change: ").append(toIndentedString(change)).append("\n"); + sb.append(" assets: ").append(toIndentedString(assets)).append("\n"); + sb.append(" errors: ").append(toIndentedString(errors)).append("\n"); + sb.append(" changeLog: ").append(toIndentedString(changeLog)).append("\n"); + sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + + public static HashSet openapiFields; + public static HashSet openapiRequiredFields; + + static { + // a set of all properties/fields (JSON key names) + openapiFields = new HashSet(Arrays.asList("href", "uuid", "state", "project", "number", "rirRegion", "location", "range", "ownershipChallengeDetails", "change", "assets", "errors", "changeLog")); + + // a set of required properties/fields (JSON key names) + openapiRequiredFields = new HashSet(0); + } + + /** + * Validates the JSON Element and throws an exception if issues found + * + * @param jsonElement JSON Element + * @throws IOException if the JSON Element is invalid with respect to Asn + */ + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + if (jsonElement == null) { + if (!Asn.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in Asn is not found in the empty JSON string", Asn.openapiRequiredFields.toString())); + } + } + JsonObject jsonObj = jsonElement.getAsJsonObject(); + if ((jsonObj.get("href") != null && !jsonObj.get("href").isJsonNull()) && !jsonObj.get("href").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `href` to be a primitive type in the JSON string but got `%s`", jsonObj.get("href").toString())); + } + if ((jsonObj.get("uuid") != null && !jsonObj.get("uuid").isJsonNull()) && !jsonObj.get("uuid").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `uuid` to be a primitive type in the JSON string but got `%s`", jsonObj.get("uuid").toString())); + } + // validate the optional field `state` + if (jsonObj.get("state") != null && !jsonObj.get("state").isJsonNull()) { + AsnState.validateJsonElement(jsonObj.get("state")); + } + // validate the optional field `project` + if (jsonObj.get("project") != null && !jsonObj.get("project").isJsonNull()) { + Project.validateJsonElement(jsonObj.get("project")); + } + // validate the optional field `rirRegion` + if (jsonObj.get("rirRegion") != null && !jsonObj.get("rirRegion").isJsonNull()) { + AsnRirRegion.validateJsonElement(jsonObj.get("rirRegion")); + } + // validate the optional field `location` + if (jsonObj.get("location") != null && !jsonObj.get("location").isJsonNull()) { + SimplifiedLocation.validateJsonElement(jsonObj.get("location")); + } + // validate the optional field `range` + if (jsonObj.get("range") != null && !jsonObj.get("range").isJsonNull()) { + AsnRange.validateJsonElement(jsonObj.get("range")); + } + // validate the optional field `ownershipChallengeDetails` + if (jsonObj.get("ownershipChallengeDetails") != null && !jsonObj.get("ownershipChallengeDetails").isJsonNull()) { + AsnOwnershipChallengeDetails.validateJsonElement(jsonObj.get("ownershipChallengeDetails")); + } + // validate the optional field `change` + if (jsonObj.get("change") != null && !jsonObj.get("change").isJsonNull()) { + AsnChange.validateJsonElement(jsonObj.get("change")); + } + if (jsonObj.get("assets") != null && !jsonObj.get("assets").isJsonNull()) { + JsonArray jsonArrayassets = jsonObj.getAsJsonArray("assets"); + if (jsonArrayassets != null) { + // ensure the json data is an array + if (!jsonObj.get("assets").isJsonArray()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `assets` to be an array in the JSON string but got `%s`", jsonObj.get("assets").toString())); + } + + // validate the optional field `assets` (array) + for (int i = 0; i < jsonArrayassets.size(); i++) { + AsnAsset.validateJsonElement(jsonArrayassets.get(i)); + }; + } + } + if (jsonObj.get("errors") != null && !jsonObj.get("errors").isJsonNull()) { + JsonArray jsonArrayerrors = jsonObj.getAsJsonArray("errors"); + if (jsonArrayerrors != null) { + // ensure the json data is an array + if (!jsonObj.get("errors").isJsonArray()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `errors` to be an array in the JSON string but got `%s`", jsonObj.get("errors").toString())); + } + + // validate the optional field `errors` (array) + for (int i = 0; i < jsonArrayerrors.size(); i++) { + Error.validateJsonElement(jsonArrayerrors.get(i)); + }; + } + } + // validate the optional field `changeLog` + if (jsonObj.get("changeLog") != null && !jsonObj.get("changeLog").isJsonNull()) { + Changelog.validateJsonElement(jsonObj.get("changeLog")); + } + } + + public static class CustomTypeAdapterFactory implements TypeAdapterFactory { + @SuppressWarnings("unchecked") + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + if (!Asn.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'Asn' and its subtypes + } + final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(Asn.class)); + + return (TypeAdapter) new TypeAdapter() { + @Override + public void write(JsonWriter out, Asn value) throws IOException { + JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); + obj.remove("additionalProperties"); + // serialize additional properties + if (value.getAdditionalProperties() != null) { + for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { + if (entry.getValue() instanceof String) + obj.addProperty(entry.getKey(), (String) entry.getValue()); + else if (entry.getValue() instanceof Number) + obj.addProperty(entry.getKey(), (Number) entry.getValue()); + else if (entry.getValue() instanceof Boolean) + obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); + else if (entry.getValue() instanceof Character) + obj.addProperty(entry.getKey(), (Character) entry.getValue()); + else { + JsonElement jsonElement = gson.toJsonTree(entry.getValue()); + if (jsonElement.isJsonArray()) { + obj.add(entry.getKey(), jsonElement.getAsJsonArray()); + } else { + obj.add(entry.getKey(), jsonElement.getAsJsonObject()); + } + } + } + } + elementAdapter.write(out, obj); + } + + @Override + public Asn read(JsonReader in) throws IOException { + JsonElement jsonElement = elementAdapter.read(in); + validateJsonElement(jsonElement); + JsonObject jsonObj = jsonElement.getAsJsonObject(); + // store additional fields in the deserialized instance + Asn instance = thisAdapter.fromJsonTree(jsonObj); + for (Map.Entry entry : jsonObj.entrySet()) { + if (!openapiFields.contains(entry.getKey())) { + if (entry.getValue().isJsonPrimitive()) { // primitive type + if (entry.getValue().getAsJsonPrimitive().isString()) + instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); + else if (entry.getValue().getAsJsonPrimitive().isNumber()) + instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); + else if (entry.getValue().getAsJsonPrimitive().isBoolean()) + instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); + else + throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); + } else if (entry.getValue().isJsonArray()) { + instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); + } else { // JSON object + instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); + } + } + } + return instance; + } + + }.nullSafe(); + } + } + + /** + * Create an instance of Asn given an JSON string + * + * @param jsonString JSON string + * @return An instance of Asn + * @throws IOException if the JSON string is invalid with respect to Asn + */ + public static Asn fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, Asn.class); + } + + /** + * Convert an instance of Asn to an JSON string + * + * @return JSON string + */ + public String toJson() { + return JSON.getGson().toJson(this); + } +} + diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/VpicInterface.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnAsset.java similarity index 56% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/VpicInterface.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnAsset.java index 67f35d21..31398585 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/VpicInterface.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnAsset.java @@ -13,15 +13,18 @@ import java.util.Objects; import java.util.Locale; +import com.equinix.sdk.fabricv4.model.AsnAssetIpBlockRef; +import com.equinix.sdk.fabricv4.model.AsnAssetService; +import com.equinix.sdk.fabricv4.model.Changelog; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; import java.io.IOException; -import java.net.URI; +import java.util.ArrayList; import java.util.Arrays; -import java.util.UUID; +import java.util.List; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -48,57 +51,138 @@ import com.equinix.sdk.fabricv4.JSON; /** - * MCN VPIC Interface Information + * Asset associated with ASN */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class VpicInterface { - public static final String SERIALIZED_NAME_HREF = "href"; - @SerializedName(SERIALIZED_NAME_HREF) - @javax.annotation.Nullable - private URI href; - +public class AsnAsset { public static final String SERIALIZED_NAME_UUID = "uuid"; @SerializedName(SERIALIZED_NAME_UUID) @javax.annotation.Nullable - private UUID uuid; + private String uuid; + + public static final String SERIALIZED_NAME_SERVICE = "service"; + @SerializedName(SERIALIZED_NAME_SERVICE) + @javax.annotation.Nullable + private AsnAssetService service; + + public static final String SERIALIZED_NAME_ANNOUNCING_METRO = "announcingMetro"; + @SerializedName(SERIALIZED_NAME_ANNOUNCING_METRO) + @javax.annotation.Nullable + private String announcingMetro; + + public static final String SERIALIZED_NAME_IP_BLOCKS = "ipBlocks"; + @SerializedName(SERIALIZED_NAME_IP_BLOCKS) + @javax.annotation.Nullable + private List ipBlocks = new ArrayList<>(); + + public static final String SERIALIZED_NAME_CHANGE_LOG = "changeLog"; + @SerializedName(SERIALIZED_NAME_CHANGE_LOG) + @javax.annotation.Nullable + private Changelog changeLog; + + public AsnAsset() { + } + + public AsnAsset uuid(@javax.annotation.Nullable String uuid) { + this.uuid = uuid; + return this; + } + + /** + * Get uuid + * @return uuid + */ + @javax.annotation.Nullable + public String getUuid() { + return uuid; + } - public VpicInterface() { + public void setUuid(@javax.annotation.Nullable String uuid) { + this.uuid = uuid; } - public VpicInterface( - URI href - ) { - this(); - this.href = href; + + public AsnAsset service(@javax.annotation.Nullable AsnAssetService service) { + this.service = service; + return this; } /** - * The Canonical URL at which the resource resides. - * @return href + * Get service + * @return service */ @javax.annotation.Nullable - public URI getHref() { - return href; + public AsnAssetService getService() { + return service; } + public void setService(@javax.annotation.Nullable AsnAssetService service) { + this.service = service; + } - public VpicInterface uuid(@javax.annotation.Nullable UUID uuid) { - this.uuid = uuid; + public AsnAsset announcingMetro(@javax.annotation.Nullable String announcingMetro) { + this.announcingMetro = announcingMetro; return this; } /** - * MCN assigned VPIC Interface Identifier - * @return uuid + * Get announcingMetro + * @return announcingMetro */ @javax.annotation.Nullable - public UUID getUuid() { - return uuid; + public String getAnnouncingMetro() { + return announcingMetro; } - public void setUuid(@javax.annotation.Nullable UUID uuid) { - this.uuid = uuid; + public void setAnnouncingMetro(@javax.annotation.Nullable String announcingMetro) { + this.announcingMetro = announcingMetro; + } + + + public AsnAsset ipBlocks(@javax.annotation.Nullable List ipBlocks) { + this.ipBlocks = ipBlocks; + return this; + } + + public AsnAsset addIpBlocksItem(AsnAssetIpBlockRef ipBlocksItem) { + if (this.ipBlocks == null) { + this.ipBlocks = new ArrayList<>(); + } + this.ipBlocks.add(ipBlocksItem); + return this; + } + + /** + * Get ipBlocks + * @return ipBlocks + */ + @javax.annotation.Nullable + public List getIpBlocks() { + return ipBlocks; + } + + public void setIpBlocks(@javax.annotation.Nullable List ipBlocks) { + this.ipBlocks = ipBlocks; + } + + + public AsnAsset changeLog(@javax.annotation.Nullable Changelog changeLog) { + this.changeLog = changeLog; + return this; + } + + /** + * Get changeLog + * @return changeLog + */ + @javax.annotation.Nullable + public Changelog getChangeLog() { + return changeLog; + } + + public void setChangeLog(@javax.annotation.Nullable Changelog changeLog) { + this.changeLog = changeLog; } /** @@ -114,9 +198,9 @@ public void setUuid(@javax.annotation.Nullable UUID uuid) { * * @param key name of the property * @param value value of the property - * @return the VpicInterface instance itself + * @return the AsnAsset instance itself */ - public VpicInterface putAdditionalProperty(String key, Object value) { + public AsnAsset putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -155,23 +239,29 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - VpicInterface vpicInterface = (VpicInterface) o; - return Objects.equals(this.href, vpicInterface.href) && - Objects.equals(this.uuid, vpicInterface.uuid)&& - Objects.equals(this.additionalProperties, vpicInterface.additionalProperties); + AsnAsset asnAsset = (AsnAsset) o; + return Objects.equals(this.uuid, asnAsset.uuid) && + Objects.equals(this.service, asnAsset.service) && + Objects.equals(this.announcingMetro, asnAsset.announcingMetro) && + Objects.equals(this.ipBlocks, asnAsset.ipBlocks) && + Objects.equals(this.changeLog, asnAsset.changeLog)&& + Objects.equals(this.additionalProperties, asnAsset.additionalProperties); } @Override public int hashCode() { - return Objects.hash(href, uuid, additionalProperties); + return Objects.hash(uuid, service, announcingMetro, ipBlocks, changeLog, additionalProperties); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class VpicInterface {\n"); - sb.append(" href: ").append(toIndentedString(href)).append("\n"); + sb.append("class AsnAsset {\n"); sb.append(" uuid: ").append(toIndentedString(uuid)).append("\n"); + sb.append(" service: ").append(toIndentedString(service)).append("\n"); + sb.append(" announcingMetro: ").append(toIndentedString(announcingMetro)).append("\n"); + sb.append(" ipBlocks: ").append(toIndentedString(ipBlocks)).append("\n"); + sb.append(" changeLog: ").append(toIndentedString(changeLog)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -194,7 +284,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("href", "uuid")); + openapiFields = new HashSet(Arrays.asList("uuid", "service", "announcingMetro", "ipBlocks", "changeLog")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(0); @@ -204,37 +294,59 @@ private String toIndentedString(Object o) { * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to VpicInterface + * @throws IOException if the JSON Element is invalid with respect to AsnAsset */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!VpicInterface.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in VpicInterface is not found in the empty JSON string", VpicInterface.openapiRequiredFields.toString())); + if (!AsnAsset.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in AsnAsset is not found in the empty JSON string", AsnAsset.openapiRequiredFields.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); - if ((jsonObj.get("href") != null && !jsonObj.get("href").isJsonNull()) && !jsonObj.get("href").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `href` to be a primitive type in the JSON string but got `%s`", jsonObj.get("href").toString())); - } if ((jsonObj.get("uuid") != null && !jsonObj.get("uuid").isJsonNull()) && !jsonObj.get("uuid").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `uuid` to be a primitive type in the JSON string but got `%s`", jsonObj.get("uuid").toString())); } + // validate the optional field `service` + if (jsonObj.get("service") != null && !jsonObj.get("service").isJsonNull()) { + AsnAssetService.validateJsonElement(jsonObj.get("service")); + } + if ((jsonObj.get("announcingMetro") != null && !jsonObj.get("announcingMetro").isJsonNull()) && !jsonObj.get("announcingMetro").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `announcingMetro` to be a primitive type in the JSON string but got `%s`", jsonObj.get("announcingMetro").toString())); + } + if (jsonObj.get("ipBlocks") != null && !jsonObj.get("ipBlocks").isJsonNull()) { + JsonArray jsonArrayipBlocks = jsonObj.getAsJsonArray("ipBlocks"); + if (jsonArrayipBlocks != null) { + // ensure the json data is an array + if (!jsonObj.get("ipBlocks").isJsonArray()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `ipBlocks` to be an array in the JSON string but got `%s`", jsonObj.get("ipBlocks").toString())); + } + + // validate the optional field `ipBlocks` (array) + for (int i = 0; i < jsonArrayipBlocks.size(); i++) { + AsnAssetIpBlockRef.validateJsonElement(jsonArrayipBlocks.get(i)); + }; + } + } + // validate the optional field `changeLog` + if (jsonObj.get("changeLog") != null && !jsonObj.get("changeLog").isJsonNull()) { + Changelog.validateJsonElement(jsonObj.get("changeLog")); + } } public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!VpicInterface.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'VpicInterface' and its subtypes + if (!AsnAsset.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'AsnAsset' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(VpicInterface.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(AsnAsset.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, VpicInterface value) throws IOException { + public void write(JsonWriter out, AsnAsset value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -262,12 +374,12 @@ else if (entry.getValue() instanceof Character) } @Override - public VpicInterface read(JsonReader in) throws IOException { + public AsnAsset read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - VpicInterface instance = thisAdapter.fromJsonTree(jsonObj); + AsnAsset instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -294,18 +406,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of VpicInterface given an JSON string + * Create an instance of AsnAsset given an JSON string * * @param jsonString JSON string - * @return An instance of VpicInterface - * @throws IOException if the JSON string is invalid with respect to VpicInterface + * @return An instance of AsnAsset + * @throws IOException if the JSON string is invalid with respect to AsnAsset */ - public static VpicInterface fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, VpicInterface.class); + public static AsnAsset fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, AsnAsset.class); } /** - * Convert an instance of VpicInterface to an JSON string + * Convert an instance of AsnAsset to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfileLastMileContactInfoItem.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnAssetIpBlockRef.java similarity index 68% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfileLastMileContactInfoItem.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnAssetIpBlockRef.java index 5333a41d..8cd339de 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfileLastMileContactInfoItem.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnAssetIpBlockRef.java @@ -19,9 +19,7 @@ import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; import java.io.IOException; -import java.util.ArrayList; import java.util.Arrays; -import java.util.List; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -48,20 +46,23 @@ import com.equinix.sdk.fabricv4.JSON; /** - * Last-mile provider contact information item. + * AsnAssetIpBlockRef */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class ServiceProfileLastMileContactInfoItem { +public class AsnAssetIpBlockRef { + public static final String SERIALIZED_NAME_HREF = "href"; + @SerializedName(SERIALIZED_NAME_HREF) + @javax.annotation.Nullable + private String href; + /** - * Contact type. + * Gets or Sets type */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { - SUPPORT_URL("SUPPORT_URL"), + IPV4_IP_BLOCK("IPV4_IP_BLOCK"), - DOCUMENTATION_URL("DOCUMENTATION_URL"), - - SUPPORT_EMAIL("SUPPORT_EMAIL"); + IPV6_IP_BLOCK("IPV6_IP_BLOCK"); private String value; @@ -111,81 +112,68 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @javax.annotation.Nullable private TypeEnum type; - public static final String SERIALIZED_NAME_URL = "url"; - @SerializedName(SERIALIZED_NAME_URL) - @javax.annotation.Nullable - private String url; - - public static final String SERIALIZED_NAME_EMAILS = "emails"; - @SerializedName(SERIALIZED_NAME_EMAILS) + public static final String SERIALIZED_NAME_UUID = "uuid"; + @SerializedName(SERIALIZED_NAME_UUID) @javax.annotation.Nullable - private List emails = new ArrayList<>(); + private String uuid; - public ServiceProfileLastMileContactInfoItem() { + public AsnAssetIpBlockRef() { } - public ServiceProfileLastMileContactInfoItem type(@javax.annotation.Nullable TypeEnum type) { - this.type = type; + public AsnAssetIpBlockRef href(@javax.annotation.Nullable String href) { + this.href = href; return this; } /** - * Contact type. - * @return type + * Get href + * @return href */ @javax.annotation.Nullable - public TypeEnum getType() { - return type; + public String getHref() { + return href; } - public void setType(@javax.annotation.Nullable TypeEnum type) { - this.type = type; + public void setHref(@javax.annotation.Nullable String href) { + this.href = href; } - public ServiceProfileLastMileContactInfoItem url(@javax.annotation.Nullable String url) { - this.url = url; + public AsnAssetIpBlockRef type(@javax.annotation.Nullable TypeEnum type) { + this.type = type; return this; } /** - * Contact URL. - * @return url + * Get type + * @return type */ @javax.annotation.Nullable - public String getUrl() { - return url; + public TypeEnum getType() { + return type; } - public void setUrl(@javax.annotation.Nullable String url) { - this.url = url; + public void setType(@javax.annotation.Nullable TypeEnum type) { + this.type = type; } - public ServiceProfileLastMileContactInfoItem emails(@javax.annotation.Nullable List emails) { - this.emails = emails; - return this; - } - - public ServiceProfileLastMileContactInfoItem addEmailsItem(String emailsItem) { - if (this.emails == null) { - this.emails = new ArrayList<>(); - } - this.emails.add(emailsItem); + public AsnAssetIpBlockRef uuid(@javax.annotation.Nullable String uuid) { + this.uuid = uuid; return this; } /** - * List of contact emails. - * @return emails + * Get uuid + * @return uuid */ @javax.annotation.Nullable - public List getEmails() { - return emails; + public String getUuid() { + return uuid; } - public void setEmails(@javax.annotation.Nullable List emails) { - this.emails = emails; + public void setUuid(@javax.annotation.Nullable String uuid) { + this.uuid = uuid; } /** @@ -201,9 +189,9 @@ public void setEmails(@javax.annotation.Nullable List emails) { * * @param key name of the property * @param value value of the property - * @return the ServiceProfileLastMileContactInfoItem instance itself + * @return the AsnAssetIpBlockRef instance itself */ - public ServiceProfileLastMileContactInfoItem putAdditionalProperty(String key, Object value) { + public AsnAssetIpBlockRef putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -242,25 +230,25 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - ServiceProfileLastMileContactInfoItem serviceProfileLastMileContactInfoItem = (ServiceProfileLastMileContactInfoItem) o; - return Objects.equals(this.type, serviceProfileLastMileContactInfoItem.type) && - Objects.equals(this.url, serviceProfileLastMileContactInfoItem.url) && - Objects.equals(this.emails, serviceProfileLastMileContactInfoItem.emails)&& - Objects.equals(this.additionalProperties, serviceProfileLastMileContactInfoItem.additionalProperties); + AsnAssetIpBlockRef asnAssetIpBlockRef = (AsnAssetIpBlockRef) o; + return Objects.equals(this.href, asnAssetIpBlockRef.href) && + Objects.equals(this.type, asnAssetIpBlockRef.type) && + Objects.equals(this.uuid, asnAssetIpBlockRef.uuid)&& + Objects.equals(this.additionalProperties, asnAssetIpBlockRef.additionalProperties); } @Override public int hashCode() { - return Objects.hash(type, url, emails, additionalProperties); + return Objects.hash(href, type, uuid, additionalProperties); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class ServiceProfileLastMileContactInfoItem {\n"); + sb.append("class AsnAssetIpBlockRef {\n"); + sb.append(" href: ").append(toIndentedString(href)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); - sb.append(" url: ").append(toIndentedString(url)).append("\n"); - sb.append(" emails: ").append(toIndentedString(emails)).append("\n"); + sb.append(" uuid: ").append(toIndentedString(uuid)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -283,7 +271,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("type", "url", "emails")); + openapiFields = new HashSet(Arrays.asList("href", "type", "uuid")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(0); @@ -293,15 +281,18 @@ private String toIndentedString(Object o) { * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to ServiceProfileLastMileContactInfoItem + * @throws IOException if the JSON Element is invalid with respect to AsnAssetIpBlockRef */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!ServiceProfileLastMileContactInfoItem.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in ServiceProfileLastMileContactInfoItem is not found in the empty JSON string", ServiceProfileLastMileContactInfoItem.openapiRequiredFields.toString())); + if (!AsnAssetIpBlockRef.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in AsnAssetIpBlockRef is not found in the empty JSON string", AsnAssetIpBlockRef.openapiRequiredFields.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); + if ((jsonObj.get("href") != null && !jsonObj.get("href").isJsonNull()) && !jsonObj.get("href").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `href` to be a primitive type in the JSON string but got `%s`", jsonObj.get("href").toString())); + } if ((jsonObj.get("type") != null && !jsonObj.get("type").isJsonNull()) && !jsonObj.get("type").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `type` to be a primitive type in the JSON string but got `%s`", jsonObj.get("type").toString())); } @@ -309,12 +300,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if (jsonObj.get("type") != null && !jsonObj.get("type").isJsonNull()) { TypeEnum.validateJsonElement(jsonObj.get("type")); } - if ((jsonObj.get("url") != null && !jsonObj.get("url").isJsonNull()) && !jsonObj.get("url").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `url` to be a primitive type in the JSON string but got `%s`", jsonObj.get("url").toString())); - } - // ensure the optional json data is an array if present - if (jsonObj.get("emails") != null && !jsonObj.get("emails").isJsonNull() && !jsonObj.get("emails").isJsonArray()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `emails` to be an array in the JSON string but got `%s`", jsonObj.get("emails").toString())); + if ((jsonObj.get("uuid") != null && !jsonObj.get("uuid").isJsonNull()) && !jsonObj.get("uuid").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `uuid` to be a primitive type in the JSON string but got `%s`", jsonObj.get("uuid").toString())); } } @@ -322,16 +309,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!ServiceProfileLastMileContactInfoItem.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'ServiceProfileLastMileContactInfoItem' and its subtypes + if (!AsnAssetIpBlockRef.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'AsnAssetIpBlockRef' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(ServiceProfileLastMileContactInfoItem.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(AsnAssetIpBlockRef.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, ServiceProfileLastMileContactInfoItem value) throws IOException { + public void write(JsonWriter out, AsnAssetIpBlockRef value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -359,12 +346,12 @@ else if (entry.getValue() instanceof Character) } @Override - public ServiceProfileLastMileContactInfoItem read(JsonReader in) throws IOException { + public AsnAssetIpBlockRef read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - ServiceProfileLastMileContactInfoItem instance = thisAdapter.fromJsonTree(jsonObj); + AsnAssetIpBlockRef instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -391,18 +378,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of ServiceProfileLastMileContactInfoItem given an JSON string + * Create an instance of AsnAssetIpBlockRef given an JSON string * * @param jsonString JSON string - * @return An instance of ServiceProfileLastMileContactInfoItem - * @throws IOException if the JSON string is invalid with respect to ServiceProfileLastMileContactInfoItem + * @return An instance of AsnAssetIpBlockRef + * @throws IOException if the JSON string is invalid with respect to AsnAssetIpBlockRef */ - public static ServiceProfileLastMileContactInfoItem fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, ServiceProfileLastMileContactInfoItem.class); + public static AsnAssetIpBlockRef fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, AsnAssetIpBlockRef.class); } /** - * Convert an instance of ServiceProfileLastMileContactInfoItem to an JSON string + * Convert an instance of AsnAssetIpBlockRef to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Router.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnAssetService.java similarity index 82% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Router.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnAssetService.java index 0d5dc096..9d33df43 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Router.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnAssetService.java @@ -19,9 +19,7 @@ import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; import java.io.IOException; -import java.net.URI; import java.util.Arrays; -import java.util.UUID; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -48,26 +46,21 @@ import com.equinix.sdk.fabricv4.JSON; /** - * Router + * Associated Internet Access Service reference */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class Router { +public class AsnAssetService { public static final String SERIALIZED_NAME_HREF = "href"; @SerializedName(SERIALIZED_NAME_HREF) @javax.annotation.Nullable - private URI href; - - public static final String SERIALIZED_NAME_UUID = "uuid"; - @SerializedName(SERIALIZED_NAME_UUID) - @javax.annotation.Nullable - private UUID uuid; + private String href; /** * Gets or Sets type */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { - XF_ROUTER("XF_ROUTER"); + IA("IA"); private String value; @@ -117,62 +110,68 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @javax.annotation.Nullable private TypeEnum type; - public Router() { + public static final String SERIALIZED_NAME_UUID = "uuid"; + @SerializedName(SERIALIZED_NAME_UUID) + @javax.annotation.Nullable + private String uuid; + + public AsnAssetService() { } - public Router( - URI href - ) { - this(); + public AsnAssetService href(@javax.annotation.Nullable String href) { this.href = href; + return this; } /** - * Fabric Cloud Router URI + * Get href * @return href */ @javax.annotation.Nullable - public URI getHref() { + public String getHref() { return href; } + public void setHref(@javax.annotation.Nullable String href) { + this.href = href; + } - public Router uuid(@javax.annotation.Nullable UUID uuid) { - this.uuid = uuid; + public AsnAssetService type(@javax.annotation.Nullable TypeEnum type) { + this.type = type; return this; } /** - * Cloud Router UUID - * @return uuid + * Get type + * @return type */ @javax.annotation.Nullable - public UUID getUuid() { - return uuid; + public TypeEnum getType() { + return type; } - public void setUuid(@javax.annotation.Nullable UUID uuid) { - this.uuid = uuid; + public void setType(@javax.annotation.Nullable TypeEnum type) { + this.type = type; } - public Router type(@javax.annotation.Nullable TypeEnum type) { - this.type = type; + public AsnAssetService uuid(@javax.annotation.Nullable String uuid) { + this.uuid = uuid; return this; } /** - * Get type - * @return type + * Get uuid + * @return uuid */ @javax.annotation.Nullable - public TypeEnum getType() { - return type; + public String getUuid() { + return uuid; } - public void setType(@javax.annotation.Nullable TypeEnum type) { - this.type = type; + public void setUuid(@javax.annotation.Nullable String uuid) { + this.uuid = uuid; } /** @@ -188,9 +187,9 @@ public void setType(@javax.annotation.Nullable TypeEnum type) { * * @param key name of the property * @param value value of the property - * @return the Router instance itself + * @return the AsnAssetService instance itself */ - public Router putAdditionalProperty(String key, Object value) { + public AsnAssetService putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -229,25 +228,25 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Router router = (Router) o; - return Objects.equals(this.href, router.href) && - Objects.equals(this.uuid, router.uuid) && - Objects.equals(this.type, router.type)&& - Objects.equals(this.additionalProperties, router.additionalProperties); + AsnAssetService asnAssetService = (AsnAssetService) o; + return Objects.equals(this.href, asnAssetService.href) && + Objects.equals(this.type, asnAssetService.type) && + Objects.equals(this.uuid, asnAssetService.uuid)&& + Objects.equals(this.additionalProperties, asnAssetService.additionalProperties); } @Override public int hashCode() { - return Objects.hash(href, uuid, type, additionalProperties); + return Objects.hash(href, type, uuid, additionalProperties); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Router {\n"); + sb.append("class AsnAssetService {\n"); sb.append(" href: ").append(toIndentedString(href)).append("\n"); - sb.append(" uuid: ").append(toIndentedString(uuid)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" uuid: ").append(toIndentedString(uuid)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -270,7 +269,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("href", "uuid", "type")); + openapiFields = new HashSet(Arrays.asList("href", "type", "uuid")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(0); @@ -280,21 +279,18 @@ private String toIndentedString(Object o) { * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to Router + * @throws IOException if the JSON Element is invalid with respect to AsnAssetService */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!Router.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in Router is not found in the empty JSON string", Router.openapiRequiredFields.toString())); + if (!AsnAssetService.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in AsnAssetService is not found in the empty JSON string", AsnAssetService.openapiRequiredFields.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); if ((jsonObj.get("href") != null && !jsonObj.get("href").isJsonNull()) && !jsonObj.get("href").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `href` to be a primitive type in the JSON string but got `%s`", jsonObj.get("href").toString())); } - if ((jsonObj.get("uuid") != null && !jsonObj.get("uuid").isJsonNull()) && !jsonObj.get("uuid").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `uuid` to be a primitive type in the JSON string but got `%s`", jsonObj.get("uuid").toString())); - } if ((jsonObj.get("type") != null && !jsonObj.get("type").isJsonNull()) && !jsonObj.get("type").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `type` to be a primitive type in the JSON string but got `%s`", jsonObj.get("type").toString())); } @@ -302,22 +298,25 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if (jsonObj.get("type") != null && !jsonObj.get("type").isJsonNull()) { TypeEnum.validateJsonElement(jsonObj.get("type")); } + if ((jsonObj.get("uuid") != null && !jsonObj.get("uuid").isJsonNull()) && !jsonObj.get("uuid").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `uuid` to be a primitive type in the JSON string but got `%s`", jsonObj.get("uuid").toString())); + } } public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!Router.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'Router' and its subtypes + if (!AsnAssetService.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'AsnAssetService' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(Router.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(AsnAssetService.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, Router value) throws IOException { + public void write(JsonWriter out, AsnAssetService value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -345,12 +344,12 @@ else if (entry.getValue() instanceof Character) } @Override - public Router read(JsonReader in) throws IOException { + public AsnAssetService read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - Router instance = thisAdapter.fromJsonTree(jsonObj); + AsnAssetService instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -377,18 +376,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of Router given an JSON string + * Create an instance of AsnAssetService given an JSON string * * @param jsonString JSON string - * @return An instance of Router - * @throws IOException if the JSON string is invalid with respect to Router + * @return An instance of AsnAssetService + * @throws IOException if the JSON string is invalid with respect to AsnAssetService */ - public static Router fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, Router.class); + public static AsnAssetService fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, AsnAssetService.class); } /** - * Convert an instance of Router to an JSON string + * Convert an instance of AsnAssetService to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccess.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnChange.java similarity index 76% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccess.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnChange.java index 1104e0eb..b6b2e656 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccess.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnChange.java @@ -20,7 +20,6 @@ import com.google.gson.stream.JsonWriter; import java.io.IOException; import java.util.Arrays; -import java.util.UUID; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -47,34 +46,34 @@ import com.equinix.sdk.fabricv4.JSON; /** - * Internet Access Details + * Change reference for ASN */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class InternetAccess { - public static final String SERIALIZED_NAME_UUID = "uuid"; - @SerializedName(SERIALIZED_NAME_UUID) +public class AsnChange { + public static final String SERIALIZED_NAME_HREF = "href"; + @SerializedName(SERIALIZED_NAME_HREF) @javax.annotation.Nullable - private UUID uuid; + private String href; - public InternetAccess() { + public AsnChange() { } - public InternetAccess uuid(@javax.annotation.Nullable UUID uuid) { - this.uuid = uuid; + public AsnChange href(@javax.annotation.Nullable String href) { + this.href = href; return this; } /** - * Internet Access Service Identifier - * @return uuid + * URL path to the change event + * @return href */ @javax.annotation.Nullable - public UUID getUuid() { - return uuid; + public String getHref() { + return href; } - public void setUuid(@javax.annotation.Nullable UUID uuid) { - this.uuid = uuid; + public void setHref(@javax.annotation.Nullable String href) { + this.href = href; } /** @@ -90,9 +89,9 @@ public void setUuid(@javax.annotation.Nullable UUID uuid) { * * @param key name of the property * @param value value of the property - * @return the InternetAccess instance itself + * @return the AsnChange instance itself */ - public InternetAccess putAdditionalProperty(String key, Object value) { + public AsnChange putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -131,21 +130,21 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - InternetAccess internetAccess = (InternetAccess) o; - return Objects.equals(this.uuid, internetAccess.uuid)&& - Objects.equals(this.additionalProperties, internetAccess.additionalProperties); + AsnChange asnChange = (AsnChange) o; + return Objects.equals(this.href, asnChange.href)&& + Objects.equals(this.additionalProperties, asnChange.additionalProperties); } @Override public int hashCode() { - return Objects.hash(uuid, additionalProperties); + return Objects.hash(href, additionalProperties); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class InternetAccess {\n"); - sb.append(" uuid: ").append(toIndentedString(uuid)).append("\n"); + sb.append("class AsnChange {\n"); + sb.append(" href: ").append(toIndentedString(href)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -168,7 +167,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("uuid")); + openapiFields = new HashSet(Arrays.asList("href")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(0); @@ -178,17 +177,17 @@ private String toIndentedString(Object o) { * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to InternetAccess + * @throws IOException if the JSON Element is invalid with respect to AsnChange */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!InternetAccess.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in InternetAccess is not found in the empty JSON string", InternetAccess.openapiRequiredFields.toString())); + if (!AsnChange.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in AsnChange is not found in the empty JSON string", AsnChange.openapiRequiredFields.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); - if ((jsonObj.get("uuid") != null && !jsonObj.get("uuid").isJsonNull()) && !jsonObj.get("uuid").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `uuid` to be a primitive type in the JSON string but got `%s`", jsonObj.get("uuid").toString())); + if ((jsonObj.get("href") != null && !jsonObj.get("href").isJsonNull()) && !jsonObj.get("href").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `href` to be a primitive type in the JSON string but got `%s`", jsonObj.get("href").toString())); } } @@ -196,16 +195,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!InternetAccess.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'InternetAccess' and its subtypes + if (!AsnChange.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'AsnChange' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(InternetAccess.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(AsnChange.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, InternetAccess value) throws IOException { + public void write(JsonWriter out, AsnChange value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -233,12 +232,12 @@ else if (entry.getValue() instanceof Character) } @Override - public InternetAccess read(JsonReader in) throws IOException { + public AsnChange read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - InternetAccess instance = thisAdapter.fromJsonTree(jsonObj); + AsnChange instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -265,18 +264,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of InternetAccess given an JSON string + * Create an instance of AsnChange given an JSON string * * @param jsonString JSON string - * @return An instance of InternetAccess - * @throws IOException if the JSON string is invalid with respect to InternetAccess + * @return An instance of AsnChange + * @throws IOException if the JSON string is invalid with respect to AsnChange */ - public static InternetAccess fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, InternetAccess.class); + public static AsnChange fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, AsnChange.class); } /** - * Convert an instance of InternetAccess to an JSON string + * Convert an instance of AsnChange to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ResponseIncompleteDetails.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnPatchOperation.java similarity index 62% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ResponseIncompleteDetails.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnPatchOperation.java index e1d7bb40..cfb96975 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ResponseIncompleteDetails.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnPatchOperation.java @@ -46,22 +46,24 @@ import com.equinix.sdk.fabricv4.JSON; /** - * Details about why the response is incomplete. + * AsnPatchOperation */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class ResponseIncompleteDetails { +public class AsnPatchOperation { /** - * The reason why the response is incomplete. + * JSON Patch operation */ - @JsonAdapter(ReasonEnum.Adapter.class) - public enum ReasonEnum { - MAX_OUTPUT_TOKENS("max_output_tokens"), + @JsonAdapter(OpEnum.Adapter.class) + public enum OpEnum { + ADD("add"), - CONTENT_FILTER("content_filter"); + REMOVE("remove"), + + REPLACE("replace"); private String value; - ReasonEnum(String value) { + OpEnum(String value) { this.value = value; } @@ -74,8 +76,8 @@ public String toString() { return String.valueOf(value); } - public static ReasonEnum fromValue(String value) { - for (ReasonEnum b : ReasonEnum.values()) { + public static OpEnum fromValue(String value) { + for (OpEnum b : OpEnum.values()) { if (b.value.equals(value)) { return b; } @@ -83,49 +85,97 @@ public static ReasonEnum fromValue(String value) { throw new IllegalArgumentException("Unexpected value '" + value + "'"); } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final ReasonEnum enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final OpEnum enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public ReasonEnum read(final JsonReader jsonReader) throws IOException { + public OpEnum read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return ReasonEnum.fromValue(value); + return OpEnum.fromValue(value); } } public static void validateJsonElement(JsonElement jsonElement) throws IOException { String value = jsonElement.getAsString(); - ReasonEnum.fromValue(value); + OpEnum.fromValue(value); } } - public static final String SERIALIZED_NAME_REASON = "reason"; - @SerializedName(SERIALIZED_NAME_REASON) + public static final String SERIALIZED_NAME_OP = "op"; + @SerializedName(SERIALIZED_NAME_OP) + @javax.annotation.Nonnull + private OpEnum op; + + public static final String SERIALIZED_NAME_PATH = "path"; + @SerializedName(SERIALIZED_NAME_PATH) + @javax.annotation.Nonnull + private String path; + + public static final String SERIALIZED_NAME_VALUE = "value"; + @SerializedName(SERIALIZED_NAME_VALUE) @javax.annotation.Nullable - private ReasonEnum reason; + private Object value = null; + + public AsnPatchOperation() { + } + + public AsnPatchOperation op(@javax.annotation.Nonnull OpEnum op) { + this.op = op; + return this; + } + + /** + * JSON Patch operation + * @return op + */ + @javax.annotation.Nonnull + public OpEnum getOp() { + return op; + } + + public void setOp(@javax.annotation.Nonnull OpEnum op) { + this.op = op; + } + - public ResponseIncompleteDetails() { + public AsnPatchOperation path(@javax.annotation.Nonnull String path) { + this.path = path; + return this; + } + + /** + * JSON Pointer to the field to update + * @return path + */ + @javax.annotation.Nonnull + public String getPath() { + return path; } - public ResponseIncompleteDetails reason(@javax.annotation.Nullable ReasonEnum reason) { - this.reason = reason; + public void setPath(@javax.annotation.Nonnull String path) { + this.path = path; + } + + + public AsnPatchOperation value(@javax.annotation.Nullable Object value) { + this.value = value; return this; } /** - * The reason why the response is incomplete. - * @return reason + * New value for add or replace operations + * @return value */ @javax.annotation.Nullable - public ReasonEnum getReason() { - return reason; + public Object getValue() { + return value; } - public void setReason(@javax.annotation.Nullable ReasonEnum reason) { - this.reason = reason; + public void setValue(@javax.annotation.Nullable Object value) { + this.value = value; } /** @@ -141,9 +191,9 @@ public void setReason(@javax.annotation.Nullable ReasonEnum reason) { * * @param key name of the property * @param value value of the property - * @return the ResponseIncompleteDetails instance itself + * @return the AsnPatchOperation instance itself */ - public ResponseIncompleteDetails putAdditionalProperty(String key, Object value) { + public AsnPatchOperation putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -182,21 +232,25 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - ResponseIncompleteDetails responseIncompleteDetails = (ResponseIncompleteDetails) o; - return Objects.equals(this.reason, responseIncompleteDetails.reason)&& - Objects.equals(this.additionalProperties, responseIncompleteDetails.additionalProperties); + AsnPatchOperation asnPatchOperation = (AsnPatchOperation) o; + return Objects.equals(this.op, asnPatchOperation.op) && + Objects.equals(this.path, asnPatchOperation.path) && + Objects.equals(this.value, asnPatchOperation.value)&& + Objects.equals(this.additionalProperties, asnPatchOperation.additionalProperties); } @Override public int hashCode() { - return Objects.hash(reason, additionalProperties); + return Objects.hash(op, path, value, additionalProperties); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class ResponseIncompleteDetails {\n"); - sb.append(" reason: ").append(toIndentedString(reason)).append("\n"); + sb.append("class AsnPatchOperation {\n"); + sb.append(" op: ").append(toIndentedString(op)).append("\n"); + sb.append(" path: ").append(toIndentedString(path)).append("\n"); + sb.append(" value: ").append(toIndentedString(value)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -219,31 +273,39 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("reason")); + openapiFields = new HashSet(Arrays.asList("op", "path", "value")); // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); + openapiRequiredFields = new HashSet(Arrays.asList("op", "path", "value")); } /** * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to ResponseIncompleteDetails + * @throws IOException if the JSON Element is invalid with respect to AsnPatchOperation */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!ResponseIncompleteDetails.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in ResponseIncompleteDetails is not found in the empty JSON string", ResponseIncompleteDetails.openapiRequiredFields.toString())); + if (!AsnPatchOperation.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in AsnPatchOperation is not found in the empty JSON string", AsnPatchOperation.openapiRequiredFields.toString())); + } + } + + // check to make sure all required properties/fields are present in the JSON string + for (String requiredField : AsnPatchOperation.openapiRequiredFields) { + if (jsonElement.getAsJsonObject().get(requiredField) == null) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); - if ((jsonObj.get("reason") != null && !jsonObj.get("reason").isJsonNull()) && !jsonObj.get("reason").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `reason` to be a primitive type in the JSON string but got `%s`", jsonObj.get("reason").toString())); + if (!jsonObj.get("op").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `op` to be a primitive type in the JSON string but got `%s`", jsonObj.get("op").toString())); } - // validate the optional field `reason` - if (jsonObj.get("reason") != null && !jsonObj.get("reason").isJsonNull()) { - ReasonEnum.validateJsonElement(jsonObj.get("reason")); + // validate the required field `op` + OpEnum.validateJsonElement(jsonObj.get("op")); + if (!jsonObj.get("path").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `path` to be a primitive type in the JSON string but got `%s`", jsonObj.get("path").toString())); } } @@ -251,16 +313,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!ResponseIncompleteDetails.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'ResponseIncompleteDetails' and its subtypes + if (!AsnPatchOperation.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'AsnPatchOperation' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(ResponseIncompleteDetails.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(AsnPatchOperation.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, ResponseIncompleteDetails value) throws IOException { + public void write(JsonWriter out, AsnPatchOperation value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -288,12 +350,12 @@ else if (entry.getValue() instanceof Character) } @Override - public ResponseIncompleteDetails read(JsonReader in) throws IOException { + public AsnPatchOperation read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - ResponseIncompleteDetails instance = thisAdapter.fromJsonTree(jsonObj); + AsnPatchOperation instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -320,18 +382,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of ResponseIncompleteDetails given an JSON string + * Create an instance of AsnPatchOperation given an JSON string * * @param jsonString JSON string - * @return An instance of ResponseIncompleteDetails - * @throws IOException if the JSON string is invalid with respect to ResponseIncompleteDetails + * @return An instance of AsnPatchOperation + * @throws IOException if the JSON string is invalid with respect to AsnPatchOperation */ - public static ResponseIncompleteDetails fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, ResponseIncompleteDetails.class); + public static AsnPatchOperation fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, AsnPatchOperation.class); } /** - * Convert an instance of ResponseIncompleteDetails to an JSON string + * Convert an instance of AsnPatchOperation to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayPackageCode.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnRange.java similarity index 65% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayPackageCode.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnRange.java index 19ef404e..97c80c38 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayPackageCode.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnRange.java @@ -24,16 +24,18 @@ import com.google.gson.stream.JsonWriter; /** - * Gateway package code + * ASN range selection */ -@JsonAdapter(GatewayPackageCode.Adapter.class) -public enum GatewayPackageCode { +@JsonAdapter(AsnRange.Adapter.class) +public enum AsnRange { - LAB("LAB"); + _16_BIT("16_BIT"), + + _32_BIT("32_BIT"); private String value; - GatewayPackageCode(String value) { + AsnRange(String value) { this.value = value; } @@ -46,8 +48,8 @@ public String toString() { return String.valueOf(value); } - public static GatewayPackageCode fromValue(String value) { - for (GatewayPackageCode b : GatewayPackageCode.values()) { + public static AsnRange fromValue(String value) { + for (AsnRange b : AsnRange.values()) { if (b.value.equals(value)) { return b; } @@ -55,22 +57,22 @@ public static GatewayPackageCode fromValue(String value) { throw new IllegalArgumentException("Unexpected value '" + value + "'"); } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final GatewayPackageCode enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final AsnRange enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public GatewayPackageCode read(final JsonReader jsonReader) throws IOException { + public AsnRange read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return GatewayPackageCode.fromValue(value); + return AsnRange.fromValue(value); } } public static void validateJsonElement(JsonElement jsonElement) throws IOException { String value = jsonElement.getAsString(); - GatewayPackageCode.fromValue(value); + AsnRange.fromValue(value); } } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/SignatureType.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnRirRegion.java similarity index 64% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/SignatureType.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnRirRegion.java index 37ef4872..ce925209 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/SignatureType.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnRirRegion.java @@ -24,20 +24,24 @@ import com.google.gson.stream.JsonWriter; /** - * Cross Connect Signature Type. + * Regional Internet Registry region */ -@JsonAdapter(SignatureType.Adapter.class) -public enum SignatureType { +@JsonAdapter(AsnRirRegion.Adapter.class) +public enum AsnRirRegion { - DELEGATE("DELEGATE"), + AFRINIC("AFRINIC"), - SELF("SELF"), + APNIC("APNIC"), - ACCOUNT_SUPPORT("ACCOUNT_SUPPORT"); + ARIN("ARIN"), + + LACNIC("LACNIC"), + + RIPE_NCC("RIPE_NCC"); private String value; - SignatureType(String value) { + AsnRirRegion(String value) { this.value = value; } @@ -50,8 +54,8 @@ public String toString() { return String.valueOf(value); } - public static SignatureType fromValue(String value) { - for (SignatureType b : SignatureType.values()) { + public static AsnRirRegion fromValue(String value) { + for (AsnRirRegion b : AsnRirRegion.values()) { if (b.value.equals(value)) { return b; } @@ -59,22 +63,22 @@ public static SignatureType fromValue(String value) { throw new IllegalArgumentException("Unexpected value '" + value + "'"); } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final SignatureType enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final AsnRirRegion enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public SignatureType read(final JsonReader jsonReader) throws IOException { + public AsnRirRegion read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return SignatureType.fromValue(value); + return AsnRirRegion.fromValue(value); } } public static void validateJsonElement(JsonElement jsonElement) throws IOException { String value = jsonElement.getAsString(); - SignatureType.fromValue(value); + AsnRirRegion.fromValue(value); } } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewaySearchRequest.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnSearchRequestBody.java similarity index 78% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewaySearchRequest.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnSearchRequestBody.java index b543cfd0..4423a4f9 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewaySearchRequest.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnSearchRequestBody.java @@ -13,9 +13,9 @@ import java.util.Objects; import java.util.Locale; -import com.equinix.sdk.fabricv4.model.GatewaySortCriteria; +import com.equinix.sdk.fabricv4.model.AsnSearchSortCriteria; import com.equinix.sdk.fabricv4.model.PaginationRequest; -import com.equinix.sdk.fabricv4.model.SearchFilter; +import com.equinix.sdk.fabricv4.model.SearchExpression; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -51,72 +51,72 @@ import com.equinix.sdk.fabricv4.JSON; /** - * Search gateways + * AsnSearchRequestBody */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class GatewaySearchRequest { - public static final String SERIALIZED_NAME_FILTER = "filter"; - @SerializedName(SERIALIZED_NAME_FILTER) - @javax.annotation.Nullable - private SearchFilter filter; - +public class AsnSearchRequestBody { public static final String SERIALIZED_NAME_PAGINATION = "pagination"; @SerializedName(SERIALIZED_NAME_PAGINATION) @javax.annotation.Nullable private PaginationRequest pagination; + public static final String SERIALIZED_NAME_FILTER = "filter"; + @SerializedName(SERIALIZED_NAME_FILTER) + @javax.annotation.Nullable + private SearchExpression filter; + public static final String SERIALIZED_NAME_SORT = "sort"; @SerializedName(SERIALIZED_NAME_SORT) @javax.annotation.Nullable - private List sort = new ArrayList<>(); + private List sort = new ArrayList<>(); - public GatewaySearchRequest() { + public AsnSearchRequestBody() { } - public GatewaySearchRequest filter(@javax.annotation.Nullable SearchFilter filter) { - this.filter = filter; + public AsnSearchRequestBody pagination(@javax.annotation.Nullable PaginationRequest pagination) { + this.pagination = pagination; return this; } /** - * Get filter - * @return filter + * Get pagination + * @return pagination */ @javax.annotation.Nullable - public SearchFilter getFilter() { - return filter; + public PaginationRequest getPagination() { + return pagination; } - public void setFilter(@javax.annotation.Nullable SearchFilter filter) { - this.filter = filter; + public void setPagination(@javax.annotation.Nullable PaginationRequest pagination) { + this.pagination = pagination; } - public GatewaySearchRequest pagination(@javax.annotation.Nullable PaginationRequest pagination) { - this.pagination = pagination; + public AsnSearchRequestBody filter(@javax.annotation.Nullable SearchExpression filter) { + this.filter = filter; return this; } /** - * Get pagination - * @return pagination + * Get filter + * @return filter */ @javax.annotation.Nullable - public PaginationRequest getPagination() { - return pagination; + public SearchExpression getFilter() { + return filter; } - public void setPagination(@javax.annotation.Nullable PaginationRequest pagination) { - this.pagination = pagination; + public void setFilter(@javax.annotation.Nullable SearchExpression filter) { + this.filter = filter; } - public GatewaySearchRequest sort(@javax.annotation.Nullable List sort) { + public AsnSearchRequestBody sort(@javax.annotation.Nullable List sort) { this.sort = sort; return this; } - public GatewaySearchRequest addSortItem(GatewaySortCriteria sortItem) { + public AsnSearchRequestBody addSortItem(AsnSearchSortCriteria sortItem) { if (this.sort == null) { this.sort = new ArrayList<>(); } @@ -129,11 +129,11 @@ public GatewaySearchRequest addSortItem(GatewaySortCriteria sortItem) { * @return sort */ @javax.annotation.Nullable - public List getSort() { + public List getSort() { return sort; } - public void setSort(@javax.annotation.Nullable List sort) { + public void setSort(@javax.annotation.Nullable List sort) { this.sort = sort; } @@ -150,9 +150,9 @@ public void setSort(@javax.annotation.Nullable List sort) { * * @param key name of the property * @param value value of the property - * @return the GatewaySearchRequest instance itself + * @return the AsnSearchRequestBody instance itself */ - public GatewaySearchRequest putAdditionalProperty(String key, Object value) { + public AsnSearchRequestBody putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -191,24 +191,24 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - GatewaySearchRequest gatewaySearchRequest = (GatewaySearchRequest) o; - return Objects.equals(this.filter, gatewaySearchRequest.filter) && - Objects.equals(this.pagination, gatewaySearchRequest.pagination) && - Objects.equals(this.sort, gatewaySearchRequest.sort)&& - Objects.equals(this.additionalProperties, gatewaySearchRequest.additionalProperties); + AsnSearchRequestBody asnSearchRequestBody = (AsnSearchRequestBody) o; + return Objects.equals(this.pagination, asnSearchRequestBody.pagination) && + Objects.equals(this.filter, asnSearchRequestBody.filter) && + Objects.equals(this.sort, asnSearchRequestBody.sort)&& + Objects.equals(this.additionalProperties, asnSearchRequestBody.additionalProperties); } @Override public int hashCode() { - return Objects.hash(filter, pagination, sort, additionalProperties); + return Objects.hash(pagination, filter, sort, additionalProperties); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class GatewaySearchRequest {\n"); - sb.append(" filter: ").append(toIndentedString(filter)).append("\n"); + sb.append("class AsnSearchRequestBody {\n"); sb.append(" pagination: ").append(toIndentedString(pagination)).append("\n"); + sb.append(" filter: ").append(toIndentedString(filter)).append("\n"); sb.append(" sort: ").append(toIndentedString(sort)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); @@ -232,7 +232,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("filter", "pagination", "sort")); + openapiFields = new HashSet(Arrays.asList("pagination", "filter", "sort")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(0); @@ -242,23 +242,23 @@ private String toIndentedString(Object o) { * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to GatewaySearchRequest + * @throws IOException if the JSON Element is invalid with respect to AsnSearchRequestBody */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!GatewaySearchRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in GatewaySearchRequest is not found in the empty JSON string", GatewaySearchRequest.openapiRequiredFields.toString())); + if (!AsnSearchRequestBody.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in AsnSearchRequestBody is not found in the empty JSON string", AsnSearchRequestBody.openapiRequiredFields.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); - // validate the optional field `filter` - if (jsonObj.get("filter") != null && !jsonObj.get("filter").isJsonNull()) { - SearchFilter.validateJsonElement(jsonObj.get("filter")); - } // validate the optional field `pagination` if (jsonObj.get("pagination") != null && !jsonObj.get("pagination").isJsonNull()) { PaginationRequest.validateJsonElement(jsonObj.get("pagination")); } + // validate the optional field `filter` + if (jsonObj.get("filter") != null && !jsonObj.get("filter").isJsonNull()) { + SearchExpression.validateJsonElement(jsonObj.get("filter")); + } if (jsonObj.get("sort") != null && !jsonObj.get("sort").isJsonNull()) { JsonArray jsonArraysort = jsonObj.getAsJsonArray("sort"); if (jsonArraysort != null) { @@ -269,7 +269,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti // validate the optional field `sort` (array) for (int i = 0; i < jsonArraysort.size(); i++) { - GatewaySortCriteria.validateJsonElement(jsonArraysort.get(i)); + AsnSearchSortCriteria.validateJsonElement(jsonArraysort.get(i)); }; } } @@ -279,16 +279,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!GatewaySearchRequest.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'GatewaySearchRequest' and its subtypes + if (!AsnSearchRequestBody.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'AsnSearchRequestBody' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(GatewaySearchRequest.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(AsnSearchRequestBody.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, GatewaySearchRequest value) throws IOException { + public void write(JsonWriter out, AsnSearchRequestBody value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -316,12 +316,12 @@ else if (entry.getValue() instanceof Character) } @Override - public GatewaySearchRequest read(JsonReader in) throws IOException { + public AsnSearchRequestBody read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - GatewaySearchRequest instance = thisAdapter.fromJsonTree(jsonObj); + AsnSearchRequestBody instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -348,18 +348,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of GatewaySearchRequest given an JSON string + * Create an instance of AsnSearchRequestBody given an JSON string * * @param jsonString JSON string - * @return An instance of GatewaySearchRequest - * @throws IOException if the JSON string is invalid with respect to GatewaySearchRequest + * @return An instance of AsnSearchRequestBody + * @throws IOException if the JSON string is invalid with respect to AsnSearchRequestBody */ - public static GatewaySearchRequest fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, GatewaySearchRequest.class); + public static AsnSearchRequestBody fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, AsnSearchRequestBody.class); } /** - * Convert an instance of GatewaySearchRequest to an JSON string + * Convert an instance of AsnSearchRequestBody to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayTunnelSearchRequest.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnSearchResponseBody.java similarity index 65% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayTunnelSearchRequest.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnSearchResponseBody.java index d0ff6657..3bfda1c9 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayTunnelSearchRequest.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnSearchResponseBody.java @@ -13,9 +13,9 @@ import java.util.Objects; import java.util.Locale; -import com.equinix.sdk.fabricv4.model.GatewayTunnelSortCriteria; -import com.equinix.sdk.fabricv4.model.PaginationRequest; -import com.equinix.sdk.fabricv4.model.SearchFilter; +import com.equinix.sdk.fabricv4.model.Asn; +import com.equinix.sdk.fabricv4.model.AsnSearchSortCriteria; +import com.equinix.sdk.fabricv4.model.Pagination; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -51,48 +51,29 @@ import com.equinix.sdk.fabricv4.JSON; /** - * Search Gateway Tunnels + * AsnSearchResponseBody */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class GatewayTunnelSearchRequest { - public static final String SERIALIZED_NAME_FILTER = "filter"; - @SerializedName(SERIALIZED_NAME_FILTER) - @javax.annotation.Nullable - private SearchFilter filter; - +public class AsnSearchResponseBody { public static final String SERIALIZED_NAME_PAGINATION = "pagination"; @SerializedName(SERIALIZED_NAME_PAGINATION) - @javax.annotation.Nullable - private PaginationRequest pagination; + @javax.annotation.Nonnull + private Pagination pagination; public static final String SERIALIZED_NAME_SORT = "sort"; @SerializedName(SERIALIZED_NAME_SORT) @javax.annotation.Nullable - private List sort = new ArrayList<>(); - - public GatewayTunnelSearchRequest() { - } + private List sort = new ArrayList<>(); - public GatewayTunnelSearchRequest filter(@javax.annotation.Nullable SearchFilter filter) { - this.filter = filter; - return this; - } - - /** - * Get filter - * @return filter - */ - @javax.annotation.Nullable - public SearchFilter getFilter() { - return filter; - } + public static final String SERIALIZED_NAME_DATA = "data"; + @SerializedName(SERIALIZED_NAME_DATA) + @javax.annotation.Nonnull + private List data = new ArrayList<>(); - public void setFilter(@javax.annotation.Nullable SearchFilter filter) { - this.filter = filter; + public AsnSearchResponseBody() { } - - public GatewayTunnelSearchRequest pagination(@javax.annotation.Nullable PaginationRequest pagination) { + public AsnSearchResponseBody pagination(@javax.annotation.Nonnull Pagination pagination) { this.pagination = pagination; return this; } @@ -101,22 +82,22 @@ public GatewayTunnelSearchRequest pagination(@javax.annotation.Nullable Paginati * Get pagination * @return pagination */ - @javax.annotation.Nullable - public PaginationRequest getPagination() { + @javax.annotation.Nonnull + public Pagination getPagination() { return pagination; } - public void setPagination(@javax.annotation.Nullable PaginationRequest pagination) { + public void setPagination(@javax.annotation.Nonnull Pagination pagination) { this.pagination = pagination; } - public GatewayTunnelSearchRequest sort(@javax.annotation.Nullable List sort) { + public AsnSearchResponseBody sort(@javax.annotation.Nullable List sort) { this.sort = sort; return this; } - public GatewayTunnelSearchRequest addSortItem(GatewayTunnelSortCriteria sortItem) { + public AsnSearchResponseBody addSortItem(AsnSearchSortCriteria sortItem) { if (this.sort == null) { this.sort = new ArrayList<>(); } @@ -129,14 +110,41 @@ public GatewayTunnelSearchRequest addSortItem(GatewayTunnelSortCriteria sortItem * @return sort */ @javax.annotation.Nullable - public List getSort() { + public List getSort() { return sort; } - public void setSort(@javax.annotation.Nullable List sort) { + public void setSort(@javax.annotation.Nullable List sort) { this.sort = sort; } + + public AsnSearchResponseBody data(@javax.annotation.Nonnull List data) { + this.data = data; + return this; + } + + public AsnSearchResponseBody addDataItem(Asn dataItem) { + if (this.data == null) { + this.data = new ArrayList<>(); + } + this.data.add(dataItem); + return this; + } + + /** + * Get data + * @return data + */ + @javax.annotation.Nonnull + public List getData() { + return data; + } + + public void setData(@javax.annotation.Nonnull List data) { + this.data = data; + } + /** * A container for additional, undeclared properties. * This is a holder for any undeclared properties as specified with @@ -150,9 +158,9 @@ public void setSort(@javax.annotation.Nullable List s * * @param key name of the property * @param value value of the property - * @return the GatewayTunnelSearchRequest instance itself + * @return the AsnSearchResponseBody instance itself */ - public GatewayTunnelSearchRequest putAdditionalProperty(String key, Object value) { + public AsnSearchResponseBody putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -191,25 +199,25 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - GatewayTunnelSearchRequest gatewayTunnelSearchRequest = (GatewayTunnelSearchRequest) o; - return Objects.equals(this.filter, gatewayTunnelSearchRequest.filter) && - Objects.equals(this.pagination, gatewayTunnelSearchRequest.pagination) && - Objects.equals(this.sort, gatewayTunnelSearchRequest.sort)&& - Objects.equals(this.additionalProperties, gatewayTunnelSearchRequest.additionalProperties); + AsnSearchResponseBody asnSearchResponseBody = (AsnSearchResponseBody) o; + return Objects.equals(this.pagination, asnSearchResponseBody.pagination) && + Objects.equals(this.sort, asnSearchResponseBody.sort) && + Objects.equals(this.data, asnSearchResponseBody.data)&& + Objects.equals(this.additionalProperties, asnSearchResponseBody.additionalProperties); } @Override public int hashCode() { - return Objects.hash(filter, pagination, sort, additionalProperties); + return Objects.hash(pagination, sort, data, additionalProperties); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class GatewayTunnelSearchRequest {\n"); - sb.append(" filter: ").append(toIndentedString(filter)).append("\n"); + sb.append("class AsnSearchResponseBody {\n"); sb.append(" pagination: ").append(toIndentedString(pagination)).append("\n"); sb.append(" sort: ").append(toIndentedString(sort)).append("\n"); + sb.append(" data: ").append(toIndentedString(data)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -232,33 +240,34 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("filter", "pagination", "sort")); + openapiFields = new HashSet(Arrays.asList("pagination", "sort", "data")); // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); + openapiRequiredFields = new HashSet(Arrays.asList("pagination", "data")); } /** * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to GatewayTunnelSearchRequest + * @throws IOException if the JSON Element is invalid with respect to AsnSearchResponseBody */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!GatewayTunnelSearchRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in GatewayTunnelSearchRequest is not found in the empty JSON string", GatewayTunnelSearchRequest.openapiRequiredFields.toString())); + if (!AsnSearchResponseBody.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in AsnSearchResponseBody is not found in the empty JSON string", AsnSearchResponseBody.openapiRequiredFields.toString())); } } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // validate the optional field `filter` - if (jsonObj.get("filter") != null && !jsonObj.get("filter").isJsonNull()) { - SearchFilter.validateJsonElement(jsonObj.get("filter")); - } - // validate the optional field `pagination` - if (jsonObj.get("pagination") != null && !jsonObj.get("pagination").isJsonNull()) { - PaginationRequest.validateJsonElement(jsonObj.get("pagination")); + + // check to make sure all required properties/fields are present in the JSON string + for (String requiredField : AsnSearchResponseBody.openapiRequiredFields) { + if (jsonElement.getAsJsonObject().get(requiredField) == null) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); + } } + JsonObject jsonObj = jsonElement.getAsJsonObject(); + // validate the required field `pagination` + Pagination.validateJsonElement(jsonObj.get("pagination")); if (jsonObj.get("sort") != null && !jsonObj.get("sort").isJsonNull()) { JsonArray jsonArraysort = jsonObj.getAsJsonArray("sort"); if (jsonArraysort != null) { @@ -269,26 +278,36 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti // validate the optional field `sort` (array) for (int i = 0; i < jsonArraysort.size(); i++) { - GatewayTunnelSortCriteria.validateJsonElement(jsonArraysort.get(i)); + AsnSearchSortCriteria.validateJsonElement(jsonArraysort.get(i)); }; } } + // ensure the json data is an array + if (!jsonObj.get("data").isJsonArray()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `data` to be an array in the JSON string but got `%s`", jsonObj.get("data").toString())); + } + + JsonArray jsonArraydata = jsonObj.getAsJsonArray("data"); + // validate the required field `data` (array) + for (int i = 0; i < jsonArraydata.size(); i++) { + Asn.validateJsonElement(jsonArraydata.get(i)); + }; } public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!GatewayTunnelSearchRequest.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'GatewayTunnelSearchRequest' and its subtypes + if (!AsnSearchResponseBody.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'AsnSearchResponseBody' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(GatewayTunnelSearchRequest.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(AsnSearchResponseBody.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, GatewayTunnelSearchRequest value) throws IOException { + public void write(JsonWriter out, AsnSearchResponseBody value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -316,12 +335,12 @@ else if (entry.getValue() instanceof Character) } @Override - public GatewayTunnelSearchRequest read(JsonReader in) throws IOException { + public AsnSearchResponseBody read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - GatewayTunnelSearchRequest instance = thisAdapter.fromJsonTree(jsonObj); + AsnSearchResponseBody instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -348,18 +367,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of GatewayTunnelSearchRequest given an JSON string + * Create an instance of AsnSearchResponseBody given an JSON string * * @param jsonString JSON string - * @return An instance of GatewayTunnelSearchRequest - * @throws IOException if the JSON string is invalid with respect to GatewayTunnelSearchRequest + * @return An instance of AsnSearchResponseBody + * @throws IOException if the JSON string is invalid with respect to AsnSearchResponseBody */ - public static GatewayTunnelSearchRequest fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, GatewayTunnelSearchRequest.class); + public static AsnSearchResponseBody fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, AsnSearchResponseBody.class); } /** - * Convert an instance of GatewayTunnelSearchRequest to an JSON string + * Convert an instance of AsnSearchResponseBody to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewaySortCriteria.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnSearchSortCriteria.java similarity index 70% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewaySortCriteria.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnSearchSortCriteria.java index 60912d97..d367296e 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewaySortCriteria.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnSearchSortCriteria.java @@ -13,7 +13,6 @@ import java.util.Objects; import java.util.Locale; -import com.equinix.sdk.fabricv4.model.GatewaySortDirection; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -47,49 +46,101 @@ import com.equinix.sdk.fabricv4.JSON; /** - * GatewaySortCriteria + * AsnSearchSortCriteria */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class GatewaySortCriteria { +public class AsnSearchSortCriteria { + /** + * Sorting direction + */ + @JsonAdapter(DirectionEnum.Adapter.class) + public enum DirectionEnum { + DESC("DESC"), + + ASC("ASC"); + + private String value; + + DirectionEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static DirectionEnum fromValue(String value) { + for (DirectionEnum b : DirectionEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final DirectionEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public DirectionEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return DirectionEnum.fromValue(value); + } + } + + public static void validateJsonElement(JsonElement jsonElement) throws IOException { + String value = jsonElement.getAsString(); + DirectionEnum.fromValue(value); + } + } + public static final String SERIALIZED_NAME_DIRECTION = "direction"; @SerializedName(SERIALIZED_NAME_DIRECTION) @javax.annotation.Nullable - private GatewaySortDirection direction = GatewaySortDirection.DESC; + private DirectionEnum direction = DirectionEnum.DESC; public static final String SERIALIZED_NAME_PROPERTY = "property"; @SerializedName(SERIALIZED_NAME_PROPERTY) @javax.annotation.Nullable private String property = "/changeLog/updatedDateTime"; - public GatewaySortCriteria() { + public AsnSearchSortCriteria() { } - public GatewaySortCriteria direction(@javax.annotation.Nullable GatewaySortDirection direction) { + public AsnSearchSortCriteria direction(@javax.annotation.Nullable DirectionEnum direction) { this.direction = direction; return this; } /** - * Get direction + * Sorting direction * @return direction */ @javax.annotation.Nullable - public GatewaySortDirection getDirection() { + public DirectionEnum getDirection() { return direction; } - public void setDirection(@javax.annotation.Nullable GatewaySortDirection direction) { + public void setDirection(@javax.annotation.Nullable DirectionEnum direction) { this.direction = direction; } - public GatewaySortCriteria property(@javax.annotation.Nullable String property) { + public AsnSearchSortCriteria property(@javax.annotation.Nullable String property) { this.property = property; return this; } /** - * Possible field names to use on sorting: * `/name` - Gateway name * `/uuid` - Gateway uuid * `/state` - Gateway status * `/changeLog/createdDateTime` - Date and time when change flow starts * `/changeLog/updatedDateTime` - Date and time when change object is updated + * Possible field names to use on sorting * @return property */ @javax.annotation.Nullable @@ -114,9 +165,9 @@ public void setProperty(@javax.annotation.Nullable String property) { * * @param key name of the property * @param value value of the property - * @return the GatewaySortCriteria instance itself + * @return the AsnSearchSortCriteria instance itself */ - public GatewaySortCriteria putAdditionalProperty(String key, Object value) { + public AsnSearchSortCriteria putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -155,10 +206,10 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - GatewaySortCriteria gatewaySortCriteria = (GatewaySortCriteria) o; - return Objects.equals(this.direction, gatewaySortCriteria.direction) && - Objects.equals(this.property, gatewaySortCriteria.property)&& - Objects.equals(this.additionalProperties, gatewaySortCriteria.additionalProperties); + AsnSearchSortCriteria asnSearchSortCriteria = (AsnSearchSortCriteria) o; + return Objects.equals(this.direction, asnSearchSortCriteria.direction) && + Objects.equals(this.property, asnSearchSortCriteria.property)&& + Objects.equals(this.additionalProperties, asnSearchSortCriteria.additionalProperties); } @Override @@ -169,7 +220,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class GatewaySortCriteria {\n"); + sb.append("class AsnSearchSortCriteria {\n"); sb.append(" direction: ").append(toIndentedString(direction)).append("\n"); sb.append(" property: ").append(toIndentedString(property)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); @@ -204,18 +255,21 @@ private String toIndentedString(Object o) { * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to GatewaySortCriteria + * @throws IOException if the JSON Element is invalid with respect to AsnSearchSortCriteria */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!GatewaySortCriteria.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in GatewaySortCriteria is not found in the empty JSON string", GatewaySortCriteria.openapiRequiredFields.toString())); + if (!AsnSearchSortCriteria.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in AsnSearchSortCriteria is not found in the empty JSON string", AsnSearchSortCriteria.openapiRequiredFields.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); + if ((jsonObj.get("direction") != null && !jsonObj.get("direction").isJsonNull()) && !jsonObj.get("direction").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `direction` to be a primitive type in the JSON string but got `%s`", jsonObj.get("direction").toString())); + } // validate the optional field `direction` if (jsonObj.get("direction") != null && !jsonObj.get("direction").isJsonNull()) { - GatewaySortDirection.validateJsonElement(jsonObj.get("direction")); + DirectionEnum.validateJsonElement(jsonObj.get("direction")); } if ((jsonObj.get("property") != null && !jsonObj.get("property").isJsonNull()) && !jsonObj.get("property").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `property` to be a primitive type in the JSON string but got `%s`", jsonObj.get("property").toString())); @@ -226,16 +280,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!GatewaySortCriteria.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'GatewaySortCriteria' and its subtypes + if (!AsnSearchSortCriteria.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'AsnSearchSortCriteria' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(GatewaySortCriteria.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(AsnSearchSortCriteria.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, GatewaySortCriteria value) throws IOException { + public void write(JsonWriter out, AsnSearchSortCriteria value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -263,12 +317,12 @@ else if (entry.getValue() instanceof Character) } @Override - public GatewaySortCriteria read(JsonReader in) throws IOException { + public AsnSearchSortCriteria read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - GatewaySortCriteria instance = thisAdapter.fromJsonTree(jsonObj); + AsnSearchSortCriteria instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -295,18 +349,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of GatewaySortCriteria given an JSON string + * Create an instance of AsnSearchSortCriteria given an JSON string * * @param jsonString JSON string - * @return An instance of GatewaySortCriteria - * @throws IOException if the JSON string is invalid with respect to GatewaySortCriteria + * @return An instance of AsnSearchSortCriteria + * @throws IOException if the JSON string is invalid with respect to AsnSearchSortCriteria */ - public static GatewaySortCriteria fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, GatewaySortCriteria.class); + public static AsnSearchSortCriteria fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, AsnSearchSortCriteria.class); } /** - * Convert an instance of GatewaySortCriteria to an JSON string + * Convert an instance of AsnSearchSortCriteria to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ConnectionState.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnState.java similarity index 65% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ConnectionState.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnState.java index 176caa2b..bb4abcf1 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ConnectionState.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/AsnState.java @@ -24,32 +24,34 @@ import com.google.gson.stream.JsonWriter; /** - * Connection status + * ASN lifecycle state */ -@JsonAdapter(ConnectionState.Adapter.class) -public enum ConnectionState { +@JsonAdapter(AsnState.Adapter.class) +public enum AsnState { - ACTIVE("ACTIVE"), + REQUESTED("REQUESTED"), - CANCELLED("CANCELLED"), + PROVISIONING("PROVISIONING"), - DEPROVISIONED("DEPROVISIONED"), + PENDING("PENDING"), - DEPROVISIONING("DEPROVISIONING"), + PROVISIONED("PROVISIONED"), - DRAFT("DRAFT"), + ATTACHED("ATTACHED"), FAILED("FAILED"), - PENDING("PENDING"), + PROVISIONING_FAILED("PROVISIONING_FAILED"), - PROVISIONING("PROVISIONING"), + DEPROVISIONING("DEPROVISIONING"), + + DEPROVISIONING_FAILED("DEPROVISIONING_FAILED"), - EMPTY(""); + DEPROVISIONED("DEPROVISIONED"); private String value; - ConnectionState(String value) { + AsnState(String value) { this.value = value; } @@ -62,8 +64,8 @@ public String toString() { return String.valueOf(value); } - public static ConnectionState fromValue(String value) { - for (ConnectionState b : ConnectionState.values()) { + public static AsnState fromValue(String value) { + for (AsnState b : AsnState.values()) { if (b.value.equals(value)) { return b; } @@ -71,22 +73,22 @@ public static ConnectionState fromValue(String value) { throw new IllegalArgumentException("Unexpected value '" + value + "'"); } - public static class Adapter extends TypeAdapter { + public static class Adapter extends TypeAdapter { @Override - public void write(final JsonWriter jsonWriter, final ConnectionState enumeration) throws IOException { + public void write(final JsonWriter jsonWriter, final AsnState enumeration) throws IOException { jsonWriter.value(enumeration.getValue()); } @Override - public ConnectionState read(final JsonReader jsonReader) throws IOException { + public AsnState read(final JsonReader jsonReader) throws IOException { String value = jsonReader.nextString(); - return ConnectionState.fromValue(value); + return AsnState.fromValue(value); } } public static void validateJsonElement(JsonElement jsonElement) throws IOException { String value = jsonElement.getAsString(); - ConnectionState.fromValue(value); + AsnState.fromValue(value); } } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CloudRouterChangeOperation.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CloudRouterChangeOperation.java index 8369c4df..ba32660a 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CloudRouterChangeOperation.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CloudRouterChangeOperation.java @@ -116,8 +116,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public CloudRouterChangeOperation() { } @@ -160,7 +160,7 @@ public void setPath(@javax.annotation.Nonnull String path) { } - public CloudRouterChangeOperation value(@javax.annotation.Nonnull Object value) { + public CloudRouterChangeOperation value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -169,12 +169,12 @@ public CloudRouterChangeOperation value(@javax.annotation.Nonnull Object value) * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileChangeItem.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileChangeItem.java index a48d905f..e4846b48 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileChangeItem.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileChangeItem.java @@ -62,8 +62,8 @@ public class CompanyProfileChangeItem { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public CompanyProfileChangeItem() { } @@ -106,7 +106,7 @@ public void setPath(@javax.annotation.Nonnull String path) { } - public CompanyProfileChangeItem value(@javax.annotation.Nonnull Object value) { + public CompanyProfileChangeItem value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -115,12 +115,12 @@ public CompanyProfileChangeItem value(@javax.annotation.Nonnull Object value) { * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileContact.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileContact.java index 2b0d1464..870a0ace 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileContact.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileContact.java @@ -13,7 +13,7 @@ import java.util.Objects; import java.util.Locale; -import com.equinix.sdk.fabricv4.model.CompanyProfileContactContacts; +import com.equinix.sdk.fabricv4.model.CompanyProfileContactContactsInner; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -111,7 +111,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti public static final String SERIALIZED_NAME_CONTACTS = "contacts"; @SerializedName(SERIALIZED_NAME_CONTACTS) @javax.annotation.Nullable - private List contacts = new ArrayList<>(); + private List contacts = new ArrayList<>(); public CompanyProfileContact() { } @@ -135,12 +135,12 @@ public void setType(@javax.annotation.Nullable TypeEnum type) { } - public CompanyProfileContact contacts(@javax.annotation.Nullable List contacts) { + public CompanyProfileContact contacts(@javax.annotation.Nullable List contacts) { this.contacts = contacts; return this; } - public CompanyProfileContact addContactsItem(CompanyProfileContactContacts contactsItem) { + public CompanyProfileContact addContactsItem(CompanyProfileContactContactsInner contactsItem) { if (this.contacts == null) { this.contacts = new ArrayList<>(); } @@ -153,11 +153,11 @@ public CompanyProfileContact addContactsItem(CompanyProfileContactContacts conta * @return contacts */ @javax.annotation.Nullable - public List getContacts() { + public List getContacts() { return contacts; } - public void setContacts(@javax.annotation.Nullable List contacts) { + public void setContacts(@javax.annotation.Nullable List contacts) { this.contacts = contacts; } @@ -290,7 +290,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti // validate the optional field `contacts` (array) for (int i = 0; i < jsonArraycontacts.size(); i++) { - CompanyProfileContactContacts.validateJsonElement(jsonArraycontacts.get(i)); + CompanyProfileContactContactsInner.validateJsonElement(jsonArraycontacts.get(i)); }; } } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileContactContacts.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileContactContactsInner.java similarity index 83% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileContactContacts.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileContactContactsInner.java index d0daf4ee..f766fdd6 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileContactContacts.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileContactContactsInner.java @@ -46,10 +46,10 @@ import com.equinix.sdk.fabricv4.JSON; /** - * CompanyProfileContactContacts + * CompanyProfileContactContactsInner */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class CompanyProfileContactContacts { +public class CompanyProfileContactContactsInner { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) @javax.annotation.Nullable @@ -65,10 +65,10 @@ public class CompanyProfileContactContacts { @javax.annotation.Nonnull private String email; - public CompanyProfileContactContacts() { + public CompanyProfileContactContactsInner() { } - public CompanyProfileContactContacts name(@javax.annotation.Nullable String name) { + public CompanyProfileContactContactsInner name(@javax.annotation.Nullable String name) { this.name = name; return this; } @@ -87,7 +87,7 @@ public void setName(@javax.annotation.Nullable String name) { } - public CompanyProfileContactContacts role(@javax.annotation.Nullable String role) { + public CompanyProfileContactContactsInner role(@javax.annotation.Nullable String role) { this.role = role; return this; } @@ -106,7 +106,7 @@ public void setRole(@javax.annotation.Nullable String role) { } - public CompanyProfileContactContacts email(@javax.annotation.Nonnull String email) { + public CompanyProfileContactContactsInner email(@javax.annotation.Nonnull String email) { this.email = email; return this; } @@ -137,9 +137,9 @@ public void setEmail(@javax.annotation.Nonnull String email) { * * @param key name of the property * @param value value of the property - * @return the CompanyProfileContactContacts instance itself + * @return the CompanyProfileContactContactsInner instance itself */ - public CompanyProfileContactContacts putAdditionalProperty(String key, Object value) { + public CompanyProfileContactContactsInner putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -178,11 +178,11 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - CompanyProfileContactContacts companyProfileContactContacts = (CompanyProfileContactContacts) o; - return Objects.equals(this.name, companyProfileContactContacts.name) && - Objects.equals(this.role, companyProfileContactContacts.role) && - Objects.equals(this.email, companyProfileContactContacts.email)&& - Objects.equals(this.additionalProperties, companyProfileContactContacts.additionalProperties); + CompanyProfileContactContactsInner companyProfileContactContactsInner = (CompanyProfileContactContactsInner) o; + return Objects.equals(this.name, companyProfileContactContactsInner.name) && + Objects.equals(this.role, companyProfileContactContactsInner.role) && + Objects.equals(this.email, companyProfileContactContactsInner.email)&& + Objects.equals(this.additionalProperties, companyProfileContactContactsInner.additionalProperties); } @Override @@ -193,7 +193,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class CompanyProfileContactContacts {\n"); + sb.append("class CompanyProfileContactContactsInner {\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" role: ").append(toIndentedString(role)).append("\n"); sb.append(" email: ").append(toIndentedString(email)).append("\n"); @@ -229,17 +229,17 @@ private String toIndentedString(Object o) { * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to CompanyProfileContactContacts + * @throws IOException if the JSON Element is invalid with respect to CompanyProfileContactContactsInner */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!CompanyProfileContactContacts.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in CompanyProfileContactContacts is not found in the empty JSON string", CompanyProfileContactContacts.openapiRequiredFields.toString())); + if (!CompanyProfileContactContactsInner.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in CompanyProfileContactContactsInner is not found in the empty JSON string", CompanyProfileContactContactsInner.openapiRequiredFields.toString())); } } // check to make sure all required properties/fields are present in the JSON string - for (String requiredField : CompanyProfileContactContacts.openapiRequiredFields) { + for (String requiredField : CompanyProfileContactContactsInner.openapiRequiredFields) { if (jsonElement.getAsJsonObject().get(requiredField) == null) { throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); } @@ -260,16 +260,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!CompanyProfileContactContacts.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'CompanyProfileContactContacts' and its subtypes + if (!CompanyProfileContactContactsInner.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'CompanyProfileContactContactsInner' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(CompanyProfileContactContacts.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(CompanyProfileContactContactsInner.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, CompanyProfileContactContacts value) throws IOException { + public void write(JsonWriter out, CompanyProfileContactContactsInner value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -297,12 +297,12 @@ else if (entry.getValue() instanceof Character) } @Override - public CompanyProfileContactContacts read(JsonReader in) throws IOException { + public CompanyProfileContactContactsInner read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - CompanyProfileContactContacts instance = thisAdapter.fromJsonTree(jsonObj); + CompanyProfileContactContactsInner instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -329,18 +329,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of CompanyProfileContactContacts given an JSON string + * Create an instance of CompanyProfileContactContactsInner given an JSON string * * @param jsonString JSON string - * @return An instance of CompanyProfileContactContacts - * @throws IOException if the JSON string is invalid with respect to CompanyProfileContactContacts + * @return An instance of CompanyProfileContactContactsInner + * @throws IOException if the JSON string is invalid with respect to CompanyProfileContactContactsInner */ - public static CompanyProfileContactContacts fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, CompanyProfileContactContacts.class); + public static CompanyProfileContactContactsInner fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, CompanyProfileContactContactsInner.class); } /** - * Convert an instance of CompanyProfileContactContacts to an JSON string + * Convert an instance of CompanyProfileContactContactsInner to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileResponse.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileResponse.java index e3efbaeb..61413054 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileResponse.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileResponse.java @@ -18,7 +18,6 @@ import com.equinix.sdk.fabricv4.model.CompanyMetro; import com.equinix.sdk.fabricv4.model.CompanyProfileChange; import com.equinix.sdk.fabricv4.model.CompanyProfileContact; -import com.equinix.sdk.fabricv4.model.CompanyProfileResponseAccount; import com.equinix.sdk.fabricv4.model.CompanyServiceProfile; import com.equinix.sdk.fabricv4.model.PrivateService; import com.equinix.sdk.fabricv4.model.SimplifiedNotification; @@ -97,11 +96,6 @@ public class CompanyProfileResponse { @javax.annotation.Nullable private String state; - public static final String SERIALIZED_NAME_ACCOUNT = "account"; - @SerializedName(SERIALIZED_NAME_ACCOUNT) - @javax.annotation.Nullable - private CompanyProfileResponseAccount account; - public static final String SERIALIZED_NAME_METROS = "metros"; @SerializedName(SERIALIZED_NAME_METROS) @javax.annotation.Nullable @@ -298,25 +292,6 @@ public void setState(@javax.annotation.Nullable String state) { } - public CompanyProfileResponse account(@javax.annotation.Nullable CompanyProfileResponseAccount account) { - this.account = account; - return this; - } - - /** - * Get account - * @return account - */ - @javax.annotation.Nullable - public CompanyProfileResponseAccount getAccount() { - return account; - } - - public void setAccount(@javax.annotation.Nullable CompanyProfileResponseAccount account) { - this.account = account; - } - - public CompanyProfileResponse metros(@javax.annotation.Nullable List metros) { this.metros = metros; return this; @@ -654,7 +629,6 @@ public boolean equals(Object o) { Objects.equals(this.summary, companyProfileResponse.summary) && Objects.equals(this.description, companyProfileResponse.description) && Objects.equals(this.state, companyProfileResponse.state) && - Objects.equals(this.account, companyProfileResponse.account) && Objects.equals(this.metros, companyProfileResponse.metros) && Objects.equals(this.logo, companyProfileResponse.logo) && Objects.equals(this.tags, companyProfileResponse.tags) && @@ -672,7 +646,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(href, uuid, type, name, summary, description, state, account, metros, logo, tags, serviceProfiles, privateServices, pointOfContacts, notifications, overview, webUrl, contactUrl, change, changeLog, additionalProperties); + return Objects.hash(href, uuid, type, name, summary, description, state, metros, logo, tags, serviceProfiles, privateServices, pointOfContacts, notifications, overview, webUrl, contactUrl, change, changeLog, additionalProperties); } @Override @@ -686,7 +660,6 @@ public String toString() { sb.append(" summary: ").append(toIndentedString(summary)).append("\n"); sb.append(" description: ").append(toIndentedString(description)).append("\n"); sb.append(" state: ").append(toIndentedString(state)).append("\n"); - sb.append(" account: ").append(toIndentedString(account)).append("\n"); sb.append(" metros: ").append(toIndentedString(metros)).append("\n"); sb.append(" logo: ").append(toIndentedString(logo)).append("\n"); sb.append(" tags: ").append(toIndentedString(tags)).append("\n"); @@ -721,7 +694,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("href", "uuid", "type", "name", "summary", "description", "state", "account", "metros", "logo", "tags", "serviceProfiles", "privateServices", "pointOfContacts", "notifications", "overview", "webUrl", "contactUrl", "change", "changeLog")); + openapiFields = new HashSet(Arrays.asList("href", "uuid", "type", "name", "summary", "description", "state", "metros", "logo", "tags", "serviceProfiles", "privateServices", "pointOfContacts", "notifications", "overview", "webUrl", "contactUrl", "change", "changeLog")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(0); @@ -761,10 +734,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("state") != null && !jsonObj.get("state").isJsonNull()) && !jsonObj.get("state").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `state` to be a primitive type in the JSON string but got `%s`", jsonObj.get("state").toString())); } - // validate the optional field `account` - if (jsonObj.get("account") != null && !jsonObj.get("account").isJsonNull()) { - CompanyProfileResponseAccount.validateJsonElement(jsonObj.get("account")); - } if (jsonObj.get("metros") != null && !jsonObj.get("metros").isJsonNull()) { JsonArray jsonArraymetros = jsonObj.getAsJsonArray("metros"); if (jsonArraymetros != null) { diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileResponseAccount.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileResponseAccount.java deleted file mode 100644 index 91f8e144..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CompanyProfileResponseAccount.java +++ /dev/null @@ -1,286 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.Arrays; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * CompanyProfileResponseAccount - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class CompanyProfileResponseAccount { - public static final String SERIALIZED_NAME_ROOT_ORG_ID = "rootOrgId"; - @SerializedName(SERIALIZED_NAME_ROOT_ORG_ID) - @javax.annotation.Nullable - private String rootOrgId; - - public CompanyProfileResponseAccount() { - } - - public CompanyProfileResponseAccount rootOrgId(@javax.annotation.Nullable String rootOrgId) { - this.rootOrgId = rootOrgId; - return this; - } - - /** - * Get rootOrgId - * @return rootOrgId - */ - @javax.annotation.Nullable - public String getRootOrgId() { - return rootOrgId; - } - - public void setRootOrgId(@javax.annotation.Nullable String rootOrgId) { - this.rootOrgId = rootOrgId; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the CompanyProfileResponseAccount instance itself - */ - public CompanyProfileResponseAccount putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CompanyProfileResponseAccount companyProfileResponseAccount = (CompanyProfileResponseAccount) o; - return Objects.equals(this.rootOrgId, companyProfileResponseAccount.rootOrgId)&& - Objects.equals(this.additionalProperties, companyProfileResponseAccount.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(rootOrgId, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CompanyProfileResponseAccount {\n"); - sb.append(" rootOrgId: ").append(toIndentedString(rootOrgId)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("rootOrgId")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to CompanyProfileResponseAccount - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!CompanyProfileResponseAccount.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in CompanyProfileResponseAccount is not found in the empty JSON string", CompanyProfileResponseAccount.openapiRequiredFields.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - if ((jsonObj.get("rootOrgId") != null && !jsonObj.get("rootOrgId").isJsonNull()) && !jsonObj.get("rootOrgId").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `rootOrgId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("rootOrgId").toString())); - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!CompanyProfileResponseAccount.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'CompanyProfileResponseAccount' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(CompanyProfileResponseAccount.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, CompanyProfileResponseAccount value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public CompanyProfileResponseAccount read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - CompanyProfileResponseAccount instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of CompanyProfileResponseAccount given an JSON string - * - * @param jsonString JSON string - * @return An instance of CompanyProfileResponseAccount - * @throws IOException if the JSON string is invalid with respect to CompanyProfileResponseAccount - */ - public static CompanyProfileResponseAccount fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, CompanyProfileResponseAccount.class); - } - - /** - * Convert an instance of CompanyProfileResponseAccount to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Connection.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Connection.java index 305adf7e..446be267 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Connection.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Connection.java @@ -20,7 +20,6 @@ import com.equinix.sdk.fabricv4.model.ConnectionRedundancy; import com.equinix.sdk.fabricv4.model.ConnectionSide; import com.equinix.sdk.fabricv4.model.ConnectionSideAdditionalInfo; -import com.equinix.sdk.fabricv4.model.ConnectionState; import com.equinix.sdk.fabricv4.model.ConnectionType; import com.equinix.sdk.fabricv4.model.GeoScopeType; import com.equinix.sdk.fabricv4.model.MarketplaceSubscription; @@ -93,11 +92,6 @@ public class Connection { @javax.annotation.Nullable private String description; - public static final String SERIALIZED_NAME_STATE = "state"; - @SerializedName(SERIALIZED_NAME_STATE) - @javax.annotation.Nullable - private ConnectionState state; - public static final String SERIALIZED_NAME_CHANGE = "change"; @SerializedName(SERIALIZED_NAME_CHANGE) @javax.annotation.Nullable @@ -275,25 +269,6 @@ public void setDescription(@javax.annotation.Nullable String description) { } - public Connection state(@javax.annotation.Nullable ConnectionState state) { - this.state = state; - return this; - } - - /** - * Get state - * @return state - */ - @javax.annotation.Nullable - public ConnectionState getState() { - return state; - } - - public void setState(@javax.annotation.Nullable ConnectionState state) { - this.state = state; - } - - public Connection change(@javax.annotation.Nullable Change change) { this.change = change; return this; @@ -675,7 +650,6 @@ public boolean equals(Object o) { Objects.equals(this.uuid, connection.uuid) && Objects.equals(this.name, connection.name) && Objects.equals(this.description, connection.description) && - Objects.equals(this.state, connection.state) && Objects.equals(this.change, connection.change) && Objects.equals(this.operation, connection.operation) && Objects.equals(this.order, connection.order) && @@ -697,7 +671,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(href, type, uuid, name, description, state, change, operation, order, notifications, account, changeLog, bandwidth, geoScope, redundancy, isRemote, direction, aSide, zSide, marketplaceSubscription, additionalInfo, project, additionalProperties); + return Objects.hash(href, type, uuid, name, description, change, operation, order, notifications, account, changeLog, bandwidth, geoScope, redundancy, isRemote, direction, aSide, zSide, marketplaceSubscription, additionalInfo, project, additionalProperties); } @Override @@ -709,7 +683,6 @@ public String toString() { sb.append(" uuid: ").append(toIndentedString(uuid)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" state: ").append(toIndentedString(state)).append("\n"); sb.append(" change: ").append(toIndentedString(change)).append("\n"); sb.append(" operation: ").append(toIndentedString(operation)).append("\n"); sb.append(" order: ").append(toIndentedString(order)).append("\n"); @@ -748,7 +721,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("href", "type", "uuid", "name", "description", "state", "change", "operation", "order", "notifications", "account", "changeLog", "bandwidth", "geoScope", "redundancy", "isRemote", "direction", "aSide", "zSide", "marketplaceSubscription", "additionalInfo", "project")); + openapiFields = new HashSet(Arrays.asList("href", "type", "uuid", "name", "description", "change", "operation", "order", "notifications", "account", "changeLog", "bandwidth", "geoScope", "redundancy", "isRemote", "direction", "aSide", "zSide", "marketplaceSubscription", "additionalInfo", "project")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(Arrays.asList("type", "name", "bandwidth", "aSide", "zSide")); @@ -788,10 +761,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("description") != null && !jsonObj.get("description").isJsonNull()) && !jsonObj.get("description").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `description` to be a primitive type in the JSON string but got `%s`", jsonObj.get("description").toString())); } - // validate the optional field `state` - if (jsonObj.get("state") != null && !jsonObj.get("state").isJsonNull()) { - ConnectionState.validateJsonElement(jsonObj.get("state")); - } // validate the optional field `change` if (jsonObj.get("change") != null && !jsonObj.get("change").isJsonNull()) { Change.validateJsonElement(jsonObj.get("change")); diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ConnectionChangeOperation.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ConnectionChangeOperation.java index 389b8f6b..b6c3318a 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ConnectionChangeOperation.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ConnectionChangeOperation.java @@ -62,8 +62,8 @@ public class ConnectionChangeOperation { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public ConnectionChangeOperation() { } @@ -106,7 +106,7 @@ public void setPath(@javax.annotation.Nonnull String path) { } - public ConnectionChangeOperation value(@javax.annotation.Nonnull Object value) { + public ConnectionChangeOperation value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -115,12 +115,12 @@ public ConnectionChangeOperation value(@javax.annotation.Nonnull Object value) { * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ConnectionInvitation.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ConnectionInvitation.java deleted file mode 100644 index 2d2d87f3..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ConnectionInvitation.java +++ /dev/null @@ -1,344 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.Arrays; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * Connection Invitation Details - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class ConnectionInvitation { - public static final String SERIALIZED_NAME_EMAIL = "email"; - @SerializedName(SERIALIZED_NAME_EMAIL) - @javax.annotation.Nullable - private String email; - - public static final String SERIALIZED_NAME_MESSAGE = "message"; - @SerializedName(SERIALIZED_NAME_MESSAGE) - @javax.annotation.Nullable - private String message; - - public static final String SERIALIZED_NAME_CTR_DRAFT_ORDER_ID = "ctrDraftOrderId"; - @SerializedName(SERIALIZED_NAME_CTR_DRAFT_ORDER_ID) - @javax.annotation.Nullable - private String ctrDraftOrderId; - - public ConnectionInvitation() { - } - - public ConnectionInvitation email(@javax.annotation.Nullable String email) { - this.email = email; - return this; - } - - /** - * invitee email - * @return email - */ - @javax.annotation.Nullable - public String getEmail() { - return email; - } - - public void setEmail(@javax.annotation.Nullable String email) { - this.email = email; - } - - - public ConnectionInvitation message(@javax.annotation.Nullable String message) { - this.message = message; - return this; - } - - /** - * invitation message - * @return message - */ - @javax.annotation.Nullable - public String getMessage() { - return message; - } - - public void setMessage(@javax.annotation.Nullable String message) { - this.message = message; - } - - - public ConnectionInvitation ctrDraftOrderId(@javax.annotation.Nullable String ctrDraftOrderId) { - this.ctrDraftOrderId = ctrDraftOrderId; - return this; - } - - /** - * draft order id for invitation - * @return ctrDraftOrderId - */ - @javax.annotation.Nullable - public String getCtrDraftOrderId() { - return ctrDraftOrderId; - } - - public void setCtrDraftOrderId(@javax.annotation.Nullable String ctrDraftOrderId) { - this.ctrDraftOrderId = ctrDraftOrderId; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the ConnectionInvitation instance itself - */ - public ConnectionInvitation putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ConnectionInvitation connectionInvitation = (ConnectionInvitation) o; - return Objects.equals(this.email, connectionInvitation.email) && - Objects.equals(this.message, connectionInvitation.message) && - Objects.equals(this.ctrDraftOrderId, connectionInvitation.ctrDraftOrderId)&& - Objects.equals(this.additionalProperties, connectionInvitation.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(email, message, ctrDraftOrderId, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ConnectionInvitation {\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append(" ctrDraftOrderId: ").append(toIndentedString(ctrDraftOrderId)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("email", "message", "ctrDraftOrderId")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to ConnectionInvitation - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!ConnectionInvitation.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in ConnectionInvitation is not found in the empty JSON string", ConnectionInvitation.openapiRequiredFields.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - if ((jsonObj.get("email") != null && !jsonObj.get("email").isJsonNull()) && !jsonObj.get("email").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `email` to be a primitive type in the JSON string but got `%s`", jsonObj.get("email").toString())); - } - if ((jsonObj.get("message") != null && !jsonObj.get("message").isJsonNull()) && !jsonObj.get("message").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `message` to be a primitive type in the JSON string but got `%s`", jsonObj.get("message").toString())); - } - if ((jsonObj.get("ctrDraftOrderId") != null && !jsonObj.get("ctrDraftOrderId").isJsonNull()) && !jsonObj.get("ctrDraftOrderId").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `ctrDraftOrderId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("ctrDraftOrderId").toString())); - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!ConnectionInvitation.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'ConnectionInvitation' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(ConnectionInvitation.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, ConnectionInvitation value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public ConnectionInvitation read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - ConnectionInvitation instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of ConnectionInvitation given an JSON string - * - * @param jsonString JSON string - * @return An instance of ConnectionInvitation - * @throws IOException if the JSON string is invalid with respect to ConnectionInvitation - */ - public static ConnectionInvitation fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, ConnectionInvitation.class); - } - - /** - * Convert an instance of ConnectionInvitation to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ConnectionPostRequest.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ConnectionPostRequest.java index 39256c96..de779b14 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ConnectionPostRequest.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ConnectionPostRequest.java @@ -17,7 +17,6 @@ import com.equinix.sdk.fabricv4.model.ConnectionSide; import com.equinix.sdk.fabricv4.model.ConnectionSideAdditionalInfo; import com.equinix.sdk.fabricv4.model.ConnectionType; -import com.equinix.sdk.fabricv4.model.EndCustomer; import com.equinix.sdk.fabricv4.model.GeoScopeType; import com.equinix.sdk.fabricv4.model.MarketplaceSubscription; import com.equinix.sdk.fabricv4.model.Order; @@ -122,11 +121,6 @@ public class ConnectionPostRequest { @javax.annotation.Nullable private MarketplaceSubscription marketplaceSubscription; - public static final String SERIALIZED_NAME_END_CUSTOMER = "endCustomer"; - @SerializedName(SERIALIZED_NAME_END_CUSTOMER) - @javax.annotation.Nullable - private EndCustomer endCustomer; - public ConnectionPostRequest() { } @@ -375,25 +369,6 @@ public void setMarketplaceSubscription(@javax.annotation.Nullable MarketplaceSub this.marketplaceSubscription = marketplaceSubscription; } - - public ConnectionPostRequest endCustomer(@javax.annotation.Nullable EndCustomer endCustomer) { - this.endCustomer = endCustomer; - return this; - } - - /** - * Get endCustomer - * @return endCustomer - */ - @javax.annotation.Nullable - public EndCustomer getEndCustomer() { - return endCustomer; - } - - public void setEndCustomer(@javax.annotation.Nullable EndCustomer endCustomer) { - this.endCustomer = endCustomer; - } - /** * A container for additional, undeclared properties. * This is a holder for any undeclared properties as specified with @@ -460,14 +435,13 @@ public boolean equals(Object o) { Objects.equals(this.zSide, connectionPostRequest.zSide) && Objects.equals(this.project, connectionPostRequest.project) && Objects.equals(this.additionalInfo, connectionPostRequest.additionalInfo) && - Objects.equals(this.marketplaceSubscription, connectionPostRequest.marketplaceSubscription) && - Objects.equals(this.endCustomer, connectionPostRequest.endCustomer)&& + Objects.equals(this.marketplaceSubscription, connectionPostRequest.marketplaceSubscription)&& Objects.equals(this.additionalProperties, connectionPostRequest.additionalProperties); } @Override public int hashCode() { - return Objects.hash(type, name, order, notifications, bandwidth, geoScope, redundancy, aSide, zSide, project, additionalInfo, marketplaceSubscription, endCustomer, additionalProperties); + return Objects.hash(type, name, order, notifications, bandwidth, geoScope, redundancy, aSide, zSide, project, additionalInfo, marketplaceSubscription, additionalProperties); } @Override @@ -486,7 +460,6 @@ public String toString() { sb.append(" project: ").append(toIndentedString(project)).append("\n"); sb.append(" additionalInfo: ").append(toIndentedString(additionalInfo)).append("\n"); sb.append(" marketplaceSubscription: ").append(toIndentedString(marketplaceSubscription)).append("\n"); - sb.append(" endCustomer: ").append(toIndentedString(endCustomer)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -509,7 +482,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("type", "name", "order", "notifications", "bandwidth", "geoScope", "redundancy", "aSide", "zSide", "project", "additionalInfo", "marketplaceSubscription", "endCustomer")); + openapiFields = new HashSet(Arrays.asList("type", "name", "order", "notifications", "bandwidth", "geoScope", "redundancy", "aSide", "zSide", "project", "additionalInfo", "marketplaceSubscription")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(Arrays.asList("type", "name", "notifications", "bandwidth", "aSide", "zSide")); @@ -588,10 +561,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if (jsonObj.get("marketplaceSubscription") != null && !jsonObj.get("marketplaceSubscription").isJsonNull()) { MarketplaceSubscription.validateJsonElement(jsonObj.get("marketplaceSubscription")); } - // validate the optional field `endCustomer` - if (jsonObj.get("endCustomer") != null && !jsonObj.get("endCustomer").isJsonNull()) { - EndCustomer.validateJsonElement(jsonObj.get("endCustomer")); - } } public static class CustomTypeAdapterFactory implements TypeAdapterFactory { diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectASideRequestDemarcationPoint.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CreateAsnRequest.java similarity index 53% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectASideRequestDemarcationPoint.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CreateAsnRequest.java index 80c84ce7..775048b9 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectASideRequestDemarcationPoint.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CreateAsnRequest.java @@ -13,6 +13,11 @@ import java.util.Objects; import java.util.Locale; +import com.equinix.sdk.fabricv4.model.AsnOwnershipChallengeDetails; +import com.equinix.sdk.fabricv4.model.AsnRange; +import com.equinix.sdk.fabricv4.model.AsnRirRegion; +import com.equinix.sdk.fabricv4.model.Project; +import com.equinix.sdk.fabricv4.model.SimplifiedLocation; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -46,106 +51,154 @@ import com.equinix.sdk.fabricv4.JSON; /** - * CrossConnectASideRequestDemarcationPoint + * Create ASN request body */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class CrossConnectASideRequestDemarcationPoint { - public static final String SERIALIZED_NAME_PATCH_PANEL_ID = "patchPanelId"; - @SerializedName(SERIALIZED_NAME_PATCH_PANEL_ID) +public class CreateAsnRequest { + public static final String SERIALIZED_NAME_PROJECT = "project"; + @SerializedName(SERIALIZED_NAME_PROJECT) @javax.annotation.Nonnull - private String patchPanelId; + private Project project; - public static final String SERIALIZED_NAME_PATCH_PANEL_PORT_A = "patchPanelPortA"; - @SerializedName(SERIALIZED_NAME_PATCH_PANEL_PORT_A) + public static final String SERIALIZED_NAME_NUMBER = "number"; + @SerializedName(SERIALIZED_NAME_NUMBER) @javax.annotation.Nullable - private Integer patchPanelPortA; + private Long number; - public static final String SERIALIZED_NAME_PATCH_PANEL_PORT_B = "patchPanelPortB"; - @SerializedName(SERIALIZED_NAME_PATCH_PANEL_PORT_B) + public static final String SERIALIZED_NAME_RIR_REGION = "rirRegion"; + @SerializedName(SERIALIZED_NAME_RIR_REGION) @javax.annotation.Nullable - private Integer patchPanelPortB; + private AsnRirRegion rirRegion; - public static final String SERIALIZED_NAME_CONNECTOR_TYPE = "connectorType"; - @SerializedName(SERIALIZED_NAME_CONNECTOR_TYPE) - @javax.annotation.Nonnull - private String connectorType; + public static final String SERIALIZED_NAME_OWNERSHIP_CHALLENGE_DETAILS = "ownershipChallengeDetails"; + @SerializedName(SERIALIZED_NAME_OWNERSHIP_CHALLENGE_DETAILS) + @javax.annotation.Nullable + private AsnOwnershipChallengeDetails ownershipChallengeDetails; + + public static final String SERIALIZED_NAME_LOCATION = "location"; + @SerializedName(SERIALIZED_NAME_LOCATION) + @javax.annotation.Nullable + private SimplifiedLocation location; - public CrossConnectASideRequestDemarcationPoint() { + public static final String SERIALIZED_NAME_RANGE = "range"; + @SerializedName(SERIALIZED_NAME_RANGE) + @javax.annotation.Nullable + private AsnRange range; + + public CreateAsnRequest() { } - public CrossConnectASideRequestDemarcationPoint patchPanelId(@javax.annotation.Nonnull String patchPanelId) { - this.patchPanelId = patchPanelId; + public CreateAsnRequest project(@javax.annotation.Nonnull Project project) { + this.project = project; return this; } /** - * Patch Panel Identifier. - * @return patchPanelId + * Get project + * @return project */ @javax.annotation.Nonnull - public String getPatchPanelId() { - return patchPanelId; + public Project getProject() { + return project; } - public void setPatchPanelId(@javax.annotation.Nonnull String patchPanelId) { - this.patchPanelId = patchPanelId; + public void setProject(@javax.annotation.Nonnull Project project) { + this.project = project; } - public CrossConnectASideRequestDemarcationPoint patchPanelPortA(@javax.annotation.Nullable Integer patchPanelPortA) { - this.patchPanelPortA = patchPanelPortA; + public CreateAsnRequest number(@javax.annotation.Nullable Long number) { + this.number = number; return this; } /** - * Specify the desired port number. When ports are not provided, next available ports will be used. - * @return patchPanelPortA + * ASN number used for public ASN creation. + * @return number */ @javax.annotation.Nullable - public Integer getPatchPanelPortA() { - return patchPanelPortA; + public Long getNumber() { + return number; } - public void setPatchPanelPortA(@javax.annotation.Nullable Integer patchPanelPortA) { - this.patchPanelPortA = patchPanelPortA; + public void setNumber(@javax.annotation.Nullable Long number) { + this.number = number; } - public CrossConnectASideRequestDemarcationPoint patchPanelPortB(@javax.annotation.Nullable Integer patchPanelPortB) { - this.patchPanelPortB = patchPanelPortB; + public CreateAsnRequest rirRegion(@javax.annotation.Nullable AsnRirRegion rirRegion) { + this.rirRegion = rirRegion; return this; } /** - * Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only. - * @return patchPanelPortB + * Get rirRegion + * @return rirRegion */ @javax.annotation.Nullable - public Integer getPatchPanelPortB() { - return patchPanelPortB; + public AsnRirRegion getRirRegion() { + return rirRegion; } - public void setPatchPanelPortB(@javax.annotation.Nullable Integer patchPanelPortB) { - this.patchPanelPortB = patchPanelPortB; + public void setRirRegion(@javax.annotation.Nullable AsnRirRegion rirRegion) { + this.rirRegion = rirRegion; } - public CrossConnectASideRequestDemarcationPoint connectorType(@javax.annotation.Nonnull String connectorType) { - this.connectorType = connectorType; + public CreateAsnRequest ownershipChallengeDetails(@javax.annotation.Nullable AsnOwnershipChallengeDetails ownershipChallengeDetails) { + this.ownershipChallengeDetails = ownershipChallengeDetails; return this; } /** - * Connector Type. - * @return connectorType + * Get ownershipChallengeDetails + * @return ownershipChallengeDetails */ - @javax.annotation.Nonnull - public String getConnectorType() { - return connectorType; + @javax.annotation.Nullable + public AsnOwnershipChallengeDetails getOwnershipChallengeDetails() { + return ownershipChallengeDetails; + } + + public void setOwnershipChallengeDetails(@javax.annotation.Nullable AsnOwnershipChallengeDetails ownershipChallengeDetails) { + this.ownershipChallengeDetails = ownershipChallengeDetails; + } + + + public CreateAsnRequest location(@javax.annotation.Nullable SimplifiedLocation location) { + this.location = location; + return this; + } + + /** + * Get location + * @return location + */ + @javax.annotation.Nullable + public SimplifiedLocation getLocation() { + return location; + } + + public void setLocation(@javax.annotation.Nullable SimplifiedLocation location) { + this.location = location; + } + + + public CreateAsnRequest range(@javax.annotation.Nullable AsnRange range) { + this.range = range; + return this; + } + + /** + * Get range + * @return range + */ + @javax.annotation.Nullable + public AsnRange getRange() { + return range; } - public void setConnectorType(@javax.annotation.Nonnull String connectorType) { - this.connectorType = connectorType; + public void setRange(@javax.annotation.Nullable AsnRange range) { + this.range = range; } /** @@ -161,9 +214,9 @@ public void setConnectorType(@javax.annotation.Nonnull String connectorType) { * * @param key name of the property * @param value value of the property - * @return the CrossConnectASideRequestDemarcationPoint instance itself + * @return the CreateAsnRequest instance itself */ - public CrossConnectASideRequestDemarcationPoint putAdditionalProperty(String key, Object value) { + public CreateAsnRequest putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -202,27 +255,31 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - CrossConnectASideRequestDemarcationPoint crossConnectASideRequestDemarcationPoint = (CrossConnectASideRequestDemarcationPoint) o; - return Objects.equals(this.patchPanelId, crossConnectASideRequestDemarcationPoint.patchPanelId) && - Objects.equals(this.patchPanelPortA, crossConnectASideRequestDemarcationPoint.patchPanelPortA) && - Objects.equals(this.patchPanelPortB, crossConnectASideRequestDemarcationPoint.patchPanelPortB) && - Objects.equals(this.connectorType, crossConnectASideRequestDemarcationPoint.connectorType)&& - Objects.equals(this.additionalProperties, crossConnectASideRequestDemarcationPoint.additionalProperties); + CreateAsnRequest createAsnRequest = (CreateAsnRequest) o; + return Objects.equals(this.project, createAsnRequest.project) && + Objects.equals(this.number, createAsnRequest.number) && + Objects.equals(this.rirRegion, createAsnRequest.rirRegion) && + Objects.equals(this.ownershipChallengeDetails, createAsnRequest.ownershipChallengeDetails) && + Objects.equals(this.location, createAsnRequest.location) && + Objects.equals(this.range, createAsnRequest.range)&& + Objects.equals(this.additionalProperties, createAsnRequest.additionalProperties); } @Override public int hashCode() { - return Objects.hash(patchPanelId, patchPanelPortA, patchPanelPortB, connectorType, additionalProperties); + return Objects.hash(project, number, rirRegion, ownershipChallengeDetails, location, range, additionalProperties); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class CrossConnectASideRequestDemarcationPoint {\n"); - sb.append(" patchPanelId: ").append(toIndentedString(patchPanelId)).append("\n"); - sb.append(" patchPanelPortA: ").append(toIndentedString(patchPanelPortA)).append("\n"); - sb.append(" patchPanelPortB: ").append(toIndentedString(patchPanelPortB)).append("\n"); - sb.append(" connectorType: ").append(toIndentedString(connectorType)).append("\n"); + sb.append("class CreateAsnRequest {\n"); + sb.append(" project: ").append(toIndentedString(project)).append("\n"); + sb.append(" number: ").append(toIndentedString(number)).append("\n"); + sb.append(" rirRegion: ").append(toIndentedString(rirRegion)).append("\n"); + sb.append(" ownershipChallengeDetails: ").append(toIndentedString(ownershipChallengeDetails)).append("\n"); + sb.append(" location: ").append(toIndentedString(location)).append("\n"); + sb.append(" range: ").append(toIndentedString(range)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); return sb.toString(); @@ -245,37 +302,49 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("patchPanelId", "patchPanelPortA", "patchPanelPortB", "connectorType")); + openapiFields = new HashSet(Arrays.asList("project", "number", "rirRegion", "ownershipChallengeDetails", "location", "range")); // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(Arrays.asList("patchPanelId", "connectorType")); + openapiRequiredFields = new HashSet(Arrays.asList("project")); } /** * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to CrossConnectASideRequestDemarcationPoint + * @throws IOException if the JSON Element is invalid with respect to CreateAsnRequest */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!CrossConnectASideRequestDemarcationPoint.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in CrossConnectASideRequestDemarcationPoint is not found in the empty JSON string", CrossConnectASideRequestDemarcationPoint.openapiRequiredFields.toString())); + if (!CreateAsnRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in CreateAsnRequest is not found in the empty JSON string", CreateAsnRequest.openapiRequiredFields.toString())); } } // check to make sure all required properties/fields are present in the JSON string - for (String requiredField : CrossConnectASideRequestDemarcationPoint.openapiRequiredFields) { + for (String requiredField : CreateAsnRequest.openapiRequiredFields) { if (jsonElement.getAsJsonObject().get(requiredField) == null) { throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); - if (!jsonObj.get("patchPanelId").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `patchPanelId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("patchPanelId").toString())); + // validate the required field `project` + Project.validateJsonElement(jsonObj.get("project")); + // validate the optional field `rirRegion` + if (jsonObj.get("rirRegion") != null && !jsonObj.get("rirRegion").isJsonNull()) { + AsnRirRegion.validateJsonElement(jsonObj.get("rirRegion")); + } + // validate the optional field `ownershipChallengeDetails` + if (jsonObj.get("ownershipChallengeDetails") != null && !jsonObj.get("ownershipChallengeDetails").isJsonNull()) { + AsnOwnershipChallengeDetails.validateJsonElement(jsonObj.get("ownershipChallengeDetails")); + } + // validate the optional field `location` + if (jsonObj.get("location") != null && !jsonObj.get("location").isJsonNull()) { + SimplifiedLocation.validateJsonElement(jsonObj.get("location")); } - if (!jsonObj.get("connectorType").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `connectorType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("connectorType").toString())); + // validate the optional field `range` + if (jsonObj.get("range") != null && !jsonObj.get("range").isJsonNull()) { + AsnRange.validateJsonElement(jsonObj.get("range")); } } @@ -283,16 +352,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!CrossConnectASideRequestDemarcationPoint.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'CrossConnectASideRequestDemarcationPoint' and its subtypes + if (!CreateAsnRequest.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'CreateAsnRequest' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(CrossConnectASideRequestDemarcationPoint.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(CreateAsnRequest.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, CrossConnectASideRequestDemarcationPoint value) throws IOException { + public void write(JsonWriter out, CreateAsnRequest value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -320,12 +389,12 @@ else if (entry.getValue() instanceof Character) } @Override - public CrossConnectASideRequestDemarcationPoint read(JsonReader in) throws IOException { + public CreateAsnRequest read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - CrossConnectASideRequestDemarcationPoint instance = thisAdapter.fromJsonTree(jsonObj); + CreateAsnRequest instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -352,18 +421,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of CrossConnectASideRequestDemarcationPoint given an JSON string + * Create an instance of CreateAsnRequest given an JSON string * * @param jsonString JSON string - * @return An instance of CrossConnectASideRequestDemarcationPoint - * @throws IOException if the JSON string is invalid with respect to CrossConnectASideRequestDemarcationPoint + * @return An instance of CreateAsnRequest + * @throws IOException if the JSON string is invalid with respect to CreateAsnRequest */ - public static CrossConnectASideRequestDemarcationPoint fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, CrossConnectASideRequestDemarcationPoint.class); + public static CreateAsnRequest fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, CreateAsnRequest.class); } /** - * Convert an instance of CrossConnectASideRequestDemarcationPoint to an JSON string + * Convert an instance of CreateAsnRequest to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectASideRequest.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectASideRequest.java index 67676da8..6409484d 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectASideRequest.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectASideRequest.java @@ -13,7 +13,7 @@ import java.util.Objects; import java.util.Locale; -import com.equinix.sdk.fabricv4.model.CrossConnectASideRequestDemarcationPoint; +import com.equinix.sdk.fabricv4.model.CrossConnectDemarcationPoint; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -54,12 +54,12 @@ public class CrossConnectASideRequest { public static final String SERIALIZED_NAME_DEMARCATION_POINT = "demarcationPoint"; @SerializedName(SERIALIZED_NAME_DEMARCATION_POINT) @javax.annotation.Nullable - private CrossConnectASideRequestDemarcationPoint demarcationPoint; + private CrossConnectDemarcationPoint demarcationPoint; public CrossConnectASideRequest() { } - public CrossConnectASideRequest demarcationPoint(@javax.annotation.Nullable CrossConnectASideRequestDemarcationPoint demarcationPoint) { + public CrossConnectASideRequest demarcationPoint(@javax.annotation.Nullable CrossConnectDemarcationPoint demarcationPoint) { this.demarcationPoint = demarcationPoint; return this; } @@ -69,11 +69,11 @@ public CrossConnectASideRequest demarcationPoint(@javax.annotation.Nullable Cros * @return demarcationPoint */ @javax.annotation.Nullable - public CrossConnectASideRequestDemarcationPoint getDemarcationPoint() { + public CrossConnectDemarcationPoint getDemarcationPoint() { return demarcationPoint; } - public void setDemarcationPoint(@javax.annotation.Nullable CrossConnectASideRequestDemarcationPoint demarcationPoint) { + public void setDemarcationPoint(@javax.annotation.Nullable CrossConnectDemarcationPoint demarcationPoint) { this.demarcationPoint = demarcationPoint; } @@ -189,7 +189,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti JsonObject jsonObj = jsonElement.getAsJsonObject(); // validate the optional field `demarcationPoint` if (jsonObj.get("demarcationPoint") != null && !jsonObj.get("demarcationPoint").isJsonNull()) { - CrossConnectASideRequestDemarcationPoint.validateJsonElement(jsonObj.get("demarcationPoint")); + CrossConnectDemarcationPoint.validateJsonElement(jsonObj.get("demarcationPoint")); } } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectEndCustomer.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectEndCustomer.java deleted file mode 100644 index 39903d80..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectEndCustomer.java +++ /dev/null @@ -1,341 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.Arrays; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * End customer details for the Cross Connect. - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class CrossConnectEndCustomer { - public static final String SERIALIZED_NAME_IS_DISCLOSED = "isDisclosed"; - @SerializedName(SERIALIZED_NAME_IS_DISCLOSED) - @javax.annotation.Nullable - private Boolean isDisclosed; - - public static final String SERIALIZED_NAME_NAME = "name"; - @SerializedName(SERIALIZED_NAME_NAME) - @javax.annotation.Nullable - private String name; - - public static final String SERIALIZED_NAME_MDM_ID = "mdmId"; - @SerializedName(SERIALIZED_NAME_MDM_ID) - @javax.annotation.Nullable - private String mdmId; - - public CrossConnectEndCustomer() { - } - - public CrossConnectEndCustomer isDisclosed(@javax.annotation.Nullable Boolean isDisclosed) { - this.isDisclosed = isDisclosed; - return this; - } - - /** - * Indicates if the end customer is disclosed. - * @return isDisclosed - */ - @javax.annotation.Nullable - public Boolean getIsDisclosed() { - return isDisclosed; - } - - public void setIsDisclosed(@javax.annotation.Nullable Boolean isDisclosed) { - this.isDisclosed = isDisclosed; - } - - - public CrossConnectEndCustomer name(@javax.annotation.Nullable String name) { - this.name = name; - return this; - } - - /** - * End customer name. - * @return name - */ - @javax.annotation.Nullable - public String getName() { - return name; - } - - public void setName(@javax.annotation.Nullable String name) { - this.name = name; - } - - - public CrossConnectEndCustomer mdmId(@javax.annotation.Nullable String mdmId) { - this.mdmId = mdmId; - return this; - } - - /** - * Master Data Management identifier of the end customer, as held by Equinix. - * @return mdmId - */ - @javax.annotation.Nullable - public String getMdmId() { - return mdmId; - } - - public void setMdmId(@javax.annotation.Nullable String mdmId) { - this.mdmId = mdmId; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the CrossConnectEndCustomer instance itself - */ - public CrossConnectEndCustomer putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CrossConnectEndCustomer crossConnectEndCustomer = (CrossConnectEndCustomer) o; - return Objects.equals(this.isDisclosed, crossConnectEndCustomer.isDisclosed) && - Objects.equals(this.name, crossConnectEndCustomer.name) && - Objects.equals(this.mdmId, crossConnectEndCustomer.mdmId)&& - Objects.equals(this.additionalProperties, crossConnectEndCustomer.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(isDisclosed, name, mdmId, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CrossConnectEndCustomer {\n"); - sb.append(" isDisclosed: ").append(toIndentedString(isDisclosed)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" mdmId: ").append(toIndentedString(mdmId)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("isDisclosed", "name", "mdmId")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to CrossConnectEndCustomer - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!CrossConnectEndCustomer.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in CrossConnectEndCustomer is not found in the empty JSON string", CrossConnectEndCustomer.openapiRequiredFields.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - if ((jsonObj.get("name") != null && !jsonObj.get("name").isJsonNull()) && !jsonObj.get("name").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `name` to be a primitive type in the JSON string but got `%s`", jsonObj.get("name").toString())); - } - if ((jsonObj.get("mdmId") != null && !jsonObj.get("mdmId").isJsonNull()) && !jsonObj.get("mdmId").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `mdmId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("mdmId").toString())); - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!CrossConnectEndCustomer.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'CrossConnectEndCustomer' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(CrossConnectEndCustomer.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, CrossConnectEndCustomer value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public CrossConnectEndCustomer read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - CrossConnectEndCustomer instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of CrossConnectEndCustomer given an JSON string - * - * @param jsonString JSON string - * @return An instance of CrossConnectEndCustomer - * @throws IOException if the JSON string is invalid with respect to CrossConnectEndCustomer - */ - public static CrossConnectEndCustomer fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, CrossConnectEndCustomer.class); - } - - /** - * Convert an instance of CrossConnectEndCustomer to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectProject.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectProject.java deleted file mode 100644 index fc1937c2..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectProject.java +++ /dev/null @@ -1,294 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.Arrays; -import java.util.UUID; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * Cross Connect Project. - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class CrossConnectProject { - public static final String SERIALIZED_NAME_PROJECT_ID = "projectId"; - @SerializedName(SERIALIZED_NAME_PROJECT_ID) - @javax.annotation.Nonnull - private UUID projectId; - - public CrossConnectProject() { - } - - public CrossConnectProject projectId(@javax.annotation.Nonnull UUID projectId) { - this.projectId = projectId; - return this; - } - - /** - * Project Identifier. - * @return projectId - */ - @javax.annotation.Nonnull - public UUID getProjectId() { - return projectId; - } - - public void setProjectId(@javax.annotation.Nonnull UUID projectId) { - this.projectId = projectId; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the CrossConnectProject instance itself - */ - public CrossConnectProject putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CrossConnectProject crossConnectProject = (CrossConnectProject) o; - return Objects.equals(this.projectId, crossConnectProject.projectId)&& - Objects.equals(this.additionalProperties, crossConnectProject.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(projectId, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CrossConnectProject {\n"); - sb.append(" projectId: ").append(toIndentedString(projectId)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("projectId")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(Arrays.asList("projectId")); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to CrossConnectProject - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!CrossConnectProject.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in CrossConnectProject is not found in the empty JSON string", CrossConnectProject.openapiRequiredFields.toString())); - } - } - - // check to make sure all required properties/fields are present in the JSON string - for (String requiredField : CrossConnectProject.openapiRequiredFields) { - if (jsonElement.getAsJsonObject().get(requiredField) == null) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - if (!jsonObj.get("projectId").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `projectId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("projectId").toString())); - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!CrossConnectProject.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'CrossConnectProject' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(CrossConnectProject.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, CrossConnectProject value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public CrossConnectProject read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - CrossConnectProject instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of CrossConnectProject given an JSON string - * - * @param jsonString JSON string - * @return An instance of CrossConnectProject - * @throws IOException if the JSON string is invalid with respect to CrossConnectProject - */ - public static CrossConnectProject fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, CrossConnectProject.class); - } - - /** - * Convert an instance of CrossConnectProject to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectProvider.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectProvider.java deleted file mode 100644 index adf46267..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectProvider.java +++ /dev/null @@ -1,286 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.Arrays; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * Provider at the Z-Side. - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class CrossConnectProvider { - public static final String SERIALIZED_NAME_NAME = "name"; - @SerializedName(SERIALIZED_NAME_NAME) - @javax.annotation.Nullable - private String name; - - public CrossConnectProvider() { - } - - public CrossConnectProvider name(@javax.annotation.Nullable String name) { - this.name = name; - return this; - } - - /** - * Name of the provider at the Z-Side. - * @return name - */ - @javax.annotation.Nullable - public String getName() { - return name; - } - - public void setName(@javax.annotation.Nullable String name) { - this.name = name; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the CrossConnectProvider instance itself - */ - public CrossConnectProvider putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CrossConnectProvider crossConnectProvider = (CrossConnectProvider) o; - return Objects.equals(this.name, crossConnectProvider.name)&& - Objects.equals(this.additionalProperties, crossConnectProvider.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(name, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CrossConnectProvider {\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("name")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to CrossConnectProvider - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!CrossConnectProvider.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in CrossConnectProvider is not found in the empty JSON string", CrossConnectProvider.openapiRequiredFields.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - if ((jsonObj.get("name") != null && !jsonObj.get("name").isJsonNull()) && !jsonObj.get("name").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `name` to be a primitive type in the JSON string but got `%s`", jsonObj.get("name").toString())); - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!CrossConnectProvider.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'CrossConnectProvider' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(CrossConnectProvider.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, CrossConnectProvider value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public CrossConnectProvider read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - CrossConnectProvider instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of CrossConnectProvider given an JSON string - * - * @param jsonString JSON string - * @return An instance of CrossConnectProvider - * @throws IOException if the JSON string is invalid with respect to CrossConnectProvider - */ - public static CrossConnectProvider fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, CrossConnectProvider.class); - } - - /** - * Convert an instance of CrossConnectProvider to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectResponse.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectResponse.java index bd2c1597..fc72b6df 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectResponse.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectResponse.java @@ -20,7 +20,7 @@ import com.equinix.sdk.fabricv4.model.CrossConnectLink; import com.equinix.sdk.fabricv4.model.CrossConnectNotification; import com.equinix.sdk.fabricv4.model.CrossConnectRedundancy; -import com.equinix.sdk.fabricv4.model.CrossConnectResponseAllowedActions; +import com.equinix.sdk.fabricv4.model.CrossConnectResponseAllowedActionsInner; import com.equinix.sdk.fabricv4.model.CrossConnectState; import com.equinix.sdk.fabricv4.model.CrossConnectType; import com.equinix.sdk.fabricv4.model.CrossConnectZSideResponse; @@ -94,7 +94,7 @@ public class CrossConnectResponse { public static final String SERIALIZED_NAME_ALLOWED_ACTIONS = "allowedActions"; @SerializedName(SERIALIZED_NAME_ALLOWED_ACTIONS) @javax.annotation.Nullable - private List allowedActions = new ArrayList<>(); + private List allowedActions = new ArrayList<>(); public static final String SERIALIZED_NAME_BMMR_TYPE = "bmmrType"; @SerializedName(SERIALIZED_NAME_BMMR_TYPE) @@ -165,7 +165,7 @@ public CrossConnectResponse() { } public CrossConnectResponse( - List allowedActions, + List allowedActions, String serialNumber, List links ) { @@ -275,7 +275,7 @@ public void setState(@javax.annotation.Nullable CrossConnectState state) { * @return allowedActions */ @javax.annotation.Nullable - public List getAllowedActions() { + public List getAllowedActions() { return allowedActions; } @@ -692,7 +692,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti // validate the optional field `allowedActions` (array) for (int i = 0; i < jsonArrayallowedActions.size(); i++) { - CrossConnectResponseAllowedActions.validateJsonElement(jsonArrayallowedActions.get(i)); + CrossConnectResponseAllowedActionsInner.validateJsonElement(jsonArrayallowedActions.get(i)); }; } } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectResponseAllowedActions.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectResponseAllowedActionsInner.java similarity index 82% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectResponseAllowedActions.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectResponseAllowedActionsInner.java index f530df43..e4ceaa0e 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectResponseAllowedActions.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/CrossConnectResponseAllowedActionsInner.java @@ -47,19 +47,19 @@ import com.equinix.sdk.fabricv4.JSON; /** - * CrossConnectResponseAllowedActions + * CrossConnectResponseAllowedActionsInner */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class CrossConnectResponseAllowedActions { +public class CrossConnectResponseAllowedActionsInner { public static final String SERIALIZED_NAME_TYPE = "type"; @SerializedName(SERIALIZED_NAME_TYPE) @javax.annotation.Nullable private CrossConnectActionType type; - public CrossConnectResponseAllowedActions() { + public CrossConnectResponseAllowedActionsInner() { } - public CrossConnectResponseAllowedActions type(@javax.annotation.Nullable CrossConnectActionType type) { + public CrossConnectResponseAllowedActionsInner type(@javax.annotation.Nullable CrossConnectActionType type) { this.type = type; return this; } @@ -90,9 +90,9 @@ public void setType(@javax.annotation.Nullable CrossConnectActionType type) { * * @param key name of the property * @param value value of the property - * @return the CrossConnectResponseAllowedActions instance itself + * @return the CrossConnectResponseAllowedActionsInner instance itself */ - public CrossConnectResponseAllowedActions putAdditionalProperty(String key, Object value) { + public CrossConnectResponseAllowedActionsInner putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -131,9 +131,9 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - CrossConnectResponseAllowedActions crossConnectResponseAllowedActions = (CrossConnectResponseAllowedActions) o; - return Objects.equals(this.type, crossConnectResponseAllowedActions.type)&& - Objects.equals(this.additionalProperties, crossConnectResponseAllowedActions.additionalProperties); + CrossConnectResponseAllowedActionsInner crossConnectResponseAllowedActionsInner = (CrossConnectResponseAllowedActionsInner) o; + return Objects.equals(this.type, crossConnectResponseAllowedActionsInner.type)&& + Objects.equals(this.additionalProperties, crossConnectResponseAllowedActionsInner.additionalProperties); } @Override @@ -144,7 +144,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class CrossConnectResponseAllowedActions {\n"); + sb.append("class CrossConnectResponseAllowedActionsInner {\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); @@ -178,12 +178,12 @@ private String toIndentedString(Object o) { * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to CrossConnectResponseAllowedActions + * @throws IOException if the JSON Element is invalid with respect to CrossConnectResponseAllowedActionsInner */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!CrossConnectResponseAllowedActions.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in CrossConnectResponseAllowedActions is not found in the empty JSON string", CrossConnectResponseAllowedActions.openapiRequiredFields.toString())); + if (!CrossConnectResponseAllowedActionsInner.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in CrossConnectResponseAllowedActionsInner is not found in the empty JSON string", CrossConnectResponseAllowedActionsInner.openapiRequiredFields.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); @@ -197,16 +197,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!CrossConnectResponseAllowedActions.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'CrossConnectResponseAllowedActions' and its subtypes + if (!CrossConnectResponseAllowedActionsInner.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'CrossConnectResponseAllowedActionsInner' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(CrossConnectResponseAllowedActions.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(CrossConnectResponseAllowedActionsInner.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, CrossConnectResponseAllowedActions value) throws IOException { + public void write(JsonWriter out, CrossConnectResponseAllowedActionsInner value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -234,12 +234,12 @@ else if (entry.getValue() instanceof Character) } @Override - public CrossConnectResponseAllowedActions read(JsonReader in) throws IOException { + public CrossConnectResponseAllowedActionsInner read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - CrossConnectResponseAllowedActions instance = thisAdapter.fromJsonTree(jsonObj); + CrossConnectResponseAllowedActionsInner instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -266,18 +266,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of CrossConnectResponseAllowedActions given an JSON string + * Create an instance of CrossConnectResponseAllowedActionsInner given an JSON string * * @param jsonString JSON string - * @return An instance of CrossConnectResponseAllowedActions - * @throws IOException if the JSON string is invalid with respect to CrossConnectResponseAllowedActions + * @return An instance of CrossConnectResponseAllowedActionsInner + * @throws IOException if the JSON string is invalid with respect to CrossConnectResponseAllowedActionsInner */ - public static CrossConnectResponseAllowedActions fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, CrossConnectResponseAllowedActions.class); + public static CrossConnectResponseAllowedActionsInner fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, CrossConnectResponseAllowedActionsInner.class); } /** - * Convert an instance of CrossConnectResponseAllowedActions to an JSON string + * Convert an instance of CrossConnectResponseAllowedActionsInner to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/DeleteCrossConnect.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/DeleteCrossConnect.java deleted file mode 100644 index ff6c3990..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/DeleteCrossConnect.java +++ /dev/null @@ -1,375 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.equinix.sdk.fabricv4.model.CrossConnectNotification; -import com.equinix.sdk.fabricv4.model.DeinstallScheduleRequest; -import com.equinix.sdk.fabricv4.model.OrderRequest; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * Delete Cross Connect request. Carries the removal schedule together with the notification and order details to apply to the removal order. - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class DeleteCrossConnect { - public static final String SERIALIZED_NAME_SCHEDULE = "schedule"; - @SerializedName(SERIALIZED_NAME_SCHEDULE) - @javax.annotation.Nonnull - private DeinstallScheduleRequest schedule; - - public static final String SERIALIZED_NAME_NOTIFICATIONS = "notifications"; - @SerializedName(SERIALIZED_NAME_NOTIFICATIONS) - @javax.annotation.Nullable - private List notifications = new ArrayList<>(); - - public static final String SERIALIZED_NAME_ORDER = "order"; - @SerializedName(SERIALIZED_NAME_ORDER) - @javax.annotation.Nullable - private OrderRequest order; - - public DeleteCrossConnect() { - } - - public DeleteCrossConnect schedule(@javax.annotation.Nonnull DeinstallScheduleRequest schedule) { - this.schedule = schedule; - return this; - } - - /** - * Removal schedule. The requestedDateTime is mandatory. Only the STANDARD schedule type is supported for a removal. - * @return schedule - */ - @javax.annotation.Nonnull - public DeinstallScheduleRequest getSchedule() { - return schedule; - } - - public void setSchedule(@javax.annotation.Nonnull DeinstallScheduleRequest schedule) { - this.schedule = schedule; - } - - - public DeleteCrossConnect notifications(@javax.annotation.Nullable List notifications) { - this.notifications = notifications; - return this; - } - - public DeleteCrossConnect addNotificationsItem(CrossConnectNotification notificationsItem) { - if (this.notifications == null) { - this.notifications = new ArrayList<>(); - } - this.notifications.add(notificationsItem); - return this; - } - - /** - * Optional. The contacts are appended to the ones already held on the Cross Connect. - * @return notifications - */ - @javax.annotation.Nullable - public List getNotifications() { - return notifications; - } - - public void setNotifications(@javax.annotation.Nullable List notifications) { - this.notifications = notifications; - } - - - public DeleteCrossConnect order(@javax.annotation.Nullable OrderRequest order) { - this.order = order; - return this; - } - - /** - * Optional. The purchase order and the customer reference identifier replace the ones already held on the Cross Connect. - * @return order - */ - @javax.annotation.Nullable - public OrderRequest getOrder() { - return order; - } - - public void setOrder(@javax.annotation.Nullable OrderRequest order) { - this.order = order; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the DeleteCrossConnect instance itself - */ - public DeleteCrossConnect putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DeleteCrossConnect deleteCrossConnect = (DeleteCrossConnect) o; - return Objects.equals(this.schedule, deleteCrossConnect.schedule) && - Objects.equals(this.notifications, deleteCrossConnect.notifications) && - Objects.equals(this.order, deleteCrossConnect.order)&& - Objects.equals(this.additionalProperties, deleteCrossConnect.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(schedule, notifications, order, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DeleteCrossConnect {\n"); - sb.append(" schedule: ").append(toIndentedString(schedule)).append("\n"); - sb.append(" notifications: ").append(toIndentedString(notifications)).append("\n"); - sb.append(" order: ").append(toIndentedString(order)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("schedule", "notifications", "order")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(Arrays.asList("schedule")); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to DeleteCrossConnect - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!DeleteCrossConnect.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in DeleteCrossConnect is not found in the empty JSON string", DeleteCrossConnect.openapiRequiredFields.toString())); - } - } - - // check to make sure all required properties/fields are present in the JSON string - for (String requiredField : DeleteCrossConnect.openapiRequiredFields) { - if (jsonElement.getAsJsonObject().get(requiredField) == null) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // validate the required field `schedule` - DeinstallScheduleRequest.validateJsonElement(jsonObj.get("schedule")); - if (jsonObj.get("notifications") != null && !jsonObj.get("notifications").isJsonNull()) { - JsonArray jsonArraynotifications = jsonObj.getAsJsonArray("notifications"); - if (jsonArraynotifications != null) { - // ensure the json data is an array - if (!jsonObj.get("notifications").isJsonArray()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `notifications` to be an array in the JSON string but got `%s`", jsonObj.get("notifications").toString())); - } - - // validate the optional field `notifications` (array) - for (int i = 0; i < jsonArraynotifications.size(); i++) { - CrossConnectNotification.validateJsonElement(jsonArraynotifications.get(i)); - }; - } - } - // validate the optional field `order` - if (jsonObj.get("order") != null && !jsonObj.get("order").isJsonNull()) { - OrderRequest.validateJsonElement(jsonObj.get("order")); - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!DeleteCrossConnect.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'DeleteCrossConnect' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(DeleteCrossConnect.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, DeleteCrossConnect value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public DeleteCrossConnect read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - DeleteCrossConnect instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of DeleteCrossConnect given an JSON string - * - * @param jsonString JSON string - * @return An instance of DeleteCrossConnect - * @throws IOException if the JSON string is invalid with respect to DeleteCrossConnect - */ - public static DeleteCrossConnect fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, DeleteCrossConnect.class); - } - - /** - * Convert an instance of DeleteCrossConnect to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/EndCustomer.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/EndCustomer.java deleted file mode 100644 index cd0fbd04..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/EndCustomer.java +++ /dev/null @@ -1,341 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.Arrays; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * EndCustomer - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class EndCustomer { - public static final String SERIALIZED_NAME_IS_DISCLOSED = "isDisclosed"; - @SerializedName(SERIALIZED_NAME_IS_DISCLOSED) - @javax.annotation.Nullable - private Boolean isDisclosed = false; - - public static final String SERIALIZED_NAME_NAME = "name"; - @SerializedName(SERIALIZED_NAME_NAME) - @javax.annotation.Nullable - private String name; - - public static final String SERIALIZED_NAME_MDM_ID = "mdmId"; - @SerializedName(SERIALIZED_NAME_MDM_ID) - @javax.annotation.Nullable - private String mdmId; - - public EndCustomer() { - } - - public EndCustomer isDisclosed(@javax.annotation.Nullable Boolean isDisclosed) { - this.isDisclosed = isDisclosed; - return this; - } - - /** - * Indicate if endCustomer info should be disclosed or not - * @return isDisclosed - */ - @javax.annotation.Nullable - public Boolean getIsDisclosed() { - return isDisclosed; - } - - public void setIsDisclosed(@javax.annotation.Nullable Boolean isDisclosed) { - this.isDisclosed = isDisclosed; - } - - - public EndCustomer name(@javax.annotation.Nullable String name) { - this.name = name; - return this; - } - - /** - * Get name - * @return name - */ - @javax.annotation.Nullable - public String getName() { - return name; - } - - public void setName(@javax.annotation.Nullable String name) { - this.name = name; - } - - - public EndCustomer mdmId(@javax.annotation.Nullable String mdmId) { - this.mdmId = mdmId; - return this; - } - - /** - * Get mdmId - * @return mdmId - */ - @javax.annotation.Nullable - public String getMdmId() { - return mdmId; - } - - public void setMdmId(@javax.annotation.Nullable String mdmId) { - this.mdmId = mdmId; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the EndCustomer instance itself - */ - public EndCustomer putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - EndCustomer endCustomer = (EndCustomer) o; - return Objects.equals(this.isDisclosed, endCustomer.isDisclosed) && - Objects.equals(this.name, endCustomer.name) && - Objects.equals(this.mdmId, endCustomer.mdmId)&& - Objects.equals(this.additionalProperties, endCustomer.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(isDisclosed, name, mdmId, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class EndCustomer {\n"); - sb.append(" isDisclosed: ").append(toIndentedString(isDisclosed)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" mdmId: ").append(toIndentedString(mdmId)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("isDisclosed", "name", "mdmId")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to EndCustomer - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!EndCustomer.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in EndCustomer is not found in the empty JSON string", EndCustomer.openapiRequiredFields.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - if ((jsonObj.get("name") != null && !jsonObj.get("name").isJsonNull()) && !jsonObj.get("name").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `name` to be a primitive type in the JSON string but got `%s`", jsonObj.get("name").toString())); - } - if ((jsonObj.get("mdmId") != null && !jsonObj.get("mdmId").isJsonNull()) && !jsonObj.get("mdmId").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `mdmId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("mdmId").toString())); - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!EndCustomer.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'EndCustomer' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(EndCustomer.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, EndCustomer value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public EndCustomer read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - EndCustomer instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of EndCustomer given an JSON string - * - * @param jsonString JSON string - * @return An instance of EndCustomer - * @throws IOException if the JSON string is invalid with respect to EndCustomer - */ - public static EndCustomer fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, EndCustomer.class); - } - - /** - * Convert an instance of EndCustomer to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Error.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Error.java index 3f95d283..7f4a1ddd 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Error.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Error.java @@ -13,7 +13,7 @@ import java.util.Objects; import java.util.Locale; -import com.equinix.sdk.fabricv4.model.PriceErrorAdditionalInfo; +import com.equinix.sdk.fabricv4.model.ErrorAdditionalInfoInner; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -81,7 +81,7 @@ public class Error { public static final String SERIALIZED_NAME_ADDITIONAL_INFO = "additionalInfo"; @SerializedName(SERIALIZED_NAME_ADDITIONAL_INFO) @javax.annotation.Nullable - private List additionalInfo = new ArrayList<>(); + private List additionalInfo = new ArrayList<>(); public Error() { } @@ -181,12 +181,12 @@ public void setHelp(@javax.annotation.Nullable String help) { } - public Error additionalInfo(@javax.annotation.Nullable List additionalInfo) { + public Error additionalInfo(@javax.annotation.Nullable List additionalInfo) { this.additionalInfo = additionalInfo; return this; } - public Error addAdditionalInfoItem(PriceErrorAdditionalInfo additionalInfoItem) { + public Error addAdditionalInfoItem(ErrorAdditionalInfoInner additionalInfoItem) { if (this.additionalInfo == null) { this.additionalInfo = new ArrayList<>(); } @@ -199,11 +199,11 @@ public Error addAdditionalInfoItem(PriceErrorAdditionalInfo additionalInfoItem) * @return additionalInfo */ @javax.annotation.Nullable - public List getAdditionalInfo() { + public List getAdditionalInfo() { return additionalInfo; } - public void setAdditionalInfo(@javax.annotation.Nullable List additionalInfo) { + public void setAdditionalInfo(@javax.annotation.Nullable List additionalInfo) { this.additionalInfo = additionalInfo; } @@ -359,7 +359,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti // validate the optional field `additionalInfo` (array) for (int i = 0; i < jsonArrayadditionalInfo.size(); i++) { - PriceErrorAdditionalInfo.validateJsonElement(jsonArrayadditionalInfo.get(i)); + ErrorAdditionalInfoInner.validateJsonElement(jsonArrayadditionalInfo.get(i)); }; } } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PriceErrorAdditionalInfo.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ErrorAdditionalInfoInner.java similarity index 84% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PriceErrorAdditionalInfo.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ErrorAdditionalInfoInner.java index 7721ec5b..55c5ab4d 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PriceErrorAdditionalInfo.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ErrorAdditionalInfoInner.java @@ -46,10 +46,10 @@ import com.equinix.sdk.fabricv4.JSON; /** - * PriceErrorAdditionalInfo + * ErrorAdditionalInfoInner */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class PriceErrorAdditionalInfo { +public class ErrorAdditionalInfoInner { public static final String SERIALIZED_NAME_PROPERTY = "property"; @SerializedName(SERIALIZED_NAME_PROPERTY) @javax.annotation.Nullable @@ -60,10 +60,10 @@ public class PriceErrorAdditionalInfo { @javax.annotation.Nullable private String reason; - public PriceErrorAdditionalInfo() { + public ErrorAdditionalInfoInner() { } - public PriceErrorAdditionalInfo property(@javax.annotation.Nullable String property) { + public ErrorAdditionalInfoInner property(@javax.annotation.Nullable String property) { this.property = property; return this; } @@ -82,7 +82,7 @@ public void setProperty(@javax.annotation.Nullable String property) { } - public PriceErrorAdditionalInfo reason(@javax.annotation.Nullable String reason) { + public ErrorAdditionalInfoInner reason(@javax.annotation.Nullable String reason) { this.reason = reason; return this; } @@ -113,9 +113,9 @@ public void setReason(@javax.annotation.Nullable String reason) { * * @param key name of the property * @param value value of the property - * @return the PriceErrorAdditionalInfo instance itself + * @return the ErrorAdditionalInfoInner instance itself */ - public PriceErrorAdditionalInfo putAdditionalProperty(String key, Object value) { + public ErrorAdditionalInfoInner putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -154,10 +154,10 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - PriceErrorAdditionalInfo priceErrorAdditionalInfo = (PriceErrorAdditionalInfo) o; - return Objects.equals(this.property, priceErrorAdditionalInfo.property) && - Objects.equals(this.reason, priceErrorAdditionalInfo.reason)&& - Objects.equals(this.additionalProperties, priceErrorAdditionalInfo.additionalProperties); + ErrorAdditionalInfoInner errorAdditionalInfoInner = (ErrorAdditionalInfoInner) o; + return Objects.equals(this.property, errorAdditionalInfoInner.property) && + Objects.equals(this.reason, errorAdditionalInfoInner.reason)&& + Objects.equals(this.additionalProperties, errorAdditionalInfoInner.additionalProperties); } @Override @@ -168,7 +168,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class PriceErrorAdditionalInfo {\n"); + sb.append("class ErrorAdditionalInfoInner {\n"); sb.append(" property: ").append(toIndentedString(property)).append("\n"); sb.append(" reason: ").append(toIndentedString(reason)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); @@ -203,12 +203,12 @@ private String toIndentedString(Object o) { * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to PriceErrorAdditionalInfo + * @throws IOException if the JSON Element is invalid with respect to ErrorAdditionalInfoInner */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!PriceErrorAdditionalInfo.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in PriceErrorAdditionalInfo is not found in the empty JSON string", PriceErrorAdditionalInfo.openapiRequiredFields.toString())); + if (!ErrorAdditionalInfoInner.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in ErrorAdditionalInfoInner is not found in the empty JSON string", ErrorAdditionalInfoInner.openapiRequiredFields.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); @@ -224,16 +224,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!PriceErrorAdditionalInfo.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'PriceErrorAdditionalInfo' and its subtypes + if (!ErrorAdditionalInfoInner.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'ErrorAdditionalInfoInner' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(PriceErrorAdditionalInfo.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(ErrorAdditionalInfoInner.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, PriceErrorAdditionalInfo value) throws IOException { + public void write(JsonWriter out, ErrorAdditionalInfoInner value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -261,12 +261,12 @@ else if (entry.getValue() instanceof Character) } @Override - public PriceErrorAdditionalInfo read(JsonReader in) throws IOException { + public ErrorAdditionalInfoInner read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - PriceErrorAdditionalInfo instance = thisAdapter.fromJsonTree(jsonObj); + ErrorAdditionalInfoInner instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -293,18 +293,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of PriceErrorAdditionalInfo given an JSON string + * Create an instance of ErrorAdditionalInfoInner given an JSON string * * @param jsonString JSON string - * @return An instance of PriceErrorAdditionalInfo - * @throws IOException if the JSON string is invalid with respect to PriceErrorAdditionalInfo + * @return An instance of ErrorAdditionalInfoInner + * @throws IOException if the JSON string is invalid with respect to ErrorAdditionalInfoInner */ - public static PriceErrorAdditionalInfo fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, PriceErrorAdditionalInfo.class); + public static ErrorAdditionalInfoInner fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, ErrorAdditionalInfoInner.class); } /** - * Convert an instance of PriceErrorAdditionalInfo to an JSON string + * Convert an instance of ErrorAdditionalInfoInner to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayIpv4.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayIpv4.java deleted file mode 100644 index da83a81a..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayIpv4.java +++ /dev/null @@ -1,315 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.Arrays; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * Gateway IPv4 address - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class GatewayIpv4 { - public static final String SERIALIZED_NAME_PRIMARY_IP = "primaryIp"; - @SerializedName(SERIALIZED_NAME_PRIMARY_IP) - @javax.annotation.Nullable - private String primaryIp; - - public static final String SERIALIZED_NAME_SECONDARY_IP = "secondaryIp"; - @SerializedName(SERIALIZED_NAME_SECONDARY_IP) - @javax.annotation.Nullable - private String secondaryIp; - - public GatewayIpv4() { - } - - public GatewayIpv4 primaryIp(@javax.annotation.Nullable String primaryIp) { - this.primaryIp = primaryIp; - return this; - } - - /** - * Get primaryIp - * @return primaryIp - */ - @javax.annotation.Nullable - public String getPrimaryIp() { - return primaryIp; - } - - public void setPrimaryIp(@javax.annotation.Nullable String primaryIp) { - this.primaryIp = primaryIp; - } - - - public GatewayIpv4 secondaryIp(@javax.annotation.Nullable String secondaryIp) { - this.secondaryIp = secondaryIp; - return this; - } - - /** - * Get secondaryIp - * @return secondaryIp - */ - @javax.annotation.Nullable - public String getSecondaryIp() { - return secondaryIp; - } - - public void setSecondaryIp(@javax.annotation.Nullable String secondaryIp) { - this.secondaryIp = secondaryIp; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the GatewayIpv4 instance itself - */ - public GatewayIpv4 putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - GatewayIpv4 gatewayIpv4 = (GatewayIpv4) o; - return Objects.equals(this.primaryIp, gatewayIpv4.primaryIp) && - Objects.equals(this.secondaryIp, gatewayIpv4.secondaryIp)&& - Objects.equals(this.additionalProperties, gatewayIpv4.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(primaryIp, secondaryIp, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class GatewayIpv4 {\n"); - sb.append(" primaryIp: ").append(toIndentedString(primaryIp)).append("\n"); - sb.append(" secondaryIp: ").append(toIndentedString(secondaryIp)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("primaryIp", "secondaryIp")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to GatewayIpv4 - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!GatewayIpv4.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in GatewayIpv4 is not found in the empty JSON string", GatewayIpv4.openapiRequiredFields.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - if ((jsonObj.get("primaryIp") != null && !jsonObj.get("primaryIp").isJsonNull()) && !jsonObj.get("primaryIp").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `primaryIp` to be a primitive type in the JSON string but got `%s`", jsonObj.get("primaryIp").toString())); - } - if ((jsonObj.get("secondaryIp") != null && !jsonObj.get("secondaryIp").isJsonNull()) && !jsonObj.get("secondaryIp").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `secondaryIp` to be a primitive type in the JSON string but got `%s`", jsonObj.get("secondaryIp").toString())); - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!GatewayIpv4.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'GatewayIpv4' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(GatewayIpv4.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, GatewayIpv4 value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public GatewayIpv4 read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - GatewayIpv4 instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of GatewayIpv4 given an JSON string - * - * @param jsonString JSON string - * @return An instance of GatewayIpv4 - * @throws IOException if the JSON string is invalid with respect to GatewayIpv4 - */ - public static GatewayIpv4 fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, GatewayIpv4.class); - } - - /** - * Convert an instance of GatewayIpv4 to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewaySortDirection.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewaySortDirection.java deleted file mode 100644 index 90d532c8..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewaySortDirection.java +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.annotations.SerializedName; - -import java.io.IOException; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.JsonElement; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; - -/** - * Sorting direction - */ -@JsonAdapter(GatewaySortDirection.Adapter.class) -public enum GatewaySortDirection { - - DESC("DESC"), - - ASC("ASC"); - - private String value; - - GatewaySortDirection(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static GatewaySortDirection fromValue(String value) { - for (GatewaySortDirection b : GatewaySortDirection.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final GatewaySortDirection enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public GatewaySortDirection read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return GatewaySortDirection.fromValue(value); - } - } - - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - String value = jsonElement.getAsString(); - GatewaySortDirection.fromValue(value); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayTunnelSortCriteria.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayTunnelSortCriteria.java deleted file mode 100644 index 9091a79c..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayTunnelSortCriteria.java +++ /dev/null @@ -1,317 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.equinix.sdk.fabricv4.model.GatewayTunnelSortDirection; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.Arrays; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * GatewayTunnelSortCriteria - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class GatewayTunnelSortCriteria { - public static final String SERIALIZED_NAME_DIRECTION = "direction"; - @SerializedName(SERIALIZED_NAME_DIRECTION) - @javax.annotation.Nullable - private GatewayTunnelSortDirection direction = GatewayTunnelSortDirection.DESC; - - public static final String SERIALIZED_NAME_PROPERTY = "property"; - @SerializedName(SERIALIZED_NAME_PROPERTY) - @javax.annotation.Nullable - private String property = "/changeLog/updatedDateTime"; - - public GatewayTunnelSortCriteria() { - } - - public GatewayTunnelSortCriteria direction(@javax.annotation.Nullable GatewayTunnelSortDirection direction) { - this.direction = direction; - return this; - } - - /** - * Get direction - * @return direction - */ - @javax.annotation.Nullable - public GatewayTunnelSortDirection getDirection() { - return direction; - } - - public void setDirection(@javax.annotation.Nullable GatewayTunnelSortDirection direction) { - this.direction = direction; - } - - - public GatewayTunnelSortCriteria property(@javax.annotation.Nullable String property) { - this.property = property; - return this; - } - - /** - * Possible field names to use on sorting: * `/name` - Gateway Tunnel name * `/uuid` - Gateway Tunnel uuid * `/state` - Gateway Tunnel status * `/changeLog/createdDateTime` - Date and time when change flow starts * `/changeLog/updatedDateTime` - Date and time when change object is updated - * @return property - */ - @javax.annotation.Nullable - public String getProperty() { - return property; - } - - public void setProperty(@javax.annotation.Nullable String property) { - this.property = property; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the GatewayTunnelSortCriteria instance itself - */ - public GatewayTunnelSortCriteria putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - GatewayTunnelSortCriteria gatewayTunnelSortCriteria = (GatewayTunnelSortCriteria) o; - return Objects.equals(this.direction, gatewayTunnelSortCriteria.direction) && - Objects.equals(this.property, gatewayTunnelSortCriteria.property)&& - Objects.equals(this.additionalProperties, gatewayTunnelSortCriteria.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(direction, property, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class GatewayTunnelSortCriteria {\n"); - sb.append(" direction: ").append(toIndentedString(direction)).append("\n"); - sb.append(" property: ").append(toIndentedString(property)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("direction", "property")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to GatewayTunnelSortCriteria - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!GatewayTunnelSortCriteria.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in GatewayTunnelSortCriteria is not found in the empty JSON string", GatewayTunnelSortCriteria.openapiRequiredFields.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // validate the optional field `direction` - if (jsonObj.get("direction") != null && !jsonObj.get("direction").isJsonNull()) { - GatewayTunnelSortDirection.validateJsonElement(jsonObj.get("direction")); - } - if ((jsonObj.get("property") != null && !jsonObj.get("property").isJsonNull()) && !jsonObj.get("property").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `property` to be a primitive type in the JSON string but got `%s`", jsonObj.get("property").toString())); - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!GatewayTunnelSortCriteria.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'GatewayTunnelSortCriteria' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(GatewayTunnelSortCriteria.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, GatewayTunnelSortCriteria value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public GatewayTunnelSortCriteria read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - GatewayTunnelSortCriteria instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of GatewayTunnelSortCriteria given an JSON string - * - * @param jsonString JSON string - * @return An instance of GatewayTunnelSortCriteria - * @throws IOException if the JSON string is invalid with respect to GatewayTunnelSortCriteria - */ - public static GatewayTunnelSortCriteria fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, GatewayTunnelSortCriteria.class); - } - - /** - * Convert an instance of GatewayTunnelSortCriteria to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayTunnelSortDirection.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayTunnelSortDirection.java deleted file mode 100644 index 76e3a5bd..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/GatewayTunnelSortDirection.java +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.annotations.SerializedName; - -import java.io.IOException; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.JsonElement; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; - -/** - * Sorting direction - */ -@JsonAdapter(GatewayTunnelSortDirection.Adapter.class) -public enum GatewayTunnelSortDirection { - - DESC("DESC"), - - ASC("ASC"); - - private String value; - - GatewayTunnelSortDirection(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static GatewayTunnelSortDirection fromValue(String value) { - for (GatewayTunnelSortDirection b : GatewayTunnelSortDirection.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final GatewayTunnelSortDirection enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public GatewayTunnelSortDirection read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return GatewayTunnelSortDirection.fromValue(value); - } - } - - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - String value = jsonElement.getAsString(); - GatewayTunnelSortDirection.fromValue(value); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Hop.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Hop.java index e90fdb52..d0c6f17b 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Hop.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Hop.java @@ -13,7 +13,7 @@ import java.util.Objects; import java.util.Locale; -import com.equinix.sdk.fabricv4.model.HopProbes; +import com.equinix.sdk.fabricv4.model.HopProbesInner; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -61,7 +61,7 @@ public class Hop { public static final String SERIALIZED_NAME_PROBES = "probes"; @SerializedName(SERIALIZED_NAME_PROBES) @javax.annotation.Nullable - private List probes = new ArrayList<>(); + private List probes = new ArrayList<>(); public Hop() { } @@ -85,12 +85,12 @@ public void setHop(@javax.annotation.Nullable Integer hop) { } - public Hop probes(@javax.annotation.Nullable List probes) { + public Hop probes(@javax.annotation.Nullable List probes) { this.probes = probes; return this; } - public Hop addProbesItem(HopProbes probesItem) { + public Hop addProbesItem(HopProbesInner probesItem) { if (this.probes == null) { this.probes = new ArrayList<>(); } @@ -103,11 +103,11 @@ public Hop addProbesItem(HopProbes probesItem) { * @return probes */ @javax.annotation.Nullable - public List getProbes() { + public List getProbes() { return probes; } - public void setProbes(@javax.annotation.Nullable List probes) { + public void setProbes(@javax.annotation.Nullable List probes) { this.probes = probes; } @@ -233,7 +233,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti // validate the optional field `probes` (array) for (int i = 0; i < jsonArrayprobes.size(); i++) { - HopProbes.validateJsonElement(jsonArrayprobes.get(i)); + HopProbesInner.validateJsonElement(jsonArrayprobes.get(i)); }; } } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/HopProbes.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/HopProbesInner.java similarity index 84% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/HopProbes.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/HopProbesInner.java index 898f70df..f77434da 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/HopProbes.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/HopProbesInner.java @@ -46,10 +46,10 @@ import com.equinix.sdk.fabricv4.JSON; /** - * HopProbes + * HopProbesInner */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class HopProbes { +public class HopProbesInner { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) @javax.annotation.Nullable @@ -75,10 +75,10 @@ public class HopProbes { @javax.annotation.Nullable private String annotation; - public HopProbes() { + public HopProbesInner() { } - public HopProbes name(@javax.annotation.Nullable String name) { + public HopProbesInner name(@javax.annotation.Nullable String name) { this.name = name; return this; } @@ -97,7 +97,7 @@ public void setName(@javax.annotation.Nullable String name) { } - public HopProbes ip(@javax.annotation.Nullable String ip) { + public HopProbesInner ip(@javax.annotation.Nullable String ip) { this.ip = ip; return this; } @@ -116,7 +116,7 @@ public void setIp(@javax.annotation.Nullable String ip) { } - public HopProbes asn(@javax.annotation.Nullable Integer asn) { + public HopProbesInner asn(@javax.annotation.Nullable Integer asn) { this.asn = asn; return this; } @@ -135,7 +135,7 @@ public void setAsn(@javax.annotation.Nullable Integer asn) { } - public HopProbes rtt(@javax.annotation.Nullable String rtt) { + public HopProbesInner rtt(@javax.annotation.Nullable String rtt) { this.rtt = rtt; return this; } @@ -154,7 +154,7 @@ public void setRtt(@javax.annotation.Nullable String rtt) { } - public HopProbes annotation(@javax.annotation.Nullable String annotation) { + public HopProbesInner annotation(@javax.annotation.Nullable String annotation) { this.annotation = annotation; return this; } @@ -185,9 +185,9 @@ public void setAnnotation(@javax.annotation.Nullable String annotation) { * * @param key name of the property * @param value value of the property - * @return the HopProbes instance itself + * @return the HopProbesInner instance itself */ - public HopProbes putAdditionalProperty(String key, Object value) { + public HopProbesInner putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -226,13 +226,13 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - HopProbes hopProbes = (HopProbes) o; - return Objects.equals(this.name, hopProbes.name) && - Objects.equals(this.ip, hopProbes.ip) && - Objects.equals(this.asn, hopProbes.asn) && - Objects.equals(this.rtt, hopProbes.rtt) && - Objects.equals(this.annotation, hopProbes.annotation)&& - Objects.equals(this.additionalProperties, hopProbes.additionalProperties); + HopProbesInner hopProbesInner = (HopProbesInner) o; + return Objects.equals(this.name, hopProbesInner.name) && + Objects.equals(this.ip, hopProbesInner.ip) && + Objects.equals(this.asn, hopProbesInner.asn) && + Objects.equals(this.rtt, hopProbesInner.rtt) && + Objects.equals(this.annotation, hopProbesInner.annotation)&& + Objects.equals(this.additionalProperties, hopProbesInner.additionalProperties); } @Override @@ -243,7 +243,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class HopProbes {\n"); + sb.append("class HopProbesInner {\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" ip: ").append(toIndentedString(ip)).append("\n"); sb.append(" asn: ").append(toIndentedString(asn)).append("\n"); @@ -281,12 +281,12 @@ private String toIndentedString(Object o) { * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to HopProbes + * @throws IOException if the JSON Element is invalid with respect to HopProbesInner */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!HopProbes.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in HopProbes is not found in the empty JSON string", HopProbes.openapiRequiredFields.toString())); + if (!HopProbesInner.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in HopProbesInner is not found in the empty JSON string", HopProbesInner.openapiRequiredFields.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); @@ -308,16 +308,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!HopProbes.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'HopProbes' and its subtypes + if (!HopProbesInner.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'HopProbesInner' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(HopProbes.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(HopProbesInner.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, HopProbes value) throws IOException { + public void write(JsonWriter out, HopProbesInner value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -345,12 +345,12 @@ else if (entry.getValue() instanceof Character) } @Override - public HopProbes read(JsonReader in) throws IOException { + public HopProbesInner read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - HopProbes instance = thisAdapter.fromJsonTree(jsonObj); + HopProbesInner instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -377,18 +377,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of HopProbes given an JSON string + * Create an instance of HopProbesInner given an JSON string * * @param jsonString JSON string - * @return An instance of HopProbes - * @throws IOException if the JSON string is invalid with respect to HopProbes + * @return An instance of HopProbesInner + * @throws IOException if the JSON string is invalid with respect to HopProbesInner */ - public static HopProbes fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, HopProbes.class); + public static HopProbesInner fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, HopProbesInner.class); } /** - * Convert an instance of HopProbes to an JSON string + * Convert an instance of HopProbesInner to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgp.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgp.java index 6dd9fd09..20fd34e7 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgp.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgp.java @@ -19,7 +19,7 @@ import com.equinix.sdk.fabricv4.model.InternetAccessCustomerRoute; import com.equinix.sdk.fabricv4.model.InternetAccessExportPolicy; import com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocol; -import com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolBgpAsn; +import com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolBgpAllOfAsn; import com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolType; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; @@ -68,7 +68,7 @@ public class InternetAccessRoutingProtocolBgp extends InternetAccessRoutingProto public static final String SERIALIZED_NAME_ASN = "asn"; @SerializedName(SERIALIZED_NAME_ASN) @javax.annotation.Nullable - private InternetAccessRoutingProtocolBgpAsn asn; + private InternetAccessRoutingProtocolBgpAllOfAsn asn; public static final String SERIALIZED_NAME_CUSTOMER_ASN = "customerAsn"; @Deprecated @@ -114,7 +114,7 @@ public void setExportPolicy(@javax.annotation.Nonnull InternetAccessExportPolicy } - public InternetAccessRoutingProtocolBgp asn(@javax.annotation.Nullable InternetAccessRoutingProtocolBgpAsn asn) { + public InternetAccessRoutingProtocolBgp asn(@javax.annotation.Nullable InternetAccessRoutingProtocolBgpAllOfAsn asn) { this.asn = asn; return this; } @@ -124,11 +124,11 @@ public InternetAccessRoutingProtocolBgp asn(@javax.annotation.Nullable InternetA * @return asn */ @javax.annotation.Nullable - public InternetAccessRoutingProtocolBgpAsn getAsn() { + public InternetAccessRoutingProtocolBgpAllOfAsn getAsn() { return asn; } - public void setAsn(@javax.annotation.Nullable InternetAccessRoutingProtocolBgpAsn asn) { + public void setAsn(@javax.annotation.Nullable InternetAccessRoutingProtocolBgpAllOfAsn asn) { this.asn = asn; } @@ -303,7 +303,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti InternetAccessExportPolicy.validateJsonElement(jsonObj.get("exportPolicy")); // validate the optional field `asn` if (jsonObj.get("asn") != null && !jsonObj.get("asn").isJsonNull()) { - InternetAccessRoutingProtocolBgpAsn.validateJsonElement(jsonObj.get("asn")); + InternetAccessRoutingProtocolBgpAllOfAsn.validateJsonElement(jsonObj.get("asn")); } if ((jsonObj.get("bgpAuthKey") != null && !jsonObj.get("bgpAuthKey").isJsonNull()) && !jsonObj.get("bgpAuthKey").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `bgpAuthKey` to be a primitive type in the JSON string but got `%s`", jsonObj.get("bgpAuthKey").toString())); diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpAsn.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpAllOfAsn.java similarity index 82% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpAsn.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpAllOfAsn.java index 5f2061ba..e4ecc3ae 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpAsn.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpAllOfAsn.java @@ -47,10 +47,10 @@ import com.equinix.sdk.fabricv4.JSON; /** - * InternetAccessRoutingProtocolBgpAsn + * InternetAccessRoutingProtocolBgpAllOfAsn */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class InternetAccessRoutingProtocolBgpAsn { +public class InternetAccessRoutingProtocolBgpAllOfAsn { public static final String SERIALIZED_NAME_HREF = "href"; @SerializedName(SERIALIZED_NAME_HREF) @javax.annotation.Nullable @@ -61,10 +61,10 @@ public class InternetAccessRoutingProtocolBgpAsn { @javax.annotation.Nonnull private UUID uuid; - public InternetAccessRoutingProtocolBgpAsn() { + public InternetAccessRoutingProtocolBgpAllOfAsn() { } - public InternetAccessRoutingProtocolBgpAsn href(@javax.annotation.Nullable String href) { + public InternetAccessRoutingProtocolBgpAllOfAsn href(@javax.annotation.Nullable String href) { this.href = href; return this; } @@ -83,7 +83,7 @@ public void setHref(@javax.annotation.Nullable String href) { } - public InternetAccessRoutingProtocolBgpAsn uuid(@javax.annotation.Nonnull UUID uuid) { + public InternetAccessRoutingProtocolBgpAllOfAsn uuid(@javax.annotation.Nonnull UUID uuid) { this.uuid = uuid; return this; } @@ -114,9 +114,9 @@ public void setUuid(@javax.annotation.Nonnull UUID uuid) { * * @param key name of the property * @param value value of the property - * @return the InternetAccessRoutingProtocolBgpAsn instance itself + * @return the InternetAccessRoutingProtocolBgpAllOfAsn instance itself */ - public InternetAccessRoutingProtocolBgpAsn putAdditionalProperty(String key, Object value) { + public InternetAccessRoutingProtocolBgpAllOfAsn putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -155,10 +155,10 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - InternetAccessRoutingProtocolBgpAsn internetAccessRoutingProtocolBgpAsn = (InternetAccessRoutingProtocolBgpAsn) o; - return Objects.equals(this.href, internetAccessRoutingProtocolBgpAsn.href) && - Objects.equals(this.uuid, internetAccessRoutingProtocolBgpAsn.uuid)&& - Objects.equals(this.additionalProperties, internetAccessRoutingProtocolBgpAsn.additionalProperties); + InternetAccessRoutingProtocolBgpAllOfAsn internetAccessRoutingProtocolBgpAllOfAsn = (InternetAccessRoutingProtocolBgpAllOfAsn) o; + return Objects.equals(this.href, internetAccessRoutingProtocolBgpAllOfAsn.href) && + Objects.equals(this.uuid, internetAccessRoutingProtocolBgpAllOfAsn.uuid)&& + Objects.equals(this.additionalProperties, internetAccessRoutingProtocolBgpAllOfAsn.additionalProperties); } @Override @@ -169,7 +169,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class InternetAccessRoutingProtocolBgpAsn {\n"); + sb.append("class InternetAccessRoutingProtocolBgpAllOfAsn {\n"); sb.append(" href: ").append(toIndentedString(href)).append("\n"); sb.append(" uuid: ").append(toIndentedString(uuid)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); @@ -204,17 +204,17 @@ private String toIndentedString(Object o) { * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to InternetAccessRoutingProtocolBgpAsn + * @throws IOException if the JSON Element is invalid with respect to InternetAccessRoutingProtocolBgpAllOfAsn */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!InternetAccessRoutingProtocolBgpAsn.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in InternetAccessRoutingProtocolBgpAsn is not found in the empty JSON string", InternetAccessRoutingProtocolBgpAsn.openapiRequiredFields.toString())); + if (!InternetAccessRoutingProtocolBgpAllOfAsn.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in InternetAccessRoutingProtocolBgpAllOfAsn is not found in the empty JSON string", InternetAccessRoutingProtocolBgpAllOfAsn.openapiRequiredFields.toString())); } } // check to make sure all required properties/fields are present in the JSON string - for (String requiredField : InternetAccessRoutingProtocolBgpAsn.openapiRequiredFields) { + for (String requiredField : InternetAccessRoutingProtocolBgpAllOfAsn.openapiRequiredFields) { if (jsonElement.getAsJsonObject().get(requiredField) == null) { throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); } @@ -232,16 +232,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!InternetAccessRoutingProtocolBgpAsn.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'InternetAccessRoutingProtocolBgpAsn' and its subtypes + if (!InternetAccessRoutingProtocolBgpAllOfAsn.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'InternetAccessRoutingProtocolBgpAllOfAsn' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(InternetAccessRoutingProtocolBgpAsn.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(InternetAccessRoutingProtocolBgpAllOfAsn.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, InternetAccessRoutingProtocolBgpAsn value) throws IOException { + public void write(JsonWriter out, InternetAccessRoutingProtocolBgpAllOfAsn value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -269,12 +269,12 @@ else if (entry.getValue() instanceof Character) } @Override - public InternetAccessRoutingProtocolBgpAsn read(JsonReader in) throws IOException { + public InternetAccessRoutingProtocolBgpAllOfAsn read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - InternetAccessRoutingProtocolBgpAsn instance = thisAdapter.fromJsonTree(jsonObj); + InternetAccessRoutingProtocolBgpAllOfAsn instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -301,18 +301,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of InternetAccessRoutingProtocolBgpAsn given an JSON string + * Create an instance of InternetAccessRoutingProtocolBgpAllOfAsn given an JSON string * * @param jsonString JSON string - * @return An instance of InternetAccessRoutingProtocolBgpAsn - * @throws IOException if the JSON string is invalid with respect to InternetAccessRoutingProtocolBgpAsn + * @return An instance of InternetAccessRoutingProtocolBgpAllOfAsn + * @throws IOException if the JSON string is invalid with respect to InternetAccessRoutingProtocolBgpAllOfAsn */ - public static InternetAccessRoutingProtocolBgpAsn fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, InternetAccessRoutingProtocolBgpAsn.class); + public static InternetAccessRoutingProtocolBgpAllOfAsn fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, InternetAccessRoutingProtocolBgpAllOfAsn.class); } /** - * Convert an instance of InternetAccessRoutingProtocolBgpAsn to an JSON string + * Convert an instance of InternetAccessRoutingProtocolBgpAllOfAsn to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpRequest.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpRequest.java index 37fca8f2..5932d831 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpRequest.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpRequest.java @@ -17,7 +17,7 @@ import com.equinix.sdk.fabricv4.model.InternetAccessCustomerAsnRange; import com.equinix.sdk.fabricv4.model.InternetAccessCustomerRouteRequest; import com.equinix.sdk.fabricv4.model.InternetAccessExportPolicy; -import com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolBgpRequestAsn; +import com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolBgpRequestAllOfAsn; import com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolRequest; import com.equinix.sdk.fabricv4.model.InternetAccessRoutingProtocolType; import com.google.gson.TypeAdapter; @@ -72,7 +72,7 @@ public class InternetAccessRoutingProtocolBgpRequest extends InternetAccessRouti public static final String SERIALIZED_NAME_ASN = "asn"; @SerializedName(SERIALIZED_NAME_ASN) @javax.annotation.Nullable - private InternetAccessRoutingProtocolBgpRequestAsn asn; + private InternetAccessRoutingProtocolBgpRequestAllOfAsn asn; public static final String SERIALIZED_NAME_CUSTOMER_ASN = "customerAsn"; @Deprecated @@ -139,7 +139,7 @@ public void setExportPolicy(@javax.annotation.Nonnull InternetAccessExportPolicy } - public InternetAccessRoutingProtocolBgpRequest asn(@javax.annotation.Nullable InternetAccessRoutingProtocolBgpRequestAsn asn) { + public InternetAccessRoutingProtocolBgpRequest asn(@javax.annotation.Nullable InternetAccessRoutingProtocolBgpRequestAllOfAsn asn) { this.asn = asn; return this; } @@ -149,11 +149,11 @@ public InternetAccessRoutingProtocolBgpRequest asn(@javax.annotation.Nullable In * @return asn */ @javax.annotation.Nullable - public InternetAccessRoutingProtocolBgpRequestAsn getAsn() { + public InternetAccessRoutingProtocolBgpRequestAllOfAsn getAsn() { return asn; } - public void setAsn(@javax.annotation.Nullable InternetAccessRoutingProtocolBgpRequestAsn asn) { + public void setAsn(@javax.annotation.Nullable InternetAccessRoutingProtocolBgpRequestAllOfAsn asn) { this.asn = asn; } @@ -315,7 +315,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti InternetAccessExportPolicy.validateJsonElement(jsonObj.get("exportPolicy")); // validate the optional field `asn` if (jsonObj.get("asn") != null && !jsonObj.get("asn").isJsonNull()) { - InternetAccessRoutingProtocolBgpRequestAsn.validateJsonElement(jsonObj.get("asn")); + InternetAccessRoutingProtocolBgpRequestAllOfAsn.validateJsonElement(jsonObj.get("asn")); } if ((jsonObj.get("bgpAuthKey") != null && !jsonObj.get("bgpAuthKey").isJsonNull()) && !jsonObj.get("bgpAuthKey").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `bgpAuthKey` to be a primitive type in the JSON string but got `%s`", jsonObj.get("bgpAuthKey").toString())); diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpRequestAsn.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpRequestAllOfAsn.java similarity index 83% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpRequestAsn.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpRequestAllOfAsn.java index 14f0273b..f6273905 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpRequestAsn.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/InternetAccessRoutingProtocolBgpRequestAllOfAsn.java @@ -47,19 +47,19 @@ import com.equinix.sdk.fabricv4.JSON; /** - * InternetAccessRoutingProtocolBgpRequestAsn + * InternetAccessRoutingProtocolBgpRequestAllOfAsn */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class InternetAccessRoutingProtocolBgpRequestAsn { +public class InternetAccessRoutingProtocolBgpRequestAllOfAsn { public static final String SERIALIZED_NAME_UUID = "uuid"; @SerializedName(SERIALIZED_NAME_UUID) @javax.annotation.Nonnull private UUID uuid; - public InternetAccessRoutingProtocolBgpRequestAsn() { + public InternetAccessRoutingProtocolBgpRequestAllOfAsn() { } - public InternetAccessRoutingProtocolBgpRequestAsn uuid(@javax.annotation.Nonnull UUID uuid) { + public InternetAccessRoutingProtocolBgpRequestAllOfAsn uuid(@javax.annotation.Nonnull UUID uuid) { this.uuid = uuid; return this; } @@ -90,9 +90,9 @@ public void setUuid(@javax.annotation.Nonnull UUID uuid) { * * @param key name of the property * @param value value of the property - * @return the InternetAccessRoutingProtocolBgpRequestAsn instance itself + * @return the InternetAccessRoutingProtocolBgpRequestAllOfAsn instance itself */ - public InternetAccessRoutingProtocolBgpRequestAsn putAdditionalProperty(String key, Object value) { + public InternetAccessRoutingProtocolBgpRequestAllOfAsn putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -131,9 +131,9 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - InternetAccessRoutingProtocolBgpRequestAsn internetAccessRoutingProtocolBgpRequestAsn = (InternetAccessRoutingProtocolBgpRequestAsn) o; - return Objects.equals(this.uuid, internetAccessRoutingProtocolBgpRequestAsn.uuid)&& - Objects.equals(this.additionalProperties, internetAccessRoutingProtocolBgpRequestAsn.additionalProperties); + InternetAccessRoutingProtocolBgpRequestAllOfAsn internetAccessRoutingProtocolBgpRequestAllOfAsn = (InternetAccessRoutingProtocolBgpRequestAllOfAsn) o; + return Objects.equals(this.uuid, internetAccessRoutingProtocolBgpRequestAllOfAsn.uuid)&& + Objects.equals(this.additionalProperties, internetAccessRoutingProtocolBgpRequestAllOfAsn.additionalProperties); } @Override @@ -144,7 +144,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class InternetAccessRoutingProtocolBgpRequestAsn {\n"); + sb.append("class InternetAccessRoutingProtocolBgpRequestAllOfAsn {\n"); sb.append(" uuid: ").append(toIndentedString(uuid)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); @@ -178,17 +178,17 @@ private String toIndentedString(Object o) { * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to InternetAccessRoutingProtocolBgpRequestAsn + * @throws IOException if the JSON Element is invalid with respect to InternetAccessRoutingProtocolBgpRequestAllOfAsn */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!InternetAccessRoutingProtocolBgpRequestAsn.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in InternetAccessRoutingProtocolBgpRequestAsn is not found in the empty JSON string", InternetAccessRoutingProtocolBgpRequestAsn.openapiRequiredFields.toString())); + if (!InternetAccessRoutingProtocolBgpRequestAllOfAsn.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in InternetAccessRoutingProtocolBgpRequestAllOfAsn is not found in the empty JSON string", InternetAccessRoutingProtocolBgpRequestAllOfAsn.openapiRequiredFields.toString())); } } // check to make sure all required properties/fields are present in the JSON string - for (String requiredField : InternetAccessRoutingProtocolBgpRequestAsn.openapiRequiredFields) { + for (String requiredField : InternetAccessRoutingProtocolBgpRequestAllOfAsn.openapiRequiredFields) { if (jsonElement.getAsJsonObject().get(requiredField) == null) { throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); } @@ -203,16 +203,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!InternetAccessRoutingProtocolBgpRequestAsn.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'InternetAccessRoutingProtocolBgpRequestAsn' and its subtypes + if (!InternetAccessRoutingProtocolBgpRequestAllOfAsn.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'InternetAccessRoutingProtocolBgpRequestAllOfAsn' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(InternetAccessRoutingProtocolBgpRequestAsn.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(InternetAccessRoutingProtocolBgpRequestAllOfAsn.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, InternetAccessRoutingProtocolBgpRequestAsn value) throws IOException { + public void write(JsonWriter out, InternetAccessRoutingProtocolBgpRequestAllOfAsn value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -240,12 +240,12 @@ else if (entry.getValue() instanceof Character) } @Override - public InternetAccessRoutingProtocolBgpRequestAsn read(JsonReader in) throws IOException { + public InternetAccessRoutingProtocolBgpRequestAllOfAsn read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - InternetAccessRoutingProtocolBgpRequestAsn instance = thisAdapter.fromJsonTree(jsonObj); + InternetAccessRoutingProtocolBgpRequestAllOfAsn instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -272,18 +272,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of InternetAccessRoutingProtocolBgpRequestAsn given an JSON string + * Create an instance of InternetAccessRoutingProtocolBgpRequestAllOfAsn given an JSON string * * @param jsonString JSON string - * @return An instance of InternetAccessRoutingProtocolBgpRequestAsn - * @throws IOException if the JSON string is invalid with respect to InternetAccessRoutingProtocolBgpRequestAsn + * @return An instance of InternetAccessRoutingProtocolBgpRequestAllOfAsn + * @throws IOException if the JSON string is invalid with respect to InternetAccessRoutingProtocolBgpRequestAllOfAsn */ - public static InternetAccessRoutingProtocolBgpRequestAsn fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, InternetAccessRoutingProtocolBgpRequestAsn.class); + public static InternetAccessRoutingProtocolBgpRequestAllOfAsn fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, InternetAccessRoutingProtocolBgpRequestAllOfAsn.class); } /** - * Convert an instance of InternetAccessRoutingProtocolBgpRequestAsn to an JSON string + * Convert an instance of InternetAccessRoutingProtocolBgpRequestAllOfAsn to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Metric.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Metric.java index c488073e..e2e613db 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Metric.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Metric.java @@ -13,7 +13,7 @@ import java.util.Objects; import java.util.Locale; -import com.equinix.sdk.fabricv4.model.MetricDatapoints; +import com.equinix.sdk.fabricv4.model.MetricDatapointsInner; import com.equinix.sdk.fabricv4.model.MetricResource; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; @@ -87,7 +87,7 @@ public class Metric { public static final String SERIALIZED_NAME_DATAPOINTS = "datapoints"; @SerializedName(SERIALIZED_NAME_DATAPOINTS) @javax.annotation.Nullable - private List datapoints = new ArrayList<>(); + private List datapoints = new ArrayList<>(); public Metric() { } @@ -206,12 +206,12 @@ public void setSummary(@javax.annotation.Nullable String summary) { } - public Metric datapoints(@javax.annotation.Nullable List datapoints) { + public Metric datapoints(@javax.annotation.Nullable List datapoints) { this.datapoints = datapoints; return this; } - public Metric addDatapointsItem(MetricDatapoints datapointsItem) { + public Metric addDatapointsItem(MetricDatapointsInner datapointsItem) { if (this.datapoints == null) { this.datapoints = new ArrayList<>(); } @@ -224,11 +224,11 @@ public Metric addDatapointsItem(MetricDatapoints datapointsItem) { * @return datapoints */ @javax.annotation.Nullable - public List getDatapoints() { + public List getDatapoints() { return datapoints; } - public void setDatapoints(@javax.annotation.Nullable List datapoints) { + public void setDatapoints(@javax.annotation.Nullable List datapoints) { this.datapoints = datapoints; } @@ -383,7 +383,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti // validate the optional field `datapoints` (array) for (int i = 0; i < jsonArraydatapoints.size(); i++) { - MetricDatapoints.validateJsonElement(jsonArraydatapoints.get(i)); + MetricDatapointsInner.validateJsonElement(jsonArraydatapoints.get(i)); }; } } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/MetricDatapoints.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/MetricDatapointsInner.java similarity index 82% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/MetricDatapoints.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/MetricDatapointsInner.java index 11c20392..8cdbd5dd 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/MetricDatapoints.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/MetricDatapointsInner.java @@ -48,10 +48,10 @@ import com.equinix.sdk.fabricv4.JSON; /** - * MetricDatapoints + * MetricDatapointsInner */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class MetricDatapoints { +public class MetricDatapointsInner { public static final String SERIALIZED_NAME_END_DATE_TIME = "endDateTime"; @SerializedName(SERIALIZED_NAME_END_DATE_TIME) @javax.annotation.Nullable @@ -67,10 +67,10 @@ public class MetricDatapoints { @javax.annotation.Nullable private BigDecimal value; - public MetricDatapoints() { + public MetricDatapointsInner() { } - public MetricDatapoints endDateTime(@javax.annotation.Nullable OffsetDateTime endDateTime) { + public MetricDatapointsInner endDateTime(@javax.annotation.Nullable OffsetDateTime endDateTime) { this.endDateTime = endDateTime; return this; } @@ -89,7 +89,7 @@ public void setEndDateTime(@javax.annotation.Nullable OffsetDateTime endDateTime } - public MetricDatapoints startDateTime(@javax.annotation.Nullable OffsetDateTime startDateTime) { + public MetricDatapointsInner startDateTime(@javax.annotation.Nullable OffsetDateTime startDateTime) { this.startDateTime = startDateTime; return this; } @@ -108,7 +108,7 @@ public void setStartDateTime(@javax.annotation.Nullable OffsetDateTime startDate } - public MetricDatapoints value(@javax.annotation.Nullable BigDecimal value) { + public MetricDatapointsInner value(@javax.annotation.Nullable BigDecimal value) { this.value = value; return this; } @@ -139,9 +139,9 @@ public void setValue(@javax.annotation.Nullable BigDecimal value) { * * @param key name of the property * @param value value of the property - * @return the MetricDatapoints instance itself + * @return the MetricDatapointsInner instance itself */ - public MetricDatapoints putAdditionalProperty(String key, Object value) { + public MetricDatapointsInner putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -180,11 +180,11 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - MetricDatapoints metricDatapoints = (MetricDatapoints) o; - return Objects.equals(this.endDateTime, metricDatapoints.endDateTime) && - Objects.equals(this.startDateTime, metricDatapoints.startDateTime) && - Objects.equals(this.value, metricDatapoints.value)&& - Objects.equals(this.additionalProperties, metricDatapoints.additionalProperties); + MetricDatapointsInner metricDatapointsInner = (MetricDatapointsInner) o; + return Objects.equals(this.endDateTime, metricDatapointsInner.endDateTime) && + Objects.equals(this.startDateTime, metricDatapointsInner.startDateTime) && + Objects.equals(this.value, metricDatapointsInner.value)&& + Objects.equals(this.additionalProperties, metricDatapointsInner.additionalProperties); } @Override @@ -195,7 +195,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class MetricDatapoints {\n"); + sb.append("class MetricDatapointsInner {\n"); sb.append(" endDateTime: ").append(toIndentedString(endDateTime)).append("\n"); sb.append(" startDateTime: ").append(toIndentedString(startDateTime)).append("\n"); sb.append(" value: ").append(toIndentedString(value)).append("\n"); @@ -231,12 +231,12 @@ private String toIndentedString(Object o) { * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to MetricDatapoints + * @throws IOException if the JSON Element is invalid with respect to MetricDatapointsInner */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!MetricDatapoints.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in MetricDatapoints is not found in the empty JSON string", MetricDatapoints.openapiRequiredFields.toString())); + if (!MetricDatapointsInner.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in MetricDatapointsInner is not found in the empty JSON string", MetricDatapointsInner.openapiRequiredFields.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); @@ -246,16 +246,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!MetricDatapoints.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'MetricDatapoints' and its subtypes + if (!MetricDatapointsInner.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'MetricDatapointsInner' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(MetricDatapoints.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(MetricDatapointsInner.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, MetricDatapoints value) throws IOException { + public void write(JsonWriter out, MetricDatapointsInner value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -283,12 +283,12 @@ else if (entry.getValue() instanceof Character) } @Override - public MetricDatapoints read(JsonReader in) throws IOException { + public MetricDatapointsInner read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - MetricDatapoints instance = thisAdapter.fromJsonTree(jsonObj); + MetricDatapointsInner instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -315,18 +315,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of MetricDatapoints given an JSON string + * Create an instance of MetricDatapointsInner given an JSON string * * @param jsonString JSON string - * @return An instance of MetricDatapoints - * @throws IOException if the JSON string is invalid with respect to MetricDatapoints + * @return An instance of MetricDatapointsInner + * @throws IOException if the JSON string is invalid with respect to MetricDatapointsInner */ - public static MetricDatapoints fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, MetricDatapoints.class); + public static MetricDatapointsInner fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, MetricDatapointsInner.class); } /** - * Convert an instance of MetricDatapoints to an JSON string + * Convert an instance of MetricDatapointsInner to an JSON string * * @return JSON string */ diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/MetroError.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/MetroError.java index cbf7fbc7..e7aef98d 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/MetroError.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/MetroError.java @@ -13,7 +13,7 @@ import java.util.Objects; import java.util.Locale; -import com.equinix.sdk.fabricv4.model.PriceErrorAdditionalInfo; +import com.equinix.sdk.fabricv4.model.ErrorAdditionalInfoInner; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -197,7 +197,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti public static final String SERIALIZED_NAME_ADDITIONAL_INFO = "additionalInfo"; @SerializedName(SERIALIZED_NAME_ADDITIONAL_INFO) @javax.annotation.Nullable - private List additionalInfo = new ArrayList<>(); + private List additionalInfo = new ArrayList<>(); public MetroError() { @@ -298,12 +298,12 @@ public void setHelp(@javax.annotation.Nullable String help) { } - public MetroError additionalInfo(@javax.annotation.Nullable List additionalInfo) { + public MetroError additionalInfo(@javax.annotation.Nullable List additionalInfo) { this.additionalInfo = additionalInfo; return this; } - public MetroError addAdditionalInfoItem(PriceErrorAdditionalInfo additionalInfoItem) { + public MetroError addAdditionalInfoItem(ErrorAdditionalInfoInner additionalInfoItem) { if (this.additionalInfo == null) { this.additionalInfo = new ArrayList<>(); } @@ -316,11 +316,11 @@ public MetroError addAdditionalInfoItem(PriceErrorAdditionalInfo additionalInfoI * @return additionalInfo */ @javax.annotation.Nullable - public List getAdditionalInfo() { + public List getAdditionalInfo() { return additionalInfo; } - public void setAdditionalInfo(@javax.annotation.Nullable List additionalInfo) { + public void setAdditionalInfo(@javax.annotation.Nullable List additionalInfo) { this.additionalInfo = additionalInfo; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/NetworkChangeOperation.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/NetworkChangeOperation.java index 27a780f9..9d3f7d6b 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/NetworkChangeOperation.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/NetworkChangeOperation.java @@ -116,8 +116,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public NetworkChangeOperation() { } @@ -160,7 +160,7 @@ public void setPath(@javax.annotation.Nonnull String path) { } - public NetworkChangeOperation value(@javax.annotation.Nonnull Object value) { + public NetworkChangeOperation value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -169,12 +169,12 @@ public NetworkChangeOperation value(@javax.annotation.Nonnull Object value) { * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PhysicalPort.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PhysicalPort.java index b85a750e..0551c4c3 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PhysicalPort.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PhysicalPort.java @@ -13,11 +13,9 @@ import java.util.Objects; import java.util.Locale; -import com.equinix.sdk.fabricv4.model.PhysicalPortSettings; import com.equinix.sdk.fabricv4.model.PhysicalPortType; import com.equinix.sdk.fabricv4.model.PortAdditionalInfo; import com.equinix.sdk.fabricv4.model.PortDemarcationPoint; -import com.equinix.sdk.fabricv4.model.PortInterface; import com.equinix.sdk.fabricv4.model.PortLoa; import com.equinix.sdk.fabricv4.model.PortNotification; import com.equinix.sdk.fabricv4.model.PortOperation; @@ -117,16 +115,6 @@ public class PhysicalPort { @javax.annotation.Nullable private PortDemarcationPoint demarcationPoint; - public static final String SERIALIZED_NAME_SETTINGS = "settings"; - @SerializedName(SERIALIZED_NAME_SETTINGS) - @javax.annotation.Nullable - private PhysicalPortSettings settings; - - public static final String SERIALIZED_NAME_INTERFACE = "interface"; - @SerializedName(SERIALIZED_NAME_INTERFACE) - @javax.annotation.Nullable - private PortInterface _interface; - public static final String SERIALIZED_NAME_NOTIFICATIONS = "notifications"; @SerializedName(SERIALIZED_NAME_NOTIFICATIONS) @javax.annotation.Nullable @@ -349,44 +337,6 @@ public void setDemarcationPoint(@javax.annotation.Nullable PortDemarcationPoint } - public PhysicalPort settings(@javax.annotation.Nullable PhysicalPortSettings settings) { - this.settings = settings; - return this; - } - - /** - * Get settings - * @return settings - */ - @javax.annotation.Nullable - public PhysicalPortSettings getSettings() { - return settings; - } - - public void setSettings(@javax.annotation.Nullable PhysicalPortSettings settings) { - this.settings = settings; - } - - - public PhysicalPort _interface(@javax.annotation.Nullable PortInterface _interface) { - this._interface = _interface; - return this; - } - - /** - * Get _interface - * @return _interface - */ - @javax.annotation.Nullable - public PortInterface getInterface() { - return _interface; - } - - public void setInterface(@javax.annotation.Nullable PortInterface _interface) { - this._interface = _interface; - } - - public PhysicalPort notifications(@javax.annotation.Nullable List notifications) { this.notifications = notifications; return this; @@ -570,8 +520,6 @@ public boolean equals(Object o) { Objects.equals(this.uuid, physicalPort.uuid) && Objects.equals(this.tether, physicalPort.tether) && Objects.equals(this.demarcationPoint, physicalPort.demarcationPoint) && - Objects.equals(this.settings, physicalPort.settings) && - Objects.equals(this._interface, physicalPort._interface) && Objects.equals(this.notifications, physicalPort.notifications) && Objects.equals(this.additionalInfo, physicalPort.additionalInfo) && Objects.equals(this.order, physicalPort.order) && @@ -582,7 +530,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(href, type, id, state, account, interfaceSpeed, interfaceType, uuid, tether, demarcationPoint, settings, _interface, notifications, additionalInfo, order, operation, loas, additionalProperties); + return Objects.hash(href, type, id, state, account, interfaceSpeed, interfaceType, uuid, tether, demarcationPoint, notifications, additionalInfo, order, operation, loas, additionalProperties); } @Override @@ -599,8 +547,6 @@ public String toString() { sb.append(" uuid: ").append(toIndentedString(uuid)).append("\n"); sb.append(" tether: ").append(toIndentedString(tether)).append("\n"); sb.append(" demarcationPoint: ").append(toIndentedString(demarcationPoint)).append("\n"); - sb.append(" settings: ").append(toIndentedString(settings)).append("\n"); - sb.append(" _interface: ").append(toIndentedString(_interface)).append("\n"); sb.append(" notifications: ").append(toIndentedString(notifications)).append("\n"); sb.append(" additionalInfo: ").append(toIndentedString(additionalInfo)).append("\n"); sb.append(" order: ").append(toIndentedString(order)).append("\n"); @@ -628,7 +574,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("href", "type", "id", "state", "account", "interfaceSpeed", "interfaceType", "uuid", "tether", "demarcationPoint", "settings", "interface", "notifications", "additionalInfo", "order", "operation", "loas")); + openapiFields = new HashSet(Arrays.asList("href", "type", "id", "state", "account", "interfaceSpeed", "interfaceType", "uuid", "tether", "demarcationPoint", "notifications", "additionalInfo", "order", "operation", "loas")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(0); @@ -676,14 +622,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if (jsonObj.get("demarcationPoint") != null && !jsonObj.get("demarcationPoint").isJsonNull()) { PortDemarcationPoint.validateJsonElement(jsonObj.get("demarcationPoint")); } - // validate the optional field `settings` - if (jsonObj.get("settings") != null && !jsonObj.get("settings").isJsonNull()) { - PhysicalPortSettings.validateJsonElement(jsonObj.get("settings")); - } - // validate the optional field `interface` - if (jsonObj.get("interface") != null && !jsonObj.get("interface").isJsonNull()) { - PortInterface.validateJsonElement(jsonObj.get("interface")); - } if (jsonObj.get("notifications") != null && !jsonObj.get("notifications").isJsonNull()) { JsonArray jsonArraynotifications = jsonObj.getAsJsonArray("notifications"); if (jsonArraynotifications != null) { diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PhysicalPortSettings.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PhysicalPortSettings.java deleted file mode 100644 index a5eedf31..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PhysicalPortSettings.java +++ /dev/null @@ -1,320 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.Arrays; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * Physical Port configuration settings - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class PhysicalPortSettings { - public static final String SERIALIZED_NAME_ERROR_MESSAGE = "errorMessage"; - @SerializedName(SERIALIZED_NAME_ERROR_MESSAGE) - @javax.annotation.Nullable - private String errorMessage; - - public static final String SERIALIZED_NAME_PACKAGE_TYPE = "packageType"; - @Deprecated - @SerializedName(SERIALIZED_NAME_PACKAGE_TYPE) - @javax.annotation.Nullable - private String packageType; - - public PhysicalPortSettings() { - } - - public PhysicalPortSettings errorMessage(@javax.annotation.Nullable String errorMessage) { - this.errorMessage = errorMessage; - return this; - } - - /** - * Get errorMessage - * @return errorMessage - */ - @javax.annotation.Nullable - public String getErrorMessage() { - return errorMessage; - } - - public void setErrorMessage(@javax.annotation.Nullable String errorMessage) { - this.errorMessage = errorMessage; - } - - - @Deprecated - public PhysicalPortSettings packageType(@javax.annotation.Nullable String packageType) { - this.packageType = packageType; - return this; - } - - /** - * Get packageType - * @return packageType - * @deprecated - */ - @Deprecated - @javax.annotation.Nullable - public String getPackageType() { - return packageType; - } - - @Deprecated - public void setPackageType(@javax.annotation.Nullable String packageType) { - this.packageType = packageType; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the PhysicalPortSettings instance itself - */ - public PhysicalPortSettings putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PhysicalPortSettings physicalPortSettings = (PhysicalPortSettings) o; - return Objects.equals(this.errorMessage, physicalPortSettings.errorMessage) && - Objects.equals(this.packageType, physicalPortSettings.packageType)&& - Objects.equals(this.additionalProperties, physicalPortSettings.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(errorMessage, packageType, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PhysicalPortSettings {\n"); - sb.append(" errorMessage: ").append(toIndentedString(errorMessage)).append("\n"); - sb.append(" packageType: ").append(toIndentedString(packageType)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("errorMessage", "packageType")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to PhysicalPortSettings - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!PhysicalPortSettings.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in PhysicalPortSettings is not found in the empty JSON string", PhysicalPortSettings.openapiRequiredFields.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - if ((jsonObj.get("errorMessage") != null && !jsonObj.get("errorMessage").isJsonNull()) && !jsonObj.get("errorMessage").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `errorMessage` to be a primitive type in the JSON string but got `%s`", jsonObj.get("errorMessage").toString())); - } - if ((jsonObj.get("packageType") != null && !jsonObj.get("packageType").isJsonNull()) && !jsonObj.get("packageType").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `packageType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("packageType").toString())); - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!PhysicalPortSettings.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'PhysicalPortSettings' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(PhysicalPortSettings.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, PhysicalPortSettings value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public PhysicalPortSettings read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - PhysicalPortSettings instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of PhysicalPortSettings given an JSON string - * - * @param jsonString JSON string - * @return An instance of PhysicalPortSettings - * @throws IOException if the JSON string is invalid with respect to PhysicalPortSettings - */ - public static PhysicalPortSettings fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, PhysicalPortSettings.class); - } - - /** - * Convert an instance of PhysicalPortSettings to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Port.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Port.java index bb7ee3ee..2c44033a 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Port.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/Port.java @@ -14,7 +14,6 @@ import java.util.Objects; import java.util.Locale; import com.equinix.sdk.fabricv4.model.Changelog; -import com.equinix.sdk.fabricv4.model.EndCustomer; import com.equinix.sdk.fabricv4.model.MarketplaceSubscription; import com.equinix.sdk.fabricv4.model.ModelPackage; import com.equinix.sdk.fabricv4.model.PhysicalPort; @@ -496,11 +495,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @javax.annotation.Nullable private List additionalInfo = new ArrayList<>(); - public static final String SERIALIZED_NAME_END_CUSTOMER = "endCustomer"; - @SerializedName(SERIALIZED_NAME_END_CUSTOMER) - @javax.annotation.Nullable - private EndCustomer endCustomer; - public static final String SERIALIZED_NAME_PHYSICAL_PORTS = "physicalPorts"; @SerializedName(SERIALIZED_NAME_PHYSICAL_PORTS) @javax.annotation.Nullable @@ -1292,25 +1286,6 @@ public void setAdditionalInfo(@javax.annotation.Nullable List physicalPorts) { this.physicalPorts = physicalPorts; return this; @@ -1477,7 +1452,6 @@ public boolean equals(Object o) { Objects.equals(this.physicalPortQuantity, port.physicalPortQuantity) && Objects.equals(this.notifications, port.notifications) && Objects.equals(this.additionalInfo, port.additionalInfo) && - Objects.equals(this.endCustomer, port.endCustomer) && Objects.equals(this.physicalPorts, port.physicalPorts) && Objects.equals(this.loas, port.loas) && Objects.equals(this.marketplaceSubscription, port.marketplaceSubscription)&& @@ -1486,7 +1460,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(href, type, uuid, name, description, physicalPortsSpeed, connectionsCount, physicalPortsType, physicalPortsCount, connectivitySourceType, bmmrType, project, state, order, operation, account, change, changeLog, serviceType, serviceCode, bandwidth, availableBandwidth, usedBandwidth, location, device, _interface, demarcationPointIbx, tetherIbx, demarcationPoint, redundancy, encapsulation, lagEnabled, lag, asn, _package, settings, physicalPortQuantity, notifications, additionalInfo, endCustomer, physicalPorts, loas, marketplaceSubscription, additionalProperties); + return Objects.hash(href, type, uuid, name, description, physicalPortsSpeed, connectionsCount, physicalPortsType, physicalPortsCount, connectivitySourceType, bmmrType, project, state, order, operation, account, change, changeLog, serviceType, serviceCode, bandwidth, availableBandwidth, usedBandwidth, location, device, _interface, demarcationPointIbx, tetherIbx, demarcationPoint, redundancy, encapsulation, lagEnabled, lag, asn, _package, settings, physicalPortQuantity, notifications, additionalInfo, physicalPorts, loas, marketplaceSubscription, additionalProperties); } @Override @@ -1532,7 +1506,6 @@ public String toString() { sb.append(" physicalPortQuantity: ").append(toIndentedString(physicalPortQuantity)).append("\n"); sb.append(" notifications: ").append(toIndentedString(notifications)).append("\n"); sb.append(" additionalInfo: ").append(toIndentedString(additionalInfo)).append("\n"); - sb.append(" endCustomer: ").append(toIndentedString(endCustomer)).append("\n"); sb.append(" physicalPorts: ").append(toIndentedString(physicalPorts)).append("\n"); sb.append(" loas: ").append(toIndentedString(loas)).append("\n"); sb.append(" marketplaceSubscription: ").append(toIndentedString(marketplaceSubscription)).append("\n"); @@ -1558,7 +1531,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("href", "type", "uuid", "name", "description", "physicalPortsSpeed", "connectionsCount", "physicalPortsType", "physicalPortsCount", "connectivitySourceType", "bmmrType", "project", "state", "order", "operation", "account", "change", "changeLog", "serviceType", "serviceCode", "bandwidth", "availableBandwidth", "usedBandwidth", "location", "device", "interface", "demarcationPointIbx", "tetherIbx", "demarcationPoint", "redundancy", "encapsulation", "lagEnabled", "lag", "asn", "package", "settings", "physicalPortQuantity", "notifications", "additionalInfo", "endCustomer", "physicalPorts", "loas", "marketplaceSubscription")); + openapiFields = new HashSet(Arrays.asList("href", "type", "uuid", "name", "description", "physicalPortsSpeed", "connectionsCount", "physicalPortsType", "physicalPortsCount", "connectivitySourceType", "bmmrType", "project", "state", "order", "operation", "account", "change", "changeLog", "serviceType", "serviceCode", "bandwidth", "availableBandwidth", "usedBandwidth", "location", "device", "interface", "demarcationPointIbx", "tetherIbx", "demarcationPoint", "redundancy", "encapsulation", "lagEnabled", "lag", "asn", "package", "settings", "physicalPortQuantity", "notifications", "additionalInfo", "physicalPorts", "loas", "marketplaceSubscription")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(0); @@ -1723,10 +1696,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti }; } } - // validate the optional field `endCustomer` - if (jsonObj.get("endCustomer") != null && !jsonObj.get("endCustomer").isJsonNull()) { - EndCustomer.validateJsonElement(jsonObj.get("endCustomer")); - } if (jsonObj.get("physicalPorts") != null && !jsonObj.get("physicalPorts").isJsonNull()) { JsonArray jsonArrayphysicalPorts = jsonObj.getAsJsonArray("physicalPorts"); if (jsonArrayphysicalPorts != null) { diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PortChangeOperation.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PortChangeOperation.java index cc3ac1d7..dc9c3497 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PortChangeOperation.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PortChangeOperation.java @@ -62,8 +62,8 @@ public class PortChangeOperation { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public PortChangeOperation() { } @@ -106,7 +106,7 @@ public void setPath(@javax.annotation.Nonnull String path) { } - public PortChangeOperation value(@javax.annotation.Nonnull Object value) { + public PortChangeOperation value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -115,12 +115,12 @@ public PortChangeOperation value(@javax.annotation.Nonnull Object value) { * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PortRequest.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PortRequest.java index d7d53742..0b0d2305 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PortRequest.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PortRequest.java @@ -22,7 +22,6 @@ import com.equinix.sdk.fabricv4.model.PortOrder; import com.equinix.sdk.fabricv4.model.PortRedundancy; import com.equinix.sdk.fabricv4.model.PortServiceCode; -import com.equinix.sdk.fabricv4.model.PortSettings; import com.equinix.sdk.fabricv4.model.PortType; import com.equinix.sdk.fabricv4.model.Project; import com.equinix.sdk.fabricv4.model.SimplifiedAccountRequest; @@ -388,11 +387,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @javax.annotation.Nullable private ModelPackage _package; - public static final String SERIALIZED_NAME_SETTINGS = "settings"; - @SerializedName(SERIALIZED_NAME_SETTINGS) - @javax.annotation.Nullable - private PortSettings settings; - public static final String SERIALIZED_NAME_NOTIFICATIONS = "notifications"; @SerializedName(SERIALIZED_NAME_NOTIFICATIONS) @javax.annotation.Nullable @@ -801,25 +795,6 @@ public void setPackage(@javax.annotation.Nullable ModelPackage _package) { } - public PortRequest settings(@javax.annotation.Nullable PortSettings settings) { - this.settings = settings; - return this; - } - - /** - * Get settings - * @return settings - */ - @javax.annotation.Nullable - public PortSettings getSettings() { - return settings; - } - - public void setSettings(@javax.annotation.Nullable PortSettings settings) { - this.settings = settings; - } - - public PortRequest notifications(@javax.annotation.Nullable List notifications) { this.notifications = notifications; return this; @@ -975,7 +950,6 @@ public boolean equals(Object o) { Objects.equals(this.encapsulation, portRequest.encapsulation) && Objects.equals(this.lagEnabled, portRequest.lagEnabled) && Objects.equals(this._package, portRequest._package) && - Objects.equals(this.settings, portRequest.settings) && Objects.equals(this.notifications, portRequest.notifications) && Objects.equals(this.physicalPorts, portRequest.physicalPorts) && Objects.equals(this.loas, portRequest.loas)&& @@ -984,7 +958,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(type, physicalPortsSpeed, physicalPortsType, physicalPortsCount, connectivitySourceType, bmmrType, project, order, account, serviceType, serviceCode, bandwidth, location, demarcationPointIbx, tetherIbx, demarcationPoint, redundancy, encapsulation, lagEnabled, _package, settings, notifications, physicalPorts, loas, additionalProperties); + return Objects.hash(type, physicalPortsSpeed, physicalPortsType, physicalPortsCount, connectivitySourceType, bmmrType, project, order, account, serviceType, serviceCode, bandwidth, location, demarcationPointIbx, tetherIbx, demarcationPoint, redundancy, encapsulation, lagEnabled, _package, notifications, physicalPorts, loas, additionalProperties); } @Override @@ -1011,7 +985,6 @@ public String toString() { sb.append(" encapsulation: ").append(toIndentedString(encapsulation)).append("\n"); sb.append(" lagEnabled: ").append(toIndentedString(lagEnabled)).append("\n"); sb.append(" _package: ").append(toIndentedString(_package)).append("\n"); - sb.append(" settings: ").append(toIndentedString(settings)).append("\n"); sb.append(" notifications: ").append(toIndentedString(notifications)).append("\n"); sb.append(" physicalPorts: ").append(toIndentedString(physicalPorts)).append("\n"); sb.append(" loas: ").append(toIndentedString(loas)).append("\n"); @@ -1037,7 +1010,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("type", "physicalPortsSpeed", "physicalPortsType", "physicalPortsCount", "connectivitySourceType", "bmmrType", "project", "order", "account", "serviceType", "serviceCode", "bandwidth", "location", "demarcationPointIbx", "tetherIbx", "demarcationPoint", "redundancy", "encapsulation", "lagEnabled", "package", "settings", "notifications", "physicalPorts", "loas")); + openapiFields = new HashSet(Arrays.asList("type", "physicalPortsSpeed", "physicalPortsType", "physicalPortsCount", "connectivitySourceType", "bmmrType", "project", "order", "account", "serviceType", "serviceCode", "bandwidth", "location", "demarcationPointIbx", "tetherIbx", "demarcationPoint", "redundancy", "encapsulation", "lagEnabled", "package", "notifications", "physicalPorts", "loas")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(Arrays.asList("type", "physicalPortsSpeed", "physicalPortsType", "connectivitySourceType", "project", "account", "location", "encapsulation")); @@ -1123,10 +1096,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if (jsonObj.get("package") != null && !jsonObj.get("package").isJsonNull()) { ModelPackage.validateJsonElement(jsonObj.get("package")); } - // validate the optional field `settings` - if (jsonObj.get("settings") != null && !jsonObj.get("settings").isJsonNull()) { - PortSettings.validateJsonElement(jsonObj.get("settings")); - } if (jsonObj.get("notifications") != null && !jsonObj.get("notifications").isJsonNull()) { JsonArray jsonArraynotifications = jsonObj.getAsJsonArray("notifications"); if (jsonArraynotifications != null) { diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PrecisionTimeChangeOperation.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PrecisionTimeChangeOperation.java index 10dc4a91..47f1c525 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PrecisionTimeChangeOperation.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PrecisionTimeChangeOperation.java @@ -174,8 +174,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public PrecisionTimeChangeOperation() { } @@ -218,7 +218,7 @@ public void setPath(@javax.annotation.Nonnull PathEnum path) { } - public PrecisionTimeChangeOperation value(@javax.annotation.Nonnull Object value) { + public PrecisionTimeChangeOperation value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -227,12 +227,12 @@ public PrecisionTimeChangeOperation value(@javax.annotation.Nonnull Object value * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PrecisionTimePrice.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PrecisionTimePrice.java deleted file mode 100644 index 26766f96..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PrecisionTimePrice.java +++ /dev/null @@ -1,337 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.equinix.sdk.fabricv4.model.PriceCharge; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * Precision Time Price - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class PrecisionTimePrice { - public static final String SERIALIZED_NAME_CURRENCY = "currency"; - @SerializedName(SERIALIZED_NAME_CURRENCY) - @javax.annotation.Nullable - private String currency; - - public static final String SERIALIZED_NAME_CHARGES = "charges"; - @SerializedName(SERIALIZED_NAME_CHARGES) - @javax.annotation.Nullable - private List charges = new ArrayList<>(); - - public PrecisionTimePrice() { - } - - public PrecisionTimePrice currency(@javax.annotation.Nullable String currency) { - this.currency = currency; - return this; - } - - /** - * offering price currency - * @return currency - */ - @javax.annotation.Nullable - public String getCurrency() { - return currency; - } - - public void setCurrency(@javax.annotation.Nullable String currency) { - this.currency = currency; - } - - - public PrecisionTimePrice charges(@javax.annotation.Nullable List charges) { - this.charges = charges; - return this; - } - - public PrecisionTimePrice addChargesItem(PriceCharge chargesItem) { - if (this.charges == null) { - this.charges = new ArrayList<>(); - } - this.charges.add(chargesItem); - return this; - } - - /** - * Get charges - * @return charges - */ - @javax.annotation.Nullable - public List getCharges() { - return charges; - } - - public void setCharges(@javax.annotation.Nullable List charges) { - this.charges = charges; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the PrecisionTimePrice instance itself - */ - public PrecisionTimePrice putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PrecisionTimePrice precisionTimePrice = (PrecisionTimePrice) o; - return Objects.equals(this.currency, precisionTimePrice.currency) && - Objects.equals(this.charges, precisionTimePrice.charges)&& - Objects.equals(this.additionalProperties, precisionTimePrice.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(currency, charges, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PrecisionTimePrice {\n"); - sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); - sb.append(" charges: ").append(toIndentedString(charges)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("currency", "charges")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to PrecisionTimePrice - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!PrecisionTimePrice.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in PrecisionTimePrice is not found in the empty JSON string", PrecisionTimePrice.openapiRequiredFields.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - if ((jsonObj.get("currency") != null && !jsonObj.get("currency").isJsonNull()) && !jsonObj.get("currency").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `currency` to be a primitive type in the JSON string but got `%s`", jsonObj.get("currency").toString())); - } - if (jsonObj.get("charges") != null && !jsonObj.get("charges").isJsonNull()) { - JsonArray jsonArraycharges = jsonObj.getAsJsonArray("charges"); - if (jsonArraycharges != null) { - // ensure the json data is an array - if (!jsonObj.get("charges").isJsonArray()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `charges` to be an array in the JSON string but got `%s`", jsonObj.get("charges").toString())); - } - - // validate the optional field `charges` (array) - for (int i = 0; i < jsonArraycharges.size(); i++) { - PriceCharge.validateJsonElement(jsonArraycharges.get(i)); - }; - } - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!PrecisionTimePrice.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'PrecisionTimePrice' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(PrecisionTimePrice.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, PrecisionTimePrice value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public PrecisionTimePrice read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - PrecisionTimePrice instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of PrecisionTimePrice given an JSON string - * - * @param jsonString JSON string - * @return An instance of PrecisionTimePrice - * @throws IOException if the JSON string is invalid with respect to PrecisionTimePrice - */ - public static PrecisionTimePrice fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, PrecisionTimePrice.class); - } - - /** - * Convert an instance of PrecisionTimePrice to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PrecisionTimeServiceResponse.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PrecisionTimeServiceResponse.java index ab7fd9b7..6bbc5757 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PrecisionTimeServiceResponse.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PrecisionTimeServiceResponse.java @@ -18,7 +18,6 @@ import com.equinix.sdk.fabricv4.model.Md5; import com.equinix.sdk.fabricv4.model.PrecisionTimeOrder; import com.equinix.sdk.fabricv4.model.PrecisionTimePackagePostResponse; -import com.equinix.sdk.fabricv4.model.PrecisionTimePrice; import com.equinix.sdk.fabricv4.model.Project; import com.equinix.sdk.fabricv4.model.PtpAdvanceConfiguration; import com.equinix.sdk.fabricv4.model.SimplifiedAccount; @@ -263,11 +262,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @javax.annotation.Nullable private PrecisionTimeOrder order; - public static final String SERIALIZED_NAME_PRICING = "pricing"; - @SerializedName(SERIALIZED_NAME_PRICING) - @javax.annotation.Nullable - private PrecisionTimePrice pricing; - public static final String SERIALIZED_NAME_CHANGE_LOG = "changeLog"; @SerializedName(SERIALIZED_NAME_CHANGE_LOG) @javax.annotation.Nullable @@ -558,25 +552,6 @@ public void setOrder(@javax.annotation.Nullable PrecisionTimeOrder order) { } - public PrecisionTimeServiceResponse pricing(@javax.annotation.Nullable PrecisionTimePrice pricing) { - this.pricing = pricing; - return this; - } - - /** - * Get pricing - * @return pricing - */ - @javax.annotation.Nullable - public PrecisionTimePrice getPricing() { - return pricing; - } - - public void setPricing(@javax.annotation.Nullable PrecisionTimePrice pricing) { - this.pricing = pricing; - } - - public PrecisionTimeServiceResponse changeLog(@javax.annotation.Nullable Changelog changeLog) { this.changeLog = changeLog; return this; @@ -664,14 +639,13 @@ public boolean equals(Object o) { Objects.equals(this.project, precisionTimeServiceResponse.project) && Objects.equals(this.account, precisionTimeServiceResponse.account) && Objects.equals(this.order, precisionTimeServiceResponse.order) && - Objects.equals(this.pricing, precisionTimeServiceResponse.pricing) && Objects.equals(this.changeLog, precisionTimeServiceResponse.changeLog)&& Objects.equals(this.additionalProperties, precisionTimeServiceResponse.additionalProperties); } @Override public int hashCode() { - return Objects.hash(href, type, name, uuid, state, operation, _package, connections, ipv4, ntpAdvancedConfiguration, ptpAdvancedConfiguration, project, account, order, pricing, changeLog, additionalProperties); + return Objects.hash(href, type, name, uuid, state, operation, _package, connections, ipv4, ntpAdvancedConfiguration, ptpAdvancedConfiguration, project, account, order, changeLog, additionalProperties); } @Override @@ -692,7 +666,6 @@ public String toString() { sb.append(" project: ").append(toIndentedString(project)).append("\n"); sb.append(" account: ").append(toIndentedString(account)).append("\n"); sb.append(" order: ").append(toIndentedString(order)).append("\n"); - sb.append(" pricing: ").append(toIndentedString(pricing)).append("\n"); sb.append(" changeLog: ").append(toIndentedString(changeLog)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); @@ -716,7 +689,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("href", "type", "name", "uuid", "state", "operation", "package", "connections", "ipv4", "ntpAdvancedConfiguration", "ptpAdvancedConfiguration", "project", "account", "order", "pricing", "changeLog")); + openapiFields = new HashSet(Arrays.asList("href", "type", "name", "uuid", "state", "operation", "package", "connections", "ipv4", "ntpAdvancedConfiguration", "ptpAdvancedConfiguration", "project", "account", "order", "changeLog")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(Arrays.asList("href", "type", "uuid", "state", "package")); @@ -815,10 +788,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if (jsonObj.get("order") != null && !jsonObj.get("order").isJsonNull()) { PrecisionTimeOrder.validateJsonElement(jsonObj.get("order")); } - // validate the optional field `pricing` - if (jsonObj.get("pricing") != null && !jsonObj.get("pricing").isJsonNull()) { - PrecisionTimePrice.validateJsonElement(jsonObj.get("pricing")); - } // validate the optional field `changeLog` if (jsonObj.get("changeLog") != null && !jsonObj.get("changeLog").isJsonNull()) { Changelog.validateJsonElement(jsonObj.get("changeLog")); diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PriceError.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PriceError.java index 6cd03af3..c35c0cae 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PriceError.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/PriceError.java @@ -13,7 +13,7 @@ import java.util.Objects; import java.util.Locale; -import com.equinix.sdk.fabricv4.model.PriceErrorAdditionalInfo; +import com.equinix.sdk.fabricv4.model.ErrorAdditionalInfoInner; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -189,7 +189,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti public static final String SERIALIZED_NAME_ADDITIONAL_INFO = "additionalInfo"; @SerializedName(SERIALIZED_NAME_ADDITIONAL_INFO) @javax.annotation.Nullable - private List additionalInfo = new ArrayList<>(); + private List additionalInfo = new ArrayList<>(); public PriceError() { @@ -290,12 +290,12 @@ public void setHelp(@javax.annotation.Nullable String help) { } - public PriceError additionalInfo(@javax.annotation.Nullable List additionalInfo) { + public PriceError additionalInfo(@javax.annotation.Nullable List additionalInfo) { this.additionalInfo = additionalInfo; return this; } - public PriceError addAdditionalInfoItem(PriceErrorAdditionalInfo additionalInfoItem) { + public PriceError addAdditionalInfoItem(ErrorAdditionalInfoInner additionalInfoItem) { if (this.additionalInfo == null) { this.additionalInfo = new ArrayList<>(); } @@ -308,11 +308,11 @@ public PriceError addAdditionalInfoItem(PriceErrorAdditionalInfo additionalInfoI * @return additionalInfo */ @javax.annotation.Nullable - public List getAdditionalInfo() { + public List getAdditionalInfo() { return additionalInfo; } - public void setAdditionalInfo(@javax.annotation.Nullable List additionalInfo) { + public void setAdditionalInfo(@javax.annotation.Nullable List additionalInfo) { this.additionalInfo = additionalInfo; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ResponseUsageInputTokensDetails.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ResponseUsageInputTokensDetails.java deleted file mode 100644 index 87e2b3aa..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ResponseUsageInputTokensDetails.java +++ /dev/null @@ -1,290 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.Arrays; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * A detailed breakdown of the input tokens. - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class ResponseUsageInputTokensDetails { - public static final String SERIALIZED_NAME_CACHED_TOKENS = "cached_tokens"; - @SerializedName(SERIALIZED_NAME_CACHED_TOKENS) - @javax.annotation.Nonnull - private Integer cachedTokens; - - public ResponseUsageInputTokensDetails() { - } - - public ResponseUsageInputTokensDetails cachedTokens(@javax.annotation.Nonnull Integer cachedTokens) { - this.cachedTokens = cachedTokens; - return this; - } - - /** - * The number of tokens that were retrieved from the cache. [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). - * @return cachedTokens - */ - @javax.annotation.Nonnull - public Integer getCachedTokens() { - return cachedTokens; - } - - public void setCachedTokens(@javax.annotation.Nonnull Integer cachedTokens) { - this.cachedTokens = cachedTokens; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the ResponseUsageInputTokensDetails instance itself - */ - public ResponseUsageInputTokensDetails putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ResponseUsageInputTokensDetails responseUsageInputTokensDetails = (ResponseUsageInputTokensDetails) o; - return Objects.equals(this.cachedTokens, responseUsageInputTokensDetails.cachedTokens)&& - Objects.equals(this.additionalProperties, responseUsageInputTokensDetails.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(cachedTokens, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ResponseUsageInputTokensDetails {\n"); - sb.append(" cachedTokens: ").append(toIndentedString(cachedTokens)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("cached_tokens")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(Arrays.asList("cached_tokens")); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to ResponseUsageInputTokensDetails - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!ResponseUsageInputTokensDetails.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in ResponseUsageInputTokensDetails is not found in the empty JSON string", ResponseUsageInputTokensDetails.openapiRequiredFields.toString())); - } - } - - // check to make sure all required properties/fields are present in the JSON string - for (String requiredField : ResponseUsageInputTokensDetails.openapiRequiredFields) { - if (jsonElement.getAsJsonObject().get(requiredField) == null) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!ResponseUsageInputTokensDetails.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'ResponseUsageInputTokensDetails' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(ResponseUsageInputTokensDetails.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, ResponseUsageInputTokensDetails value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public ResponseUsageInputTokensDetails read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - ResponseUsageInputTokensDetails instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of ResponseUsageInputTokensDetails given an JSON string - * - * @param jsonString JSON string - * @return An instance of ResponseUsageInputTokensDetails - * @throws IOException if the JSON string is invalid with respect to ResponseUsageInputTokensDetails - */ - public static ResponseUsageInputTokensDetails fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, ResponseUsageInputTokensDetails.class); - } - - /** - * Convert an instance of ResponseUsageInputTokensDetails to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ResponseUsageOutputTokensDetails.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ResponseUsageOutputTokensDetails.java deleted file mode 100644 index 78b1348c..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ResponseUsageOutputTokensDetails.java +++ /dev/null @@ -1,290 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.Arrays; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * A detailed breakdown of the output tokens. - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class ResponseUsageOutputTokensDetails { - public static final String SERIALIZED_NAME_REASONING_TOKENS = "reasoning_tokens"; - @SerializedName(SERIALIZED_NAME_REASONING_TOKENS) - @javax.annotation.Nonnull - private Integer reasoningTokens; - - public ResponseUsageOutputTokensDetails() { - } - - public ResponseUsageOutputTokensDetails reasoningTokens(@javax.annotation.Nonnull Integer reasoningTokens) { - this.reasoningTokens = reasoningTokens; - return this; - } - - /** - * The number of reasoning tokens. - * @return reasoningTokens - */ - @javax.annotation.Nonnull - public Integer getReasoningTokens() { - return reasoningTokens; - } - - public void setReasoningTokens(@javax.annotation.Nonnull Integer reasoningTokens) { - this.reasoningTokens = reasoningTokens; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the ResponseUsageOutputTokensDetails instance itself - */ - public ResponseUsageOutputTokensDetails putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ResponseUsageOutputTokensDetails responseUsageOutputTokensDetails = (ResponseUsageOutputTokensDetails) o; - return Objects.equals(this.reasoningTokens, responseUsageOutputTokensDetails.reasoningTokens)&& - Objects.equals(this.additionalProperties, responseUsageOutputTokensDetails.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(reasoningTokens, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ResponseUsageOutputTokensDetails {\n"); - sb.append(" reasoningTokens: ").append(toIndentedString(reasoningTokens)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("reasoning_tokens")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(Arrays.asList("reasoning_tokens")); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to ResponseUsageOutputTokensDetails - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!ResponseUsageOutputTokensDetails.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in ResponseUsageOutputTokensDetails is not found in the empty JSON string", ResponseUsageOutputTokensDetails.openapiRequiredFields.toString())); - } - } - - // check to make sure all required properties/fields are present in the JSON string - for (String requiredField : ResponseUsageOutputTokensDetails.openapiRequiredFields) { - if (jsonElement.getAsJsonObject().get(requiredField) == null) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!ResponseUsageOutputTokensDetails.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'ResponseUsageOutputTokensDetails' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(ResponseUsageOutputTokensDetails.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, ResponseUsageOutputTokensDetails value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public ResponseUsageOutputTokensDetails read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - ResponseUsageOutputTokensDetails instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of ResponseUsageOutputTokensDetails given an JSON string - * - * @param jsonString JSON string - * @return An instance of ResponseUsageOutputTokensDetails - * @throws IOException if the JSON string is invalid with respect to ResponseUsageOutputTokensDetails - */ - public static ResponseUsageOutputTokensDetails fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, ResponseUsageOutputTokensDetails.class); - } - - /** - * Convert an instance of ResponseUsageOutputTokensDetails to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationRulesPatchRequestItem.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationRulesPatchRequestItem.java index 063280d8..90d73958 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationRulesPatchRequestItem.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationRulesPatchRequestItem.java @@ -62,8 +62,8 @@ public class RouteAggregationRulesPatchRequestItem { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public RouteAggregationRulesPatchRequestItem() { } @@ -106,7 +106,7 @@ public void setPath(@javax.annotation.Nonnull String path) { } - public RouteAggregationRulesPatchRequestItem value(@javax.annotation.Nonnull Object value) { + public RouteAggregationRulesPatchRequestItem value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -115,12 +115,12 @@ public RouteAggregationRulesPatchRequestItem value(@javax.annotation.Nonnull Obj * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationState.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationState.java deleted file mode 100644 index d43dab64..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationState.java +++ /dev/null @@ -1,88 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.annotations.SerializedName; - -import java.io.IOException; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.JsonElement; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; - -/** - * Route Aggregation status - */ -@JsonAdapter(RouteAggregationState.Adapter.class) -public enum RouteAggregationState { - - PROVISIONING("PROVISIONING"), - - REPROVISIONING("REPROVISIONING"), - - DEPROVISIONING("DEPROVISIONING"), - - PROVISIONED("PROVISIONED"), - - DEPROVISIONED("DEPROVISIONED"), - - NOT_PROVISIONED("NOT_PROVISIONED"), - - NOT_DEPROVISIONED("NOT_DEPROVISIONED"); - - private String value; - - RouteAggregationState(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static RouteAggregationState fromValue(String value) { - for (RouteAggregationState b : RouteAggregationState.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final RouteAggregationState enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public RouteAggregationState read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return RouteAggregationState.fromValue(value); - } - } - - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - String value = jsonElement.getAsString(); - RouteAggregationState.fromValue(value); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationsData.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationsData.java index df6dac9e..7e5852be 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationsData.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationsData.java @@ -14,7 +14,6 @@ import java.util.Objects; import java.util.Locale; import com.equinix.sdk.fabricv4.model.Changelog; -import com.equinix.sdk.fabricv4.model.RouteAggregationState; import com.equinix.sdk.fabricv4.model.RouteAggregationsChange; import com.equinix.sdk.fabricv4.model.RouteAggregationsDataProject; import com.google.gson.TypeAdapter; @@ -133,11 +132,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @javax.annotation.Nullable private String description; - public static final String SERIALIZED_NAME_STATE = "state"; - @SerializedName(SERIALIZED_NAME_STATE) - @javax.annotation.Nullable - private RouteAggregationState state; - public static final String SERIALIZED_NAME_CHANGE = "change"; @SerializedName(SERIALIZED_NAME_CHANGE) @javax.annotation.Nullable @@ -261,25 +255,6 @@ public void setDescription(@javax.annotation.Nullable String description) { } - public RouteAggregationsData state(@javax.annotation.Nullable RouteAggregationState state) { - this.state = state; - return this; - } - - /** - * Get state - * @return state - */ - @javax.annotation.Nullable - public RouteAggregationState getState() { - return state; - } - - public void setState(@javax.annotation.Nullable RouteAggregationState state) { - this.state = state; - } - - public RouteAggregationsData change(@javax.annotation.Nullable RouteAggregationsChange change) { this.change = change; return this; @@ -434,7 +409,6 @@ public boolean equals(Object o) { Objects.equals(this.uuid, routeAggregationsData.uuid) && Objects.equals(this.name, routeAggregationsData.name) && Objects.equals(this.description, routeAggregationsData.description) && - Objects.equals(this.state, routeAggregationsData.state) && Objects.equals(this.change, routeAggregationsData.change) && Objects.equals(this.connectionsCount, routeAggregationsData.connectionsCount) && Objects.equals(this.rulesCount, routeAggregationsData.rulesCount) && @@ -445,7 +419,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(href, type, uuid, name, description, state, change, connectionsCount, rulesCount, project, changeLog, additionalProperties); + return Objects.hash(href, type, uuid, name, description, change, connectionsCount, rulesCount, project, changeLog, additionalProperties); } @Override @@ -457,7 +431,6 @@ public String toString() { sb.append(" uuid: ").append(toIndentedString(uuid)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" state: ").append(toIndentedString(state)).append("\n"); sb.append(" change: ").append(toIndentedString(change)).append("\n"); sb.append(" connectionsCount: ").append(toIndentedString(connectionsCount)).append("\n"); sb.append(" rulesCount: ").append(toIndentedString(rulesCount)).append("\n"); @@ -485,7 +458,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("href", "type", "uuid", "name", "description", "state", "change", "connectionsCount", "rulesCount", "project", "changeLog")); + openapiFields = new HashSet(Arrays.asList("href", "type", "uuid", "name", "description", "change", "connectionsCount", "rulesCount", "project", "changeLog")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(0); @@ -523,10 +496,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("description") != null && !jsonObj.get("description").isJsonNull()) && !jsonObj.get("description").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `description` to be a primitive type in the JSON string but got `%s`", jsonObj.get("description").toString())); } - // validate the optional field `state` - if (jsonObj.get("state") != null && !jsonObj.get("state").isJsonNull()) { - RouteAggregationState.validateJsonElement(jsonObj.get("state")); - } // validate the optional field `change` if (jsonObj.get("change") != null && !jsonObj.get("change").isJsonNull()) { RouteAggregationsChange.validateJsonElement(jsonObj.get("change")); diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationsPatchRequestItem.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationsPatchRequestItem.java index 04a456ac..adda987e 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationsPatchRequestItem.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteAggregationsPatchRequestItem.java @@ -62,8 +62,8 @@ public class RouteAggregationsPatchRequestItem { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public RouteAggregationsPatchRequestItem() { } @@ -106,7 +106,7 @@ public void setPath(@javax.annotation.Nonnull String path) { } - public RouteAggregationsPatchRequestItem value(@javax.annotation.Nonnull Object value) { + public RouteAggregationsPatchRequestItem value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -115,12 +115,12 @@ public RouteAggregationsPatchRequestItem value(@javax.annotation.Nonnull Object * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFilterRulesPatchRequestItem.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFilterRulesPatchRequestItem.java index 8d784d29..73fdb27e 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFilterRulesPatchRequestItem.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFilterRulesPatchRequestItem.java @@ -62,8 +62,8 @@ public class RouteFilterRulesPatchRequestItem { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public RouteFilterRulesPatchRequestItem() { } @@ -106,7 +106,7 @@ public void setPath(@javax.annotation.Nonnull String path) { } - public RouteFilterRulesPatchRequestItem value(@javax.annotation.Nonnull Object value) { + public RouteFilterRulesPatchRequestItem value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -115,12 +115,12 @@ public RouteFilterRulesPatchRequestItem value(@javax.annotation.Nonnull Object v * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFilterState.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFilterState.java deleted file mode 100644 index 21467ae9..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFilterState.java +++ /dev/null @@ -1,88 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.annotations.SerializedName; - -import java.io.IOException; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.JsonElement; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; - -/** - * Route Filter status - */ -@JsonAdapter(RouteFilterState.Adapter.class) -public enum RouteFilterState { - - PROVISIONING("PROVISIONING"), - - REPROVISIONING("REPROVISIONING"), - - DEPROVISIONING("DEPROVISIONING"), - - PROVISIONED("PROVISIONED"), - - DEPROVISIONED("DEPROVISIONED"), - - NOT_PROVISIONED("NOT_PROVISIONED"), - - NOT_DEPROVISIONED("NOT_DEPROVISIONED"); - - private String value; - - RouteFilterState(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static RouteFilterState fromValue(String value) { - for (RouteFilterState b : RouteFilterState.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final RouteFilterState enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public RouteFilterState read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return RouteFilterState.fromValue(value); - } - } - - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - String value = jsonElement.getAsString(); - RouteFilterState.fromValue(value); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFiltersData.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFiltersData.java index 14c0dada..a4f2bd60 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFiltersData.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFiltersData.java @@ -14,7 +14,6 @@ import java.util.Objects; import java.util.Locale; import com.equinix.sdk.fabricv4.model.Changelog; -import com.equinix.sdk.fabricv4.model.RouteFilterState; import com.equinix.sdk.fabricv4.model.RouteFiltersChange; import com.equinix.sdk.fabricv4.model.RouteFiltersDataProject; import com.google.gson.TypeAdapter; @@ -133,11 +132,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @javax.annotation.Nullable private String description; - public static final String SERIALIZED_NAME_STATE = "state"; - @SerializedName(SERIALIZED_NAME_STATE) - @javax.annotation.Nullable - private RouteFilterState state; - public static final String SERIALIZED_NAME_CHANGE = "change"; @SerializedName(SERIALIZED_NAME_CHANGE) @javax.annotation.Nullable @@ -318,25 +312,6 @@ public void setDescription(@javax.annotation.Nullable String description) { } - public RouteFiltersData state(@javax.annotation.Nullable RouteFilterState state) { - this.state = state; - return this; - } - - /** - * Get state - * @return state - */ - @javax.annotation.Nullable - public RouteFilterState getState() { - return state; - } - - public void setState(@javax.annotation.Nullable RouteFilterState state) { - this.state = state; - } - - public RouteFiltersData change(@javax.annotation.Nullable RouteFiltersChange change) { this.change = change; return this; @@ -510,7 +485,6 @@ public boolean equals(Object o) { Objects.equals(this.uuid, routeFiltersData.uuid) && Objects.equals(this.name, routeFiltersData.name) && Objects.equals(this.description, routeFiltersData.description) && - Objects.equals(this.state, routeFiltersData.state) && Objects.equals(this.change, routeFiltersData.change) && Objects.equals(this.notMatchedRuleAction, routeFiltersData.notMatchedRuleAction) && Objects.equals(this.connectionsCount, routeFiltersData.connectionsCount) && @@ -522,7 +496,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(href, type, uuid, name, description, state, change, notMatchedRuleAction, connectionsCount, rulesCount, project, changelog, additionalProperties); + return Objects.hash(href, type, uuid, name, description, change, notMatchedRuleAction, connectionsCount, rulesCount, project, changelog, additionalProperties); } @Override @@ -534,7 +508,6 @@ public String toString() { sb.append(" uuid: ").append(toIndentedString(uuid)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" state: ").append(toIndentedString(state)).append("\n"); sb.append(" change: ").append(toIndentedString(change)).append("\n"); sb.append(" notMatchedRuleAction: ").append(toIndentedString(notMatchedRuleAction)).append("\n"); sb.append(" connectionsCount: ").append(toIndentedString(connectionsCount)).append("\n"); @@ -563,7 +536,7 @@ private String toIndentedString(Object o) { static { // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("href", "type", "uuid", "name", "description", "state", "change", "notMatchedRuleAction", "connectionsCount", "rulesCount", "project", "changelog")); + openapiFields = new HashSet(Arrays.asList("href", "type", "uuid", "name", "description", "change", "notMatchedRuleAction", "connectionsCount", "rulesCount", "project", "changelog")); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(0); @@ -601,10 +574,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("description") != null && !jsonObj.get("description").isJsonNull()) && !jsonObj.get("description").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `description` to be a primitive type in the JSON string but got `%s`", jsonObj.get("description").toString())); } - // validate the optional field `state` - if (jsonObj.get("state") != null && !jsonObj.get("state").isJsonNull()) { - RouteFilterState.validateJsonElement(jsonObj.get("state")); - } // validate the optional field `change` if (jsonObj.get("change") != null && !jsonObj.get("change").isJsonNull()) { RouteFiltersChange.validateJsonElement(jsonObj.get("change")); diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFiltersPatchRequestItem.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFiltersPatchRequestItem.java index d253ba30..f6e76341 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFiltersPatchRequestItem.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/RouteFiltersPatchRequestItem.java @@ -62,8 +62,8 @@ public class RouteFiltersPatchRequestItem { public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public RouteFiltersPatchRequestItem() { } @@ -106,7 +106,7 @@ public void setPath(@javax.annotation.Nonnull String path) { } - public RouteFiltersPatchRequestItem value(@javax.annotation.Nonnull Object value) { + public RouteFiltersPatchRequestItem value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -115,12 +115,12 @@ public RouteFiltersPatchRequestItem value(@javax.annotation.Nonnull Object value * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfile.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfile.java index 733db96c..43f7d251 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfile.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfile.java @@ -1022,10 +1022,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("projectId") != null && !jsonObj.get("projectId").isJsonNull()) && !jsonObj.get("projectId").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `projectId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("projectId").toString())); } - // validate the optional field `lastMileConfig` - if (jsonObj.get("lastMileConfig") != null && !jsonObj.get("lastMileConfig").isJsonNull()) { - ServiceProfileLastMileConfig.validateJsonElement(jsonObj.get("lastMileConfig")); - } } public static class CustomTypeAdapterFactory implements TypeAdapterFactory { diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfileLastMileConfig.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfileLastMileConfig.java index 0fd78646..f1a57b5c 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfileLastMileConfig.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfileLastMileConfig.java @@ -224,10 +224,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti } } JsonObject jsonObj = jsonElement.getAsJsonObject(); - // validate the optional field `apiIntegration` - if (jsonObj.get("apiIntegration") != null && !jsonObj.get("apiIntegration").isJsonNull()) { - ServiceProfileLastMileApiIntegration.validateJsonElement(jsonObj.get("apiIntegration")); - } if (jsonObj.get("productCatalogs") != null && !jsonObj.get("productCatalogs").isJsonNull()) { JsonArray jsonArrayproductCatalogs = jsonObj.getAsJsonArray("productCatalogs"); if (jsonArrayproductCatalogs != null) { diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfileRequest.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfileRequest.java index d3765d54..ae3c9b78 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfileRequest.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceProfileRequest.java @@ -903,10 +903,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("projectId") != null && !jsonObj.get("projectId").isJsonNull()) && !jsonObj.get("projectId").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `projectId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("projectId").toString())); } - // validate the optional field `lastMileConfig` - if (jsonObj.get("lastMileConfig") != null && !jsonObj.get("lastMileConfig").isJsonNull()) { - ServiceProfileLastMileConfig.validateJsonElement(jsonObj.get("lastMileConfig")); - } } public static class CustomTypeAdapterFactory implements TypeAdapterFactory { diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceTokenChangeOperation.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceTokenChangeOperation.java index 78f3b272..8a794a45 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceTokenChangeOperation.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ServiceTokenChangeOperation.java @@ -116,8 +116,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti public static final String SERIALIZED_NAME_VALUE = "value"; @SerializedName(SERIALIZED_NAME_VALUE) - @javax.annotation.Nonnull - private Object value; + @javax.annotation.Nullable + private Object value = null; public ServiceTokenChangeOperation() { } @@ -160,7 +160,7 @@ public void setPath(@javax.annotation.Nonnull String path) { } - public ServiceTokenChangeOperation value(@javax.annotation.Nonnull Object value) { + public ServiceTokenChangeOperation value(@javax.annotation.Nullable Object value) { this.value = value; return this; } @@ -169,12 +169,12 @@ public ServiceTokenChangeOperation value(@javax.annotation.Nonnull Object value) * new value for updated parameter * @return value */ - @javax.annotation.Nonnull + @javax.annotation.Nullable public Object getValue() { return value; } - public void setValue(@javax.annotation.Nonnull Object value) { + public void setValue(@javax.annotation.Nullable Object value) { this.value = value; } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/SignatureRequest.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/SignatureRequest.java deleted file mode 100644 index 4afaaf16..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/SignatureRequest.java +++ /dev/null @@ -1,322 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.equinix.sdk.fabricv4.model.SignatureType; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.Arrays; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * Cross Connect Order Signature. - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class SignatureRequest { - public static final String SERIALIZED_NAME_TYPE = "type"; - @SerializedName(SERIALIZED_NAME_TYPE) - @javax.annotation.Nonnull - private SignatureType type; - - public static final String SERIALIZED_NAME_EMAIL = "email"; - @SerializedName(SERIALIZED_NAME_EMAIL) - @javax.annotation.Nullable - private String email; - - public SignatureRequest() { - } - - public SignatureRequest type(@javax.annotation.Nonnull SignatureType type) { - this.type = type; - return this; - } - - /** - * Get type - * @return type - */ - @javax.annotation.Nonnull - public SignatureType getType() { - return type; - } - - public void setType(@javax.annotation.Nonnull SignatureType type) { - this.type = type; - } - - - public SignatureRequest email(@javax.annotation.Nullable String email) { - this.email = email; - return this; - } - - /** - * Signatory email address. - * @return email - */ - @javax.annotation.Nullable - public String getEmail() { - return email; - } - - public void setEmail(@javax.annotation.Nullable String email) { - this.email = email; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the SignatureRequest instance itself - */ - public SignatureRequest putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - SignatureRequest signatureRequest = (SignatureRequest) o; - return Objects.equals(this.type, signatureRequest.type) && - Objects.equals(this.email, signatureRequest.email)&& - Objects.equals(this.additionalProperties, signatureRequest.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(type, email, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class SignatureRequest {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("type", "email")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(Arrays.asList("type")); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to SignatureRequest - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!SignatureRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in SignatureRequest is not found in the empty JSON string", SignatureRequest.openapiRequiredFields.toString())); - } - } - - // check to make sure all required properties/fields are present in the JSON string - for (String requiredField : SignatureRequest.openapiRequiredFields) { - if (jsonElement.getAsJsonObject().get(requiredField) == null) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // validate the required field `type` - SignatureType.validateJsonElement(jsonObj.get("type")); - if ((jsonObj.get("email") != null && !jsonObj.get("email").isJsonNull()) && !jsonObj.get("email").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `email` to be a primitive type in the JSON string but got `%s`", jsonObj.get("email").toString())); - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!SignatureRequest.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'SignatureRequest' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(SignatureRequest.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, SignatureRequest value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public SignatureRequest read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - SignatureRequest instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of SignatureRequest given an JSON string - * - * @param jsonString JSON string - * @return An instance of SignatureRequest - * @throws IOException if the JSON string is invalid with respect to SignatureRequest - */ - public static SignatureRequest fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, SignatureRequest.class); - } - - /** - * Convert an instance of SignatureRequest to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/SimplifiedServiceProfile.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/SimplifiedServiceProfile.java index 04c3b06c..eaed57c2 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/SimplifiedServiceProfile.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/SimplifiedServiceProfile.java @@ -867,10 +867,6 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if ((jsonObj.get("projectId") != null && !jsonObj.get("projectId").isJsonNull()) && !jsonObj.get("projectId").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `projectId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("projectId").toString())); } - // validate the optional field `lastMileConfig` - if (jsonObj.get("lastMileConfig") != null && !jsonObj.get("lastMileConfig").isJsonNull()) { - ServiceProfileLastMileConfig.validateJsonElement(jsonObj.get("lastMileConfig")); - } } public static class CustomTypeAdapterFactory implements TypeAdapterFactory { diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/StreamAssetInterface.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/StreamAssetInterface.java deleted file mode 100644 index 12081819..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/StreamAssetInterface.java +++ /dev/null @@ -1,553 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.net.URI; -import java.util.Arrays; -import java.util.UUID; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * Network Edge Device interface attached to a stream - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class StreamAssetInterface { - public static final String SERIALIZED_NAME_HREF = "href"; - @SerializedName(SERIALIZED_NAME_HREF) - @javax.annotation.Nullable - private URI href; - - public static final String SERIALIZED_NAME_ID = "id"; - @SerializedName(SERIALIZED_NAME_ID) - @javax.annotation.Nullable - private Integer id; - - public static final String SERIALIZED_NAME_UUID = "uuid"; - @SerializedName(SERIALIZED_NAME_UUID) - @javax.annotation.Nullable - private UUID uuid; - - /** - * Network Edge Device interface type - */ - @JsonAdapter(TypeEnum.Adapter.class) - public enum TypeEnum { - DATA("DATA"), - - MGMT("MGMT"), - - SSH("SSH"), - - FAB("FAB"), - - CTRL("CTRL"); - - private String value; - - TypeEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static TypeEnum fromValue(String value) { - for (TypeEnum b : TypeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public TypeEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return TypeEnum.fromValue(value); - } - } - - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - String value = jsonElement.getAsString(); - TypeEnum.fromValue(value); - } - } - - public static final String SERIALIZED_NAME_TYPE = "type"; - @SerializedName(SERIALIZED_NAME_TYPE) - @javax.annotation.Nullable - private TypeEnum type; - - public static final String SERIALIZED_NAME_STATE = "state"; - @SerializedName(SERIALIZED_NAME_STATE) - @javax.annotation.Nullable - private String state; - - /** - * interface attachment status - */ - @JsonAdapter(AttachmentStatusEnum.Adapter.class) - public enum AttachmentStatusEnum { - ATTACHING("ATTACHING"), - - ATTACHED("ATTACHED"), - - DETACHED("DETACHED"), - - DETACHING("DETACHING"), - - FAILED("FAILED"); - - private String value; - - AttachmentStatusEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static AttachmentStatusEnum fromValue(String value) { - for (AttachmentStatusEnum b : AttachmentStatusEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final AttachmentStatusEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public AttachmentStatusEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return AttachmentStatusEnum.fromValue(value); - } - } - - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - String value = jsonElement.getAsString(); - AttachmentStatusEnum.fromValue(value); - } - } - - public static final String SERIALIZED_NAME_ATTACHMENT_STATUS = "attachmentStatus"; - @SerializedName(SERIALIZED_NAME_ATTACHMENT_STATUS) - @javax.annotation.Nullable - private AttachmentStatusEnum attachmentStatus; - - public StreamAssetInterface() { - } - - public StreamAssetInterface( - URI href - ) { - this(); - this.href = href; - } - - /** - * Network Edge Device interface URI - * @return href - */ - @javax.annotation.Nullable - public URI getHref() { - return href; - } - - - - public StreamAssetInterface id(@javax.annotation.Nullable Integer id) { - this.id = id; - return this; - } - - /** - * Network Edge Device interface identifier - * @return id - */ - @javax.annotation.Nullable - public Integer getId() { - return id; - } - - public void setId(@javax.annotation.Nullable Integer id) { - this.id = id; - } - - - public StreamAssetInterface uuid(@javax.annotation.Nullable UUID uuid) { - this.uuid = uuid; - return this; - } - - /** - * Network Edge Device interface UUID - * @return uuid - */ - @javax.annotation.Nullable - public UUID getUuid() { - return uuid; - } - - public void setUuid(@javax.annotation.Nullable UUID uuid) { - this.uuid = uuid; - } - - - public StreamAssetInterface type(@javax.annotation.Nullable TypeEnum type) { - this.type = type; - return this; - } - - /** - * Network Edge Device interface type - * @return type - */ - @javax.annotation.Nullable - public TypeEnum getType() { - return type; - } - - public void setType(@javax.annotation.Nullable TypeEnum type) { - this.type = type; - } - - - public StreamAssetInterface state(@javax.annotation.Nullable String state) { - this.state = state; - return this; - } - - /** - * Network Edge Device interface usage status - * @return state - */ - @javax.annotation.Nullable - public String getState() { - return state; - } - - public void setState(@javax.annotation.Nullable String state) { - this.state = state; - } - - - public StreamAssetInterface attachmentStatus(@javax.annotation.Nullable AttachmentStatusEnum attachmentStatus) { - this.attachmentStatus = attachmentStatus; - return this; - } - - /** - * interface attachment status - * @return attachmentStatus - */ - @javax.annotation.Nullable - public AttachmentStatusEnum getAttachmentStatus() { - return attachmentStatus; - } - - public void setAttachmentStatus(@javax.annotation.Nullable AttachmentStatusEnum attachmentStatus) { - this.attachmentStatus = attachmentStatus; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the StreamAssetInterface instance itself - */ - public StreamAssetInterface putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - StreamAssetInterface streamAssetInterface = (StreamAssetInterface) o; - return Objects.equals(this.href, streamAssetInterface.href) && - Objects.equals(this.id, streamAssetInterface.id) && - Objects.equals(this.uuid, streamAssetInterface.uuid) && - Objects.equals(this.type, streamAssetInterface.type) && - Objects.equals(this.state, streamAssetInterface.state) && - Objects.equals(this.attachmentStatus, streamAssetInterface.attachmentStatus)&& - Objects.equals(this.additionalProperties, streamAssetInterface.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(href, id, uuid, type, state, attachmentStatus, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class StreamAssetInterface {\n"); - sb.append(" href: ").append(toIndentedString(href)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" uuid: ").append(toIndentedString(uuid)).append("\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); - sb.append(" state: ").append(toIndentedString(state)).append("\n"); - sb.append(" attachmentStatus: ").append(toIndentedString(attachmentStatus)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("href", "id", "uuid", "type", "state", "attachmentStatus")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to StreamAssetInterface - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!StreamAssetInterface.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in StreamAssetInterface is not found in the empty JSON string", StreamAssetInterface.openapiRequiredFields.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - if ((jsonObj.get("href") != null && !jsonObj.get("href").isJsonNull()) && !jsonObj.get("href").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `href` to be a primitive type in the JSON string but got `%s`", jsonObj.get("href").toString())); - } - if ((jsonObj.get("uuid") != null && !jsonObj.get("uuid").isJsonNull()) && !jsonObj.get("uuid").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `uuid` to be a primitive type in the JSON string but got `%s`", jsonObj.get("uuid").toString())); - } - if ((jsonObj.get("type") != null && !jsonObj.get("type").isJsonNull()) && !jsonObj.get("type").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `type` to be a primitive type in the JSON string but got `%s`", jsonObj.get("type").toString())); - } - // validate the optional field `type` - if (jsonObj.get("type") != null && !jsonObj.get("type").isJsonNull()) { - TypeEnum.validateJsonElement(jsonObj.get("type")); - } - if ((jsonObj.get("state") != null && !jsonObj.get("state").isJsonNull()) && !jsonObj.get("state").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `state` to be a primitive type in the JSON string but got `%s`", jsonObj.get("state").toString())); - } - if ((jsonObj.get("attachmentStatus") != null && !jsonObj.get("attachmentStatus").isJsonNull()) && !jsonObj.get("attachmentStatus").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `attachmentStatus` to be a primitive type in the JSON string but got `%s`", jsonObj.get("attachmentStatus").toString())); - } - // validate the optional field `attachmentStatus` - if (jsonObj.get("attachmentStatus") != null && !jsonObj.get("attachmentStatus").isJsonNull()) { - AttachmentStatusEnum.validateJsonElement(jsonObj.get("attachmentStatus")); - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!StreamAssetInterface.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'StreamAssetInterface' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(StreamAssetInterface.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, StreamAssetInterface value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public StreamAssetInterface read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - StreamAssetInterface instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of StreamAssetInterface given an JSON string - * - * @param jsonString JSON string - * @return An instance of StreamAssetInterface - * @throws IOException if the JSON string is invalid with respect to StreamAssetInterface - */ - public static StreamAssetInterface fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, StreamAssetInterface.class); - } - - /** - * Convert an instance of StreamAssetInterface to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/TunnelRoutingProtocolIpv4.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/TunnelRoutingProtocolIpv4.java deleted file mode 100644 index cbed8db6..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/TunnelRoutingProtocolIpv4.java +++ /dev/null @@ -1,341 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.Arrays; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * IPv4 configuration for the Routing Protocol - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class TunnelRoutingProtocolIpv4 { - public static final String SERIALIZED_NAME_ENABLED = "enabled"; - @SerializedName(SERIALIZED_NAME_ENABLED) - @javax.annotation.Nullable - private Boolean enabled; - - public static final String SERIALIZED_NAME_LOCAL_PEER_IP = "localPeerIp"; - @SerializedName(SERIALIZED_NAME_LOCAL_PEER_IP) - @javax.annotation.Nullable - private String localPeerIp; - - public static final String SERIALIZED_NAME_REMOTE_PEER_IP = "remotePeerIp"; - @SerializedName(SERIALIZED_NAME_REMOTE_PEER_IP) - @javax.annotation.Nullable - private String remotePeerIp; - - public TunnelRoutingProtocolIpv4() { - } - - public TunnelRoutingProtocolIpv4 enabled(@javax.annotation.Nullable Boolean enabled) { - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the Routing Protocol on IPv4 - * @return enabled - */ - @javax.annotation.Nullable - public Boolean getEnabled() { - return enabled; - } - - public void setEnabled(@javax.annotation.Nullable Boolean enabled) { - this.enabled = enabled; - } - - - public TunnelRoutingProtocolIpv4 localPeerIp(@javax.annotation.Nullable String localPeerIp) { - this.localPeerIp = localPeerIp; - return this; - } - - /** - * The local IP address - * @return localPeerIp - */ - @javax.annotation.Nullable - public String getLocalPeerIp() { - return localPeerIp; - } - - public void setLocalPeerIp(@javax.annotation.Nullable String localPeerIp) { - this.localPeerIp = localPeerIp; - } - - - public TunnelRoutingProtocolIpv4 remotePeerIp(@javax.annotation.Nullable String remotePeerIp) { - this.remotePeerIp = remotePeerIp; - return this; - } - - /** - * The remote peer's IP address - * @return remotePeerIp - */ - @javax.annotation.Nullable - public String getRemotePeerIp() { - return remotePeerIp; - } - - public void setRemotePeerIp(@javax.annotation.Nullable String remotePeerIp) { - this.remotePeerIp = remotePeerIp; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the TunnelRoutingProtocolIpv4 instance itself - */ - public TunnelRoutingProtocolIpv4 putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TunnelRoutingProtocolIpv4 tunnelRoutingProtocolIpv4 = (TunnelRoutingProtocolIpv4) o; - return Objects.equals(this.enabled, tunnelRoutingProtocolIpv4.enabled) && - Objects.equals(this.localPeerIp, tunnelRoutingProtocolIpv4.localPeerIp) && - Objects.equals(this.remotePeerIp, tunnelRoutingProtocolIpv4.remotePeerIp)&& - Objects.equals(this.additionalProperties, tunnelRoutingProtocolIpv4.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(enabled, localPeerIp, remotePeerIp, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TunnelRoutingProtocolIpv4 {\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" localPeerIp: ").append(toIndentedString(localPeerIp)).append("\n"); - sb.append(" remotePeerIp: ").append(toIndentedString(remotePeerIp)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("enabled", "localPeerIp", "remotePeerIp")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to TunnelRoutingProtocolIpv4 - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!TunnelRoutingProtocolIpv4.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in TunnelRoutingProtocolIpv4 is not found in the empty JSON string", TunnelRoutingProtocolIpv4.openapiRequiredFields.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - if ((jsonObj.get("localPeerIp") != null && !jsonObj.get("localPeerIp").isJsonNull()) && !jsonObj.get("localPeerIp").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `localPeerIp` to be a primitive type in the JSON string but got `%s`", jsonObj.get("localPeerIp").toString())); - } - if ((jsonObj.get("remotePeerIp") != null && !jsonObj.get("remotePeerIp").isJsonNull()) && !jsonObj.get("remotePeerIp").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `remotePeerIp` to be a primitive type in the JSON string but got `%s`", jsonObj.get("remotePeerIp").toString())); - } - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!TunnelRoutingProtocolIpv4.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'TunnelRoutingProtocolIpv4' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(TunnelRoutingProtocolIpv4.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, TunnelRoutingProtocolIpv4 value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public TunnelRoutingProtocolIpv4 read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - TunnelRoutingProtocolIpv4 instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of TunnelRoutingProtocolIpv4 given an JSON string - * - * @param jsonString JSON string - * @return An instance of TunnelRoutingProtocolIpv4 - * @throws IOException if the JSON string is invalid with respect to TunnelRoutingProtocolIpv4 - */ - public static TunnelRoutingProtocolIpv4 fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, TunnelRoutingProtocolIpv4.class); - } - - /** - * Convert an instance of TunnelRoutingProtocolIpv4 to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/TunnelRoutingProtocolPostRequestIpv4.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/TunnelRoutingProtocolPostRequestIpv4.java deleted file mode 100644 index 5ef7481d..00000000 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/TunnelRoutingProtocolPostRequestIpv4.java +++ /dev/null @@ -1,283 +0,0 @@ -/* - * Equinix Fabric API v4 - * - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.equinix.sdk.fabricv4.model; - -import java.util.Objects; -import java.util.Locale; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; -import java.util.Arrays; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonDeserializationContext; -import com.google.gson.JsonDeserializer; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParseException; -import com.google.gson.TypeAdapterFactory; -import com.google.gson.reflect.TypeToken; -import com.google.gson.TypeAdapter; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.Locale; - -import com.equinix.sdk.fabricv4.JSON; - -/** - * IPv4 configuration for the Routing Protocol - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class TunnelRoutingProtocolPostRequestIpv4 { - public static final String SERIALIZED_NAME_ENABLED = "enabled"; - @SerializedName(SERIALIZED_NAME_ENABLED) - @javax.annotation.Nullable - private Boolean enabled; - - public TunnelRoutingProtocolPostRequestIpv4() { - } - - public TunnelRoutingProtocolPostRequestIpv4 enabled(@javax.annotation.Nullable Boolean enabled) { - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the Routing Protocol on IPv4 - * @return enabled - */ - @javax.annotation.Nullable - public Boolean getEnabled() { - return enabled; - } - - public void setEnabled(@javax.annotation.Nullable Boolean enabled) { - this.enabled = enabled; - } - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - private Map additionalProperties; - - /** - * Set the additional (undeclared) property with the specified name and value. - * If the property does not already exist, create it otherwise replace it. - * - * @param key name of the property - * @param value value of the property - * @return the TunnelRoutingProtocolPostRequestIpv4 instance itself - */ - public TunnelRoutingProtocolPostRequestIpv4 putAdditionalProperty(String key, Object value) { - if (this.additionalProperties == null) { - this.additionalProperties = new HashMap(); - } - this.additionalProperties.put(key, value); - return this; - } - - /** - * Return the additional (undeclared) property. - * - * @return a map of objects - */ - public Map getAdditionalProperties() { - return additionalProperties; - } - - /** - * Return the additional (undeclared) property with the specified name. - * - * @param key name of the property - * @return an object - */ - public Object getAdditionalProperty(String key) { - if (this.additionalProperties == null) { - return null; - } - return this.additionalProperties.get(key); - } - - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TunnelRoutingProtocolPostRequestIpv4 tunnelRoutingProtocolPostRequestIpv4 = (TunnelRoutingProtocolPostRequestIpv4) o; - return Objects.equals(this.enabled, tunnelRoutingProtocolPostRequestIpv4.enabled)&& - Objects.equals(this.additionalProperties, tunnelRoutingProtocolPostRequestIpv4.additionalProperties); - } - - @Override - public int hashCode() { - return Objects.hash(enabled, additionalProperties); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TunnelRoutingProtocolPostRequestIpv4 {\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - - - public static HashSet openapiFields; - public static HashSet openapiRequiredFields; - - static { - // a set of all properties/fields (JSON key names) - openapiFields = new HashSet(Arrays.asList("enabled")); - - // a set of required properties/fields (JSON key names) - openapiRequiredFields = new HashSet(0); - } - - /** - * Validates the JSON Element and throws an exception if issues found - * - * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to TunnelRoutingProtocolPostRequestIpv4 - */ - public static void validateJsonElement(JsonElement jsonElement) throws IOException { - if (jsonElement == null) { - if (!TunnelRoutingProtocolPostRequestIpv4.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in TunnelRoutingProtocolPostRequestIpv4 is not found in the empty JSON string", TunnelRoutingProtocolPostRequestIpv4.openapiRequiredFields.toString())); - } - } - JsonObject jsonObj = jsonElement.getAsJsonObject(); - } - - public static class CustomTypeAdapterFactory implements TypeAdapterFactory { - @SuppressWarnings("unchecked") - @Override - public TypeAdapter create(Gson gson, TypeToken type) { - if (!TunnelRoutingProtocolPostRequestIpv4.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'TunnelRoutingProtocolPostRequestIpv4' and its subtypes - } - final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(TunnelRoutingProtocolPostRequestIpv4.class)); - - return (TypeAdapter) new TypeAdapter() { - @Override - public void write(JsonWriter out, TunnelRoutingProtocolPostRequestIpv4 value) throws IOException { - JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); - obj.remove("additionalProperties"); - // serialize additional properties - if (value.getAdditionalProperties() != null) { - for (Map.Entry entry : value.getAdditionalProperties().entrySet()) { - if (entry.getValue() instanceof String) - obj.addProperty(entry.getKey(), (String) entry.getValue()); - else if (entry.getValue() instanceof Number) - obj.addProperty(entry.getKey(), (Number) entry.getValue()); - else if (entry.getValue() instanceof Boolean) - obj.addProperty(entry.getKey(), (Boolean) entry.getValue()); - else if (entry.getValue() instanceof Character) - obj.addProperty(entry.getKey(), (Character) entry.getValue()); - else { - JsonElement jsonElement = gson.toJsonTree(entry.getValue()); - if (jsonElement.isJsonArray()) { - obj.add(entry.getKey(), jsonElement.getAsJsonArray()); - } else { - obj.add(entry.getKey(), jsonElement.getAsJsonObject()); - } - } - } - } - elementAdapter.write(out, obj); - } - - @Override - public TunnelRoutingProtocolPostRequestIpv4 read(JsonReader in) throws IOException { - JsonElement jsonElement = elementAdapter.read(in); - validateJsonElement(jsonElement); - JsonObject jsonObj = jsonElement.getAsJsonObject(); - // store additional fields in the deserialized instance - TunnelRoutingProtocolPostRequestIpv4 instance = thisAdapter.fromJsonTree(jsonObj); - for (Map.Entry entry : jsonObj.entrySet()) { - if (!openapiFields.contains(entry.getKey())) { - if (entry.getValue().isJsonPrimitive()) { // primitive type - if (entry.getValue().getAsJsonPrimitive().isString()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString()); - else if (entry.getValue().getAsJsonPrimitive().isNumber()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber()); - else if (entry.getValue().getAsJsonPrimitive().isBoolean()) - instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean()); - else - throw new IllegalArgumentException(String.format(Locale.ROOT, "The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString())); - } else if (entry.getValue().isJsonArray()) { - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class)); - } else { // JSON object - instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class)); - } - } - } - return instance; - } - - }.nullSafe(); - } - } - - /** - * Create an instance of TunnelRoutingProtocolPostRequestIpv4 given an JSON string - * - * @param jsonString JSON string - * @return An instance of TunnelRoutingProtocolPostRequestIpv4 - * @throws IOException if the JSON string is invalid with respect to TunnelRoutingProtocolPostRequestIpv4 - */ - public static TunnelRoutingProtocolPostRequestIpv4 fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, TunnelRoutingProtocolPostRequestIpv4.class); - } - - /** - * Convert an instance of TunnelRoutingProtocolPostRequestIpv4 to an JSON string - * - * @return JSON string - */ - public String toJson() { - return JSON.getGson().toJson(this); - } -} - diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ValidateRequestFilter.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ValidateRequestFilter.java index 7136e520..1811c3cb 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ValidateRequestFilter.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ValidateRequestFilter.java @@ -13,7 +13,7 @@ import java.util.Objects; import java.util.Locale; -import com.equinix.sdk.fabricv4.model.ValidateRequestFilterAnd; +import com.equinix.sdk.fabricv4.model.ValidateRequestFilterAndInner; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -56,17 +56,17 @@ public class ValidateRequestFilter { public static final String SERIALIZED_NAME_AND = "and"; @SerializedName(SERIALIZED_NAME_AND) @javax.annotation.Nullable - private List and = new ArrayList<>(); + private List and = new ArrayList<>(); public ValidateRequestFilter() { } - public ValidateRequestFilter and(@javax.annotation.Nullable List and) { + public ValidateRequestFilter and(@javax.annotation.Nullable List and) { this.and = and; return this; } - public ValidateRequestFilter addAndItem(ValidateRequestFilterAnd andItem) { + public ValidateRequestFilter addAndItem(ValidateRequestFilterAndInner andItem) { if (this.and == null) { this.and = new ArrayList<>(); } @@ -79,11 +79,11 @@ public ValidateRequestFilter addAndItem(ValidateRequestFilterAnd andItem) { * @return and */ @javax.annotation.Nullable - public List getAnd() { + public List getAnd() { return and; } - public void setAnd(@javax.annotation.Nullable List and) { + public void setAnd(@javax.annotation.Nullable List and) { this.and = and; } @@ -207,7 +207,7 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti // validate the optional field `and` (array) for (int i = 0; i < jsonArrayand.size(); i++) { - ValidateRequestFilterAnd.validateJsonElement(jsonArrayand.get(i)); + ValidateRequestFilterAndInner.validateJsonElement(jsonArrayand.get(i)); }; } } diff --git a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ValidateRequestFilterAnd.java b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ValidateRequestFilterAndInner.java similarity index 83% rename from services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ValidateRequestFilterAnd.java rename to services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ValidateRequestFilterAndInner.java index 8ba21326..a85e84d5 100644 --- a/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ValidateRequestFilterAnd.java +++ b/services/fabricv4/src/main/java/com/equinix/sdk/fabricv4/model/ValidateRequestFilterAndInner.java @@ -48,10 +48,10 @@ import com.equinix.sdk.fabricv4.JSON; /** - * ValidateRequestFilterAnd + * ValidateRequestFilterAndInner */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.16.0") -public class ValidateRequestFilterAnd { +public class ValidateRequestFilterAndInner { public static final String SERIALIZED_NAME_PROPERTY = "property"; @SerializedName(SERIALIZED_NAME_PROPERTY) @javax.annotation.Nullable @@ -67,10 +67,10 @@ public class ValidateRequestFilterAnd { @javax.annotation.Nullable private List values = new ArrayList<>(); - public ValidateRequestFilterAnd() { + public ValidateRequestFilterAndInner() { } - public ValidateRequestFilterAnd property(@javax.annotation.Nullable String property) { + public ValidateRequestFilterAndInner property(@javax.annotation.Nullable String property) { this.property = property; return this; } @@ -89,7 +89,7 @@ public void setProperty(@javax.annotation.Nullable String property) { } - public ValidateRequestFilterAnd operator(@javax.annotation.Nullable String operator) { + public ValidateRequestFilterAndInner operator(@javax.annotation.Nullable String operator) { this.operator = operator; return this; } @@ -108,12 +108,12 @@ public void setOperator(@javax.annotation.Nullable String operator) { } - public ValidateRequestFilterAnd values(@javax.annotation.Nullable List values) { + public ValidateRequestFilterAndInner values(@javax.annotation.Nullable List values) { this.values = values; return this; } - public ValidateRequestFilterAnd addValuesItem(String valuesItem) { + public ValidateRequestFilterAndInner addValuesItem(String valuesItem) { if (this.values == null) { this.values = new ArrayList<>(); } @@ -147,9 +147,9 @@ public void setValues(@javax.annotation.Nullable List values) { * * @param key name of the property * @param value value of the property - * @return the ValidateRequestFilterAnd instance itself + * @return the ValidateRequestFilterAndInner instance itself */ - public ValidateRequestFilterAnd putAdditionalProperty(String key, Object value) { + public ValidateRequestFilterAndInner putAdditionalProperty(String key, Object value) { if (this.additionalProperties == null) { this.additionalProperties = new HashMap(); } @@ -188,11 +188,11 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - ValidateRequestFilterAnd validateRequestFilterAnd = (ValidateRequestFilterAnd) o; - return Objects.equals(this.property, validateRequestFilterAnd.property) && - Objects.equals(this.operator, validateRequestFilterAnd.operator) && - Objects.equals(this.values, validateRequestFilterAnd.values)&& - Objects.equals(this.additionalProperties, validateRequestFilterAnd.additionalProperties); + ValidateRequestFilterAndInner validateRequestFilterAndInner = (ValidateRequestFilterAndInner) o; + return Objects.equals(this.property, validateRequestFilterAndInner.property) && + Objects.equals(this.operator, validateRequestFilterAndInner.operator) && + Objects.equals(this.values, validateRequestFilterAndInner.values)&& + Objects.equals(this.additionalProperties, validateRequestFilterAndInner.additionalProperties); } @Override @@ -203,7 +203,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class ValidateRequestFilterAnd {\n"); + sb.append("class ValidateRequestFilterAndInner {\n"); sb.append(" property: ").append(toIndentedString(property)).append("\n"); sb.append(" operator: ").append(toIndentedString(operator)).append("\n"); sb.append(" values: ").append(toIndentedString(values)).append("\n"); @@ -239,12 +239,12 @@ private String toIndentedString(Object o) { * Validates the JSON Element and throws an exception if issues found * * @param jsonElement JSON Element - * @throws IOException if the JSON Element is invalid with respect to ValidateRequestFilterAnd + * @throws IOException if the JSON Element is invalid with respect to ValidateRequestFilterAndInner */ public static void validateJsonElement(JsonElement jsonElement) throws IOException { if (jsonElement == null) { - if (!ValidateRequestFilterAnd.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null - throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in ValidateRequestFilterAnd is not found in the empty JSON string", ValidateRequestFilterAnd.openapiRequiredFields.toString())); + if (!ValidateRequestFilterAndInner.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null + throw new IllegalArgumentException(String.format(Locale.ROOT, "The required field(s) %s in ValidateRequestFilterAndInner is not found in the empty JSON string", ValidateRequestFilterAndInner.openapiRequiredFields.toString())); } } JsonObject jsonObj = jsonElement.getAsJsonObject(); @@ -264,16 +264,16 @@ public static class CustomTypeAdapterFactory implements TypeAdapterFactory { @SuppressWarnings("unchecked") @Override public TypeAdapter create(Gson gson, TypeToken type) { - if (!ValidateRequestFilterAnd.class.isAssignableFrom(type.getRawType())) { - return null; // this class only serializes 'ValidateRequestFilterAnd' and its subtypes + if (!ValidateRequestFilterAndInner.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'ValidateRequestFilterAndInner' and its subtypes } final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); - final TypeAdapter thisAdapter - = gson.getDelegateAdapter(this, TypeToken.get(ValidateRequestFilterAnd.class)); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(ValidateRequestFilterAndInner.class)); - return (TypeAdapter) new TypeAdapter() { + return (TypeAdapter) new TypeAdapter() { @Override - public void write(JsonWriter out, ValidateRequestFilterAnd value) throws IOException { + public void write(JsonWriter out, ValidateRequestFilterAndInner value) throws IOException { JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); obj.remove("additionalProperties"); // serialize additional properties @@ -301,12 +301,12 @@ else if (entry.getValue() instanceof Character) } @Override - public ValidateRequestFilterAnd read(JsonReader in) throws IOException { + public ValidateRequestFilterAndInner read(JsonReader in) throws IOException { JsonElement jsonElement = elementAdapter.read(in); validateJsonElement(jsonElement); JsonObject jsonObj = jsonElement.getAsJsonObject(); // store additional fields in the deserialized instance - ValidateRequestFilterAnd instance = thisAdapter.fromJsonTree(jsonObj); + ValidateRequestFilterAndInner instance = thisAdapter.fromJsonTree(jsonObj); for (Map.Entry entry : jsonObj.entrySet()) { if (!openapiFields.contains(entry.getKey())) { if (entry.getValue().isJsonPrimitive()) { // primitive type @@ -333,18 +333,18 @@ else if (entry.getValue().getAsJsonPrimitive().isBoolean()) } /** - * Create an instance of ValidateRequestFilterAnd given an JSON string + * Create an instance of ValidateRequestFilterAndInner given an JSON string * * @param jsonString JSON string - * @return An instance of ValidateRequestFilterAnd - * @throws IOException if the JSON string is invalid with respect to ValidateRequestFilterAnd + * @return An instance of ValidateRequestFilterAndInner + * @throws IOException if the JSON string is invalid with respect to ValidateRequestFilterAndInner */ - public static ValidateRequestFilterAnd fromJson(String jsonString) throws IOException { - return JSON.getGson().fromJson(jsonString, ValidateRequestFilterAnd.class); + public static ValidateRequestFilterAndInner fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, ValidateRequestFilterAndInner.class); } /** - * Convert an instance of ValidateRequestFilterAnd to an JSON string + * Convert an instance of ValidateRequestFilterAndInner to an JSON string * * @return JSON string */ diff --git a/spec/services/fabricv4/oas3.fetched/openapi.yaml b/spec/services/fabricv4/oas3.fetched/openapi.yaml index 05e938bc..bb19aabc 100644 --- a/spec/services/fabricv4/oas3.fetched/openapi.yaml +++ b/spec/services/fabricv4/oas3.fetched/openapi.yaml @@ -1,5 +1,6 @@ openapi: 3.0.3 info: + version: 4.34.0 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 @@ -9,10 +10,6 @@ info: license: name: Equinix Inc url: https://developer.equinix.com/agreement - version: "4.34.0" -externalDocs: - description: Find more information on Equinix Developer Portal - url: https://developer.equinix.com servers: - url: https://api.equinix.com description: Equinix Inc @@ -99,7 +96,633 @@ tags: description: Streams - name: Tags description: Tags Beta +externalDocs: + url: https://developer.equinix.com + description: Find more information on Equinix Developer Portal paths: + /fabric/v4/asns: + post: + tags: + - ASNs + summary: Create ASN + description: Create a new Public or Private ASN record + operationId: createAsn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAsnRequest' + examples: + CreatePublicAsn: + summary: Create a public ASN + value: + type: PUBLIC_ASN + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + number: 64497 + rirRegion: RIPE_NCC + ownershipChallengeDetails: + type: RPKI + CreatePrivateAsn: + summary: Create a private ASN + value: + type: PRIVATE_ASN + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + location: + metroCode: SV + range: 16_BIT + required: true + responses: + '202': + description: ASN request accepted + content: + application/json: + schema: + $ref: '#/components/schemas/Asn' + examples: + PublicAsnCreated: + summary: Public ASN creation response + value: + href: fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43 + uuid: 6db706f8-2a37-4546-a3ed-1df113a84d43 + type: PUBLIC_ASN + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + state: PENDING + number: 64497 + rirRegion: RIPE_NCC + ownershipChallengeDetails: + type: RPKI + message: eqx-rpki-challenge-2026-04-21T11:20:00Z-64497 + signature: null + assets: [] + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + PrivateAsnCreated: + summary: Private ASN creation response + value: + href: fabric/v4/asns/3b37813d-f8bf-4152-bf8f-43d661860ba3 + uuid: 3b37813d-f8bf-4152-bf8f-43d661860ba3 + type: PRIVATE_ASN + state: PROVISIONING + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + location: + metroCode: SV + number: null + range: 16_BIT + assets: [] + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH + /fabric/v4/asns/search: + post: + tags: + - ASNs + summary: Search ASNs + description: Search for ASN records based on criteria + operationId: searchAsns + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AsnSearchRequestBody' + examples: + SearchByProject: + summary: Search ASNs by project + value: + pagination: + offset: 0 + limit: 25 + filter: + and: + - property: /project/projectId + operator: '=' + values: + - 03ed2230-604a-494c-bca2-c042d38d80bc + sort: + - direction: DESC + property: /changeLog/createdDateTime + required: true + responses: + '200': + description: ASN records found successfully + content: + application/json: + schema: + $ref: '#/components/schemas/AsnSearchResponseBody' + examples: + SearchAsnsByProject: + summary: Search results for an ASN project + value: + pagination: + total: 1 + sort: + - direction: DESC + property: /changeLog/createdDateTime + data: + - href: fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43 + uuid: 6db706f8-2a37-4546-a3ed-1df113a84d43 + type: PUBLIC_ASN + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + state: PROVISIONING + number: 64497 + rirRegion: RIPE_NCC + ownershipChallengeDetails: + type: RPKI + message: eqx-rpki-challenge-2026-04-21T11:20:00Z-64497 + signature: MEUCIQCrExampleBase64SignatureValue7h4Yg== + assets: + - service: + href: https://api.equinix.com/fabric/v4/internetAccessService/52fbdb3f-8def-410d-868b-ef920878bff8 + type: IA + uuid: 52fbdb3f-8def-410d-868b-ef920878bff8 + announcingMetro: LD + ipBlocks: + - href: https://api.equinix.com/fabric/v4/ipBlocks/129afa61-f706-41cb-a03a-69a276bdb0b4 + type: IPV4_IP_BLOCK + uuid: 129afa61-f706-41cb-a03a-69a276bdb0b4 + - href: https://api.equinix.com/fabric/v4/ipBlocks/72fc7c32-67c8-4ae4-b43f-d4d656961f04 + type: IPV6_IP_BLOCK + uuid: 72fc7c32-67c8-4ae4-b43f-d4d656961f04 + changeLog: + createdDateTime: '2025-12-01T12:11:22.222Z' + updatedDateTime: '2025-12-01T13:11:22.222Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH + /fabric/v4/asns/{asnId}: + get: + tags: + - ASNs + summary: Get ASN + description: Retrieve ASN record by UUID + operationId: getAsnById + parameters: + - name: asnId + in: path + description: UUID of the ASN record + required: true + schema: + type: string + format: uuid + responses: + '200': + description: ASN retrieved successfully + content: + application/json: + schema: + $ref: '#/components/schemas/Asn' + examples: + PublicAsnRetrieved: + summary: Public ASN after ownership signature update + value: + href: fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43 + uuid: 6db706f8-2a37-4546-a3ed-1df113a84d43 + type: PUBLIC_ASN + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + state: PROVISIONING + number: 64497 + rirRegion: RIPE_NCC + ownershipChallengeDetails: + type: RPKI + message: eqx-rpki-challenge-2026-04-21T11:20:00Z-64497 + signature: MEUCIQCrExampleBase64SignatureValue7h4Yg== + assets: + - service: + href: https://api.equinix.com/fabric/v4/internetAccessService/52fbdb3f-8def-410d-868b-ef920878bff8 + type: IA + uuid: 52fbdb3f-8def-410d-868b-ef920878bff8 + announcingMetro: LD + ipBlocks: + - href: https://api.equinix.com/fabric/v4/ipBlocks/129afa61-f706-41cb-a03a-69a276bdb0b4 + type: IPV4_IP_BLOCK + uuid: 129afa61-f706-41cb-a03a-69a276bdb0b4 + - href: https://api.equinix.com/fabric/v4/ipBlocks/72fc7c32-67c8-4ae4-b43f-d4d656961f04 + type: IPV6_IP_BLOCK + uuid: 72fc7c32-67c8-4ae4-b43f-d4d656961f04 + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + updatedDateTime: '2025-12-01T13:11:22.222351Z' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH + patch: + tags: + - ASNs + summary: Update ASN + description: Update ASN record + operationId: patchAsnById + parameters: + - name: asnId + in: path + description: UUID of the ASN record + required: true + schema: + type: string + format: uuid + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AsnPatchRequest' + examples: + AddOwnershipSignature: + summary: Add the ownership challenge signature + value: + - op: replace + path: /ownershipChallengeDetails/signature + value: MEUCIQCrExampleBase64SignatureValue7h4Yg== + required: true + responses: + '202': + description: ASN request accepted + content: + application/json: + schema: + $ref: '#/components/schemas/Asn' + examples: + PublicAsnCreated: + summary: Public ASN creation response + value: + href: fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43 + uuid: 6db706f8-2a37-4546-a3ed-1df113a84d43 + type: PUBLIC_ASN + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + state: PENDING + number: 64497 + rirRegion: RIPE_NCC + ownershipChallengeDetails: + type: RPKI + message: eqx-rpki-challenge-2026-04-21T11:20:00Z-64497 + signature: null + assets: [] + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + PrivateAsnCreated: + summary: Private ASN creation response + value: + href: fabric/v4/asns/3b37813d-f8bf-4152-bf8f-43d661860ba3 + uuid: 3b37813d-f8bf-4152-bf8f-43d661860ba3 + type: PRIVATE_ASN + state: PROVISIONING + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + location: + metroCode: SV + number: null + range: 16_BIT + assets: [] + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH + delete: + tags: + - ASNs + summary: Delete ASN + description: Deprovision ASN record by UUID + operationId: deleteAsnById + parameters: + - name: asnId + in: path + description: UUID of the ASN record + required: true + schema: + type: string + format: uuid + responses: + '202': + description: ASN request accepted + content: + application/json: + schema: + $ref: '#/components/schemas/Asn' + examples: + PublicAsnCreated: + summary: Public ASN creation response + value: + href: fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43 + uuid: 6db706f8-2a37-4546-a3ed-1df113a84d43 + type: PUBLIC_ASN + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + state: PENDING + number: 64497 + rirRegion: RIPE_NCC + ownershipChallengeDetails: + type: RPKI + message: eqx-rpki-challenge-2026-04-21T11:20:00Z-64497 + signature: null + assets: [] + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + PrivateAsnCreated: + summary: Private ASN creation response + value: + href: fabric/v4/asns/3b37813d-f8bf-4152-bf8f-43d661860ba3 + uuid: 3b37813d-f8bf-4152-bf8f-43d661860ba3 + type: PRIVATE_ASN + state: PROVISIONING + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + location: + metroCode: SV + number: null + range: 16_BIT + assets: [] + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/{asset}/{assetId}/cloudevents: get: tags: @@ -107,90 +730,189 @@ paths: summary: Get Cloud Events by Asset Id (Deprecated) description: This API provides capability to retrieve cloud events of an asset id operationId: getCloudEventByAssetId + deprecated: true parameters: - name: asset in: path description: asset required: true schema: - $ref: "#/components/schemas/CloudEventAssetType" + $ref: '#/components/schemas/CloudEventAssetType' - name: assetId in: path description: asset UUID required: true schema: - $ref: "#/components/schemas/AssetId" + description: Asset UUID + type: string + format: uuid + example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - name: fromDateTime in: query description: Start date and time required: false schema: - $ref: "#/components/schemas/StartDateTime" + $ref: '#/components/schemas/StartDateTime' - name: toDateTime in: query description: End date and time required: false schema: - $ref: "#/components/schemas/EndDateTime" + $ref: '#/components/schemas/EndDateTime' - name: offset in: query description: offset required: false schema: - $ref: "#/components/schemas/Offset" + $ref: '#/components/schemas/Offset' - name: limit in: query description: limit required: false schema: - $ref: "#/components/schemas/Limit" + $ref: '#/components/schemas/Limit' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetCloudEventsByAssetResponse" + $ref: '#/components/schemas/GetCloudEventsByAssetResponse' examples: Example: - $ref: "#/components/examples/get-cloud-events-by-asset-id" - "401": + 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 + traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, + tracestate: 71a60705518f,81a607055181 + data: + message: Neighbor 100.100.100.102 address session state changed to Connect + auth: + authtype: system + authid: 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' + traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, + tracestate: 71a60705518f,81a607055181 + data: + message: Connection named TEST-CONNECTION state changed to provisioning + resource: + href: http://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: + authtype: user + authid: '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 + traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, + tracestate: 71a60705518f,81a607055181 + data: + message: Connection named TEST-CONNECTION state changed to provisioned + resource: + href: http://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: + authtype: system + authid: equinix + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: uuid not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: uuid not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - deprecated: true + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/cloudevents/{cloudEventId}: get: tags: @@ -204,53 +926,99 @@ paths: description: Cloud Event UUID required: true schema: - $ref: "#/components/schemas/CloudEventId" + description: Cloud Event UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Cloud Event object content: application/json: schema: - $ref: "#/components/schemas/CloudEvent" + $ref: '#/components/schemas/CloudEvent' examples: CloudEventResponseExample: - $ref: "#/components/examples/get-cloud-event" - "401": + 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' + traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, + tracestate: 71a60705518f,81a607055181 + data: + message: Connection named TEST-CONNECTION state changed to provisioning + resource: + href: http://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: + authtype: user + authid: '123456' + name: test user + email: testuser@test.com + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: uuid not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: uuid not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/cloudevents/search: post: tags: @@ -258,62 +1026,183 @@ paths: 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" + $ref: '#/components/schemas/CloudEventSearchRequest' examples: CloudEventSearchRequestExample: - $ref: "#/components/examples/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: /equinixorganization + operator: '=' + values: + - '526698000597331' + - property: /equinixproject + operator: '=' + values: + - dadd3ab6-c0af-430c-8216-43d44f08c1c5 + - property: /time + operator: '>' + values: + - '2018-04-05T17:31:00.000Z' + pagination: + offset: 0 + limit: 20 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetCloudEventsByAssetResponse" + $ref: '#/components/schemas/GetCloudEventsByAssetResponse' examples: Example: - $ref: "#/components/examples/get-cloud-events-by-asset-id" - "401": + 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 + traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, + tracestate: 71a60705518f,81a607055181 + data: + message: Neighbor 100.100.100.102 address session state changed to Connect + auth: + authtype: system + authid: 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' + traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, + tracestate: 71a60705518f,81a607055181 + data: + message: Connection named TEST-CONNECTION state changed to provisioning + resource: + href: http://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: + authtype: user + authid: '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 + traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, + tracestate: 71a60705518f,81a607055181 + data: + message: Connection named TEST-CONNECTION state changed to provisioned + resource: + href: http://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: + authtype: system + authid: equinix + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: uuid not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: uuid not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/liveEvents/search: post: tags: @@ -321,62 +1210,111 @@ paths: summary: Search last Operational Cloud Events description: This API provides capability to search last operational cloud events from a filtered query operationId: searchLastOpEvents - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/LiveEventSearchRequest" + $ref: '#/components/schemas/LiveEventSearchRequest' examples: LiveEventSearchRequestExample: - $ref: "#/components/examples/search-live-events" + value: + filter: + and: + - property: /subject + operator: IN + values: + - /fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + pagination: + offset: 0 + limit: 2 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/SearchLiveEventResponse" + $ref: '#/components/schemas/SearchLiveEventResponse' examples: Example: - $ref: "#/components/examples/search-live-events-response" - "401": + value: + pagination: + offset: 0 + limit: 2 + total: 1 + data: + - specversion: '1.0' + source: https://api.equinix.com/fabric/v4/cloudevents + id: 6c573287-9914-4202-8b6d-2d15e7da04b8 + type: equinix.fabric.port.status.down + subject: /fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + time: '2018-04-05T17:31:00.000Z' + dataschema: https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json + datacontenttype: application/json + severitynumber: '21' + severitytext: FATAL + equinixalert: raise/AABBcCCDDeEfFf123, + equinixproject: project-123 + data: + message: Virtual port 'port-name' status changed to DOWN + resource: + href: https://api.equinix.com//fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + uuid: 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + type: XF_PORT + state: PROVISIONED + operation: + operationalStatus: DOWN + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: uuid not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: uuid not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/{asset}/{assetId}/metrics: get: tags: @@ -384,19 +1322,23 @@ paths: summary: Get Metrics by Asset Id (Deprecated) description: This API provides capability to retrieve Metrics of an asset id operationId: getMetricByAssetId + deprecated: true parameters: - name: asset in: path description: asset required: true schema: - $ref: "#/components/schemas/MetricAssetType" + $ref: '#/components/schemas/MetricAssetType' - name: assetId in: path description: asset UUID required: true schema: - $ref: "#/components/schemas/AssetId" + description: Asset UUID + type: string + format: uuid + example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - name: name in: query description: | @@ -421,8 +1363,8 @@ paths: - `equinix.fabric.metro.{SOURCE_METRO_CODE}_{DESTINATION_METRO_CODE}.jitter_avg` required: true schema: - pattern: ^equinix\.fabric\.(connection|port|metro)\..+ type: string + pattern: ^equinix\.fabric\.(connection|port|metro)\..+ examples: connectionRxUsageExample: value: equinix.fabric.connection.bandwidth_rx.usage @@ -465,72 +1407,170 @@ paths: description: Start date and time required: false schema: - $ref: "#/components/schemas/StartDateTime" + $ref: '#/components/schemas/StartDateTime' - name: toDateTime in: query description: End date and time required: false schema: - $ref: "#/components/schemas/EndDateTime" + $ref: '#/components/schemas/EndDateTime' - name: offset in: query description: offset required: false schema: - $ref: "#/components/schemas/Offset" + $ref: '#/components/schemas/Offset' - name: limit in: query description: limit required: false schema: - $ref: "#/components/schemas/Limit_1" + $ref: '#/components/schemas/Limit-2' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetMetricsByAssetResponse" + $ref: '#/components/schemas/GetMetricsByAssetResponse' examples: Example: - $ref: "#/components/examples/get-metrics-by-asset-id" - "401": + value: + pagination: + offset: 0 + limit: 10 + total: 2 + next: null + previous: null + data: + - type: GAUGE + name: equinix.fabric.port.bandwidth_rx.usage + unit: bit/s + interval: PT5M + resource: + href: https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72 + uuid: 0689734d-25c6-40d1-a9ff-3e4edea07a72 + type: XF_PORT + state: PROVISIONED + name: my-port-name + summary: + mean: 102.15384615384616 + max: 107 + datapoints: + - endDateTime: '2025-05-14T13:57:56.000Z' + value: 107 + - endDateTime: '2025-05-14T14:02:48.000Z' + value: 97 + - endDateTime: '2025-05-14T14:07:58.000Z' + value: 105 + - endDateTime: '2025-05-14T14:12:36.000Z' + value: 102 + - endDateTime: '2025-05-14T14:18:00.000Z' + value: 96 + - endDateTime: '2025-05-14T14:23:03.000Z' + value: 106 + - endDateTime: '2025-05-14T14:27:59.000Z' + value: 104 + - endDateTime: '2025-05-14T14:32:56.000Z' + value: 104 + - endDateTime: '2025-05-14T14:37:51.000Z' + value: 103 + - endDateTime: '2025-05-14T14:42:59.000Z' + value: 100 + - endDateTime: '2025-05-14T14:47:58.000Z' + value: 105 + - endDateTime: '2025-05-14T14:53:08.000Z' + value: 94 + - endDateTime: '2025-05-14T14:57:46.000Z' + value: 105 + - type: GAUGE + name: equinix.fabric.port.bandwidth_tx.usage + unit: bit/s + interval: PT5M + resource: + href: https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72 + uuid: 0689734d-25c6-40d1-a9ff-3e4edea07a72 + summary: + mean: 255.92307692307693 + max: 295 + datapoints: + - endDateTime: '2025-05-14T13:57:56.000Z' + value: 259 + - endDateTime: '2025-05-14T14:02:48.000Z' + value: 234 + - endDateTime: '2025-05-14T14:07:58.000Z' + value: 242 + - endDateTime: '2025-05-14T14:12:36.000Z' + value: 280 + - endDateTime: '2025-05-14T14:18:00.000Z' + value: 243 + - endDateTime: '2025-05-14T14:23:03.000Z' + value: 262 + - endDateTime: '2025-05-14T14:27:59.000Z' + value: 247 + - endDateTime: '2025-05-14T14:32:56.000Z' + value: 295 + - endDateTime: '2025-05-14T14:37:51.000Z' + value: 284 + - endDateTime: '2025-05-14T14:42:59.000Z' + value: 227 + - endDateTime: '2025-05-14T14:47:58.000Z' + value: 260 + - endDateTime: '2025-05-14T14:53:08.000Z' + value: 251 + - endDateTime: '2025-05-14T14:57:46.000Z' + value: 243 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: uuid not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: uuid not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - deprecated: true + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/metrics: get: tags: @@ -547,8 +1587,8 @@ paths: - `equinix.fabric.metro.*.jitter_avg` required: true schema: - pattern: ^equinix\.fabric\.metro\.\*\..+ type: string + pattern: ^equinix\.fabric\.metro\.\*\..+ examples: metroLatencyExample: value: equinix.fabric.metro.*.latency @@ -559,65 +1599,115 @@ paths: description: value required: true schema: - $ref: "#/components/schemas/Value" + $ref: '#/components/schemas/Value' - name: offset in: query description: offset required: false schema: - $ref: "#/components/schemas/Offset" + $ref: '#/components/schemas/Offset' - name: limit in: query description: limit required: false schema: - $ref: "#/components/schemas/Limit_1" + $ref: '#/components/schemas/Limit-2' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetMetricsByNameResponse" + $ref: '#/components/schemas/GetMetricsByNameResponse' examples: Example: - $ref: "#/components/examples/get-metrics-by-name" - "401": + value: + pagination: + offset: 0 + limit: 5000 + total: 3 + data: + - type: GAUGE + name: equinix.fabric.metro.at_am.latency + unit: ms + resource: + href: https://uatapi.equinix.com/fabric/v4/metros/AT + type: XF_METRO + description: Atlanta to Amsterdam intermetro latency, average in milliseconds + datapoints: + - endDateTime: '2026-02-03T23:05:04Z' + value: 94.8 + - type: GAUGE + name: equinix.fabric.metro.at_ba.latency + unit: ms + resource: + href: https://uatapi.equinix.com/fabric/v4/metros/AT + type: XF_METRO + description: Atlanta to Barcelona intermetro latency, average in milliseconds + datapoints: + - endDateTime: '2026-02-03T23:05:04Z' + value: 111 + - type: GAUGE + name: equinix.fabric.metro.at_bg.latency + unit: ms + resource: + href: https://uatapi.equinix.com/fabric/v4/metros/AT + type: XF_METRO + description: Atlanta to Bogota intermetro latency, average in milliseconds + datapoints: + - endDateTime: '2026-02-03T23:05:04Z' + value: 69.8 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: uuid not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: uuid not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/metrics/search: post: tags: @@ -625,62 +1715,181 @@ paths: summary: Search Metrics description: This API provides capability to search metrics from a filtered query operationId: searchMetrics - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/MetricsSearchRequest" + $ref: '#/components/schemas/MetricsSearchRequest' examples: MetricSearchRequestExample: - $ref: "#/components/examples/search-metrics" + value: + filter: + and: + - property: /subject + operator: '=' + values: + - /fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + - property: /name + operator: IN + values: + - equinix.fabric.port.bandwidth_rx.usage + - equinix.fabric.port.bandwidth_tx.usage + - equinix.fabric.port.packets_dropped_rx.count + - equinix.fabric.port.packets_dropped_tx.count + - property: /dataPoints/endDateTime + operator: BETWEEN + values: + - '2025-09-01T19:19:50Z' + - '2025-09-03T19:19:50Z' + pagination: + offset: 0 + limit: 10 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetMetricsByAssetResponse" + $ref: '#/components/schemas/GetMetricsByAssetResponse' examples: Example: - $ref: "#/components/examples/get-metrics-by-asset-id" - "401": + value: + pagination: + offset: 0 + limit: 10 + total: 2 + next: null + previous: null + data: + - type: GAUGE + name: equinix.fabric.port.bandwidth_rx.usage + unit: bit/s + interval: PT5M + resource: + href: https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72 + uuid: 0689734d-25c6-40d1-a9ff-3e4edea07a72 + type: XF_PORT + state: PROVISIONED + name: my-port-name + summary: + mean: 102.15384615384616 + max: 107 + datapoints: + - endDateTime: '2025-05-14T13:57:56.000Z' + value: 107 + - endDateTime: '2025-05-14T14:02:48.000Z' + value: 97 + - endDateTime: '2025-05-14T14:07:58.000Z' + value: 105 + - endDateTime: '2025-05-14T14:12:36.000Z' + value: 102 + - endDateTime: '2025-05-14T14:18:00.000Z' + value: 96 + - endDateTime: '2025-05-14T14:23:03.000Z' + value: 106 + - endDateTime: '2025-05-14T14:27:59.000Z' + value: 104 + - endDateTime: '2025-05-14T14:32:56.000Z' + value: 104 + - endDateTime: '2025-05-14T14:37:51.000Z' + value: 103 + - endDateTime: '2025-05-14T14:42:59.000Z' + value: 100 + - endDateTime: '2025-05-14T14:47:58.000Z' + value: 105 + - endDateTime: '2025-05-14T14:53:08.000Z' + value: 94 + - endDateTime: '2025-05-14T14:57:46.000Z' + value: 105 + - type: GAUGE + name: equinix.fabric.port.bandwidth_tx.usage + unit: bit/s + interval: PT5M + resource: + href: https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72 + uuid: 0689734d-25c6-40d1-a9ff-3e4edea07a72 + summary: + mean: 255.92307692307693 + max: 295 + datapoints: + - endDateTime: '2025-05-14T13:57:56.000Z' + value: 259 + - endDateTime: '2025-05-14T14:02:48.000Z' + value: 234 + - endDateTime: '2025-05-14T14:07:58.000Z' + value: 242 + - endDateTime: '2025-05-14T14:12:36.000Z' + value: 280 + - endDateTime: '2025-05-14T14:18:00.000Z' + value: 243 + - endDateTime: '2025-05-14T14:23:03.000Z' + value: 262 + - endDateTime: '2025-05-14T14:27:59.000Z' + value: 247 + - endDateTime: '2025-05-14T14:32:56.000Z' + value: 295 + - endDateTime: '2025-05-14T14:37:51.000Z' + value: 284 + - endDateTime: '2025-05-14T14:42:59.000Z' + value: 227 + - endDateTime: '2025-05-14T14:47:58.000Z' + value: 260 + - endDateTime: '2025-05-14T14:53:08.000Z' + value: 251 + - endDateTime: '2025-05-14T14:57:46.000Z' + value: 243 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: uuid not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: uuid not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/connections: post: tags: @@ -700,336 +1909,5234 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ConnectionPostRequest" + $ref: '#/components/schemas/ConnectionPostRequest' examples: Colo2Colo-Dot1q2Dot1q: - $ref: "#/components/examples/COLO2COLO-Dot1q2Dot1q" + value: + type: EVPL_VC + name: My-Port-2-Port-Connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a8ba52de-faae-43b5-b0b1-6904d37ee063 + linkProtocol: + type: DOT1Q + vlanTag: 1001 + zSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Colo-Dot1q2Dot1q-WithTerms: - $ref: "#/components/examples/COLO2COLO-Dot1q2Dot1q-withTerms" + value: + type: EVPL_VC + name: My-Port-2-Port-Connection-1 + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 24 + aSide: + accessPoint: + type: COLO + port: + uuid: a8ba52de-faae-43b5-b0b1-6904d37ee063 + linkProtocol: + type: DOT1Q + vlanTag: 1001 + zSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Colo-Dot1q2Dot1q-WithGeoScope: - $ref: "#/components/examples/COLO2COLO-Dot1q2Dot1q-withGeoScope" + value: + type: EVPL_VC + name: My-Port-2-Port-Connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a867f685-41b0-1b07-6de0-320a5c00abdd + linkProtocol: + type: DOT1Q + vlanTag: 1001 + zSide: + accessPoint: + type: COLO + port: + uuid: b067f685-49b0-1a09-6fe0-360a5d00afdd + linkProtocol: + type: DOT1Q + vlanTag: 1001 + geoScope: CONUS + project: + projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 + notifications: + - type: ALL + emails: + - test@test.com Colo2Colo-Dot1q2Qinq: - $ref: "#/components/examples/COLO2COLO-Dot1Q2QinQ" + value: + type: EVPL_VC + name: My-Port-2-Port-Connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + zSide: + accessPoint: + type: COLO + port: + uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c + linkProtocol: + type: QINQ + vlanSTag: 1001 + vlanCTag: 1002 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Colo-Qinq2Qinq: - $ref: "#/components/examples/COLO2COLO-Qinq2Qinq" + value: + type: EVPL_VC + name: My-Port-2-Port-Connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: QINQ + vlanSTag: 12 + zSide: + accessPoint: + type: COLO + port: + uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c + linkProtocol: + type: QINQ + vlanSTag: 13 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Colo-Qinq2Dot1q: - $ref: "#/components/examples/COLO2COLO-Qinq2Dot1q" + value: + type: EVPL_VC + name: My-Port-2-Port-Connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: QINQ + vlanSTag: 1001 + vlanCTag: 1125 + zSide: + accessPoint: + type: COLO + port: + uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c + linkProtocol: + type: DOT1Q + vlanTag: 1001 + notifications: + - type: ALL + emails: + - test@test.com Colo2Colo-AsResellerForSubCustomer: - $ref: "#/components/examples/COLO2COLO-AsReseller" + value: + type: EVPL_VC + name: Conn-1 + order: + purchaseOrderNumber: 1-129105284100 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Colo2Colo-MetroConnect: - $ref: "#/components/examples/COLO2COLO-MetroConnect" + value: + type: MC_VC + name: metro-connect-P2P + bandwidth: 1000 + 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: - $ref: "#/components/examples/COLO2COLO-EPL" + value: + type: EPL_VC + name: My-Port-2-Port-Connection-1 + order: + purchaseOrderNumber: po1234 + termLength: 1 + bandwidth: 100 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + zSide: + accessPoint: + type: COLO + port: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Colo2Colo-AccessEpl: - $ref: "#/components/examples/COLO2COLO-AccessEpl" + value: + type: ACCESS_EPL_VC + name: My-Port-2-Port-Connection-1 + order: + purchaseOrderNumber: 1-129105284100 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Colo2Sp-Generic: - $ref: "#/components/examples/COLO2SPwithDot1q" + value: + type: EVPL_VC + name: My-Layer2-Connection-3 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c + location: + metroCode: DC + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Sp-Generic-WithGeoScope: - $ref: "#/components/examples/COLO2SPwithGeoScope" + value: + type: EVPL_VC + name: My-Port-2-GenSP-Conn-1 + bandwidth: 50 + redundancy: + priority: PRIMARY + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: c4d93b39-034e-34ec-ace0-30fa5c00ad01 + linkProtocol: + type: DOT1Q + vlanTag: 23 + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: 5a76497a-ff00-4a89-a605-b0680799c6aa + location: + metroCode: DC + geoScope: CONUS + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric_user@equinix.com Colo2Sp-NetworkEdgeGeneric: - $ref: "#/components/examples/COLO2SPwithDot1q" + value: + type: EVPL_VC + name: My-Layer2-Connection-3 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c + location: + metroCode: DC + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Sp-Non-Generic-WithGeoScope: - $ref: "#/components/examples/COLO2SPNonGenwithGeoScope" + value: + type: EVPL_VC + name: My-Port-2-NonGenSP-Conn-1 + bandwidth: 100 + redundancy: + priority: PRIMARY + order: + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: c4d93b39-0341-341c-ace0-30fa5c00ad01 + linkProtocol: + type: QINQ + vlanSTag: 23 + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: bfb74121-7e2c-4f74-99b3-69cdafb03b41 + location: + metroCode: SV + authenticationKey: xxxx-xxx-xxxx + geoScope: CONUS + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric_user@equinix.com Colo2Sp-Alibaba: - $ref: "#/components/examples/COLO2AlibabaSPwithDot1q" + value: + type: EVPL_VC + name: port2alibaba-connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Sp-Aws-Primary: - $ref: "#/components/examples/COLO2AWSSPwithDot1q-Primary" + value: + type: EVPL_VC + name: Primary-Aws + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + redundancy: + priority: PRIMARY + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Sp-Azure-Primary: - $ref: "#/components/examples/COLO2AzureSP-Primary" + value: + type: EVPL_VC + name: port2azure-connection-1 + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: d166b9ce-79ed-4ea6-8f8b-785fd69f3dcc + linkProtocol: + type: DOT1Q + vlanTag: 123 + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: a1390b22-abe0-4e93-ad37-85beef9d254a + location: + metroCode: DC + peeringType: PRIVATE + authenticationKey: xxx-xxx-xxx + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Sp-LMaaS-Primary: - $ref: "#/components/examples/COLO2LMaaSSP" + value: + type: EVPL_VC + name: Last Mile Connection 1 + bandwidth: 10 + redundancy: + priority: PRIMARY + order: + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: d4db1048-ef3d-f3d6-49e0-306a5c00a341 + linkProtocol: + type: QINQ + vlanSTag: 121 + vlanCTag: 145 + zSide: + accessPoint: + type: SP + profile: + uuid: 8236fbb9-51e5-428f-86bf-6b67e1223ac1 + location: + metroCode: DC + productOffering: + id: sample-product-offering-id + name: Sample product offering 1 + billingTerm: 12 + bandwidthCommit: 50 + address: + id: lmaas-addr-sample-id + streetNr: '1234' + streetName: Main St + city: San Jose + stateOrProvince: CA + postCode: '95101' + country: United States + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - someone@sample.com + - type: ORDERING + emails: + - someone@sample.com + phone: + - type: OFFICE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: MOBILE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: TECHNICAL + emails: + - someone@sample.com + phone: + - type: OFFICE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: MOBILE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME Colo2Sp-Google: - $ref: "#/components/examples/COLO2GoogleSPwithDot1q" + value: + type: EVPL_VC + name: My-Layer2-Connection-3 + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@test.com Colo2Sp-Ibm_1.0: - $ref: "#/components/examples/COLO2IBM_1" + value: + type: EVPL_VC + name: My-Layer2-Connection-3 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com + additionalInfo: + - key: ASN + value: '1234' + - key: Global + value: 'false' Colo2Sp-Ibm_2.0: - $ref: "#/components/examples/COLO2IBM_2" + value: + type: EVPL_VC + name: My-Layer2-Connection-3 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + 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 Colo2Sp-Oracle: - $ref: "#/components/examples/COLO2OracleSPwithDot1q" + value: + type: EVPL_VC + name: My-Layer2-Connection-3 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2ServiceToken: - $ref: "#/components/examples/COLO2ServiceToken" + value: + type: EVPL_VC + name: Conn-1 + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + location: + metroCode: SV + zSide: + serviceToken: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Colo2Network-EVPLAN_VC: - $ref: "#/components/examples/COLO2NETWORKwithDot1q" + value: + type: EVPLAN_VC + name: colo2network-evplan-vc + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Colo2Network-EPLAN_VC: - $ref: "#/components/examples/COLO2NETWORKwithEPL" + value: + type: EPLAN_VC + name: colo2network-eplan-vc + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 + zSide: + accessPoint: + type: NETWORK + network: + uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Colo2Network-EVPTREE_VC: - $ref: "#/components/examples/COLO2NETWORK_EVPTREE_withDot1q" + value: + type: EVPTREE_VC + name: colo2network-evptree-vc + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + role: LEAF + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Colo2Network-EPTREE_VC: - $ref: "#/components/examples/COLO2NETWORK_EPTREE_withEPL" + value: + type: EPTREE_VC + name: colo2network-eptree-vc + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 + zSide: + accessPoint: + type: NETWORK + network: + uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 + role: LEAF + project: + projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 + notifications: + - type: ALL + emails: + - fabric@equinix.com Vd2Network: - $ref: "#/components/examples/Vd2NETWORK" + value: + type: EVPLAN_VC + name: MY-EVPLAN-CONNECTION-1 + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: VD + virtualDevice: + type: EDGE + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + type: NETWORK + id: 3 + zSide: + accessPoint: + type: NETWORK + network: + uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 + project: + projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Vd2Sp-Aws: - $ref: "#/components/examples/Vd2AwsSP" + value: + type: EVPL_VC + name: vd2aws-connection-1 + bandwidth: 50 + order: + purchaseOrderNumber: 1-1234567890 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Vd2Sp-Azure: - $ref: "#/components/examples/Vd2AzureSP" + value: + type: EVPL_VC + name: vd2azure-connection-1 + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Vd2Sp-Oracle: - $ref: "#/components/examples/Vd2OracleSP" + value: + type: EVPL_VC + name: vd2oracle-connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 24 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Vd2Sp-IBM_1.0: - $ref: "#/components/examples/Vd2Ibm_1" + value: + type: EVPL_VC + name: vd2ibm10-connection-1 + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Vd2Sp-IBM_2.0: - $ref: "#/components/examples/Vd2Ibm_2" + value: + type: EVPL_VC + name: vd2ibm20-connection-1 + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Vd2Sp-Alibaba: - $ref: "#/components/examples/Vd2AlibabaSP" + value: + type: EVPL_VC + name: vd2alibaba-connection-1 + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Vd2Sp-Google: - $ref: "#/components/examples/Vd2GoogleSP" + value: + type: EVPL_VC + name: vd2googleSp-connection-1 + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 24 + 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 + notifications: + - type: ALL + emails: + - fabric@equinx.com Vd2Sp-Primary: - $ref: "#/components/examples/Vd2Sp-Primary" + value: + type: EVPL_VC + name: Network Device to SP + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + redundancy: + priority: PRIMARY + aSide: + accessPoint: + type: VD + virtualDevice: + type: EDGE + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + type: NETWORK + id: 3 + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 + authenticationKey: xx-xx-xx + sellerRegion: us-west-1 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Vd2Sp-Secondary: - $ref: "#/components/examples/Vd2Sp-Secondary" + value: + type: EVPL_VC + name: Network Device to SP + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: 3 + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 + authenticationKey: xx-xx-xx + sellerRegion: us-west-1 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Vd2Colo: - $ref: "#/components/examples/Vd2Colo" + value: + type: EVPL_VC + name: vd to COLO + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 24 + aSide: + accessPoint: + type: VD + virtualDevice: + type: EDGE + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + type: NETWORK + id: 3 + zSide: + accessPoint: + type: COLO + port: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + linkProtocol: + type: DOT1Q + vlanTag: 300 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Vd2Colo-WithGeoScope: - $ref: "#/components/examples/VD2COLO-Dot1q-withGeoScope" + value: + type: EVPL_VC + name: My-VD-2-COLO-Connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: VD + virtualDevice: + uuid: a867f685-41b0-1b07-6de0-320a5c00abdd + interface: + type: NETWORK + id: 1 + location: + metroCode: FR + zSide: + accessPoint: + type: COLO + port: + uuid: b067f685-49b0-1a09-6fe0-360a5d00afd0 + linkProtocol: + type: DOT1Q + vlanTag: 1001 + location: + metroCode: AM + geoScope: EU + project: + projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 + notifications: + - type: ALL + emails: + - test@test.com Vd2Colo-vlanTag: - $ref: "#/components/examples/Vd2Colo-VlanTag" + value: + type: EVPL_VC + name: vd to COLO + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: VD + virtualDevice: + type: EDGE + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + type: NETWORK + id: 3 + zSide: + accessPoint: + type: COLO + port: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + linkProtocol: + type: DOT1Q + vlanTagMin: 300 + vlanTagMax: 1099 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Vd2Colo-vlanCTag: - $ref: "#/components/examples/Vd2Colo-VlanCTag" + value: + type: EVPL_VC + name: vd to COLO + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: VD + virtualDevice: + type: EDGE + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + type: NETWORK + id: 3 + zSide: + accessPoint: + type: COLO + port: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + linkProtocol: + type: QINQ + vlanCTag: 300 + vlanSTag: 301 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Vd2ColoUntagged: - $ref: "#/components/examples/Vd2ColoUntagged" + value: + type: EVPL_VC + name: vd to SP + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: VD + virtualDevice: + type: EDGE + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + type: NETWORK + id: 3 + zSide: + accessPoint: + type: COLO + port: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + linkProtocol: + type: UNTAGGED + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Vd2ServiceToken: - $ref: "#/components/examples/Vd2ServiceToken" + value: + type: EVPL_VC + name: vd2token-conn-1 + order: + purchaseOrderNumber: po1234 + termLength: 1 + bandwidth: 10 + redundancy: + priority: PRIMARY + aSide: + accessPoint: + type: VD + virtualDevice: + type: EDGE + uuid: 207667ba-3211-452c-b0a8-8b9046e122a2 + zSide: + serviceToken: + uuid: 557411a5-16a6-4aef-beea-7f622e94f1e0 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcda Fcr2Colo: - $ref: "#/components/examples/Fcr2Colo" + value: + type: IP_VC + name: My-FCR-Connection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Google: - $ref: "#/components/examples/Fcr2Sp-Google" + value: + type: IP_VC + name: My-FCR-GCPConnection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Azure: - $ref: "#/components/examples/Fcr2Sp-Azure" + value: + type: IP_VC + name: My-FCR-AzureConnection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-IBM: - $ref: "#/components/examples/Fcr2Sp-IBM" + value: + type: IP_VC + name: My-FCR-IBMConnection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: CLOUD_ROUTER + router: + uuid: 66a21614-1c4a-11ec-9621-0242ac130002 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com + additionalInfo: + - key: Global + value: 'false' + - key: IBM IPv4 CIDR + value: 172.16.0.18/30 + - key: CER IPv4 CIDR + value: 172.16.0.19/30 Fcr2Sp-Generic: - $ref: "#/components/examples/Fcr2Sp-Generic" + value: + type: IP_VC + name: My-FCR-GenericConnection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Generic-Redundant-Primary: - $ref: "#/components/examples/Fcr2Sp-Generic" + value: + type: IP_VC + name: My-FCR-GenericConnection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Generic-Redundant-Secondary: - $ref: "#/components/examples/Fcr2Sp-Generic-Redundant-Secondary" + value: + type: IP_VC + name: FCR_to_RedSP_Secondary + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Generic-Redundant-Primary-re-add: - $ref: "#/components/examples/Fcr2Sp-Generic-Redundant-Primary" + value: + type: IP_VC + name: FCR_to_RedSP_Primary-Re-add + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Aws: - $ref: "#/components/examples/Fcr2Sp-Aws" + value: + type: IP_VC + name: My-FCR-AWSConnection + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Oracle: - $ref: "#/components/examples/Fcr2Sp-Oracle" + value: + type: IP_VC + name: My-FCR-OracleConnection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com Fcr2Sp-Alibaba: - $ref: "#/components/examples/Fcr2Sp-Alibaba" + value: + type: IP_VC + name: My-FCR-AlibabaConnection + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + authenticationKey: xx-xx-xx + sellerRegion: us-west-1 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Vd: - $ref: "#/components/examples/Fcr2Vd" + value: + type: IP_VC + name: My-GW-VDConnection + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: 3 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Vd-Redundant-Secondary: - $ref: "#/components/examples/Fcr2Vd-Redundant-Secondary" + value: + type: IP_VC + name: My-GW-VDConnection-Secondary + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: 3 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2IpWan: - $ref: "#/components/examples/Fcr2IpWan" + value: + type: IPWAN_VC + name: MY-IPWAN-CONNECTION-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: CLOUD_ROUTER + router: + uuid: 66a21614-1c4a-11ec-9621-0242ac130002 + zSide: + accessPoint: + type: NETWORK + network: + uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Aws-Marketplace-subscription: - $ref: "#/components/examples/Fcr2Sp-Aws-marketplaceSubscription" + value: + type: IP_VC + name: My-FCR-AWSConnection + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 Fcr2MetalNetwork: - $ref: "#/components/examples/Fcr2Metal-Network" + value: + type: IP_VC + name: My-FCR-MetalNetwork-Connection + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2ServiceToken: - $ref: "#/components/examples/Fcr2ServiceToken" + value: + type: IP_VC + name: My-FCR-Connection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: CLOUD_ROUTER + router: + uuid: 66a21614-1c4a-11ec-9621-0242ac130002 + location: + metroCode: SV + zSide: + serviceToken: + uuid: 4cc30499-d472-4edb-9114-1381ed17e356 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com AsideServiceToken2ColoWithDot1q: - $ref: "#/components/examples/AsideServiceToken2PortWithDot1q" + value: + type: EVPL_VC + name: Aside-token + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com AsideServiceToken2ColoWithQinq: - $ref: "#/components/examples/AsideServiceToken2PortWithQinq" + value: + type: EVPL_VC + name: Aside-Token + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com AsideServiceToken2PrivateSP-NE: - $ref: "#/components/examples/AsideServiceToken2PrivateSP-NE" + value: + type: EVPL_VC + name: Token2PrivateSP-NE + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + serviceToken: + uuid: 41a9e1ef-18bb-485b-a9b3-99801ac03684 + zSide: + accessPoint: + type: SP + profile: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 + location: + metroCode: SV + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com AsideServiceToken2ZsideServiceToken: - $ref: "#/components/examples/AsideServiceToken2ZsideServiceToken" + value: + type: EVPL_VC + name: Aside to zside token connection + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + serviceToken: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + zSide: + serviceToken: + uuid: 4f9c5438-90eb-4295-b109-7754119a1e8d + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Metal2Sp-Aws: - $ref: "#/components/examples/Metal2Sp-Aws" + value: + type: EVPL_VC + name: My-Metal-sp-connection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com Metal2Sp-Azure: - $ref: "#/components/examples/Metal2Sp-Azure" + value: + type: EVPL_VC + name: Metal2Azure Connection + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: 16799d66-ef43-445c-ba29-d17522d8a137 + notifications: + - type: ALL + emails: + - eqxfabricamcrh@gmail.com Metal2Sp-GCP: - $ref: "#/components/examples/Metal2Sp-GCP" + value: + type: EVPL_VC + name: Metal2GCP-Connection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com Metal2Sp-Oracle: - $ref: "#/components/examples/Metal2Sp-Oracle" + value: + type: EVPL_VC + name: Metal2Oracle-Connection + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: 16799d66-ef43-445c-ba29-d17522d8a137 + notifications: + - type: ALL + emails: + - test@gmail.com Metal2Sp-IBM: - $ref: "#/components/examples/Metal2Sp-IBM" + value: + type: EVPL_VC + name: Metal2IBM-Connection + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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' + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com Metal2Port-Dot1Q: - $ref: "#/components/examples/Metal2Port-Dot1q" + value: + type: EVPL_VC + name: Metal2Port-dot1q + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: METAL_NETWORK + authenticationKey: xxxxxxxxx + zSide: + accessPoint: + type: COLO + port: + uuid: 6c73d02c-87e1-4642-8e18-01eb4b87e243 + linkProtocol: + type: DOT1Q + vlanTag: 128 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com Metal2Port-QinQ: - $ref: "#/components/examples/Metal2Port-Qinq" + value: + type: EVPL_VC + name: Metal2Port-qinq + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com Metal2Port-ZsideServiceToken: - $ref: "#/components/examples/Metal2ServiceToken" + value: + type: EVPL_VC + name: Metal2ServiceToken + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: METAL_NETWORK + authenticationKey: xxxxxxxxx + zSide: + serviceToken: + uuid: bc1383be-579a-4d75-ae19-b0d487bbff90 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com Metal2Sp-Generic: - $ref: "#/components/examples/Metal2Sp-Generic" + value: + type: EVPL_VC + name: Metal2Generic + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: METAL_NETWORK + authenticationKey: xxxxxxxxx + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c + location: + metroCode: DC + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Vd2IASp: - $ref: "#/components/examples/Vd2IAProfile-Request" + value: + type: IA_VC + name: Network Device to IA SP + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Metal-Network: - $ref: "#/components/examples/Fcr2Metal-Network" + value: + type: IP_VC + name: My-FCR-MetalNetwork-Connection + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Connection-Colo2Sp-GenericDryRunCreate: - $ref: "#/components/examples/CreateConnectionDryRunRequest" + value: + type: EVPL_VC + name: My-EVPL-Connection + bandwidth: 500 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + notifications: + - type: ALL + emails: + - test@test.com IX2Sp-PublicPeering_VC: - $ref: "#/components/examples/IXDedicatedPublicPeeringConnection" + value: + type: IX_VC + name: Virtual-Connection-1 + bandwidth: 1000 + aSide: + accessPoint: + type: COLO + port: + uuid: 99e83e59-fd26-4134-b1b3-4c5dea6924d6 + zSide: + accessPoint: + type: SP + profile: + uuid: 0f6bdb36-e130-4924-b038-ee1785fad166 + notifications: + - type: ALL + emails: + - test@test.com + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Connection" + $ref: '#/components/schemas/Connection' examples: ConnectionDryRun-Colo2AWS: - $ref: "#/components/examples/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 ConnectionDryRun-Colo2Azure: - $ref: "#/components/examples/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 ConnectionDryRun-Colo2Google: - $ref: "#/components/examples/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 ConnectionDryRun-Colo2IBM: - $ref: "#/components/examples/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 ConnectionDryRun-Colo2Network-EPLAN_VC: - $ref: "#/components/examples/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 ConnectionDryRun-Colo2Network-EVPLAN_VC: - $ref: "#/components/examples/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 ConnectionDryRun-Colo2Sp-Generic: - $ref: "#/components/examples/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 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: + 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 + ConnectionDryRun-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 + ConnectionDryRun-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 + ConnectionDryRun-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 + '201': + description: Accept Connection Request + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' + examples: Colo2Colo-withTerms: - $ref: "#/components/examples/COLO2COLO-Dot1q2Dot1q-withTerms-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/6c157170-f84d-424a-9396-b5d6ee723296 + type: EVPL_VC + uuid: 6c157170-f84d-424a-9396-b5d6ee723296 + name: My-Port-2-Port-Connection-1 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: po1234 + billingTier: Up to 100 MB + termLength: 24 + contractedBandwidth: 100 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + changeLog: + createdBy: fabric_user + createdDateTime: '2026-04-11T19:26:58.847Z' + updatedBy: fabric_user + updatedDateTime: '2026-04-11T19:26:58.847Z' + bandwidth: 10 + redundancy: + group: d630b469-2322-481b-9c32-d04a35ca7a60 + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033a-33ac-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033a-33ac-ace0-30fa5c00ad01 + name: port-001-NK-709 + linkProtocol: + type: DOT1Q + vlanTag: 23 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DA + metroCode: DA + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-0348-348c-ace0-30fa5c00ad04 + type: XF_PORT + uuid: c4d93b39-0348-348c-ace0-30fa5c00ad09 + name: port-001-NK-710 + linkProtocol: + type: DOT1Q + vlanTag: 24 Colo2Colo-withGeoScope: - $ref: "#/components/examples/COLO2COLO-Dot1q2Dot1q-withGeoScope-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/3656347c-4ed2-4d13-8907-f4238b8a057a + type: EVPL_VC + uuid: 3656347c-4ed2-4d13-8907-f4238b8a057a + name: My-Port-2-Port-Connection-1 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + changeLog: + createdBy: fabric_user + createdDateTime: '2026-04-11T19:42:50.774Z' + updatedBy: fabric_user + updatedDateTime: '2026-04-11T19:42:50.774Z' + bandwidth: 50 + geoScope: CONUS + redundancy: + group: 6e26930e-9fbb-449e-b9eb-cd98c97725er + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033b-33bc-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033b-33bc-ace0-30fa5c00ad01 + name: reg-001-CH2-JUN-698 + linkProtocol: + type: DOT1Q + vlanTag: 39 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033a-33ac-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033a-33ac-ace0-30fa5c00ad01 + name: reg-001-CH2-JUN-694 + linkProtocol: + type: DOT1Q + vlanTag: 40 Colo2Sp: - $ref: "#/components/examples/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' Colo2Sp-Generic-withGeoScope: - $ref: "#/components/examples/COLO2SPwithGeoScope-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/0bbd1d06-35df-47b7-b358-2f435cecb198 + type: EVPL_VC + uuid: 0bbd1d06-35df-47b7-b358-2f435cecb198 + name: My-Port-2-GenSP-Conn-1 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PENDING_APPROVAL + order: + billingTier: Up to 10 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + changeLog: + createdBy: fabric_user + createdDateTime: '2026-05-11T20:23:48.480Z' + updatedBy: fabric_user + updatedDateTime: '2026-05-11T20:23:48.480Z' + bandwidth: 10 + geoScope: CONUS + redundancy: + group: b19a678b-bcf7-428f-963b-55ea07eb1ef7 + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033a-83ac-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033a-83ac-ace0-30fa5c00ad01 + name: reg-001-JUN-691 + linkProtocol: + type: DOT1Q + vlanTag: 37 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + metroCode: DC + profile: + href: https://api.equinix.com/fabric/v4/serviceProfiles/5a76497a-ff00-4a89-a605-b0680799c6aa + type: L2_PROFILE + name: Fabric_L2_SP + uuid: 5a76497a-ff00-4a89-a605-b0680799c6aa Colo2Sp-Non-Generic-withGeoScope: - $ref: "#/components/examples/COLO2SPNonGenwithGeoScope-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/360a076f-0d2f-454c-b227-c5e6f48920ea + type: EVPL_VC + uuid: 360a076f-0d2f-454c-b227-c5e6f48920ea + name: My-Port-2-NonGenSP-Conn-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + billingTier: Up to 1G + termLength: 1 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + changeLog: + createdBy: fabric_user + createdDateTime: '2026-04-11T20:07:16.611Z' + updatedBy: fabric_user + updatedDateTime: '2026-04-11T20:07:16.611Z' + bandwidth: 1000 + geoScope: CONUS + redundancy: + group: 27d24507-3222-4654-9b97-ce16c8313b01 + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-0341-341c-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-0341-341c-ace0-30fa5c00ad01 + name: reg-001-JUN-703 + linkProtocol: + type: QINQ + vlanSTag: 23 + vlanCTag: 24 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SV + metroCode: SV + profile: + href: https://api.equinix.com/fabric/v4/serviceProfiles/bfb74121-7e2c-4f74-99b3-69cdafb03b41 + type: L2_PROFILE + name: Azure Express Route + uuid: bfb74121-7e2c-4f74-99b3-69cdafb03b12 + authenticationKey: xxxx-xxx-xxxx Colo2Colo-MetroConnect: - $ref: "#/components/examples/COLO2COLO-MetroConnect-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 + type: MC_VC + uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 + name: metro-connect-P2P + bandwidth: 1000 + 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: UNTAGGED + location: + metroCode: ME + zSide: + accessPoint: + type: COLO + port: + href: https://api.equinix.com/fabric/v4/ports/20d32a80-0d61-4333-bc03-707b591ae2f4 + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + linkProtocol: + type: UNTAGGED + location: + metroCode: ME + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + changeLog: + createdDateTime: '2020-05-21T10:30:00Z' + project: + projectId: 37c8212c-c393-465c-8267-09d28c49774c Colo2Sp-Azure-Primary: - $ref: "#/components/examples/COLO2AzureSP-Primary-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/5901c429-cd23-4149-b1cc-5f1b10cc5041 + type: EVPL_VC + uuid: 5901c429-cd23-4149-b1cc-5f1b10cc5041 + name: port2azure-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabricuser + createdDateTime: '2026-03-10T02:26:31.546Z' + updatedBy: fabricuser + updatedDateTime: '2026-03-10T02:26:31.546Z' + bandwidth: 100 + redundancy: + group: ce76ec16-5857-4472-9067-2fa3d7a9f52q + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DA + metroCode: DA + port: + href: https://api.equinix.com/fabric/v4/ports/d966b9ce-79ed-4ea6-8f8a-785fd69f3dcb + type: XF_PORT + uuid: d966b9ce-79ed-4ea6-8f8a-785fd69f3dcb + name: 1-DA1-CX-PRI-012345 + linkProtocol: + type: DOT1Q + vlanTag: 123 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + metroCode: DC + profile: + href: https://api.equinix.com/fabric/v4/serviceProfiles/a1390b22-bbe0-4e93-ad37-85beef9d254a + type: L2_PROFILE + name: Azure ExpressRoute + uuid: a1390b22-bbe0-4e93-ad37-85beef9d254a + authenticationKey: xxxx-xxx-xxxx Colo2Sp-LMaaS-Primary: - $ref: "#/components/examples/COLO2LMaaSSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/8236fbb9-51e5-428f-86bf-6b67e1223ac1 + uuid: 8236fbb9-51e5-428f-86bf-6b67e1223ac1 + type: EVPL_VC + name: Last Mile Connection 1 + bandwidth: 10 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PENDING_APPROVAL + redundancy: + group: d4db1048-ef3d-f3d6-49e0-306a5c00a341 + priority: PRIMARY + order: + billingTier: Up to 10 MB + termLength: 1 + aSide: + accessPoint: + location: + metroCode: DC + port: + href: https://api.equinix.com/fabric/v4/ports/c4d9350e-780f-80fd-1ce0-306a5c00a600 + type: XF_PORT + uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 + name: Sample Port DC + linkProtocol: + type: QINQ + vlanSTag: 121 + vlanCTag: 145 + zSide: + accessPoint: + location: + metroCode: DC + profile: + href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 + uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 + type: LMAAS_PROFILE + name: Last Mile Service Profile 1 + productOffering: + id: sample-product-offering-id + name: Sample product offering 1 + billingTerm: 12 + bandwidthCommit: 50 + address: + id: lmaas-addr-sample-id + streetNr: '1234' + streetName: Main St + city: San Jose + stateOrProvince: CA + postCode: '95101' + country: United States + notifications: + - type: ALL + emails: + - someone@sample.com + - type: ORDERING + emails: + - someone@sample.com + phone: + - type: OFFICE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: MOBILE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: TECHNICAL + emails: + - someone@sample.com + phone: + - type: OFFICE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: MOBILE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + changeLog: + createdBy: sampleuser + createdByFullName: Sample User + createdByEmail: someone@sample.com + createdDateTime: '2026-01-01T00:00:00.000Z' + updatedBy: sampleuser + updatedByFullName: Sample User + updatedByEmail: someone@sample.com + updatedDateTime: '2026-01-01T00:00:00.000Z' Colo2Sp-Google: - $ref: "#/components/examples/COLO2GoogleSPwithDot1q-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/f662d4c4-fcd8-40ba-b95b-64fc7e0a61fb + type: EVPL_VC + uuid: f662d4c4-fcd8-40ba-b95b-64fc7e0a61fb + name: My-Layer2-Connection-3 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: po1234 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-25T14:25:30.509Z' + updatedBy: fabric + updatedDateTime: '2024-04-25T14:25:30.509Z' + bandwidth: 50 + redundancy: + group: 2673c07d-9bd3-43c2-9827-91e940d01a54 + priority: PRIMARY + aSide: + accessPoint: + location: + metroCode: DA + port: + href: https://api.equinix.com/fabric/v4/ports/33353aa1-18f2-4b32-94d6-59a12500f7e2 + type: XF_PORT + 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 Colo2Sp-Alibaba: - $ref: "#/components/examples/COLO2AlibabaSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/2c7bb68e-f560-41ac-9950-e62c87be191e + type: EVPL_VC + uuid: 2c7bb68e-f560-41ac-9950-e62c87be191e + name: port2alibaba-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + billingTier: Up to 50 MB + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-05-02T20:07:38.626Z' + updatedBy: fabric + updatedDateTime: '2024-05-02T20:07:38.626Z' + bandwidth: 50 + redundancy: + group: 6aafb605-f3e4-4380-a9c0-1eddf829bca0 + priority: PRIMARY + aSide: + accessPoint: + location: + metroCode: SV + port: + href: https://api.equinix.com/fabric/v4/ports/b54d71a6-aecb-40cc-b458-8a4103f5cdba + type: XF_PORT + 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 Colo2Sp-IBM_1.0: - $ref: "#/components/examples/COLO2IBM_1" + value: + href: https://api.equinix.com/fabric/v4/connections/eda6cc39-7e4c-4504-a715-3cdb8861cd6b + type: EVPL_VC + uuid: eda6cc39-7e4c-4504-a715-3cdb8861cd6b + name: port2ibm1-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-05-02T20:16:05.955Z' + updatedBy: fabric + updatedDateTime: '2024-05-02T20:16:05.955Z' + bandwidth: 50 + redundancy: + group: 7c730560-122b-4467-bcc3-54df733e4172 + priority: PRIMARY + aSide: + accessPoint: + location: + metroCode: SV + port: + href: https://api.equinix.com/fabric/v4/ports/b54d71a6-aecb-40cc-b458-8a4103f5cdba + type: XF_PORT + uuid: b54d71a6-aecb-40cc-b458-8a4103f5cdba + name: 641728-SV5-1 + linkProtocol: + type: DOT1Q + vlanTag: 1019 + zSide: + accessPoint: + location: + metroCode: DC + profile: + href: https://api.equinix.com/fabric/v4/serviceProfiles/45b446fa-d3b6-417a-b871-a5ee0efdc459 + type: L2_PROFILE + name: IBM Cloud Direct Link Exchange + uuid: 45b446fa-d3b6-417a-b871-a5ee0efdc459 + sellerRegion: Washington 2 + authenticationKey: xxxx-xxx-xxxx Colo2Sp-IBM_2.0: - $ref: "#/components/examples/COLO2IBM_2" + value: + href: https://api.equinix.com/fabric/v4/connections/3f394b6f-c8e3-4b9b-9b9b-2971a90add2e + type: EVPL_VC + uuid: 3f394b6f-c8e3-4b9b-9b9b-2971a90add2e + name: port2ibm2-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-05-02T20:18:47.194Z' + updatedBy: fabric + updatedDateTime: '2024-05-02T20:18:47.194Z' + bandwidth: 50 + redundancy: + group: c11ddf35-6e63-4b2f-a5e0-248ea56a7665 + priority: PRIMARY + aSide: + accessPoint: + location: + metroCode: SV + port: + href: https://api.equinix.com/fabric/v4/ports/b54d71a6-aecb-40cc-b458-8a4103f5cdba + type: XF_PORT + uuid: b54d71a6-aecb-40cc-b458-8a4103f5cdba + name: 641728-SV5-1 + linkProtocol: + type: DOT1Q + vlanTag: 1020 + zSide: + accessPoint: + location: + metroCode: SV + 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: San Jose 2 + authenticationKey: xxxx-xxx-xxxx Colo2Sp-Oracle: - $ref: "#/components/examples/COLO2OracleSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/6c157170-f84d-424a-9396-b5d6ee723296 + type: EVPL_VC + uuid: 6c157170-f84d-424a-9396-b5d6ee723296 + name: vd2oracle-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 1G + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-05-02T20:25:09.841Z' + updatedBy: fabric + updatedDateTime: '2024-05-02T20:25:09.841Z' + bandwidth: 1000 + redundancy: + group: e8400059-34e1-47f1-9914-cb5907ee7913 + priority: PRIMARY + aSide: + accessPoint: + location: + metroCode: SV + port: + href: https://api.equinix.com/fabric/v4/ports/b54d71a6-aecb-40cc-b458-8a4103f5cdba + type: XF_PORT + 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: - $ref: "#/components/examples/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 + termLength: 1 + 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' Vd2Token: - $ref: "#/components/examples/Vd2ServiceToken-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/e3bf3fa5-2b8f-4437-8171-688175240a1a + type: EVPL_VC + uuid: e3bf3fa5-2b8f-4437-8171-688175240a1a + name: vd2token-conn-1 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: po1234 + billingTier: Up to 10 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + changeLog: + createdBy: fabric_user + createdDateTime: '2026-04-11T20:49:02.630Z' + updatedBy: fabric_user + updatedDateTime: '2026-04-11T20:49:02.630Z' + bandwidth: 10 + redundancy: + group: 7c2b584c-f184-43ab-9626-52533a2cdb2a + priority: PRIMARY + aSide: + accessPoint: + interface: + uuid: 09918b27-0fb6-428e-a9c5-c26334e825ca + id: 10 + type: CLOUD + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + metroCode: DC + linkProtocol: + type: DOT1Q + vlanTag: 788 + virtualDevice: + uuid: 207667ba-3211-452c-b0a8-8b9046e122a1 + type: EDGE + zSide: + serviceToken: + href: https://api.equinix.com/fabric/v4/serviceTokens/557411a5-16a6-4aef-beea-7f622e94f1e1 + uuid: 557411a5-16a6-4aef-beea-7f622e94f1e1 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee965 + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DA + metroCode: DA + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-0348-348c-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-0348-348c-ace0-30fa5c00ad01 + name: reg-NK-710 + linkProtocol: + type: DOT1Q + vlanTag: 101 Vd2Colo: - $ref: "#/components/examples/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 + termLength: 1 + 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 + linkProtocol: + type: DOT1Q + vlanTag: 1522 + 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-WithGeoScope: - $ref: "#/components/examples/VD2COLO-Dot1q-withGeoScope-response" + value: + href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f3e9-4f84-8c8f-1505b43df5e2 + uuid: 3a58dd05-f3e9-4f84-8c8f-1505b43df5e2 + type: EVPL_VC + name: My-VD-2-COLO-Connection-1 + state: ACTIVE + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: VD + virtualDevice: + uuid: a867f685-41b0-1b07-6de0-320a5c00abdd + name: my-virtual-device + interface: + type: NETWORK + id: 1 + location: + metroHref: https://api.equinix.com/fabric/v4/metros/FR + metroCode: FR + zSide: + accessPoint: + type: COLO + port: + uuid: b067f685-49b0-1a09-6fe0-360a5d00afd9 + name: my-port + linkProtocol: + type: DOT1Q + vlanTag: 1001 + location: + metroCode: AM + geoScope: EU + project: + projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 + notifications: + - type: ALL + emails: + - test@test.com + operation: + providerStatus: AVAILABLE + equinixStatus: PROVISIONED + changeLog: + createdDateTime: '2023-01-15T10:00:00Z' + updatedDateTime: '2023-01-15T10:05:00Z' Vd2Colo-tag: - $ref: "#/components/examples/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 + termLength: 1 + 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-27T16:25:37.229Z' + aSide: + accessPoint: + virtualDevice: + type: EDGE + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f8 + 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: - $ref: "#/components/examples/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 + termLength: 1 + 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: - $ref: "#/components/examples/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 + termLength: 1 + 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 + createdDateTime: '2022-05-12T17:53:45.401Z' Fcr2Colo: - $ref: "#/components/examples/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 + createdDateTime: '2022-05-12T17:53:45.401Z' Fcr2IpWan: - $ref: "#/components/examples/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: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + 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 + createdDateTime: '2022-05-12T17:53:45.401Z' Fcr2Sp-Marketplace-subscription: - $ref: "#/components/examples/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 + termLength: 1 + 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 + createdDateTime: '2022-05-12T17:53:45.401Z' ServiceToken2PortResponseDot1Q: - $ref: "#/components/examples/AsideServiceToken2PortResponseWithDot1q" + value: + href: https://api.equinix.com/fabric/v4/connections/e972bd9b-5726-4062-b046-7086fe9921ab + type: EVPL_VC + uuid: e972bd9b-5726-4062-b046-7086fe9921ab + name: token2port-conn-1 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + billingTier: Up to 10 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + changeLog: + createdBy: fabric_user + createdDateTime: '2026-05-11T21:03:02.631Z' + updatedBy: fabric_user + updatedDateTime: '2026-05-11T21:03:02.631Z' + bandwidth: 10 + redundancy: + group: 48852efe-f68a-4f0d-8449-36abd43a4afa + priority: PRIMARY + aSide: + serviceToken: + href: https://api.equinix.com/fabric/v4/serviceTokens/f10d177b-4afb-461a-bb23-b65b021af367 + type: VC_TOKEN + uuid: f10d177b-4afb-461a-bb23-b65b021af367 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee96a + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033f-33fc-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033f-33fc-ace0-30fa5c00ad01 + name: reg-JUN-701 + linkProtocol: + type: DOT1Q + vlanTag: 45 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033e-33ec-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033e-33ec-ace0-30fa5c00ad01 + name: reg-JUN-700 + linkProtocol: + type: DOT1Q + vlanTag: 34 ServiceToken2PortResponseQinQ: - $ref: "#/components/examples/AsideServiceToken2PortResponseWithQinq" + value: + href: https://api.equinix.com/fabric/v4/connections/e972bd9b-5726-4062-b046-7086fe9921ab + type: EVPL_VC + uuid: e972bd9b-5726-4062-b046-7086fe9921ab + name: token2port-conn-1 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + billingTier: Up to 10 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + changeLog: + createdBy: fabric_user + createdDateTime: '2026-05-11T21:03:02.631Z' + updatedBy: fabric_user + updatedDateTime: '2026-05-11T21:03:02.631Z' + bandwidth: 10 + redundancy: + group: 48852efe-f68a-4f0d-8449-36abd43a4afa + priority: PRIMARY + aSide: + serviceToken: + href: https://api.equinix.com/fabric/v4/serviceTokens/f10d177b-4afb-461a-bb23-b65b021af367 + type: VC_TOKEN + uuid: f10d177b-4afb-461a-bb23-b65b021af367 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee96a + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033f-33fc-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033f-33fc-ace0-30fa5c00ad01 + name: reg-JUN-701 + linkProtocol: + type: QINQ + vlanSTag: 45 + vlanCTag: 46 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033e-33ec-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033e-33ec-ace0-30fa5c00ad01 + name: reg-JUN-700 + linkProtocol: + type: QINQ + vlanSTag: 34 + vlanCTag: 35 Metal2Sp-Aws: - $ref: "#/components/examples/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 + redundancy: + group: 3cbd354d-d147-4552-bfd0-78c559b4cc91 + priority: PRIMARY + aSide: + accessPoint: + type: METAL_NETWORK + virtualNetwork: + href: https://api.equinix.com/metal/v1/virtual-networks/a867f685-41b0-1b07-6de0-320a5c00abd0 + uuid: a867f685-41b0-1b07-6de0-320a5c00abd0 + 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: + accountNumber: 123213 + notifications: + - type: ALL + emails: + - fabric@gmail.com + - fabric1@gmail.com + changeLog: + createdBy: fabric + createdDateTime: '2020-05-21T10:30:00Z' Metal2Sp-Azure: - $ref: "#/components/examples/Metal2Sp-Azure-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/d3b69c6b-3b23-4ac0-a1bb-8db16460714d + type: EVPL_VC + 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 + createdDateTime: '2024-03-21T20:14:04.072Z' + updatedBy: fabric + 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: - $ref: "#/components/examples/Metal2Sp-GCP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/d3b69c6b-3b23-4ac0-a1bb-8db16460714d + type: EVPL_VC + 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 + createdDateTime: '2024-03-21T20:14:04.072Z' + updatedBy: fabric + 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: - $ref: "#/components/examples/Metal2Sp-Oracle-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/7a21d5d8-f153-45f8-ad76-f92babf3f103 + type: EVPL_VC + 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 + createdDateTime: '2024-03-19T23:09:15.547Z' + updatedBy: fabric + 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: - $ref: "#/components/examples/Metal2Sp-IBM-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/f0e56501-d92f-4ca3-b047-f95628d4a32a + type: EVPL_VC + 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 + createdDateTime: '2024-03-06T17:20:41.574Z' + updatedBy: fabric + 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: - $ref: "#/components/examples/Metal2Port-Dot1q-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/02b7b7d4-1726-4451-9598-e28091c096cd + type: EVPL_VC + 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 + createdDateTime: '2024-03-20T00:39:07.648Z' + updatedBy: fabric + 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: - $ref: "#/components/examples/Metal2Port-Qinq-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/d87489aa-c32d-4756-a81a-6f557afb871d + type: EVPL_VC + 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 + createdDateTime: '2024-03-21T23:44:22.347Z' + updatedBy: fabric + 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 Metal2Port-ZsideServiceToken: - $ref: "#/components/examples/Metal2ServiceToken-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/f712745e-ccf9-4a0d-9e4d-83c1bb5b9028 + type: EVPL_VC + 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 + createdDateTime: '2024-03-20T20:12:08.595Z' + updatedBy: fabric + 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: - $ref: "#/components/examples/Metal2Sp-Generic-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/1a9ffa8f-d4d4-44ab-9733-362c9a36ec94 + type: EVPL_VC + 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 + createdDateTime: '2024-03-22T00:42:35.386Z' + updatedBy: fabric + 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 Fcr2Metal-Network: - $ref: "#/components/examples/Fcr2Metal-Network" + value: + type: IP_VC + name: My-FCR-MetalNetwork-Connection + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Colo2Network-EVPLAN_VC: - $ref: "#/components/examples/COLO2NETWORKwithDot1q-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/f3dd7395-7196-45f4-9b6f-54094aa75f53 + type: EVPLAN_VC + 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: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-23T02:51:07.675Z' + updatedBy: fabric + updatedDateTime: '2024-04-23T02:51:07.675Z' + bandwidth: 50 + redundancy: + group: ecebee55-975b-4017-857c-74617f821b87 + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DA + metroCode: DA + port: + href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 + type: XF_PORT + 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 Colo2Network-EPLAN_VC: - $ref: "#/components/examples/COLO2NETWORKwithEPL-Response" - Colo2Network-EVPTREE_VC: - $ref: "#/components/examples/COLO2NETWORK_EVPTREE_withDot1q-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/cce170c5-a496-4928-8426-507e00818887 + type: EPLAN_VC + 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: 1 + notifications: + - type: ALL + emails: + - fabric@test.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-23T03:07:17.587Z' + updatedBy: fabric + updatedDateTime: '2024-04-23T03:07:17.587Z' + bandwidth: 50 + redundancy: + group: dbab0e00-db97-4abf-aebe-76c7a40a371e + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SP + metroCode: SP + port: + href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 + type: XF_PORT + 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 + Colo2Network-EVPTREE_VC: + value: + href: https://api.equinix.com/fabric/v4/connections/f3dd7395-7196-45f4-9b6f-54094aa75f53 + type: EVPTREE_VC + uuid: f3dd7395-7196-45f4-9b6f-54094aa75f53 + name: colo2network-evptree-vc + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-23T02:51:07.675Z' + updatedBy: fabric + updatedDateTime: '2024-04-23T02:51:07.675Z' + bandwidth: 50 + redundancy: + group: ecebee55-975b-4017-857c-74617f821b87 + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DA + metroCode: DA + port: + href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 + type: XF_PORT + 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: EVPTREE-GLOBAL + platformUuid: afe28606-8021-4161-802c-b80d4bc22f20 + state: ACTIVE + type: EVPTREE + scope: GLOBAL + role: LEAF Colo2Network-EPTREE_VC: - $ref: "#/components/examples/COLO2NETWORK_EPTREE_withEPL-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/cce170c5-a496-4928-8426-507e00818887 + type: EPTREE_VC + uuid: cce170c5-a496-4928-8426-507e00818887 + name: colo2network-eptree-vc + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@test.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-23T03:07:17.587Z' + updatedBy: fabric + updatedDateTime: '2024-04-23T03:07:17.587Z' + bandwidth: 50 + redundancy: + group: dbab0e00-db97-4abf-aebe-76c7a40a371e + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SP + metroCode: SP + port: + href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 + type: XF_PORT + 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: EPTREE-GLOBAL + platformUuid: 47aedd04-64dc-4e86-8da3-f88a9755a214 + state: ACTIVE + type: EPTREE + scope: GLOBAL + role: LEAF Vd2IASp: - $ref: "#/components/examples/Vd2IAProfile-Response" + value: + href: https://uatapi.npclouda.equinix.com/fabric/v4/connections/ce42ca81-538d-4f38-b020-d45fb48d20c7 + type: IA_VC + uuid: ce42ca81-538d-4f38-b020-d45fb48d20c7 + name: vd2eia-connection-1 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-30T20:19:44.279Z' + updatedBy: fabric + 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: + metroHref: https://api.equinix.com/fabric/v4/metros/SY + 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: - $ref: "#/components/examples/Vd2NETWORK-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/e1f165fd-29bb-4c15-8ec7-56242677e6fc + type: EVPLAN_VC + uuid: e1f165fd-29bb-4c15-8ec7-56242677e6fc + name: vd2network-connection + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-1234567890 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-23T02:12:20.334Z' + updatedBy: fabric + 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: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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 Vd2Sp-Aws: - $ref: "#/components/examples/Vd2AwsSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/f0a954e7-bdc5-4727-90cc-869f990e289f + type: EVPL_VC + uuid: f0a954e7-bdc5-4727-90cc-869f990e289f + name: vd2aws-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-1234567890 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-27T00:32:21.879Z' + updatedBy: fabric + 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: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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 Vd2Sp-Azure: - $ref: "#/components/examples/Vd2AzureSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/3da14bba-d81c-4497-93c3-3f4a3cb0bc40 + type: EVPL_VC + uuid: 3da14bba-d81c-4497-93c3-3f4a3cb0bc40 + name: vd2azure-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-1234567890 + billingTier: Up to 200 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-25T20:30:24.632Z' + updatedBy: fabric + 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: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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 Vd2Sp-Oracle: - $ref: "#/components/examples/Vd2OracleSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/53c89f1a-0be7-44a1-9c03-28059632a72d + type: EVPL_VC + uuid: 53c89f1a-0be7-44a1-9c03-28059632a72d + name: vd2oracle-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 1G + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-25T20:40:40.676Z' + updatedBy: fabric + 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: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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 Vd2Sp-IBM_1.0: - $ref: "#/components/examples/Vd2Ibm_1" + value: + href: https://api.equinix.com/fabric/v4/connections/d99408ca-7143-4ff7-b66c-93909d3ed893 + type: EVPL_VC + uuid: d99408ca-7143-4ff7-b66c-93909d3ed893 + name: vd2ibm10-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-27T00:56:19.807Z' + updatedBy: fabric + updatedDateTime: '2024-04-27T00:56:19.807Z' + bandwidth: 50 + redundancy: + group: dc80b3b0-f5b8-4e80-bb91-34a536ea52e8 + priority: PRIMARY + aSide: + accessPoint: + interface: + uuid: b3313274-d03d-42ef-a221-ab03d31b6b67 + id: 7 + type: CLOUD + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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/45b446fa-d3b6-417a-b871-a5ee0efdc459 + type: L2_PROFILE + name: IBM Cloud Direct Link Exchange + uuid: 45b446fa-d3b6-417a-b871-a5ee0efdc459 + sellerRegion: Washington 2 + authenticationKey: xxxx-xxx-xxx Vd2Sp-IBM_2.0: - $ref: "#/components/examples/Vd2Ibm_2" + value: + href: https://api.equinix.com/fabric/v4/connections/0175e136-8be7-4b04-8d57-c33c20555501 + type: EVPL_VC + uuid: 0175e136-8be7-4b04-8d57-c33c20555501 + name: vd2ibm20-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-25T20:41:37.805Z' + updatedBy: fabric + updatedDateTime: '2024-04-25T20:41:37.805Z' + bandwidth: 50 + redundancy: + group: d1f11356-91ca-4550-8488-ba434a771e09 + priority: PRIMARY + aSide: + accessPoint: + interface: + uuid: 1be460db-5125-49e8-92b4-124e75aab35f + id: 8 + type: CLOUD + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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/e092ed47-63d2-4f4a-87a0-82e3b08eefe5 + type: L2_PROFILE + name: IBM Cloud Direct Link 2 + uuid: e092ed47-63d2-4f4a-87a0-82e3b08eefe5 + sellerRegion: San Jose 2 + authenticationKey: xxxx-xxx-xxx Vd2Sp-Alibaba: - $ref: "#/components/examples/Vd2AlibabaSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/66ed4e8a-584c-4027-9788-748fecb5ce35 + type: EVPL_VC + uuid: 66ed4e8a-584c-4027-9788-748fecb5ce35 + name: vd2alibaba-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: po1234 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-25T20:43:43.199Z' + updatedBy: fabric + 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: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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 Vd2Sp-Google: - $ref: "#/components/examples/Vd2GoogleSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/50ae793c-b466-4d71-9724-c32b5e402bbe + type: EVPL_VC + uuid: 50ae793c-b466-4d71-9724-c32b5e402bbe + name: vd2googleSp-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-1234567890 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinx.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-25T14:06:48.933Z' + updatedBy: fabric + 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: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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 IX2Sp-PublicPeering_VC: - $ref: "#/components/examples/IXDedicatedPublicPeeringConnectionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/connections/a8ba52de-faae-43b5-b0b1-6904d37ee011 + uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 + type: IX_VC + name: Virtual-Connection-1 + bandwidth: 1000 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + aSide: + accessPoint: + type: COLO + port: + href: https://api.equinix.com/fabric/v4/ports/99e83e59-fd26-4134-b1b3-4c5dea6924d6 + uuid: 99e83e59-fd26-4134-b1b3-4c5dea6924d6 + type: XF_PORT + name: A-IX-Port + linkProtocol: + type: DOT1Q + vlanTag: 99 + zSide: + accessPoint: + type: SP + profile: + href: https://api.equinix.com/fabric/v4/serviceProfiles/0f6bdb36-e130-4924-b038-ee1785fad166 + uuid: 0f6bdb36-e130-4924-b038-ee1785fad166 + type: IX_PROFILE + name: Equinix Internet Exchange Peering Profile + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + notifications: + - type: ALL + emails: + - test@test.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "403": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "405": + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' + '405': description: Method not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/405" + value: + - errorCode: EQ-3142569 + errorMessage: Method not supported, Please check the URL passed + details: Method:PATCH + correlationId: f48687b0-d088-46d1-b06c-00c0688fbca9 /fabric/v4/connections/{connectionId}: get: tags: @@ -1043,124 +7150,346 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: direction in: query description: Connection Direction required: false schema: - $ref: "#/components/schemas/ConnectionDirection" + $ref: '#/components/schemas/ConnectionDirection' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Connection" + $ref: '#/components/schemas/Connection' examples: nonGenericConnectionResponse: - $ref: "#/components/examples/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 genericConnectionResponse: - $ref: "#/components/examples/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: ACTIVE + 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 coloToColoWithMaintenanceResponse: - $ref: "#/components/examples/ColoToColoWithMaintenanceResponseExample" + 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-ColoToColo-280122023234849 + state: ACTIVE + operation: + providerStatus: AVAILABLE + equinixStatus: PROVISIONED + maintenanceStatus: SCHEDULED + lockEnabled: true + order: + purchaseOrderNumber: PO754587184643 + notifications: + - type: ALL + emails: + - fake@mail.com + account: + accountNumber: 270001 + orgId: 91997 + globalOrgId: 0016u000003JZ4sAAG + changeLog: + createdBy: admin_user + createdDateTime: '2022-01-28T02:32:36.402Z' + updatedBy: test_user + updatedDateTime: '2022-01-29T02: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 + type: XF_PORT + uuid: c791f8cb-5a41-a410-8ce0-306a5c00a4ee + name: testBuyer-DA1-L-Dot1q-STD-PRI-10G-NK-329 + linkProtocol: + type: DOT1Q + vlanTag: 1043 + zSide: + 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-5a49-a490-8ce0-306a5c00a4ee + type: XF_PORT + uuid: c791f8cb-5a49-a490-8ce0-306a5c00a4ee + name: testBuyer-DA1-L-Dot1q-STD-SEC-10G-NK-337 + linkProtocol: + type: DOT1Q + vlanTag: 3322 Colo2Sp-LMaaS: - $ref: "#/components/examples/LMaaSConnectionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/connections/8236fbb9-51e5-428f-86bf-6b67e1223ac1 + uuid: 8236fbb9-51e5-428f-86bf-6b67e1223ac1 + type: EVPL_VC + name: Last Mile Connection 1 + state: ACTIVE + operation: + providerStatus: AVAILABLE + equinixStatus: PROVISIONED + order: + billingTier: Up to 10 MB + termLength: 1 + bandwidth: 10 + redundancy: + group: d4db1048-ef3d-f3d6-49e0-306a5c00a341 + priority: PRIMARY + isRemote: false + direction: INCOMING + account: + accountNumber: 201257 + orgId: 91955 + globalOrgId: '' + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + changeLog: + createdBy: sampleuser + createdDateTime: '2026-01-01T00:00:00.000Z' + updatedBy: sampleuser + updatedDateTime: '2026-01-01T00:00:00.000Z' + notifications: + - type: ALL + emails: + - someone@sample.com + - type: ORDERING + emails: + - someone@sample.com + phone: + - type: OFFICE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: MOBILE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: TECHNICAL + emails: + - someone@sample.com + phone: + - type: OFFICE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: MOBILE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + aSide: + accessPoint: + type: COLO + account: + accountNumber: 201257 + organizationName: Sample Organization + location: + region: AMER + metroName: Ashburn + metroCode: DC + ibx: DC11 + port: + href: https://api.equinix.com/fabric/v4/ports/c4d9350e-780f-80fd-1ce0-306a5c00a600 + uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 + name: Sample Port DC + redundancy: + priority: SECONDARY + linkProtocol: + type: QINQ + vlanSTag: 121 + vlanCTag: 145 + zSide: + accessPoint: + type: SP + account: + organizationName: Sample Provider Organization + location: + region: AMER + metroName: Ashburn + metroCode: DC + ibx: DC11 + profile: + href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 + type: LMAAS_PROFILE + name: Last Mile Service Profile 1 + uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 + productOffering: + id: sample-product-offering-id + name: Sample product offering 1 + billingTerm: 12 + bandwidthCommit: 50 + address: + id: lmaas-addr-sample-id + streetNr: '1234' + streetName: Main St + city: San Jose + stateOrProvince: CA + postCode: '95101' + country: United States + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_Invalid_id" - "403": + 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 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' example: - errorCode: EQ-3000005 errorMessage: You don't have permissions to perform READ operation. Please contact your master administrator to get the right permissions through Equinix Customer Portal or contact Equinix Support (support@equinix.com). - "404": - description: Not Found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/404" - delete: - tags: - - Connections - summary: Delete Connection 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": + '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" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/405" + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' patch: tags: - Connections @@ -1173,7 +7502,9 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: dryRun in: query description: option to verify that API calls will succeed @@ -1185,88 +7516,571 @@ paths: content: application/json-patch+json: schema: - $ref: "#/components/schemas/ConnectionUpdateRequest" + $ref: '#/components/schemas/ConnectionUpdateRequest' examples: ConnectionUpdateNameRequest: - $ref: "#/components/examples/ConnectionUpdateNameRequest" + value: + - op: replace + path: /name + value: Conn-Name-2 ConnectionUpdateBandwidthRequest: - $ref: "#/components/examples/ConnectionUpdateBandwidthRequest" + value: + - op: replace + path: /bandwidth + value: 1000 ConnectionUpdateTermLengthRequest: - $ref: "#/components/examples/ConnectionUpdateTermLengthRequest" + value: + - op: replace + path: /order/termLength + value: 12 ConnectionAddAccessAndSecretKeyAWSRequest: - $ref: "#/components/examples/ConnectionAddAccessAndSecretKeyAWSRequest" + value: + - op: add + path: '' + value: + additionalInfo: + - key: accessKey + value: nTTgtgoQbTQCRHTbynll + - key: secretKey + value: NwPcpbWgFEPofydsZEQGwjtHqJOYrUmBbrcxtOzP ConnectionMigrationAsideRequest: - $ref: "#/components/examples/ConnectionMigrationAsideRequest" + value: + - op: replace + path: /aSide/accessPoint/port/uuid + value: 5e7fd31d-f1e8-46fe-b6ad-6f5f2306cfd8 ConnectionUpdateNotificationEmailRequest: - $ref: "#/components/examples/ConnectionUpdateNotificationEmailRequest" + value: + - op: replace + path: /notifications + value: + - type: ALL + emails: + - testEmail1@equinix.com + - testEmail2@equinix.com ConnectionMigrationAsideRequestForVirtualDevice: - $ref: "#/components/examples/ConnectionMigrationAsideVirtualDeviceRequest" + value: + - op: replace + path: /aSide/accessPoint + value: + virtualDevice: + type: EDGE + uuid: 207667ba-3211-452c-b0a8-8b9046e122a5 + interface: + type: CLOUD + id: 4 ConnectionUpdateBandwidthRequestDryRun: - $ref: "#/components/examples/ConnectionUpdateBandwidthRequest" + value: + - op: replace + path: /bandwidth + value: 1000 ConnectionPriorityMigrationAsideRequestForVirtualDevice: - $ref: "#/components/examples/ConnectionPriorityMigrationAsideVirtualDeviceRequest" + value: + - op: replace + path: /aSide/accessPoint/fabricEdgePriority + value: PRIMARY required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Connection" + $ref: '#/components/schemas/Connection' examples: connectionPatchExampleDryRun: - $ref: "#/components/examples/ConnectionPatchResponseDryRun" - "202": + 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 + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Connection" + $ref: '#/components/schemas/Connection' examples: connectionPatchExample: - $ref: "#/components/examples/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 connectionUpdateTermLength: - $ref: "#/components/examples/ConnectionUpdateTermLengthResponse" + value: + href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 + type: EVPL_VC + uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 + name: dha_p2p_CH_1m + change: + uuid: 9b9f8a9b-4583-4649-9d91-a48494f822a7 + type: CONNECTION_UPDATE + createdDateTime: '2025-09-10T12:33:42.916Z' + data: + op: replace + path: /order/termLength + value: 12 + operation: + providerStatus: AVAILABLE + equinixStatus: PROVISIONED + order: + billingTier: Up to 200 MB + termLength: 12 + notifications: + - type: ALL + emails: + - testuser@equinix.com + changeLog: + createdBy: testuser + createdDateTime: '2025-09-10T12:26:12.344Z' + updatedBy: testuser + updatedDateTime: '2025-09-10T12:33:42.996Z' + bandwidth: 200 + redundancy: + group: 561082c7-d979-4beb-9536-520cc5b9d0ac + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + metroCode: DC + port: + href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d + type: XF_PORT + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + name: gen-l2-qa-01-auto-DC5-NL-Dot1q-STD-PRI-1G-JUN-51 + linkProtocol: + type: DOT1Q + vlanTag: 1246 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d + type: XF_PORT + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + name: gen-l2-qa-01-auto-CH1-L-Dot1q-BO-PRI-10G-JUN-189 + linkProtocol: + type: DOT1Q + vlanTag: 1247 links: Get Connection Details: operationId: getConnectionByUuid parameters: connectionId: $response.body#/uuid - "400": + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + dryRun: + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '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/400" - dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' + delete: + tags: + - Connections + summary: Delete Connection by ID + description: Delete Connection by ID + operationId: deleteConnectionByUuid + parameters: + - name: connectionId + in: path + description: Connection UUID + required: true + schema: + description: Virtual Circuit UUID + type: string + responses: + '200': + description: Delete Connection Request + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' + examples: + connectionExample: + 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': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142510 + errorMessage: Connection is in transient state + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142401 + errorMessage: Your account isn't authorized to perform this task. Contact your administrator for assistance. + correlationId: 12312y7127tges + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' + '405': + description: Method not allowed + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3142569 + errorMessage: Method not supported, Please check the URL passed + details: Method:PATCH + correlationId: f48687b0-d088-46d1-b06c-00c0688fbca9 /fabric/v4/connections/{connectionId}/actions: post: tags: @@ -1280,81 +8094,293 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ConnectionActionRequest" + $ref: '#/components/schemas/ConnectionActionRequest' examples: ApproveGenericConnection: - $ref: "#/components/examples/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 RejectGenericConnection: - $ref: "#/components/examples/Connection_Creation_Rejection" + value: + type: CONNECTION_CREATION_REJECTION + description: Invalid connection request ApproveBandwidthUpdate: - $ref: "#/components/examples/Connection_Update_Acceptance" + value: + type: CONNECTION_UPDATE_ACCEPTANCE RejectBandwidthUpdate: - $ref: "#/components/examples/Connection_Update_Rejection" + value: + type: CONNECTION_UPDATE_REJECTION + description: Invalid connection update request AcceptDeleteConnection: - $ref: "#/components/examples/Connection_Deletion_Acceptance" + value: + type: CONNECTION_DELETION_ACCEPTANCE VcMigrationZSide: - $ref: "#/components/examples/Connection_Update_Request_VC_Migration" + value: + type: CONNECTION_UPDATE_REQUEST + data: + zSide: + accessPoint: + type: COLO + port: + uuid: c791f8cb-5a47-a470-8ce0-306a5c00a4ee BGPSync: - $ref: "#/components/examples/Connection_Provider_Status_Request" + value: + type: CONNECTION_PROVIDER_STATUS_REQUEST GetProviderBandwidth: - $ref: "#/components/examples/Connection_Provider_Bandwidth_Request" + value: + type: CONNECTION_PROVIDER_BANDWIDTH_REQUEST AcceptZSide-NetworkEdge: - $ref: "#/components/examples/AcceptZSide_NetworkEdge_Request" + value: + type: CONNECTION_CREATION_ACCEPTANCE + data: + zSide: + accessPoint: + virtualDevice: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + type: CLOUD + id: 8 ProviderStatusUpdate: - $ref: "#/components/examples/Connection_Provider_Status_Update" + value: + type: CONNECTION_PROVIDER_STATUS_UPDATE_REQUEST + data: + operation: + providerStatus: QUOTING required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionAction" + $ref: '#/components/schemas/ConnectionAction' examples: connectionActionExample: - $ref: "#/components/examples/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' GetProviderBandwidth: - $ref: "#/components/examples/Connection_Provider_Bandwidth_Response" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' /fabric/v4/connections/{connectionId}/advertisedRoutes/search: post: tags: @@ -1368,71 +8394,336 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteSearchRequest" + $ref: '#/components/schemas/ConnectionRouteSearchRequest' examples: ConnectionRoutesSearchType: - $ref: "#/components/examples/ConnectionRoutesSearchByType" + value: + filter: + and: + - property: /type + operator: '=' + values: + - IPv4_BGP_ROUTE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime ConnectionRoutesSearchByState: - $ref: "#/components/examples/ConnectionRoutesSearchByState" + value: + filter: + and: + - property: /state + operator: '=' + values: + - ACTIVE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime ConnectionRoutesSearchByPrefix: - $ref: "#/components/examples/ConnectionRoutesSearchByPrefix" + value: + filter: + and: + - property: /prefix + operator: '=' + values: + - 192.168.10.0/24 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime ConnectionRoutesSearchByNextHop: - $ref: "#/components/examples/ConnectionRoutesSearchByNextHop" + value: + filter: + and: + - property: /nextHop + operator: '=' + values: + - 10.10.10.5 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime ConnectionRoutesSearchByMed: - $ref: "#/components/examples/ConnectionRoutesSearchByMed" + value: + filter: + and: + - property: /med + operator: '=' + values: + - '200' + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteTableEntrySearchResponse" + $ref: '#/components/schemas/ConnectionRouteTableEntrySearchResponse' examples: advertisedRoutes: - $ref: "#/components/examples/CloudRouterAdvertisedRoutesSearchResponse" + value: + pagination: + offset: 0 + limit: 20 + total: 1 + data: + - type: IPv4_BGP_ROUTE + protocolType: BGP + state: ACTIVE + prefix: 192.168.10.0/24 + nextHop: 10.10.10.5 + MED: 5 + asPath: + - '20001' + connection: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 81331c52-04c0-4656-a4a7-18c52669348f + name: connection_1 + changeLog: + createdBy: johnsmith + createdByFullName: John Smith + createdByEmail: john.smith@example.com + createdDateTime: '2020-11-06T07:00:00Z' + updatedBy: johnsmith + updatedByFullName: John Smith + updatedByEmail: john.smith@example.com + updatedDateTime: '2020-11-06T07:00:00Z' + deletedBy: johnsmith + deletedByFullName: John Smith + deletedByEmail: john.smith@example.com + deletedDateTime: '2020-11-06T07:00:00Z' receivedRoutes: - $ref: "#/components/examples/CloudRouterReceivedRoutesSearchResponse" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + data: + - type: IPv4_BGP_ROUTE + protocolType: BGP + state: ACTIVE + prefix: 192.168.10.0/24 + nextHop: 10.10.10.5 + MED: 5 + asPath: + - '20001' + connection: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 81331c52-04c0-4656-a4a7-18c52669348f + name: connection_1 + changeLog: + createdBy: johnsmith + createdByFullName: John Smith + createdByEmail: john.smith@example.com + createdDateTime: '2020-11-06T07:00:00Z' + updatedBy: johnsmith + updatedByFullName: John Smith + updatedByEmail: john.smith@example.com + updatedDateTime: '2020-11-06T07:00:00Z' + deletedBy: johnsmith + deletedByFullName: John Smith + deletedByEmail: john.smith@example.com + deletedDateTime: '2020-11-06T07:00:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' /fabric/v4/connections/{connectionId}/receivedRoutes/search: post: tags: @@ -1446,67 +8737,308 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteSearchRequest" + $ref: '#/components/schemas/ConnectionRouteSearchRequest' examples: ConnectionRoutesSearchType: - $ref: "#/components/examples/ConnectionRoutesSearchByType" + value: + filter: + and: + - property: /type + operator: '=' + values: + - IPv4_BGP_ROUTE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime ConnectionRoutesSearchByState: - $ref: "#/components/examples/ConnectionRoutesSearchByState" + value: + filter: + and: + - property: /state + operator: '=' + values: + - ACTIVE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime ConnectionRoutesSearchByMed: - $ref: "#/components/examples/ConnectionRoutesSearchByMed" + value: + filter: + and: + - property: /med + operator: '=' + values: + - '200' + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteTableEntrySearchResponse" + $ref: '#/components/schemas/ConnectionRouteTableEntrySearchResponse' examples: advertisedRoutes: - $ref: "#/components/examples/CloudRouterAdvertisedRoutesSearchResponse" + value: + pagination: + offset: 0 + limit: 20 + total: 1 + data: + - type: IPv4_BGP_ROUTE + protocolType: BGP + state: ACTIVE + prefix: 192.168.10.0/24 + nextHop: 10.10.10.5 + MED: 5 + asPath: + - '20001' + connection: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 81331c52-04c0-4656-a4a7-18c52669348f + name: connection_1 + changeLog: + createdBy: johnsmith + createdByFullName: John Smith + createdByEmail: john.smith@example.com + createdDateTime: '2020-11-06T07:00:00Z' + updatedBy: johnsmith + updatedByFullName: John Smith + updatedByEmail: john.smith@example.com + updatedDateTime: '2020-11-06T07:00:00Z' + deletedBy: johnsmith + deletedByFullName: John Smith + deletedByEmail: john.smith@example.com + deletedDateTime: '2020-11-06T07:00:00Z' receivedRoutes: - $ref: "#/components/examples/CloudRouterReceivedRoutesSearchResponse" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + data: + - type: IPv4_BGP_ROUTE + protocolType: BGP + state: ACTIVE + prefix: 192.168.10.0/24 + nextHop: 10.10.10.5 + MED: 5 + asPath: + - '20001' + connection: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 81331c52-04c0-4656-a4a7-18c52669348f + name: connection_1 + changeLog: + createdBy: johnsmith + createdByFullName: John Smith + createdByEmail: john.smith@example.com + createdDateTime: '2020-11-06T07:00:00Z' + updatedBy: johnsmith + updatedByFullName: John Smith + updatedByEmail: john.smith@example.com + updatedDateTime: '2020-11-06T07:00:00Z' + deletedBy: johnsmith + deletedByFullName: John Smith + deletedByEmail: john.smith@example.com + deletedDateTime: '2020-11-06T07:00:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' /fabric/v4/connections/{connectionId}/routingProtocols: get: tags: @@ -1534,64 +9066,262 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetResponse" + $ref: '#/components/schemas/GetResponse' examples: getAllRoutingProtocols: - $ref: "#/components/examples/RoutingProtocolGetAll" - "400": + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + updatedDateTime: '2021-10-30T07:21:39Z' + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 post: tags: - Routing Protocols @@ -1604,90 +9334,318 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolBase" + $ref: '#/components/schemas/RoutingProtocolBase' examples: Fcr2ColoDirectRoutingOnly: - $ref: "#/components/examples/Fcr2ColoCreateDirect" + value: + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + directIpv6: + equinixIfaceIp: 2001:7a9::34f4:0:f3dd:1/126 Fcr2ColoBGPRoutingOnly: - $ref: "#/components/examples/Fcr2ColoCreateBGP" + value: + type: BGP + bgpIpv4: + enabled: true + customerPeerIp: 10.1.1.2 + equinixPeerIp: 192.168.100.1 + bgpIpv6: + enabled: true + customerPeerIp: 2001:db8:c59b::1 + equinixPeerIp: 2001:db8:c59b::1 + outboundASPrependCount: 3 + customerAsn: 100 + bfd: + enabled: true + interval: '100' Fcr2GcpDirectRoutingOnly: - $ref: "#/components/examples/Fcr2GcpCreateDirect" + value: + type: DIRECT + directIpv4: + equinixIfaceIp: 169.254.100.1/30 Fcr2GcpBGPRoutingOnly: - $ref: "#/components/examples/Fcr2GcpCreateBGP" + value: + type: BGP + bgpIpv4: + enabled: true + customerPeerIp: 169.254.100.2 + equinixPeerIp: 169.254.100.1 + outboundASPrependCount: 3 + customerAsn: 100 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolData" + $ref: '#/components/schemas/RoutingProtocolData' examples: bgpCreateResponse: - $ref: "#/components/examples/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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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 directCreateResponse: - $ref: "#/components/examples/RoutingProtocolCreateDirectResponse" - "400": + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + updatedDateTime: '2021-10-30T07:21:39Z' + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/connections/{connectionId}/routingProtocols/bulk: post: tags: @@ -1701,84 +9659,253 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ConnectionRoutingProtocolPostRequest" + $ref: '#/components/schemas/ConnectionRoutingProtocolPostRequest' examples: DirectRoutingOnly: - $ref: "#/components/examples/CreateRoutingWithDirectOnly" + value: + data: + - type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + directIpv6: + equinixIfaceIp: 2001:7a9::34f4:0:f3dd:1/126 BGPRoutingOnly: - $ref: "#/components/examples/CreateRoutingWithBGPOnly" + value: + data: + - type: BGP + bgpIpv4: + enabled: true + customerPeerIp: 10.1.1.2 + equinixPeerIp: 192.168.100.1 + outboundASPrependCount: 3 + inboundMED: 1000 + outboundMED: 2000 + bgpIpv6: + enabled: true + customerPeerIp: 2001:db8:c59b::2 + equinixPeerIp: 2001:db8:c59b::1 + outboundASPrependCount: 3 + inboundMED: 1000 + outboundMED: 2000 + customerAsn: 0 + asOverrideEnabled: true + bgpAuthKey: string + bfd: + enabled: true + interval: '100' DirectAndBGPRouting: - $ref: "#/components/examples/CreateRoutingWithDirectAndBGP" + value: + data: + - type: BGP + bgpIpv4: + enabled: true + customerPeerIp: 192.168.100.2 + equinixPeerIp: 192.168.100.1 + outboundASPrependCount: 3 + inboundMED: 1000 + outboundMED: 2000 + bgpIpv6: + enabled: true + customerPeerIp: 2001:db8:c59b::2 + equinixPeerIp: 2001:db8:c59b::1 + outboundASPrependCount: 3 + inboundMED: 1000 + outboundMED: 2000 + customerAsn: 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 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetResponse" + $ref: '#/components/schemas/GetResponse' examples: getAllRoutingProtocols: - $ref: "#/components/examples/RoutingProtocolGetAll" - "400": + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + updatedDateTime: '2021-10-30T07:21:39Z' + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400_routing_protocol" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}: get: tags: @@ -1792,266 +9919,899 @@ paths: description: Routing Protocol Id required: true schema: - $ref: "#/components/schemas/RoutingProtocolId" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolData" + $ref: '#/components/schemas/RoutingProtocolData' examples: bgpCreateResponse: - $ref: "#/components/examples/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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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 directCreateResponse: - $ref: "#/components/examples/RoutingProtocolCreateDirectResponse" - "400": + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + updatedDateTime: '2021-10-30T07:21:39Z' + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" - put: + 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 + delete: tags: - Routing Protocols - summary: Replace Protocol - description: This API provides capability to replace complete Routing Protocols on a virtual connection - operationId: replaceConnectionRoutingProtocolByUuid + 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" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - 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 + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolData" + $ref: '#/components/schemas/RoutingProtocolData' examples: - bgpReplaceResponse: - $ref: "#/components/examples/RoutingProtocolReplaceBGPResponse" - directReplaceResponse: - $ref: "#/components/examples/RoutingProtocolReplaceDirectResponse" - "400": + directDeleteResponse: + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + updatedDateTime: '2021-10-30T07:21:39Z' + deletedBy: fabric + deletedDateTime: '2021-10-30T07:21:39Z' + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + bgpDeleteResponse: + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" - delete: + 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 + put: tags: - Routing Protocols - summary: Delete Protocol - description: This API provides capability to delete Routing Protocols on virtual connection - operationId: deleteConnectionRoutingProtocolByUuid + 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" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingProtocolBase' + examples: + DirectRoutingReplaceExample: + value: + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + directIpv6: + equinixIfaceIp: 2001:7a9::34f4:0:f3dd:1/126 + BGPRoutingReplaceExample: + value: + type: BGP + bgpIpv4: + enabled: true + customerPeerIp: 192.168.100.2 + equinixPeerIp: 192.168.100.1 + outboundASPrependCount: 3 + inboundMED: 1000 + outboundMED: 2000 + bgpIpv6: + enabled: true + customerPeerIp: 2001:db8:c59b::2 + equinixPeerIp: 2001:db8:c59b::1 + outboundASPrependCount: 3 + customerAsn: 0 + bgpAuthKey: string + asOverrideEnabled: true + bfd: + enabled: true + interval: '100' + required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolData" + $ref: '#/components/schemas/RoutingProtocolData' examples: - directDeleteResponse: - $ref: "#/components/examples/RoutingProtocolDeleteDirectResponse" - bgpDeleteResponse: - $ref: "#/components/examples/RoutingProtocolDeleteBGPResponse" - "400": + bgpReplaceResponse: + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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 + directReplaceResponse: + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + updatedDateTime: '2021-10-30T07:21:39Z' + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 patch: tags: - Routing Protocols @@ -2064,322 +10824,953 @@ paths: description: Routing Protocol Id required: true schema: - $ref: "#/components/schemas/RoutingProtocolId" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ConnectionRoutingProtocolPatchRequest" + $ref: '#/components/schemas/ConnectionRoutingProtocolPatchRequest' examples: EnableIPv4PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolEnableIPv4" + value: + - op: replace + path: /bgpIpv4/enabled + value: true EnableIPv6PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolEnableIPv6" + value: + - op: replace + path: /bgpIpv6/enabled + value: true DisableIPv4PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolDisableIPv4" + value: + - op: replace + path: /bgpIpv4/enabled + value: false DisableIPv6PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolDisableIPv6" + value: + - op: replace + path: /bgpIpv6/enabled + value: false application/json-patch+json: schema: - $ref: "#/components/schemas/ConnectionRoutingProtocolPatchRequest" + $ref: '#/components/schemas/ConnectionRoutingProtocolPatchRequest' examples: EnableIPv4PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolEnableIPv4" + value: + - op: replace + path: /bgpIpv4/enabled + value: true EnableIPv6PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolEnableIPv6" + value: + - op: replace + path: /bgpIpv6/enabled + value: true DisableIPv4PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolDisableIPv4" + value: + - op: replace + path: /bgpIpv4/enabled + value: false DisableIPv6PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolDisableIPv6" + value: + - op: replace + path: /bgpIpv6/enabled + value: false required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolData" + $ref: '#/components/schemas/RoutingProtocolData' examples: EnableBGPResponse: - $ref: "#/components/examples/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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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 DisableBGPResponse: - $ref: "#/components/examples/RoutingProtocolDisableBGPResponse" - "400": + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/actions: - get: + post: tags: - Routing Protocols - summary: Get BGP Actions - description: This API provides capability to get all BGP actions status - operationId: getConnectionRoutingProtocolAllBgpActions + 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" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - 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 + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BGPActionRequest' + examples: + 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 + required: true responses: - "200": - description: Fabric BGP Action object + '202': + description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/BGPActionsBulkData" + $ref: '#/components/schemas/BGPActionData' examples: - BGPActionsAllResponse: - $ref: "#/components/examples/BGPActionsBulkDataResponseExample" - "400": + BGPActionHardResetIpV4: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + BGPActionHardResetIpV6: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + BGPActionSoftClearInAndOutIpV4: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + BGPActionSoftClearInAndOutIpV6: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + BGPActionSoftClearInIpV4: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + BGPActionSoftClearInIpV6: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" - post: + 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 + get: tags: - Routing Protocols - summary: Clear/Reset BGP - description: This API provides capability to clear/reset Routing Protocols BGP session - operationId: postConnectionRoutingProtocolBgpActionByUuid + 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" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - 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 + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + - 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: - "202": - description: Successful operation + '200': + description: Fabric BGP Action object content: application/json: schema: - $ref: "#/components/schemas/BGPActionData" + $ref: '#/components/schemas/BGPActionsBulkData' 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": + BGPActionsAllResponse: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: 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 + createdDateTime: '2020-05-21T10:20:00Z' + updatedBy: testuser + updatedDateTime: '2020-05-21T10:25:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/actions/{actionId}: get: tags: @@ -2393,74 +11784,110 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: - $ref: "#/components/schemas/RoutingProtocolId" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: actionId in: path description: BGP Action UUID required: true schema: - $ref: "#/components/schemas/ActionId" + description: BGP Action UUID + type: string + format: uuid + example: 86534014-34b4-53f6-45d6-4b94a92d8623 responses: - "200": + '200': description: Fabric BGP Action object content: application/json: schema: - $ref: "#/components/schemas/BGPActionData" + $ref: '#/components/schemas/BGPActionData' examples: BGPActionResponse: - $ref: "#/components/examples/BGPActionDataResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: adminuser + updatedDateTime: '2020-05-21T10:35:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_Invalid_id" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/changes/{changeId}: get: tags: @@ -2474,74 +11901,140 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: - $ref: "#/components/schemas/RoutingProtocolId" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: changeId in: path description: Routing Protocol Change UUID required: true schema: - $ref: "#/components/schemas/ChangeId" + description: Routing Protocol Change UUID + type: string + format: uuid + example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: - "200": + '200': description: Fabric Routing Protocol Change object content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolChangeData" + $ref: '#/components/schemas/RoutingProtocolChangeData' examples: RoutingProtocolChangeResponse: - $ref: "#/components/examples/RoutingProtocolGetChangeResponseExample" - "400": + 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: + enabled: true + 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: + enabled: true + 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 + asOverrideEnabled: true + bgpAuthKey: string + bfd: + enabled: true + interval: '100' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_Invalid_id" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/changes: get: tags: @@ -2555,13 +12048,18 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: - $ref: "#/components/schemas/RoutingProtocolId" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: offset in: query description: offset @@ -2577,60 +12075,154 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Fabric Routing Protocol Change object content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolChangeDataResponse" + $ref: '#/components/schemas/RoutingProtocolChangeDataResponse' examples: RoutingProtocolChangesResponse: - $ref: "#/components/examples/RoutingProtocolGetAllChangesResponseExample" - "400": + 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: + enabled: true + 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: + enabled: true + 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 + 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: + enabled: true + customerPeerIp: 10.1.1.3 + equinixPeerIp: 10.1.1.4 + operation: + operationalStatus: UP + opStatusChangedAt: '2021-10-30T07:21:39Z' + bgpIpv6: + enabled: true + customerPeerIp: 2001:db8:c59b::1 + equinixPeerIp: 2001:db8:c59b::1 + operation: + operationalStatus: UP + opStatusChangedAt: '2021-10-30T07:21:39Z' + customerAsn: 0 + bgpAuthKey: string + bfd: + enabled: true + interval: '100' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_Invalid_id" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/exchangeServices: post: tags: @@ -2638,71 +12230,185 @@ paths: summary: Create Internet Exchange Service description: This API provides capability to create Internet Exchange Service operationId: createExchangeService - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceCreateRequest" + $ref: '#/components/schemas/ExchangeServiceCreateRequest' examples: ExchangeServiceCreateRequest: - $ref: "#/components/examples/ExchangeServiceCreateRequest" + value: + type: IX + name: ix_exchange_service + publicPeeringConnection: + uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 + description: ix_exchange_service + routingProtocol: + customerAsn: 5555 + macAddress: '00:11:22:33:44:55' + bgpIpv4: + domainName: gw01.sin.example.net + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5KEY12345 + prefixes: + - 203.0.113.0/24 + bgpIpv6: + domainName: gw01.sin.example.net + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5KEY123456 + prefixes: + - 2001:DB8:123::/48 + order: + purchaseOrderNumber: 1-3456576 + notifications: + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order + project: + projectId: e275485c-7072-439f-943a-c923548b2be5 + account: + accountNumber: 100179 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceResponse" + $ref: '#/components/schemas/ExchangeServiceResponse' examples: CreateExchangeServiceResponse: - $ref: "#/components/examples/ExchangeServiceResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 + uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 + type: IX + name: ix_exchange_service + bandwidth: 400000 + description: ix_exchange_service + state: PROVISIONING + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SV + metroCode: SV + publicPeeringConnection: + type: IX_VC + href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 + uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 + routingProtocol: + customerAsn: 5555 + macAddress: '00:11:22:33:44:55' + vlan: 99 + routeServerAsn: 24115 + bgpIpv4: + customerPeerIp: 12.1.1.1 + domainName: gw01.sin.example.net + primaryRouteServerIp: 10.1.1.1 + secondaryRouteServerIp: 10.1.1.2 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key12345 + prefixes: + - 203.0.113.0/24 + maxPrefixLimit: 300 + prependSelfEnabled: true + bgpIpv6: + customerPeerIp: 2001:db8:c59b::22 + domainName: gw01.sin.example.net + primaryRouteServerIp: 2001:db8:c59b::33 + secondaryRouteServerIp: 2001:db8:c59b::322 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key123456 + prefixes: + - 2001:DB8:123::/48 + maxPrefixLimit: 300 + prependSelfEnabled: true + routeCollector: + asn: 1238 + ipV4: 10.255.255.254 + ipV6: 2001:db8:85a3::8a2e:370:7334\ + order: + purchaseOrderNumber: 1-3456576 + orderNumber: 1-139105284200 + project: + projectId: e275485c-7072-439f-943a-c923548b2be5 + account: + accountNumber: 100179 + notifications: + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order + changelog: + createdBy: '12345' + createdDateTime: '2025-08-30T07:21:39Z' + additionalInfo: + errorCode: EQ-3058039 + errorMessage: Unable to activate Exchange Service Port. Please verify your configuration or contact support. + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_400" - "401": + value: + - errorCode: EQ-3067103 + errorMessage: Invalid request. Please verify the request payload. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid request. Please verify the request payload. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_401" - "403": + value: + - errorCode: EQ-3067106 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_403" - "404": + value: + - errorCode: EQ-3067102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_404" - "500": + value: + - errorCode: EQ-3067101 + errorMessage: Internet Exchange Service not found. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internet Exchange Service not found. + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_500" + value: + - errorCode: EQ-3067104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/exchangeServices/{exchangeServiceId}: get: tags: @@ -2716,62 +12422,148 @@ paths: description: Internet Exchange Service Id required: true schema: - $ref: "#/components/schemas/ExchangeServiceId" + description: Internet Exchange Service UUID + type: string + format: uuid + example: a8ba52de-faae-43b5-b0b1-6904d37ee011 responses: - "200": + '200': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceResponse" + $ref: '#/components/schemas/ExchangeServiceResponse' examples: GetExchangeServiceResponse: - $ref: "#/components/examples/ExchangeServiceResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 + uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 + type: IX + name: ix_exchange_service + bandwidth: 400000 + description: ix_exchange_service + state: PROVISIONING + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SV + metroCode: SV + publicPeeringConnection: + type: IX_VC + href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 + uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 + routingProtocol: + customerAsn: 5555 + macAddress: '00:11:22:33:44:55' + vlan: 99 + routeServerAsn: 24115 + bgpIpv4: + customerPeerIp: 12.1.1.1 + domainName: gw01.sin.example.net + primaryRouteServerIp: 10.1.1.1 + secondaryRouteServerIp: 10.1.1.2 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key12345 + prefixes: + - 203.0.113.0/24 + maxPrefixLimit: 300 + prependSelfEnabled: true + bgpIpv6: + customerPeerIp: 2001:db8:c59b::22 + domainName: gw01.sin.example.net + primaryRouteServerIp: 2001:db8:c59b::33 + secondaryRouteServerIp: 2001:db8:c59b::322 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key123456 + prefixes: + - 2001:DB8:123::/48 + maxPrefixLimit: 300 + prependSelfEnabled: true + routeCollector: + asn: 1238 + ipV4: 10.255.255.254 + ipV6: 2001:db8:85a3::8a2e:370:7334\ + order: + purchaseOrderNumber: 1-3456576 + orderNumber: 1-139105284200 + project: + projectId: e275485c-7072-439f-943a-c923548b2be5 + account: + accountNumber: 100179 + notifications: + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order + changelog: + createdBy: '12345' + createdDateTime: '2025-08-30T07:21:39Z' + additionalInfo: + errorCode: EQ-3058039 + errorMessage: Unable to activate Exchange Service Port. Please verify your configuration or contact support. + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_400" - "401": + value: + - errorCode: EQ-3067103 + errorMessage: Invalid request. Please verify the request payload. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid request. Please verify the request payload. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_401" - "403": + value: + - errorCode: EQ-3067106 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_403" - "404": + value: + - errorCode: EQ-3067102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_404" - "500": + value: + - errorCode: EQ-3067101 + errorMessage: Internet Exchange Service not found. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internet Exchange Service not found. + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_500" + value: + - errorCode: EQ-3067104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error patch: tags: - Internet Exchange Services @@ -2784,68 +12576,164 @@ paths: description: Internet Exchange Service Id required: true schema: - $ref: "#/components/schemas/ExchangeServiceId" + description: Internet Exchange Service UUID + type: string + format: uuid + example: a8ba52de-faae-43b5-b0b1-6904d37ee011 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/JsonPatch" + $ref: '#/components/schemas/JsonPatch' examples: ExchangeServicePatchMacAddressRequest: - $ref: "#/components/examples/ExchangeServicePatchMacAddressRequest" + value: + - op: replace + path: /routingProtocol/macAddress + value: 00:1A:2B:3C:4D:5E ExchangeServicePatchCustomerAsnRequest: - $ref: "#/components/examples/ExchangeServicePatchCustomerAsnRequest" + value: + - op: replace + path: /routingProtocol/customerAsn + value: 1232 ExchangeServicePatchRoutingProtocolIPv4PrefixesRequest: - $ref: "#/components/examples/ExchangeServicePatchRoutingProtocolIPv4PrefixesRequest" + value: + - op: replace + path: /routingProtocol/bgpIpv4/prefixes + value: + - 10.10.10.0/24 + - 10.10.20.0/24 ExchangeServicePatchRoutingProtocolIPv6PrefixesRequest: - $ref: "#/components/examples/ExchangeServicePatchRoutingProtocolIPv6PrefixesRequest" + value: + - op: replace + path: /routingProtocol/bgpIpv6/prefixes + value: + - 2001:db8:10::/48 + - 2001:db8:20::/48 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceResponse" + $ref: '#/components/schemas/ExchangeServiceResponse' examples: PatchExchangeServiceResponse: - $ref: "#/components/examples/ExchangeServicePatchResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 + uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 + type: IX + name: ix_exchange_service + bandwidth: 400000 + description: ix_exchange_service + state: REPROVISIONING + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SV + metroCode: SV + publicPeeringConnection: + type: IX_VC + href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 + uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 + routingProtocol: + customerAsn: 5555 + macAddress: '00:11:22:33:44:55' + vlan: 99 + routeServerAsn: 24115 + bgpIpv4: + customerPeerIp: 12.1.1.1 + domainName: gw01.sin.example.net + primaryRouteServerIp: 10.1.1.1 + secondaryRouteServerIp: 10.1.1.2 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key12345 + prefixes: + - 203.0.113.0/24 + maxPrefixLimit: 300 + prependSelfEnabled: true + bgpIpv6: + customerPeerIp: 2001:db8:c59b::22 + domainName: gw01.sin.example.net + primaryRouteServerIp: 2001:db8:c59b::33 + secondaryRouteServerIp: 2001:db8:c59b::322 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key123456 + prefixes: + - 2001:DB8:123::/48 + maxPrefixLimit: 300 + prependSelfEnabled: true + routeCollector: + asn: 1238 + ipV4: 10.255.255.254 + ipV6: 2001:db8:85a3::8a2e:370:7334 + order: + purchaseOrderNumber: 1-3456576 + orderNumber: 1-139105284200 + project: + projectId: e275485c-7072-439f-943a-c923548b2be5 + account: + accountNumber: 100179 + notifications: + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order + changelog: + updatedBy: '12345' + updatedDateTime: '2025-08-30T07:21:39Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_400" - "403": + value: + - errorCode: EQ-3067103 + errorMessage: Invalid request. Please verify the request payload. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid request. Please verify the request payload. + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_403" - "404": + value: + - errorCode: EQ-3067102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_404" - "500": + value: + - errorCode: EQ-3067101 + errorMessage: Internet Exchange Service not found. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internet Exchange Service not found. + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_500" + value: + - errorCode: EQ-3067104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/exchangeServices/search: post: tags: @@ -2853,76 +12741,255 @@ paths: summary: Search Internet Exchange Services description: The API provides capability to get list of user's Internet Exchange Service using search criteria, including optional filtering, pagination and sorting operationId: searchExchangeService - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceSearchRequest" + $ref: '#/components/schemas/ExchangeServiceSearchRequest' examples: ExchangeServiceSearchProjectId: - $ref: "#/components/examples/ExchangeServiceSearchProjectId" + value: + filter: + and: + - property: /project/projectId + operator: '=' + values: + - 30ad25e2-53dc-11ed-bdc3-0242ac120002 + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ExchangeServiceMultiProjectIdSearch: - $ref: "#/components/examples/ExchangeServiceSearchMultipleProjectIds" + value: + filter: + and: + - property: /project/projectId + operator: IN + values: + - 30ad25e2-53dc-11ed-bdc3-0242ac120002 + - 30ad25e2-53dc-11ed-bdc3-0242ac120003 + - 30ad25e2-53dc-11ed-bdc3-0242ac120004 + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ExchangeServiceStateSearch: - $ref: "#/components/examples/ExchangeServiceSearchState" + value: + filter: + and: + - property: /state + operator: '=' + values: + - PROVISIONING + pagination: + limit: 10 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ExchangeServiceMultiStateSearch: - $ref: "#/components/examples/ExchangeServiceSearchMultipleState" + value: + filter: + and: + - property: /state + operator: IN + values: + - PROVISIONING + - REPROVISIONING + pagination: + limit: 10 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ExchangeServiceMetroCodeSearch: - $ref: "#/components/examples/ExchangeServiceSearchMetroCode" + value: + filter: + and: + - property: /location/metroCode + operator: '=' + values: + - SV + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ExchangeServiceMultiMetroCodeSearch: - $ref: "#/components/examples/ExchangeServiceSearchMultipleMetroCode" + value: + filter: + and: + - property: /location/metroCode + operator: IN + values: + - SV + - NY + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ExchangeServiceBandwidthSearch: - $ref: "#/components/examples/ExchangeServiceSearchBandwidth" + value: + filter: + and: + - property: /bandwidth + operator: '=' + values: + - '500' + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ExchangeServiceMultiBandwidthSearch: - $ref: "#/components/examples/ExchangeServiceSearchMultipleBandwidth" + value: + filter: + and: + - property: /bandwidth + operator: IN + values: + - '500' + - '1000' + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceSearchResponse" + $ref: '#/components/schemas/ExchangeServiceSearchResponse' examples: example: - $ref: "#/components/examples/ExchangeServiceSearchResponse" - "400": + value: + pagination: + offset: 0 + limit: 10 + total: 1 + sort: + - property: /changeLog/updatedDateTime + direction: DESC + data: + - href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 + uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 + type: IX + name: ix_exchange_service + bandwidth: 400000 + description: ix_exchange_service + state: PROVISIONING + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SV + metroCode: SV + publicPeeringConnection: + type: IX_VC + href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 + uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 + routingProtocol: + customerAsn: 5555 + macAddress: '00:11:22:33:44:55' + vlan: 99 + routeServerAsn: 24115 + bgpIpv4: + customerPeerIp: 12.1.1.1 + domainName: gw01.sin.example.net + primaryRouteServerIp: 10.1.1.1 + secondaryRouteServerIp: 10.1.1.2 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key12345 + prefixes: + - 203.0.113.0/24 + maxPrefixLimit: 300 + prependSelfEnabled: true + bgpIpv6: + customerPeerIp: 2001:db8:c59b::22 + domainName: gw01.sin.example.net + primaryRouteServerIp: 2001:db8:c59b::33 + secondaryRouteServerIp: 2001:db8:c59b::322 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key123456 + prefixes: + - 2001:DB8:123::/48 + maxPrefixLimit: 300 + prependSelfEnabled: true + routeCollector: + asn: 1238 + ipV4: 10.255.255.254 + ipV6: 2001:db8:85a3::8a2e:370:7334 + order: + purchaseOrderNumber: 1-3456576 + orderNumber: 1-139105284200 + project: + projectId: e275485c-7072-439f-943a-c923548b2be5 + account: + accountNumber: 100179 + notifications: + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order + changelog: + updatedBy: '12345' + updatedDateTime: '2025-08-30T07:21:39Z' + additionalInfo: + errorCode: EQ-3058039 + errorMessage: Unable to activate Exchange Service Port. Please verify your configuration or contact support. + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' example: - errorCode: EQ-3000035 errorMessage: Invalid request body - "401": + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_401" - "403": + value: + - errorCode: EQ-3067106 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' example: - errorCode: EQ-3000197 errorMessage: User not authorized to perform given action - "500": + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_500" + value: + - errorCode: EQ-3067104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/exchangeServices/{exchangeServiceId}/actions: post: tags: @@ -2936,75 +13003,107 @@ paths: description: Internet Exchange Service Id required: true schema: - $ref: "#/components/schemas/ExchangeServiceId" + description: Internet Exchange Service UUID + type: string + format: uuid + example: a8ba52de-faae-43b5-b0b1-6904d37ee011 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceActionRequest" + $ref: '#/components/schemas/ExchangeServiceActionRequest' examples: ActivateExchangeServiceRequest: - $ref: "#/components/examples/EXCHANGE_SERVICE_ACTIVATE" + value: + type: EXCHANGE_SERVICE_ACTIVATE ValidateExchangeServiceRequest: - $ref: "#/components/examples/EXCHANGE_SERVICE_VALIDATE" + value: + type: EXCHANGE_SERVICE_VALIDATE RetryExchangeServiceRequest: - $ref: "#/components/examples/EXCHANGE_SERVICE_RETRY_PROVISION" + value: + type: EXCHANGE_SERVICE_RETRY_PROVISION required: true responses: - "202": + '202': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceActionResponse" + $ref: '#/components/schemas/ExchangeServiceActionResponse' examples: example: - $ref: "#/components/examples/ExchangeServiceActionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/exchangeService/a8ba52de-faae-43b5-b0b1-6904d37ee011/actions/3a58dd05-f46d-4b1d-a154-2e85c396ea62 + type: EXCHANGE_SERVICE_ACTIVATE + uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 + state: SUCCEEDED + changelog: + createdDateTime: '2026-02-10T11:30:00Z' + createdBy: Alice + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_400" - "401": + value: + - errorCode: EQ-3067103 + errorMessage: Invalid request. Please verify the request payload. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid request. Please verify the request payload. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_401" - "403": + value: + - errorCode: EQ-3067106 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_403" - "404": + value: + - errorCode: EQ-3067102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_404" - "500": + value: + - errorCode: EQ-3067101 + errorMessage: Internet Exchange Service not found. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internet Exchange Service not found. + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_500" + value: + - errorCode: EQ-3067104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/internetAccessServices: post: tags: @@ -3012,44 +13111,103 @@ paths: summary: Create Internet Access Service description: Creates Internet Access Service operationId: createEiaService - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/InternetAccessPostRequest" + $ref: '#/components/schemas/InternetAccessPostRequest' examples: CreateInternetAccess: - $ref: "#/components/examples/InternetAccessCreate" + value: + type: SINGLE_IA + name: internet-access-primary + bandwidth: 1000 + routingProtocol: + type: BGP + exportPolicy: FULL + asn: + uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 + connections: + - uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + customerRoutes: + - ipBlock: + uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + billing: + type: FIXED + project: + projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 + account: + accountNumber: '57689234' + order: + purchaseOrderNumber: PO-98765 required: true responses: - "202": + '202': description: EIA Service creation or update accepted content: application/json: schema: - $ref: "#/components/schemas/InternetAccessService" + $ref: '#/components/schemas/InternetAccessService' examples: internetAccessServiceAccepted: - $ref: "#/components/examples/InternetAccessServiceAcceptedResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 + type: SINGLE_IA + uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 + name: internet-access-primary + state: PROVISIONING + change: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents + routingProtocol: + type: BGP + exportPolicy: FULL + asn: + href: https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1 + uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 + customerRoutes: + - ipBlock: + href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + connections: + - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + billing: + type: FIXED + enabled: true + startDate: '2026-04-16T00:00:00Z' + account: + accountNumber: '57689234' + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 + project: + projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 + order: + href: https://api.equinix.com/colocations/v2/orders/100200300 + orderNumber: 100200300 + purchaseOrderNumber: PO-98765 + changeLog: + createdBy: api-user + createdDateTime: '2026-04-16T00:00:00Z' + updatedBy: api-user + updatedDateTime: '2026-04-16T00:00:01Z' + useCase: MAIN + '400': description: Invalid input parameter content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/internetAccessServices/search: post: tags: @@ -3057,44 +13215,90 @@ paths: summary: Search Internet Access Services description: Search for Internet Access Services operationId: searchEiaServices - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/InternetAccessSearchRequest" + $ref: '#/components/schemas/InternetAccessSearchRequest' examples: SearchByProject: - $ref: "#/components/examples/InternetAccessSearchByProject" + value: + filter: + and: + - property: /project/projectId + operator: '=' + values: + - 44f4c4f8-2f39-494e-838c-d8e640591be5 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime required: true responses: - "200": + '200': description: EIA Services retrieved successfully content: application/json: schema: - $ref: "#/components/schemas/InternetAccessServices" + $ref: '#/components/schemas/InternetAccessServices' examples: internetAccessServicesRetrieved: - $ref: "#/components/examples/InternetAccessServicesRetrievedResponseExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + data: + - href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 + type: SINGLE_IA + uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 + name: internet-access-primary + state: PROVISIONED + change: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents + routingProtocol: + type: BGP + customerRoutes: + - ipBlock: + href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + connections: + - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + billing: + type: FIXED + account: + accountNumber: '57689234' + project: + projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 + order: + purchaseOrderNumber: PO-98765 + changeLog: + createdDateTime: '2026-04-16T00:00:00Z' + useCase: MAIN + '400': description: Invalid input parameter content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/internetAccessServices/{uuid}: get: tags: @@ -3111,27 +13315,73 @@ paths: type: string format: uuid responses: - "200": + '200': description: EIA Service retrieved successfully content: application/json: schema: - $ref: "#/components/schemas/InternetAccessService" + $ref: '#/components/schemas/InternetAccessService' examples: internetAccessServiceRetrieved: - $ref: "#/components/examples/InternetAccessServiceRetrievedResponseExample" - "404": + value: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 + type: SINGLE_IA + uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 + name: internet-access-primary + state: PROVISIONED + bandwidth: 1000 + bandwidthCommit: 500 + change: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents + locations: + - metroHref: https://api.equinix.com/fabric/v4/metros/WA + metroCode: WA + region: AMER + ibx: WA1 + routingProtocol: + type: BGP + exportPolicy: FULL + asn: + href: https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1 + uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 + customerRoutes: + - ipBlock: + href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + connections: + - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + billing: + type: FIXED + enabled: true + startDate: '2026-04-16T00:00:00Z' + account: + accountNumber: '57689234' + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 + project: + projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 + order: + href: https://api.equinix.com/colocations/v2/orders/100200300 + orderNumber: 100200300 + purchaseOrderNumber: PO-98765 + changeLog: + createdBy: api-user + createdDateTime: '2026-04-16T00:00:00Z' + updatedBy: api-user + updatedDateTime: '2026-04-16T00:10:00Z' + useCase: MAIN + '404': description: EIA Service not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - delete: + $ref: '#/components/schemas/ErrorList' + patch: tags: - Internet Access Services - summary: Delete Internet Access Service by ID - description: Delete Internet Access Service by UUID - operationId: deleteEiaService + summary: Update Internet Access Service by ID + description: Patch Internet Access Service by UUID + operationId: patchEiaService parameters: - name: uuid in: path @@ -3140,34 +13390,96 @@ paths: schema: type: string format: uuid + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InternetAccessPatchRequest' + examples: + Add and remove IP Blocks in a single request: + value: + - op: add + path: /routingProtocol/customerRoutes + value: + ipBlock: + uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + - op: remove + path: /routingProtocol/customerRoutes[@.ipBlock.uuid=ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91] + Update bandwidth with purchase order number: + value: + - op: replace + path: /bandwidth + value: 50 + - op: replace + path: /order/purchaseOrderNumber + value: PO-98765 + Update name: + value: + - op: replace + path: /name + value: New Name + required: true responses: - "202": + '202': description: EIA Service creation or update accepted content: application/json: schema: - $ref: "#/components/schemas/InternetAccessService" + $ref: '#/components/schemas/InternetAccessService' examples: internetAccessServiceAccepted: - $ref: "#/components/examples/InternetAccessServiceAcceptedResponseExample" - "404": + value: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 + type: SINGLE_IA + uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 + name: internet-access-primary + state: PROVISIONING + change: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents + routingProtocol: + type: BGP + exportPolicy: FULL + asn: + href: https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1 + uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 + customerRoutes: + - ipBlock: + href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + connections: + - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + billing: + type: FIXED + enabled: true + startDate: '2026-04-16T00:00:00Z' + account: + accountNumber: '57689234' + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 + project: + projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 + order: + href: https://api.equinix.com/colocations/v2/orders/100200300 + orderNumber: 100200300 + purchaseOrderNumber: PO-98765 + changeLog: + createdBy: api-user + createdDateTime: '2026-04-16T00:00:00Z' + updatedBy: api-user + updatedDateTime: '2026-04-16T00:00:01Z' + useCase: MAIN + '404': description: EIA Service not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "409": - description: EIA Service cannot be deleted due to active products - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - patch: + $ref: '#/components/schemas/ErrorList' + delete: tags: - Internet Access Services - summary: Update Internet Access Service by ID - description: Patch Internet Access Service by UUID - operationId: patchEiaService + summary: Delete Internet Access Service by ID + description: Delete Internet Access Service by UUID + operationId: deleteEiaService parameters: - name: uuid in: path @@ -3176,35 +13488,67 @@ paths: schema: type: string format: uuid - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/InternetAccessPatchRequest" - examples: - Add and remove IP Blocks in a single request: - $ref: "#/components/examples/InternetAccessPatchManageCustomerRoutes" - Update bandwidth with purchase order number: - $ref: "#/components/examples/InternetAccessPatchUpdateServiceBandwidth" - Update name: - $ref: "#/components/examples/InternetAccessPatchUpdateName" - required: true responses: - "202": + '202': description: EIA Service creation or update accepted content: application/json: schema: - $ref: "#/components/schemas/InternetAccessService" + $ref: '#/components/schemas/InternetAccessService' examples: internetAccessServiceAccepted: - $ref: "#/components/examples/InternetAccessServiceAcceptedResponseExample" - "404": + value: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 + type: SINGLE_IA + uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 + name: internet-access-primary + state: PROVISIONING + change: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents + routingProtocol: + type: BGP + exportPolicy: FULL + asn: + href: https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1 + uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 + customerRoutes: + - ipBlock: + href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + connections: + - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + billing: + type: FIXED + enabled: true + startDate: '2026-04-16T00:00:00Z' + account: + accountNumber: '57689234' + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 + project: + projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 + order: + href: https://api.equinix.com/colocations/v2/orders/100200300 + orderNumber: 100200300 + purchaseOrderNumber: PO-98765 + changeLog: + createdBy: api-user + createdDateTime: '2026-04-16T00:00:00Z' + updatedBy: api-user + updatedDateTime: '2026-04-16T00:00:01Z' + useCase: MAIN + '404': description: EIA Service not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' + '409': + description: EIA Service cannot be deleted due to active products + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' /fabric/v4/ipBlocks: post: tags: @@ -3212,48 +13556,119 @@ paths: summary: Create IP Block description: Submits new Equinix owned or customer owned IP Block request operationId: submitIpBlock - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/SubmitIpBlockRequestBody" + $ref: '#/components/schemas/SubmitIpBlockRequestBody' examples: EquinixOwnedApacWithRegulations: - $ref: "#/components/examples/IpBlockCreateEquinixApacRequest" + value: + prefixLength: 24 + location: + metroCode: SY + project: + projectId: 52cb19be-63c4-434d-bec8-5e94636291fc + type: IPV4_IP_BLOCK + regulations: + addressingPlans: + - purpose: SERVERS + size: 100 + - purpose: ROUTERS + size: 154 + questions: + privateSpaceConsidered: true + refusedPreviously: true + returningAddressSpace: false + account: + accountNumber: 2-57689234 + order: + purchaseOrderNumber: purchase-order123 CustomerOwned: - $ref: "#/components/examples/IpBlockCreateCustomerOwnedRequest" + value: + prefix: 128.112.4.0/24 + type: IPV4_IP_BLOCK + project: + projectId: 52cb19be-63c4-434d-bec8-5e94636291fc required: true responses: - "202": + '202': description: IP Block submitted, patched, or deletion accepted content: application/json: schema: - $ref: "#/components/schemas/IpBlock" + $ref: '#/components/schemas/IpBlock' examples: EquinixOwnedAccepted: - $ref: "#/components/examples/IpBlockEquinixOwnershipAcceptedResponse" + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: PENDING + ownership: EQUINIX + location: + metroHref: https://api.equinix.com/fabric/v4/metros/WA + metroCode: SY + prefixLength: 24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + order: + href: https://api.equinix.com/colocations/v2/orders/1-34834234 + orderNumber: 1-34834234 + account: + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/2-57689234 + accountNumber: 2-57689234 + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + regulations: + addressingPlans: + - purpose: SERVERS + size: 100 + - purpose: ROUTERS + size: 154 + questions: + privateSpaceConsidered: true + refusedPreviously: true + returningAddressSpace: false + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] CustomerOwnedAccepted: - $ref: "#/components/examples/IpBlockCustomerOwnershipAcceptedResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: ACTIVE + ownership: CUSTOMER + prefixLength: 24 + prefix: 128.112.4.0/24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] + '400': description: Invalid input parameter content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/ipBlocks/{uuid}: get: tags: @@ -3270,35 +13685,83 @@ paths: type: string format: uuid responses: - "200": + '200': description: IP Block retrieved successfully content: application/json: schema: - $ref: "#/components/schemas/IpBlock" + $ref: '#/components/schemas/IpBlock' examples: EquinixOwnedRetrieved: - $ref: "#/components/examples/IpBlockEquinixOwnershipAcceptedResponse" + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: PENDING + ownership: EQUINIX + location: + metroHref: https://api.equinix.com/fabric/v4/metros/WA + metroCode: SY + prefixLength: 24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + order: + href: https://api.equinix.com/colocations/v2/orders/1-34834234 + orderNumber: 1-34834234 + account: + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/2-57689234 + accountNumber: 2-57689234 + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + regulations: + addressingPlans: + - purpose: SERVERS + size: 100 + - purpose: ROUTERS + size: 154 + questions: + privateSpaceConsidered: true + refusedPreviously: true + returningAddressSpace: false + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] CustomerOwnedRetrieved: - $ref: "#/components/examples/IpBlockCustomerOwnershipAcceptedResponse" - "403": + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: ACTIVE + ownership: CUSTOMER + prefixLength: 24 + prefix: 128.112.4.0/24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: IP Block not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' delete: tags: - IP Blocks @@ -3314,47 +13777,95 @@ paths: type: string format: uuid responses: - "202": + '202': description: IP Block submitted, patched, or deletion accepted content: application/json: schema: - $ref: "#/components/schemas/IpBlock" + $ref: '#/components/schemas/IpBlock' examples: EquinixOwnedAccepted: - $ref: "#/components/examples/IpBlockEquinixOwnershipAcceptedResponse" + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: PENDING + ownership: EQUINIX + location: + metroHref: https://api.equinix.com/fabric/v4/metros/WA + metroCode: SY + prefixLength: 24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + order: + href: https://api.equinix.com/colocations/v2/orders/1-34834234 + orderNumber: 1-34834234 + account: + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/2-57689234 + accountNumber: 2-57689234 + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + regulations: + addressingPlans: + - purpose: SERVERS + size: 100 + - purpose: ROUTERS + size: 154 + questions: + privateSpaceConsidered: true + refusedPreviously: true + returningAddressSpace: false + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] CustomerOwnedAccepted: - $ref: "#/components/examples/IpBlockCustomerOwnershipAcceptedResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: ACTIVE + ownership: CUSTOMER + prefixLength: 24 + prefix: 128.112.4.0/24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] + '400': description: Invalid input parameter content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: IP Block not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "409": + $ref: '#/components/schemas/ErrorList' + '409': description: IP Block cannot be deleted due to active products content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' patch: tags: - IP Blocks @@ -3373,32 +13884,80 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/PatchIpBlockRequestBody" + $ref: '#/components/schemas/PatchIpBlockRequestBody' required: true responses: - "202": + '202': description: IP Block submitted, patched, or deletion accepted content: application/json: schema: - $ref: "#/components/schemas/IpBlock" + $ref: '#/components/schemas/IpBlock' examples: EquinixOwnedAccepted: - $ref: "#/components/examples/IpBlockEquinixOwnershipAcceptedResponse" + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: PENDING + ownership: EQUINIX + location: + metroHref: https://api.equinix.com/fabric/v4/metros/WA + metroCode: SY + prefixLength: 24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + order: + href: https://api.equinix.com/colocations/v2/orders/1-34834234 + orderNumber: 1-34834234 + account: + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/2-57689234 + accountNumber: 2-57689234 + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + regulations: + addressingPlans: + - purpose: SERVERS + size: 100 + - purpose: ROUTERS + size: 154 + questions: + privateSpaceConsidered: true + refusedPreviously: true + returningAddressSpace: false + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] CustomerOwnedAccepted: - $ref: "#/components/examples/IpBlockCustomerOwnershipAcceptedResponse" - "404": + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: ACTIVE + ownership: CUSTOMER + prefixLength: 24 + prefix: 128.112.4.0/24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] + '404': description: IP Block not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/ipBlocks/search: post: tags: @@ -3406,32 +13965,31 @@ paths: summary: Search IP Blocks description: Search for IP Blocks based on criteria operationId: searchIpBlocks - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/IpBlocksSearchRequestBody" + $ref: '#/components/schemas/IpBlocksSearchRequestBody' required: true responses: - "200": + '200': description: IP Blocks found successfully content: application/json: schema: - $ref: "#/components/schemas/IpBlockSearchResponseBody" - "400": + $ref: '#/components/schemas/IpBlockSearchResponseBody' + '400': description: Invalid input parameter content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/connections/search: post: tags: @@ -3439,95 +13997,691 @@ paths: 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" + $ref: '#/components/schemas/SearchRequest' examples: ConnectionSearchDirection: - $ref: "#/components/examples/ConnectionSearchDirection" + value: + filter: + and: + - property: /direction + operator: '=' + values: + - OUTGOING + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchIsremote: - $ref: "#/components/examples/ConnectionSearchIsremote" + value: + filter: + and: + - property: /isRemote + operator: '=' + values: + - 'true' + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchName: - $ref: "#/components/examples/ConnectionSearchName" + value: + filter: + and: + - property: /name + operator: '=' + values: + - AWS-Dot1Q-AWSRemote + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchUuid: - $ref: "#/components/examples/ConnectionSearchUuid" + value: + filter: + and: + - property: /uuid + operator: '=' + values: + - 3736df8d-a903-42fd-bd06-06c9a76b238e + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchCustorg: - $ref: "#/components/examples/ConnectionSearchCustorg" + value: + filter: + and: + - property: /account/orgId + operator: '=' + values: + - '91997' + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchAccountname: - $ref: "#/components/examples/ConnectionSearchAccountname" + value: + filter: + and: + - property: /aSide/accessPoint/account/accountName + operator: '=' + values: + - testBuyer-270001 + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchCloudRouteruuid: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: + limit: 25 + offset: 0 ConnectionSearchAsidemetrocodemetroname: - $ref: "#/components/examples/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: + limit: 25 + offset: 0 ConnectionSearchAsideaccesspointname: - $ref: "#/components/examples/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: + limit: 25 + offset: 0 ConnectionSearchAsideaccesspointuuid: - $ref: "#/components/examples/ConnectionSearchAsideaccesspointuuid" + value: + filter: + and: + - property: /aSide/accessPoint/port/uuid + operator: '=' + values: + - c791f8cb-5941-9410-8ce0-306a5c00a4ee + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchAsideaccesspointtype: - $ref: "#/components/examples/ConnectionSearchAsideaccesspointtype" + value: + filter: + and: + - property: /aSide/accessPoint/type + operator: '=' + values: + - COLO + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchAsidevirtualdevicename: - $ref: "#/components/examples/ConnectionSearchAsidevirtualdevicename" + value: + filter: + and: + - property: /aSide/accessPoint/virtualDevice/name + operator: '=' + values: + - E2E-NE-Device-Aut-170122034210108 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchAsidevirtualdeviceuuid: - $ref: "#/components/examples/ConnectionSearchAsidevirtualdeviceuuid" + value: + filter: + and: + - property: /aSide/accessPoint/virtualDevice/uuid + operator: '=' + values: + - c6b96cec-cf70-4700-9c1e-2f73724d2fa5 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchAsideservicetokenuuid: - $ref: "#/components/examples/ConnectionSearchAsideservicetokenuuid" + value: + filter: + and: + - property: /aSide/serviceToken/uuid + operator: '=' + values: + - 30225621-c1ad-4614-b6a5-d9c70cad61cb + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchChangestatus: - $ref: "#/components/examples/ConnectionSearchChangestatus" + value: + filter: + and: + - property: /change/status + operator: '=' + values: + - APPROVED + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchUpdatedatetime: - $ref: "#/components/examples/ConnectionSearchUpdatedatetime" + value: + filter: + and: + - property: /changeLog/updatedDateTime + operator: '=' + values: + - '2021-01-02T00:00:00Z' + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchEquinixstatus: - $ref: "#/components/examples/ConnectionSearchEquinixstatus" + value: + filter: + and: + - property: /operation/equinixStatus + operator: '=' + values: + - PROVISIONED + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchProviderstatus: - $ref: "#/components/examples/ConnectionSearchProviderstatus" + value: + filter: + and: + - property: /operation/providerStatus + operator: '=' + values: + - AVAILABLE + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchProjectid: - $ref: "#/components/examples/ConnectionSearchProjectidOPtional-CRH" + value: + filter: + and: + - property: /project/projectId + operator: '=' + values: + - 30ad25e2-53dc-11ed-bdc3-0242ac120002 + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchRedundancygroup: - $ref: "#/components/examples/ConnectionSearchRedundancygroup" + value: + filter: + and: + - operator: '=' + property: /redundancy/group + values: + - 3f7ab592-0db3-41b8-bb9a-ecc05d5d5732 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchRedundancypriority: - $ref: "#/components/examples/ConnectionSearchRedundancypriority" + value: + filter: + and: + - operator: '=' + property: /redundancy/priority + values: + - PRIMARY + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchZsidevlanstagctag: - $ref: "#/components/examples/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: + limit: 25 + offset: 0 ConnectionSearchZsidemetrocodemetroname: - $ref: "#/components/examples/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: + limit: 25 + offset: 0 ConnectionSearchZsideaccesspointname: - $ref: "#/components/examples/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: + limit: 25 + offset: 0 ConnectionSearchZsideaccesspointuuid: - $ref: "#/components/examples/ConnectionSearchZsideaccesspointuuid" + value: + filter: + and: + - property: /zSide/accessPoint/port/uuid + operator: '=' + values: + - c791f8cb-5941-9410-8ce0-306a5c00a4ee + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchZsideaccesspointtype: - $ref: "#/components/examples/ConnectionSearchZsideaccesspointtype" + value: + filter: + and: + - property: /zSide/accessPoint/type + operator: '=' + values: + - COLO + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchZsidevirtualdevicename: - $ref: "#/components/examples/ConnectionSearchZsidevirtualdevicename" + value: + filter: + and: + - property: /zSide/accessPoint/virtualDevice/name + operator: '=' + values: + - E2E-NE-Device-Aut-170122034210108 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchZsidevirtualdeviceuuid: - $ref: "#/components/examples/ConnectionSearchZsidevirtualdeviceuuid" + value: + filter: + and: + - property: /zSide/accessPoint/virtualDevice/uuid + operator: '=' + values: + - c6b96cec-cf70-4700-9c1e-2f73724d2fa5 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchZsideservicetokenuuid: - $ref: "#/components/examples/ConnectionSearchZsideservicetokenuuid" + value: + filter: + and: + - property: /zSide/serviceToken/uuid + operator: '=' + values: + - 019eab69-8293-4abf-ac8c-e6269d5a3e92 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchZsideprofileuuid: - $ref: "#/components/examples/ConnectionSearchZsideprofileuuid" + value: + filter: + and: + - property: /zSide/accessPoint/profile/uuid + operator: '=' + values: + - c6b96cec-cf70-4700-9c1e-2f73724d2fa5 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchANDwithNestedOR-LIKE: - $ref: "#/components/examples/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: + limit: 25 + offset: 0 ConnectionSearchORwithNestedAND: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 ConnectionSearchByMaintenanceStatus: - $ref: "#/components/examples/ConnectionSearchByMaintenanceStatus" + value: + filter: + and: + - property: /operation/maintenanceStatus + operator: IN + values: + - SCHEDULED + - COMPLETED + - property: /operation/lockEnabled + operator: IN + values: + - 'true' + pagination: + limit: 25 + offset: 0 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionSearchResponse" + $ref: '#/components/schemas/ConnectionSearchResponse' example: pagination: offset: 0 @@ -3583,43 +14737,47 @@ paths: maintenanceStatus: SCHEDULED lockEnabled: true changeLog: - createdDateTime: 2020-05-21T10:30:00Z - updatedDateTime: 2020-05-21T10:30:00Z + createdDateTime: '2020-05-21T10:30:00Z' + updatedDateTime: '2020-05-21T10:30:00Z' project: projectId: 2c10d60e-29c1-4721-ad1a-b531f4e04717 - "400": + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' example: - errorCode: EQ-3000035 errorMessage: Invalid request body - "401": + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' example: - errorCode: EQ-3000197 errorMessage: User not authorized to perform given action - "404": + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' /fabric/v4/prices/search: post: tags: @@ -3627,104 +14785,962 @@ paths: summary: Search Prices description: Search prices by search criteria operationId: searchPrices - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/FilterBody" + $ref: '#/components/schemas/FilterBody' examples: virtualConnectionProductEvplVcTypeFromColoToColo: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 virtualConnectionProductFcrVcTypeFromGWToSP: - $ref: "#/components/examples/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 virtualConnectionProductFcrVcTypeFromGWToColo: - $ref: "#/components/examples/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 virtualConnectionProductFcrVcTypeFromVDToColo: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 virtualConnectionProductOfflineEvpLanVcTypeFromColoToNetwork: - $ref: "#/components/examples/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' virtualConnectionProductColoToColoWithGeoScope: - $ref: "#/components/examples/VirtualConnectionProductColoToColoWithGeoScope" + 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 + - property: /connection/geoScope + operator: '=' + values: + - CONUS cloudRouterProduct: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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' virtualPortProductUPP: - $ref: "#/components/examples/VirtualPortProductUPP" + 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/package/code + operator: '=' + values: + - UNLIMITED_PLUS + - property: /port/serviceType + operator: '=' + values: + - EPL + - property: /port/connectivitySource/type + operator: '=' + values: + - COLO + - property: /port/lag/enabled + operator: '=' + values: + - 'false' virtualPortProductIX: - $ref: "#/components/examples/VirtualPortProductIX" + value: + filter: + and: + - property: /type + operator: '=' + values: + - VIRTUAL_PORT_PRODUCT + - property: /port/location/ibx + operator: '=' + values: + - DA1 + - property: /port/type + operator: '=' + values: + - XF_PORT + - property: /port/bandwidth + operator: '=' + values: + - '1000' + - property: /port/serviceCode + operator: '=' + values: + - IX + - property: /port/connectivitySource/type + operator: '=' + values: + - COLO precisionTimeProductNtpStandardPackageCode: - $ref: "#/components/examples/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 precisionTimeProductNtpEnterprisePackageCode: - $ref: "#/components/examples/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 precisionTimeProductPtpStandardPackageCode: - $ref: "#/components/examples/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 precisionTimeProductPtpEnterprisePackageCode: - $ref: "#/components/examples/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 opticalConnectProduct: - $ref: "#/components/examples/OpticalConnectProduct" + value: + filter: + and: + - property: /type + operator: '=' + values: + - OPTICAL_CONNECT_PRODUCT + - property: /account/accountNumber + operator: '=' + values: + - '200551' + - property: /opticalConnect/type + operator: '=' + values: + - OC + - property: /opticalConnect/bandwidth + operator: '=' + values: + - '1000' + - property: /opticalConnect/pathType + operator: '=' + values: + - PROTECTED + - property: /opticalConnect/connectionDestinationType + operator: '=' + values: + - COLO + - property: /opticalConnect/aSide/location/ibxCode + operator: '=' + values: + - CH1 + - property: /opticalConnect/zSide/location/ibxCode + operator: '=' + values: + - CH3 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/PriceSearchResponse" + $ref: '#/components/schemas/PriceSearchResponse' examples: virtualConnection: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 cloudRouter: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 virtualPortUPP: - $ref: "#/components/examples/VirtualPortUPP" + 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 + package: + code: UNLIMITED_PLUS virtualPortIX: - $ref: "#/components/examples/VirtualPortIX" + value: + pagination: + offset: 0 + limit: 1 + total: 1 + data: + - type: VIRTUAL_PORT_PRODUCT + code: IX00008.PROD + name: Equinix Internet Exchange Port Product + description: Internet Exchange 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 + serviceCode: IX precisionTimeService: - $ref: "#/components/examples/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 opticalConnect: - $ref: "#/components/examples/OpticalConnect" - "400": + value: + pagination: + offset: 0 + limit: 1 + total: 1 + data: + - type: OPTICAL_CONNECT_PRODUCT + code: MC00007.PROD + name: Optical Connect Port Product + description: Optical Connect Port + account: + accountNumber: 200551 + orgId: 123 + charges: + - type: MONTHLY_RECURRING + price: 500 + - type: NON_RECURRING + price: 0 + currency: USD + opticalConnect: + type: OC + bandwidth: 1000 + pathType: PROTECTED + connectionDestinationType: COLO + aSide: + location: + ibxCode: CH1 + zSide: + location: + ibxCode: CH3 + '400': description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/PriceErrorList" + $ref: '#/components/schemas/PriceErrorList' examples: example: - $ref: "#/components/examples/400_prices" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/PriceErrorList" + $ref: '#/components/schemas/PriceErrorList' examples: example: - $ref: "#/components/examples/500_prices" + value: + - errorCode: EQ-3038030 + errorMessage: Internal Server Error + details: We couldn't process you request /fabric/v4/ports/{portId}/stats: get: tags: - Statistics summary: Get Stats by ID (DEPRECATED) 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.**(DEPRECATED)** + deprecated: true operationId: getPortStatsByPortUuid parameters: - name: portId @@ -3732,65 +15748,105 @@ paths: description: Port UUID required: true schema: - $ref: "#/components/schemas/PortUUID" + description: Port UUID + type: string + format: uuid - name: startDateTime in: query description: startDateTime required: true schema: - $ref: "#/components/schemas/StartDateTime" - example: 2020-11-06T07:00:00Z + $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 + $ref: '#/components/schemas/endDateTime' + example: '2020-11-10T07:00:00Z' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Statistics" + $ref: '#/components/schemas/Statistics' examples: statsExample: - $ref: "#/components/examples/200_port" - "401": + value: + href: http://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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "500": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - deprecated: true + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/connections/{connectionId}/stats: get: tags: - Statistics summary: Get Stats by ID (DEPRECATED) 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 **(DEPRECATED)** + deprecated: true operationId: getConnectionStatsByPortUuid parameters: - name: connectionId @@ -3798,57 +15854,108 @@ paths: description: Connection UUID required: true schema: - $ref: "#/components/schemas/VirtualCircuitId" + description: Virtual Circuit UUID + type: string - name: startDateTime in: query description: startDateTime required: true schema: - $ref: "#/components/schemas/StartDateTime" - example: 2020-11-06T07:00:00Z + $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 + $ref: '#/components/schemas/endDateTime' + example: '2020-11-10T07:00:00Z' - name: viewPoint in: query description: viewPoint required: true schema: - $ref: "#/components/schemas/viewPoint" + $ref: '#/components/schemas/viewPoint' example: aSide responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Statistics" + $ref: '#/components/schemas/Statistics' examples: statsExample: - $ref: "#/components/examples/200_vc" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - deprecated: true + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/serviceProfiles: get: tags: @@ -3881,124 +15988,698 @@ paths: - aSide - zSide responses: - "200": + '200': description: Successful operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfiles" + $ref: '#/components/schemas/ServiceProfiles' examples: ASideServiceProfile: - $ref: "#/components/examples/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 + selectiveRedundancy: 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 ZSideServiceProfile: - $ref: "#/components/examples/SellerServiceProfilesResponse" - "400": + 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 + selectiveRedundancy: 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-read" - "500": + value: + - errorCode: EQ-3001033 + errorMessage: You are not authorized to execute the requested action on the resource + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error post: tags: - Service Profiles summary: Create Service Profile description: Create Service Profile creates Equinix Fabric™ Service Profile operationId: createServiceProfile - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/ServiceProfileRequest" + $ref: '#/components/schemas/ServiceProfileRequest' examples: ServiceProfileCreate: - $ref: "#/components/examples/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 + selectiveRedundancy: 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: - $ref: "#/components/examples/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 + selectiveRedundancy: 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 LmaasServiceProfileCreate: - $ref: "#/components/examples/LmaasServiceProfileCreate" + value: + name: Last Mile Service Profile 1 + description: Sample Last Mile Service Profile + type: LMAAS_PROFILE + notifications: + - emails: + - someone@sample.com + type: QUOTE_NOTIFICATIONS + tags: [] + visibility: PUBLIC + customFields: [] + allowedEmails: [] + ports: + - type: XF_PORT + uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 + location: + metroCode: DC + crossConnectId: ECX.03.00000962 + lastMileConfig: + productCatalogs: + - id: sample-product-offering-id + name: Sample Product Offering + webUrl: https://www.example.com/lastmile + deliveryDate: + min: 10 + max: 30 + unit: DAYS + billingTerms: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + offerings: + - bandwidth: 50 + price: + unit: USD + min: 100 + max: 500 + - bandwidth: 100 + price: + unit: USD + min: 200 + max: 500 + - bandwidth: 200 + price: + unit: USD + min: 300 + max: 500 + - bandwidth: 1000 + price: + unit: USD + min: 1000 + max: 2000 + accessPointTypeConfigs: + - type: COLO + linkProtocolConfig: + namedTags: [] + reuseVlanSTag: false + enableAutoGenerateServiceKey: false + apiConfig: + equinixManagedPort: false + equinixManagedVlan: false + allowOverSubscription: false + overSubscriptionLimit: 1 + apiAvailable: false + integrationId: '' + bandwidthFromApi: false + authenticationKey: + required: false + allowRemoteConnections: true + supportedBandwidths: + - 10 + - 50 + - 200 + - 500 + - 1000 + allowCustomBandwidth: false + connectionLabel: Connection + allowBandwidthAutoApproval: false + connectionRedundancyRequired: false + selectiveRedundancy: true + marketingInfo: + processSteps: [] + promotion: true required: true responses: - "201": + '201': description: Successful Create operation - headers: - ETag: - $ref: "#/components/headers/ETag" content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfile" + $ref: '#/components/schemas/ServiceProfile' examples: ServiceProfile: - $ref: "#/components/examples/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 + selectiveRedundancy: 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 LmaasServiceProfile: - $ref: "#/components/examples/LmaasServiceProfileCreateResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 + uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 + name: Last Mile Service Profile 1 + description: Sample Last Mile Service Profile + type: LMAAS_PROFILE + notifications: + - emails: + - someone@sample.com + type: QUOTE_NOTIFICATIONS + tags: [] + visibility: PUBLIC + customFields: [] + allowedEmails: [] + ports: + - type: XF_PORT + uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 + location: + metroCode: DC + crossConnectId: ECX.03.00000962 + lastMileConfig: + apiIntegration: + siteValidationEnabled: false + dataCenterLocationEnabled: false + productOfferingEnabled: false + poqEnabled: false + quoteEnabled: false + placeOrderEnabled: false + quoteViaAggregatorEnabled: false + productCatalogs: + - id: sample-product-offering-id + name: Sample Product Offering + webUrl: https://www.example.com/lastmile + deliveryDate: + min: 10 + max: 30 + unit: DAYS + billingTerms: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + offerings: + - bandwidth: 50 + price: + unit: USD + min: 100 + max: 500 + - bandwidth: 100 + price: + unit: USD + min: 200 + max: 500 + - bandwidth: 200 + price: + unit: USD + min: 300 + max: 500 + - bandwidth: 1000 + price: + unit: USD + min: 1000 + max: 2000 + accessPointTypeConfigs: + - type: COLO + linkProtocolConfig: + namedTags: [] + reuseVlanSTag: false + enableAutoGenerateServiceKey: false + apiConfig: + equinixManagedPort: false + equinixManagedVlan: false + allowOverSubscription: false + overSubscriptionLimit: 1 + apiAvailable: false + integrationId: '' + bandwidthFromApi: false + authenticationKey: + required: false + allowRemoteConnections: true + supportedBandwidths: + - 10 + - 50 + - 200 + - 500 + - 1000 + allowCustomBandwidth: false + connectionLabel: Connection + allowBandwidthAutoApproval: false + connectionRedundancyRequired: false + selectiveRedundancy: true + marketingInfo: + processSteps: [] + promotion: true + headers: + ETag: + $ref: '#/components/headers/ETag' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-create" - "500": + value: + - errorCode: EQ-3001036 + errorMessage: You are not authorized to execute the requested action on the resource + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error /fabric/v4/serviceProfiles/search: post: tags: @@ -4020,62 +16701,243 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ServiceProfileSearchRequest" + $ref: '#/components/schemas/ServiceProfileSearchRequest' examples: ServiceProfileSearchWithUuid: - $ref: "#/components/examples/ServiceProfileSearchWithUuid" + value: + filter: + property: /uuid + operator: '=' + values: + - 13100b2d-234f-4425-ab5c-1449d4b806be + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime ServiceProfileSearchWithName: - $ref: "#/components/examples/ServiceProfileSearchWithName" + value: + filter: + property: /name + operator: '=' + values: + - My-Service-Profile-1 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime ServiceProfileSearchWithState: - $ref: "#/components/examples/ServiceProfileSearchWithState" + value: + filter: + property: /state + operator: '=' + values: + - ACTIVE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime ServiceProfileSearchWithVisibility: - $ref: "#/components/examples/ServiceProfileSearchWithVisibility" + value: + filter: + property: /visibility + operator: '=' + values: + - PUBLIC + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime ServiceProfileSearchWithProject: - $ref: "#/components/examples/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: - $ref: "#/components/examples/ServiceProfileSearchWithPort" + value: + filter: + property: /ports/uuid + operator: '=' + values: + - 23100b2d-234f-4425-ab5c-1449d4b806bf + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime ServiceProfileSearchWithMultipleFilter: - $ref: "#/components/examples/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 ServiceProfileSearchWithTypeAndMetro: - $ref: "#/components/examples/ServiceProfileSearchWithTypeAndMetro" + value: + filter: + and: + - property: /type + operator: '=' + values: + - L2_PROFILE + - property: /metros/code + operator: '=' + values: + - SG + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime required: true responses: - "200": + '200': description: Successful operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfiles" + $ref: '#/components/schemas/ServiceProfiles' examples: ServiceProfile: - $ref: "#/components/examples/ServiceProfilesResponse" - "400": + 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 + selectiveRedundancy: 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400-search" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "500": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}: get: tags: @@ -4089,7 +16951,9 @@ paths: description: Service Profile UUID required: true schema: - $ref: "#/components/schemas/ServiceProfileId" + description: Service Profile UUID + type: string + format: uuid - name: viewPoint in: query description: flips view between buyer and seller representation @@ -4100,58 +16964,360 @@ paths: - aSide - zSide responses: - "200": + '200': description: Successful operation - headers: - ETag: - $ref: "#/components/headers/ETag" content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfile" + $ref: '#/components/schemas/ServiceProfile' examples: ASideServiceProfile: - $ref: "#/components/examples/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 + selectiveRedundancy: 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 ZSideServiceProfile: - $ref: "#/components/examples/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 + selectiveRedundancy: 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 LmaasServiceProfile: - $ref: "#/components/examples/LmaasServiceProfileResponse" - "400": + value: + state: ACTIVE + account: + orgId: 90925 + organizationName: Sample Organization + globalOrgId: 0017i000011X23ZAAS + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + changeLog: + createdBy: sampleuser + createdByFullName: Sample User + createdByEmail: someone@sample.com + createdDateTime: '2026-01-01T00:00:00.000Z' + updatedBy: sampleuser + updatedByFullName: Sample User + updatedByEmail: someone@sample.com + updatedDateTime: '2026-01-01T00:00:00.000Z' + href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 + uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 + type: LMAAS_PROFILE + name: Last Mile Service Profile 1 + description:

Sample Last Mile Service Profile

+ notifications: + - type: QUOTE_NOTIFICATIONS + emails: + - someone@sample.com + visibility: PUBLIC + customFields: + - label: Account Id + description: Provider Portal User ID + required: true + dataType: NUMBER + captureInEmail: false + ports: + - type: XF_PORT + uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 + location: + metroCode: DC + crossConnectId: ECX.03.00000962 + metros: + - code: DC + name: Ashburn + ibxs: + - DC6 + - DC5 + displayName: Ashburn + accessPointTypeConfigs: + - uuid: d2d8105b-da0c-4b09-92d7-2584a85cbb33 + type: COLO + supportedBandwidths: + - 10 + - 50 + - 200 + - 500 + - 1000 + allowRemoteConnections: true + allowCustomBandwidth: false + allowBandwidthAutoApproval: false + linkProtocolConfig: + reuseVlanSTag: false + encapsulation: DOT1Q + enableAutoGenerateServiceKey: false + connectionRedundancyRequired: false + selectiveRedundancy: true + apiConfig: + apiAvailable: false + integrationId: '' + equinixManagedPort: false + equinixManagedVlan: false + allowOverSubscription: false + overSubscriptionLimit: 1 + bandwidthFromApi: false + connectionLabel: Connection + authenticationKey: + required: false + marketingInfo: + promotion: true + lastMileConfig: + apiIntegration: + siteValidationEnabled: false + dataCenterLocationEnabled: false + productOfferingEnabled: false + poqEnabled: false + quoteEnabled: false + placeOrderEnabled: false + quoteViaAggregatorEnabled: false + productCatalogs: + - id: Sample-product-offering-id + name: Sample Product Offering + webUrl: https://www.example.com/lastmile + deliveryDate: + unit: DAYS + min: 10 + max: 90 + billingTerms: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + offerings: + - bandwidth: 50 + price: + unit: USD + min: 100 + max: 500 + - bandwidth: 100 + price: + unit: USD + min: 200 + max: 500 + - bandwidth: 500 + price: + unit: USD + min: 500 + max: 1000 + - bandwidth: 1000 + price: + unit: USD + min: 1000 + max: 2000 + headers: + ETag: + $ref: '#/components/headers/ETag' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-read" - "500": + value: + - errorCode: EQ-3001033 + errorMessage: You are not authorized to execute the requested action on the resource + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error put: tags: - Service Profiles @@ -4164,7 +17330,9 @@ paths: description: Service Profile UUID required: true schema: - $ref: "#/components/schemas/ServiceProfileId" + description: Service Profile UUID + type: string + format: uuid - name: If-Match in: header description: conditional request @@ -4175,224 +17343,695 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ServiceProfileRequest" + $ref: '#/components/schemas/ServiceProfileRequest' examples: ServiceProfileUpdate: - $ref: "#/components/examples/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 + selectiveRedundancy: 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 required: true responses: - "202": + '202': description: Successful Put operation - headers: - ETag: - $ref: "#/components/headers/ETag" content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfile" + $ref: '#/components/schemas/ServiceProfile' examples: ServiceProfile: - $ref: "#/components/examples/ServiceProfilePutResponse" - "400": + 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 + selectiveRedundancy: 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 + headers: + ETag: + $ref: '#/components/headers/ETag' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-update" - "404": + value: + - errorCode: EQ-3001035 + errorMessage: You are not authorized to execute the requested action on the resource + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-404-get" - "500": + value: + - errorCode: EQ-3001011 + errorMessage: Invalid uuid + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" - delete: + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error + patch: tags: - Service Profiles - summary: Delete Service Profile - description: delete Service Profile by UUID - operationId: deleteServiceProfileByUuid + summary: Update Service 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" + description: Service Profile UUID + type: string + format: uuid + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/ServiceProfileUpdateRequest' + examples: + ServiceProfilePatchRequest: + value: + - op: add + path: /tags + value: + - sample_tag + ServiceProfilePatchRequestForVisibility: + value: + - op: replace + path: /visibility + value: PUBLIC + required: true responses: - "200": - description: Successful Delete operation - headers: - ETag: - $ref: "#/components/headers/ETag" + '200': + description: Successful Patch operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfile" + $ref: '#/components/schemas/ServiceProfile' examples: ServiceProfile: - $ref: "#/components/examples/ServiceProfileDeleteResponse" - "400": + 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 + selectiveRedundancy: 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 + ServiceProfilePatchResponseForVisibility: + value: + state: ACTIVE + account: + orgId: 91785 + organizationName: testSeller-270010 + globalOrgId: 0016u000003JZ4tAAG + change: + type: PROFILE_UPDATE_ACCEPTANCE + uuid: 9b9f8a9b-4583-4649-9d91-a48494f822a7 + createdDateTime: '2026-02-17T17:23:35.543Z' + 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: PRIVATE + 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 + selectiveRedundancy: 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 + headers: + ETag: + $ref: '#/components/headers/ETag' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400-delete" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-delete" - "404": + value: + - errorCode: EQ-3001035 + errorMessage: You are not authorized to execute the requested action on the resource + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-404-get" - "500": + value: + - errorCode: EQ-3001011 + errorMessage: Invalid uuid + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" - patch: + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error + delete: tags: - Service Profiles - summary: Update Service Profile - description: Update Service Profile by UUID - operationId: updateServiceProfileByUuid + summary: Delete Service 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" - requestBody: - content: - application/json-patch+json: - schema: - $ref: "#/components/schemas/ServiceProfileUpdateRequest" - examples: - ServiceProfilePatchRequest: - $ref: "#/components/examples/ServiceProfilePatchRequest" - ServiceProfilePatchRequestForVisibility: - $ref: "#/components/examples/ServiceProfilePatchRequestForVisibility" - required: true + description: Service Profile UUID + type: string + format: uuid responses: - "200": - description: Successful Patch operation - headers: - ETag: - $ref: "#/components/headers/ETag" + '200': + description: Successful Delete operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfile" + $ref: '#/components/schemas/ServiceProfile' examples: ServiceProfile: - $ref: "#/components/examples/ServiceProfilePatchResponse" - ServiceProfilePatchResponseForVisibility: - $ref: "#/components/examples/ServiceProfilePatchResponseForVisibility" - "400": + 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 + selectiveRedundancy: 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 + headers: + ETag: + $ref: '#/components/headers/ETag' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-400" - "401": + value: + - errorCode: EQ-3001115 + errorMessage: Unable to delete some of the profile because it does not exist + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-update" - "404": + value: + - errorCode: EQ-3001034 + errorMessage: You are not authorized to execute the requested action on the resource + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-404-get" - "500": + value: + - errorCode: EQ-3001011 + errorMessage: Invalid uuid + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}/actions: post: tags: @@ -4406,73 +18045,144 @@ paths: description: Service Profile UUID required: true schema: - $ref: "#/components/schemas/ServiceProfileId" + description: Service Profile UUID + type: string + format: uuid requestBody: content: application/json: schema: - $ref: "#/components/schemas/ServiceProfileActionRequest" + $ref: '#/components/schemas/ServiceProfileActionRequest' examples: AcceptProfileUpdate: - $ref: "#/components/examples/ServiceProfileActionRequest" + value: + type: PROFILE_UPDATE_ACCEPTANCE + description: Approved to migrate to public RejectProfileUpdate: - $ref: "#/components/examples/ServiceProfileActionRejectionRequest" + value: + type: PROFILE_UPDATE_REJECTION + description: Rejected the migration to public required: true responses: - "201": + '201': description: Successful operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfileActionResponse" + $ref: '#/components/schemas/ServiceProfileActionResponse' examples: ServiceProfileActionResponse: - $ref: "#/components/examples/ServiceProfileActionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/serviceProfiles/f30a9de3-c79e-443e-b65d-0a0692c6f3e0/actions/ac2a3233-23d9-423c-b375-0e78717bd348 + type: PROFILE_UPDATE_ACCEPTANCE + uuid: ac2a3233-23d9-423c-b375-0e78717bd348 + comments: Approved to migrate to public + changeLog: + createdBy: adminuser + createdDateTime: '2026-03-04T10:30:00Z' + updatedBy: adminuser + updatedDateTime: '2026-03-04T10:35:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-update" - "404": + value: + - errorCode: EQ-3001035 + errorMessage: You are not authorized to execute the requested action on the resource + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-404-get" - "500": + value: + - errorCode: EQ-3001011 + errorMessage: Invalid uuid + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}/environments: get: tags: @@ -4486,7 +18196,9 @@ paths: description: Service Profile UUID required: true schema: - $ref: "#/components/schemas/ServiceProfileId" + description: Service Profile UUID + type: string + format: uuid - name: offset in: query description: offset @@ -4502,51 +18214,141 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Successful operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ProviderEnvironments" + $ref: '#/components/schemas/ProviderEnvironments' examples: ServiceProfileEnvironments: - $ref: "#/components/examples/ServiceProfileEnvironmentsResponse" - "400": + value: + data: + - href: https://api.equinix.com/fabric/v4/serviceProfiles/23ad37d0-6b1c-4d1f-a4eb-9f3d68fbe4fd/environments/6ad498b5-d929-44ac-a199-ce9f0d31d9ac + uuid: 6ad498b5-d929-44ac-a199-ce9f0d31d9ac + type: IC_ENV + name: US West 1 – Production + description: Primary production environment + sellerRegion: us-west-1 + metros: + - code: CH + name: Chicago + displayName: Chicago + - code: DC + name: Ashburn + displayName: Ashburn + supportedBandwidths: + - 1000 + - 10000 + - 100000 + - href: https://api.equinix.com/fabric/v4/serviceProfiles/23ad37d0-6b1c-4d1f-a4eb-9f3d68fbe4fd/environments/1ad498b5-d929-44ac-a199-ce9f0d31d9ab + uuid: 1ad498b5-d929-44ac-a199-ce9f0d31d9ab + type: IC_ENV + name: US East 1 – Production + description: Primary production environment + sellerRegion: us-east-1 + metros: + - code: DC + name: Ashburn + displayName: Ashburn + supportedBandwidths: + - 1000 + - 10000 + - 100000 + pagination: + offset: 0 + limit: 2 + total: 2 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-read" - "500": + value: + - errorCode: EQ-3001033 + errorMessage: You are not authorized to execute the requested action on the resource + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}/environments/{environmentId}/actions: post: tags: @@ -4560,18 +18362,21 @@ paths: description: Service Profile UUID required: true schema: - $ref: "#/components/schemas/ServiceProfileId" + description: Service Profile UUID + type: string + format: uuid - name: environmentId in: path description: Provider Environment Reference required: true schema: - $ref: "#/components/schemas/EnvironmentId" + description: Provider Environment Reference + type: string requestBody: content: application/json: schema: - $ref: "#/components/schemas/EnvironmentActionRequest" + $ref: '#/components/schemas/EnvironmentActionRequest' examples: ValidateActivationKey: value: @@ -4580,48 +18385,102 @@ paths: value: key_here required: true responses: - "201": + '201': description: Successful service profile environment action operation content: application/json: schema: - $ref: "#/components/schemas/EnvironmentActionResponse" - "400": + $ref: '#/components/schemas/EnvironmentActionResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-update" - "500": + value: + - errorCode: EQ-3001035 + errorMessage: You are not authorized to execute the requested action on the resource + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}/metros: get: tags: @@ -4635,7 +18494,9 @@ paths: description: Service Profile UUID required: true schema: - $ref: "#/components/schemas/ServiceProfileId" + description: Service Profile UUID + type: string + format: uuid - name: offset in: query description: offset @@ -4651,51 +18512,164 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Successful operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceMetros" + $ref: '#/components/schemas/ServiceMetros' examples: ServiceProfileMetros: - $ref: "#/components/examples/ServiceProfilesResponse" - "400": + 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 + selectiveRedundancy: 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-read" - "500": + value: + - errorCode: EQ-3001033 + errorMessage: You are not authorized to execute the requested action on the resource + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error /fabric/v4/serviceTokens/{serviceTokenId}: get: tags: @@ -4709,52 +18683,214 @@ paths: description: Service Token UUID required: true schema: - $ref: "#/components/schemas/ServiceTokenUUID" + description: Service Token UUID + type: string + format: uuid responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceToken" + $ref: '#/components/schemas/ServiceToken' examples: tokenExample: - $ref: "#/components/examples/getServiceToken" + value: + href: http://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: http://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' tokenVDExample: - $ref: "#/components/examples/getServiceToken-VD" + value: + href: http://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' tokenNetworkExample: - $ref: "#/components/examples/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' tokenDryRunExample: - $ref: "#/components/examples/getServiceToken-DryRun" - "400": + 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 + expirationDateTime: '2020-05-31T10:30:00Z' + connection: + type: EVPL_VC + bandwidthLimit: 100 + allowRemoteConnection: false + allowCustomBandwidth: false + aSide: + accessPointSelectors: + - type: COLO + port: + href: http://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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_UUID" + value: + - errorCode: EQ-3034016 + errorMessage: Token not found + correlationId: 0963d003-ecda-4391-b166-8ccbf31d2d82 + additionalInfo: + - property: tokenUuid + reason: Token not found dryRunExample: - $ref: "#/components/examples/400_dry_run" - "403": + value: + - errorCode: EQ-3034054 + errorMessage: Dry Run is not supported for service tokens based on Network Edge + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - reason: queryParam:dryRun + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "500": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH delete: tags: - Service Tokens @@ -4767,52 +18903,214 @@ paths: description: Service Token UUID required: true schema: - $ref: "#/components/schemas/ServiceTokenUUID" + description: Service Token UUID + type: string + format: uuid responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceToken" + $ref: '#/components/schemas/ServiceToken' examples: tokenExample: - $ref: "#/components/examples/getServiceToken" + value: + href: http://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: http://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' tokenVDExample: - $ref: "#/components/examples/getServiceToken-VD" + value: + href: http://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' tokenNetworkExample: - $ref: "#/components/examples/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' tokenDryRunExample: - $ref: "#/components/examples/getServiceToken-DryRun" - "400": + 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 + expirationDateTime: '2020-05-31T10:30:00Z' + connection: + type: EVPL_VC + bandwidthLimit: 100 + allowRemoteConnection: false + allowCustomBandwidth: false + aSide: + accessPointSelectors: + - type: COLO + port: + href: http://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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_UUID" + value: + - errorCode: EQ-3034016 + errorMessage: Token not found + correlationId: 0963d003-ecda-4391-b166-8ccbf31d2d82 + additionalInfo: + - property: tokenUuid + reason: Token not found dryRunExample: - $ref: "#/components/examples/400_dry_run" - "403": + value: + - errorCode: EQ-3034054 + errorMessage: Dry Run is not supported for service tokens based on Network Edge + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - reason: queryParam:dryRun + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "500": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH patch: tags: - Service Tokens @@ -4825,7 +19123,9 @@ paths: description: Service Token UUID required: true schema: - $ref: "#/components/schemas/ServiceTokenUUID" + description: Service Token UUID + type: string + format: uuid - name: dryRun in: query description: option to verify that API calls will succeed @@ -4837,107 +19137,261 @@ paths: content: application/json-patch+json: schema: - $ref: "#/components/schemas/ServiceTokenUpdateRequest" + $ref: '#/components/schemas/ServiceTokenUpdateRequest' examples: UpdateExpirationDate: - $ref: "#/components/examples/UpdateExpirationDate" + value: + - op: replace + path: /expirationDateTime + value: '2023-01-20T18:50:34.696Z' UpdateTokenName: - $ref: "#/components/examples/UpdateTokenName" + value: + - op: replace + path: /name + value: Az_Aside_Dot1Q_NewName UpdateTokenDescription: - $ref: "#/components/examples/UpdateTokenDescription" + value: + - op: replace + path: /description + value: Az_Aside_Dot1Q_Pri_SV_NewDescription UpdateNotificationEmail: - $ref: "#/components/examples/UpdateNotificationEmail" + value: + - op: replace + path: /notifications/emails + value: + - test1@equinix.com + - test2@equinix.com UpdateAsideTokenBandwidth: - $ref: "#/components/examples/UpdateAsideTokenBandwidth" + value: + - op: replace + path: /connection/bandwidthLimit + value: 100 UpdateZsideTokenBandwidth: - $ref: "#/components/examples/UpdateZsideTokenBandwidth" + value: + - op: replace + path: /connection/supportedBandwidths + value: + - 50 + - 1000 UpdateAsideTokenBandwidthDryRun: - $ref: "#/components/examples/UpdateAsideTokenBandwidth" + value: + - op: replace + path: /connection/bandwidthLimit + value: 100 UpdateZsideTokenBandwidthDryRun: - $ref: "#/components/examples/UpdateZsideTokenBandwidth" + value: + - op: replace + path: /connection/supportedBandwidths + value: + - 50 + - 1000 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceToken" + $ref: '#/components/schemas/ServiceToken' examples: tokenExample: - $ref: "#/components/examples/getServiceToken" + value: + href: http://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: http://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' tokenVDExample: - $ref: "#/components/examples/getServiceToken-VD" + value: + href: http://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' tokenNetworkExample: - $ref: "#/components/examples/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' tokenDryRunExample: - $ref: "#/components/examples/getServiceToken-DryRun" - "400": + 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 + expirationDateTime: '2020-05-31T10:30:00Z' + connection: + type: EVPL_VC + bandwidthLimit: 100 + allowRemoteConnection: false + allowCustomBandwidth: false + aSide: + accessPointSelectors: + - type: COLO + port: + href: http://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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_UUID" + value: + - errorCode: EQ-3034016 + errorMessage: Token not found + correlationId: 0963d003-ecda-4391-b166-8ccbf31d2d82 + additionalInfo: + - property: tokenUuid + reason: Token not found dryRunExample: - $ref: "#/components/examples/400_dry_run" - "403": + value: + - errorCode: EQ-3034054 + errorMessage: Dry Run is not supported for service tokens based on Network Edge + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - reason: queryParam:dryRun + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "500": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/serviceTokens: - get: - tags: - - Service Tokens - summary: Get Service 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 @@ -4956,87 +19410,707 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ServiceToken" + $ref: '#/components/schemas/ServiceToken' examples: AsideTokenWithQnQ: - $ref: "#/components/examples/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 AsideTokenWithDot1Q: - $ref: "#/components/examples/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 AsideTokenWithVxlan: - $ref: "#/components/examples/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 + vni: 510000 + notifications: + - type: NOTIFICATION + emails: + - abc@company.com + - provider@company.com ZsideTokenWithQnQ: - $ref: "#/components/examples/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 ZsideTokenWithDot1Q: - $ref: "#/components/examples/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 ZsideTokenWithVxlan: - $ref: "#/components/examples/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 + vni: 520000 + expirationDateTime: '2021-03-18T06:43:49.980Z' + notifications: + - type: NOTIFICATION + emails: + - abc@company.com ZsideTokenWithVD: - $ref: "#/components/examples/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 ZsideTokenForEVPLAN-Network: - $ref: "#/components/examples/createZsideServiceTokenWithNetworkEvplan" + 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 ZsideTokenForEPLAN-Network: - $ref: "#/components/examples/createZsideServiceTokenWithNetworkEplan" + value: + type: VC_TOKEN + name: zside_Network_token + description: Zside_Network_token + connection: + type: EPLAN_VC + allowRemoteConnection: true + supportedBandwidths: + - 10 + - 50 + - 200 + zSide: + accessPointSelectors: + - type: NETWORK + network: + type: EPLAN + 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 ZsideTokenForEVPTree-Network: - $ref: "#/components/examples/createZsideServiceTokenWithNetworkEvptree" + value: + type: VC_TOKEN + name: zside_Network_token + description: Zside_Network_token + connection: + type: EVPTREE_VC + allowRemoteConnection: true + supportedBandwidths: + - 10 + - 50 + - 200 + zSide: + accessPointSelectors: + - type: NETWORK + network: + type: EVPTREE + 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 ZsideTokenForEPTree-Network: - $ref: "#/components/examples/createZsideServiceTokenWithNetworkEptree" + value: + type: VC_TOKEN + name: zside_Network_token + description: Zside_Network_token + connection: + type: EPTREE_VC + allowRemoteConnection: true + supportedBandwidths: + - 10 + - 50 + - 200 + zSide: + accessPointSelectors: + - type: NETWORK + network: + type: EPTREE + 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 AsideTokenWithDot1QDryRunCreate: - $ref: "#/components/examples/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 AsideFCRWithZsidePortBasedToken: - $ref: "#/components/examples/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 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceToken" + $ref: '#/components/schemas/ServiceToken' examples: ServiceTokenDryRun: - $ref: "#/components/examples/createServiceTokenDryRunResponse" - "201": + 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: http://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 + '201': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceToken" + $ref: '#/components/schemas/ServiceToken' examples: tokenExample: - $ref: "#/components/examples/getServiceToken" + value: + href: http://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: http://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' ZsideTokenForEVPLANNetwork: - $ref: "#/components/examples/createZsideServiceTokenWithNetworkEvplan-Response" + value: + href: https://api.equinix.com/fabric/v4/serviceTokens/7cf92aa3-18b8-435c-b3fc-55e45b1ce964 + type: VC_TOKEN + uuid: 7cf92aa3-18b8-435c-b3fc-55e45b1ce964 + expirationDateTime: '2025-09-09T00:00:00Z' + connection: + type: EVPLAN_VC + allowRemoteConnection: true + allowCustomBandwidth: false + supportedBandwidths: + - 10 + - 50 + - 200 + - 500 + zSide: + accessPointSelectors: + - type: NETWORK + network: + href: https://api.equinix.com/fabric/v4/networks/5e17244a-b3e6-4830-aea3-5269d61efd8c + uuid: 5e17244a-b3e6-4830-aea3-5269d61efd8c + type: EVPLAN + name: AUTO-EVPLAN-939087546 + scope: GLOBAL + state: INACTIVE + notifications: + - type: NOTIFICATION + emails: + - test@equinix.com + - user01@equinix.com + account: + orgId: 90837 + changelog: + createdBy: '890742' + createdDateTime: '2025-06-11T15:23:19.237Z' + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee962 ZsideTokenForEVPTreeNetwork: - $ref: "#/components/examples/createZsideServiceTokenWithNetworkEvptree-Response" - "400": + value: + href: https://api.equinix.com/fabric/v4/serviceTokens/543b869e-a9ba-4492-860b-44927ce619f9 + type: VC_TOKEN + uuid: 543b869e-a9ba-4492-860b-44927ce619f9 + expirationDateTime: '2025-09-09T00:00:00Z' + connection: + type: EVPTREE_VC + allowRemoteConnection: true + allowCustomBandwidth: false + supportedBandwidths: + - 10 + - 50 + - 200 + - 500 + - 1000 + zSide: + accessPointSelectors: + - type: NETWORK + network: + href: https://api.equinix.com/fabric/v4/networks/a3536780-6118-4374-ab65-23b17fc4cbbb + uuid: a3536780-6118-4374-ab65-23b17fc4cbbb + type: EVPTREE + name: EVPTREE-AMER-01 + scope: REGIONAL + location: + region: AMER + state: INACTIVE + notifications: + - type: NOTIFICATION + emails: + - test@equinix.com + - user01@equinix.com + account: + orgId: 90837 + changelog: + createdBy: '890742' + createdDateTime: '2025-06-11T15:54:33.007Z' + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee962 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400" + value: + - errorCode: EQ-3034026 + errorMessage: ServiceToken provided is in Invalid Format. + correlationId: 0963d003-ecfa-4391-b166-8ccbf31d2d82 + additionalInfo: + - property: tokenUuid + reason: Please Enter Valid serviceToken dryRunExample: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3034054 + errorMessage: Dry Run is not supported for service tokens based on Network Edge + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + get: + tags: + - Service Tokens + summary: Get Service 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: + 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: http://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: http://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' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/serviceTokens/{serviceTokenId}/actions: post: tags: @@ -5050,61 +20124,137 @@ paths: description: Service Token UUID required: true schema: - $ref: "#/components/schemas/ServiceTokenUUID" + description: Service Token UUID + type: string + format: uuid requestBody: content: application/json: schema: - $ref: "#/components/schemas/ServiceTokenActionRequest" + $ref: '#/components/schemas/ServiceTokenActionRequest' examples: ResendServiceToken: - $ref: "#/components/examples/Resend_Service_Token" + value: + type: RESEND_EMAIL_NOTIFICATION required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceToken" + $ref: '#/components/schemas/ServiceToken' examples: connectionActionExample: - $ref: "#/components/examples/postServiceTokenActionResponse" - "400": + value: + href: http://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: http://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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: /aSide/accessPoint/linkProtocol + reason: VlanCtag is Not Required for LinkProtocolType DOT1Q + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: /aSide/accessPoint/linkProtocol + reason: VlanStag is Not Required for LinkProtocolType DOT1Q + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: supported operator '=' + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: supported properties are state and uuid + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: only one uuid/state is supported at this time dryRunExample: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3034054 + errorMessage: Dry Run is not supported for service tokens based on Network Edge. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3034035 + errorMessage: Bad request - ProjectId provided has no permission. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3034016 + errorMessage: Token not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/serviceTokens/search: post: tags: @@ -5127,59 +20277,202 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ServiceTokenSearchRequest" + $ref: '#/components/schemas/ServiceTokenSearchRequest' examples: ServiceTokenRequest: - $ref: "#/components/examples/postServiceTokenSearchUuid" + value: + filter: + and: + - property: /uuid + operator: '=' + values: + - 407f8239-254c-4fe2-a378-458f197e17c4 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceTokens" + $ref: '#/components/schemas/ServiceTokens' examples: servicetokenSearchExample: - $ref: "#/components/examples/getServiceTokens" - "400": + 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: http://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: http://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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: /aSide/accessPoint/linkProtocol + reason: VlanCtag is Not Required for LinkProtocolType DOT1Q + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: /aSide/accessPoint/linkProtocol + reason: VlanStag is Not Required for LinkProtocolType DOT1Q + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: supported operator '=' + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: supported properties are state and uuid + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: only one uuid/state is supported at this time dryRunExample: - $ref: "#/components/examples/400_dry_run" - "403": + value: + - errorCode: EQ-3034054 + errorMessage: Dry Run is not supported for service tokens based on Network Edge. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - reason: queryParam:dryRun + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3034035 + errorMessage: Bad request - ProjectId provided has no permission. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3034016 + errorMessage: Token not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3034011 + 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 /fabric/v4/opticalConnects: post: tags: @@ -5188,70 +20481,282 @@ paths: description: | Create a single Optical Metro Connect circuit. operationId: createOpticalConnect - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/OpticalConnectPostRequest" + $ref: '#/components/schemas/OpticalConnectPostRequest' examples: COLOToCOLO: - $ref: "#/components/examples/ColoOpticalConnectCreate" + description: Both ends terminate on patch panels in colocation space you occupy, so no Letter of Authorization is needed. + value: + type: OC + bandwidth: 100000 + connectionDestinationType: COLO + pathType: UNPROTECTED + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '9' + patchPanelPortB: '10' + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: PP:Demarc:1259695 + patchPanelPortA: '20' + patchPanelPortB: '21' + connectorType: SC + order: + purchaseOrderNumber: '156576' + notifications: + - type: NOTIFICATION + emails: + - test@test.com COLOToRemote: - $ref: "#/components/examples/RemoteOpticalConnectCreate" + description: |- + The Z-side is identified by IBX code and the Letter of Authorization + issued by the destination customer. + value: + type: OC + bandwidth: 100000 + connectionDestinationType: REMOTE + pathType: UNPROTECTED + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + purchaseOrderNumber: '156576' + notifications: + - type: NOTIFICATION + emails: + - test@test.com COLOToBMMR: - $ref: "#/components/examples/BMMROpticalConnectCreate" + description: The Z-side is identified by location and Letter of Authorization.
bmmrType declares who operates the meet-me room. + value: + type: OC + bandwidth: 100000 + connectionDestinationType: BMMR + pathType: UNPROTECTED + bmmrType: EQUINIX + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + purchaseOrderNumber: '156576' + notifications: + - type: NOTIFICATION + emails: + - test@test.com required: true responses: - "202": + '202': description: Accepted Operation content: application/json: schema: - $ref: "#/components/schemas/OpticalConnectResponse" + $ref: '#/components/schemas/OpticalConnectResponse' examples: COLOToCOLO: - $ref: "#/components/examples/ColoOpticalConnectResponseExample" + summary: COLO connection + value: + href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: COLO + pathType: UNPROTECTED + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259690 + patchPanelPortA: '20' + patchPanelPortB: '21' + connectorType: SC + cageUniqueSpaceId: SV2:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV2 + order: + purchaseOrderNumber: '156576' + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2025-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2025-07-24T06:51:46Z' COLOToRemote: - $ref: "#/components/examples/RemoteOpticalConnectResponseExample" + summary: Remote connection + value: + href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: REMOTE + pathType: UNPROTECTED + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + purchaseOrderNumber: '156576' + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2025-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2025-07-24T06:51:46Z' COLOToBMMR: - $ref: "#/components/examples/BMMROpticalConnectResponseExample" - "400": + summary: BMMR connection + value: + href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: BMMR + pathType: UNPROTECTED + bmmrType: EQUINIX + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + purchaseOrderNumber: '156576' + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2025-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2025-07-24T06:51:46Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_400" - "403": + summary: Unknown or inaccessible connection. + value: + - errorCode: EQ-3057103 + errorMessage: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_403" - "404": + summary: Operation not permitted + value: + - errorCode: EQ-3057102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_404" - "500": + summary: Optical connection not found + value: + - errorCode: EQ-3057101 + errorMessage: Optical Connect Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Optical Connect Service not found or already deleted + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_500" + summary: Unexpected server error + value: + - errorCode: EQ-3057104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/opticalConnects/bulk: post: tags: @@ -5260,70 +20765,463 @@ paths: description: | Create a dual diverse pair of circuits on separate optical paths. operationId: createBulkOpticalConnect - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/BulkOpticalConnectRequest" + $ref: '#/components/schemas/BulkOpticalConnectRequest' examples: COLOToCOLO: - $ref: "#/components/examples/ColoOpticalConnectBulkCreate" + summary: COLO diverse pair + description: Two connections on separate patch panels. Equinix assigns the shared redundancy group and returns it on both connections. + value: + data: + - type: OC + bandwidth: 100000 + connectionDestinationType: COLO + pathType: DUAL_DIVERSE + redundancy: + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259690 + patchPanelPortA: '20' + patchPanelPortB: '21' + connectorType: SC + notifications: + - type: NOTIFICATION + emails: + - test@test.com + registeredUsers: + - test + - type: OC + bandwidth: 100000 + connectionDestinationType: COLO + pathType: DUAL_DIVERSE + redundancy: + priority: SECONDARY + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: '14' + patchPanelPortB: '15' + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260385 + patchPanelPortA: '24' + patchPanelPortB: '25' + connectorType: SC + notifications: + - type: NOTIFICATION + emails: + - test@test.com COLOToRemote: - $ref: "#/components/examples/RemoteOpticalConnectBulkCreate" + value: + data: + - type: OC + bandwidth: 100000 + connectionDestinationType: REMOTE + pathType: DUAL_DIVERSE + redundancy: + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + account: + accountNumber: 270848 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + registeredUsers: + - test@test.com + - type: OC + bandwidth: 100000 + connectionDestinationType: REMOTE + pathType: DUAL_DIVERSE + redundancy: + priority: SECONDARY + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: '14' + patchPanelPortB: '15' + connectorType: SC + zSide: + location: + ibxCode: SV2 + loa: + uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 + account: + accountNumber: 270848 + notifications: + - type: NOTIFICATION + emails: + - test@test.com COLOToBMMR: - $ref: "#/components/examples/BMMROpticalConnectBulkCreate" + value: + data: + - type: OC + bandwidth: 100000 + connectionDestinationType: BMMR + pathType: DUAL_DIVERSE + bmmrType: EQUINIX + redundancy: + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + account: + accountNumber: 270848 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + registeredUsers: + - test@test.com + - type: OC + bandwidth: 100000 + connectionDestinationType: BMMR + pathType: DUAL_DIVERSE + bmmrType: EQUINIX + redundancy: + priority: SECONDARY + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: '14' + patchPanelPortB: '15' + connectorType: SC + zSide: + location: + ibxCode: SV2 + loa: + uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 + account: + accountNumber: 270848 + notifications: + - type: NOTIFICATION + emails: + - test@test.com required: true responses: - "202": + '202': description: Accepted Operation content: application/json: schema: - $ref: "#/components/schemas/OpticalConnectBulk" + $ref: '#/components/schemas/OpticalConnectBulk' examples: COLOToCOLO: - $ref: "#/components/examples/ColoOpticalConnectBulkResponseExample" + value: + data: + - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-PRI-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: COLO + pathType: DUAL_DIVERSE + redundancy: + priority: PRIMARY + group: 22f8e668-4754-4564-825d-d1c7889c885a + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259690 + patchPanelPortA: '20' + patchPanelPortB: '21' + connectorType: SC + cageUniqueSpaceId: SV2:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV2 + order: + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + - href: https://api.equinix.com/fabric/v4/opticalConnects/a6f77b33-96c6-4eeb-8d79-76374d950603 + uuid: a6f77b33-96c6-4eeb-8d79-76374d950603 + type: OC + name: 270848-SV1-SV2-SEC-02 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: COLO + pathType: DUAL_DIVERSE + redundancy: + priority: SECONDARY + group: 22f8e668-4754-4564-825d-d1c7889c885a + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: '14' + patchPanelPortB: '15' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260385 + patchPanelPortA: '24' + patchPanelPortB: '25' + connectorType: SC + cageUniqueSpaceId: SV2:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV2 + order: + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com COLOToRemote: - $ref: "#/components/examples/RemoteOpticalConnectBulkResponseExample" + value: + data: + - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-PRI-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: REMOTE + pathType: DUAL_DIVERSE + redundancy: + priority: PRIMARY + group: 22f8e668-4754-4564-825d-d1c7889c885a + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + - href: https://api.equinix.com/fabric/v4/opticalConnects/c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 + uuid: c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 + type: OC + name: 270848-SV1-SV2-SEC-02 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: REMOTE + pathType: DUAL_DIVERSE + redundancy: + priority: SECONDARY + group: 22f8e668-4754-4564-825d-d1c7889c885a + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: '14' + patchPanelPortB: '15' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 + order: + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com COLOToBMMR: - $ref: "#/components/examples/BMMROpticalConnectBulkResponseExample" - "400": + value: + data: + - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-PRI-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: BMMR + pathType: DUAL_DIVERSE + bmmrType: EQUINIX + redundancy: + priority: PRIMARY + group: 22f8e668-4754-4564-825d-d1c7889c885a + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + - href: https://api.equinix.com/fabric/v4/opticalConnects/c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 + uuid: c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 + type: OC + name: 270848-SV1-SV2-SEC-02 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: BMMR + pathType: DUAL_DIVERSE + bmmrType: EQUINIX + redundancy: + priority: SECONDARY + group: 22f8e668-4754-4564-825d-d1c7889c885a + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: '14' + patchPanelPortB: '15' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 + order: + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_400" - "403": + summary: Unknown or inaccessible connection. + value: + - errorCode: EQ-3057103 + errorMessage: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_403" - "404": + summary: Operation not permitted + value: + - errorCode: EQ-3057102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_404" - "500": + summary: Optical connection not found + value: + - errorCode: EQ-3057101 + errorMessage: Optical Connect Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Optical Connect Service not found or already deleted + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_500" + summary: Unexpected server error + value: + - errorCode: EQ-3057104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/opticalConnects/{opticalConnectId}: get: tags: @@ -5338,57 +21236,203 @@ paths: description: Unique identifier of an Optical Connect. required: true schema: - $ref: "#/components/schemas/OpticalConnectId" + description: Unique identifier of an Optical Connect. + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/OpticalConnectResponse" + $ref: '#/components/schemas/OpticalConnectResponse' examples: COLOToCOLO: - $ref: "#/components/examples/ColoOpticalConnectResponseExample" + summary: COLO connection + value: + href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: COLO + pathType: UNPROTECTED + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259690 + patchPanelPortA: '20' + patchPanelPortB: '21' + connectorType: SC + cageUniqueSpaceId: SV2:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV2 + order: + purchaseOrderNumber: '156576' + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2025-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2025-07-24T06:51:46Z' COLOToRemote: - $ref: "#/components/examples/RemoteOpticalConnectResponseExample" + summary: Remote connection + value: + href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: REMOTE + pathType: UNPROTECTED + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + purchaseOrderNumber: '156576' + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2025-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2025-07-24T06:51:46Z' COLOToBMMR: - $ref: "#/components/examples/BMMROpticalConnectResponseExample" - "400": + summary: BMMR connection + value: + href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: BMMR + pathType: UNPROTECTED + bmmrType: EQUINIX + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + purchaseOrderNumber: '156576' + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2025-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2025-07-24T06:51:46Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_400" - "403": + summary: Unknown or inaccessible connection. + value: + - errorCode: EQ-3057103 + errorMessage: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_403" - "404": + summary: Operation not permitted + value: + - errorCode: EQ-3057102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_404" - "500": + summary: Optical connection not found + value: + - errorCode: EQ-3057101 + errorMessage: Optical Connect Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Optical Connect Service not found or already deleted + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_500" + summary: Unexpected server error + value: + - errorCode: EQ-3057104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/opticalConnects/search: post: tags: @@ -5397,75 +21441,234 @@ paths: description: | Get Optical Metro Connects matching the supplied criteria, with optional filtering, pagination and sorting. operationId: searchOpticalConnect - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/OpticalConnectSearchRequest" + $ref: '#/components/schemas/OpticalConnectSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/SearchOpticalConnectFilterByStatus" + summary: All provisioned connections + value: + filter: + and: + - property: /state + operator: '=' + values: + - PROVISIONED + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime SearchFilterByName: - $ref: "#/components/examples/SearchOpticalConnectByName" + summary: A named connection of a given type + value: + filter: + and: + - property: /name + operator: '=' + values: + - 270848-SV1-SV2-01 + - property: /type + operator: '=' + values: + - OC + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime SearchFilterOrAnd: - $ref: "#/components/examples/SearchOpticalConnectFilterOrAnd" + summary: Partial match on uuid or name + description: An OR group nested inside the top-level AND — matches circuits whose uuid starts with the given prefix, or whose name is like the value. + value: + filter: + and: + - or: + - property: /uuid + operator: LIKE + values: + - 676a0c3f-a785-4294-87bc-25fe9318a620% + - property: /name + operator: LIKE + values: + - 270848-SV1-SV2-01 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/OpticalConnectServiceSearchResponse" + $ref: '#/components/schemas/OpticalConnectServiceSearchResponse' examples: Example: - $ref: "#/components/examples/OpticalConnectSearchResponseExample" - "400": + summary: One matching connection. + 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/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-01-1 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: COLO + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259690 + patchPanelPortA: '20' + patchPanelPortB: '21' + cageUniqueSpaceId: SV2:01:002174 + cabinetUniqueSpaceId: Demarc + connectorType: SC + location: + ibxCode: SV2 + order: + purchaseOrderNumber: '156576' + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2025-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2025-07-24T06:51:46Z' + - href: https://api.equinix.com/fabric/v4/opticalConnects/07abb0e3-e67d-5090-9aff-fc5654abaae0 + uuid: 07abb0e3-e67d-5090-9aff-fc5654abaae0 + type: OC + name: 270848-SV1-SV2-01-2 + state: PROVISIONED + bandwidth: 100000 + connectionDestinationType: COLO + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1234685 + patchPanelPortA: '11' + patchPanelPortB: '12' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '22' + patchPanelPortB: '23' + connectorType: SC + cageUniqueSpaceId: SV2:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV2 + order: + purchaseOrderNumber: '126758' + orderNumber: 1-139105284200 + account: + accountNumber: 280845 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2024-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2024-07-24T06:51:46Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_400_invalid_sorting" - "401": + summary: Invalid sort direction. + value: + - errorCode: EQ-3057105 + errorMessage: Invalid value for sorting direction. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_401" - "403": + summary: Missing or invalid credentials + value: + - errorCode: EQ-3057106 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_403" - "404": + summary: Operation not permitted + value: + - errorCode: EQ-3057102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_404" - "500": + summary: Optical connection not found + value: + - errorCode: EQ-3057101 + errorMessage: Optical Connect Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Optical Connect Service not found or already deleted + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_500" + summary: Unexpected server error + value: + - errorCode: EQ-3057104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/metros: get: tags: @@ -5479,7 +21682,7 @@ paths: description: User On Boarded Metros based on Fabric resource availability required: false schema: - $ref: "#/components/schemas/Presence" + $ref: '#/components/schemas/Presence' - name: offset in: query description: offset @@ -5495,42 +21698,130 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/MetroResponse" + $ref: '#/components/schemas/MetroResponse' examples: metroExample: - $ref: "#/components/examples/metro" - "400": + 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 + services: + - type: ETHERNET_IP_SERVICE + - type: TIME_SERVICE + geoScopes: + - CANADA + - CONUS + - JAPAN + - UK + - AUSTRALIA + - BRAZIL + - SWITZERLAND + - EU + geoZones: + - code: EU + name: European Union + description: Note that Ireland and Italy are not currently included + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/MetroErrorList" + $ref: '#/components/schemas/MetroErrorList' examples: example: - $ref: "#/components/examples/400_metros" - "401": + 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': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/MetroErrorList" + $ref: '#/components/schemas/MetroErrorList' examples: example: - $ref: "#/components/examples/401_metros" - "500": + value: + - errorCode: EQ-3036001 + errorMessage: Unauthorized + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/MetroErrorList" + $ref: '#/components/schemas/MetroErrorList' examples: example: - $ref: "#/components/examples/500_metros" + value: + - errorCode: EQ-3036030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An Internal Server Error occured /fabric/v4/metros/{metroCode}: get: tags: @@ -5544,44 +21835,128 @@ paths: description: Metro Code required: true schema: - $ref: "#/components/schemas/MetroCode" + description: Metro Code + type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Metro" + $ref: '#/components/schemas/Metro' examples: metroExample: - $ref: "#/components/examples/metroByCode" - "400": + 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 + services: + - type: ETHERNET_IP_SERVICE + - type: TIME_SERVICE + geoScopes: + - CANADA + - CONUS + - JAPAN + - UK + - AUSTRALIA + - BRAZIL + - SWITZERLAND + - EU + geoZones: + - code: EU + name: European Union + description: Note that Ireland and Italy are not currently included + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/MetroErrorList" + $ref: '#/components/schemas/MetroErrorList' examples: example: - $ref: "#/components/examples/400_metroCode" - "401": + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Path Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: pathparameter-metroCode + reason: Provide valid metro code + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/MetroErrorList" + $ref: '#/components/schemas/MetroErrorList' examples: example: - $ref: "#/components/examples/401_metros" - "500": + value: + - errorCode: EQ-3036001 + errorMessage: Unauthorized + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/MetroErrorList" + $ref: '#/components/schemas/MetroErrorList' examples: example: - $ref: "#/components/examples/500_metros" + value: + - errorCode: EQ-3036030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An Internal Server Error occured /fabric/v4/ports: get: tags: @@ -5596,53 +21971,222 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AllPortsResponse" + $ref: '#/components/schemas/AllPortsResponse' examples: portExample: - $ref: "#/components/examples/ports" - "400": + value: + pagination: + offset: 0 + limit: 1000 + total: 2 + data: + - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-02db-2dbc-ace0-30fa5c00ad04 + type: XF_PORT + uuid: c4d93b39-02db-2dbc-ace0-30fa5c00ad04 + name: gen-l2-qa-01-auto-TY4-L-Qinq-STD-SEC-10G-JUN-598 + physicalPortsSpeed: 10000 + physicalPortsType: 10GBASE_LR + connectivitySourceType: COLO + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + package: + code: STANDARD + state: REPROVISIONING + cvpId: '1616554' + operation: + connectionCount: 0 + evplVCCount: 0 + accessVCCount: 0 + account: + accountNumber: 200559 + accountName: gen-l2-qa-01-auto-200559 + orgId: 90946 + organizationName: gen-l2-qa-01-auto-200551. + ucmId: 500DFED2-EBDB-480d-896C-C7870E52D0D8 + globalCustId: 0017i000011X242AAC + changeLog: + createdBy: vvyugovskiy-IMPORT_JOB + createdDateTime: '2021-06-16T01:46:52Z' + updatedBy: Order-to-activation + updatedDateTime: '2025-04-07T23:03:08.900Z' + bandwidth: 10000 + availableBandwidth: 10000 + usedBandwidth: 0 + location: + metroHref: https://api.equinix.com/fabric/v4/metros/TY + region: APAC + metroName: Tokyo + metroCode: TY + ibx: TY4 + device: + name: sit-tb1-ty-a2.lab + redundancy: + priority: SECONDARY + demarcationPointIbx: TY4 + tetherIbx: TY4 + redundancy: + priority: SECONDARY + encapsulation: + type: QINQ + tagProtocolId: '0x9100' + lagEnabled: false + settings: + buyout: false + physicalPorts: + - type: XF_PHYSICAL_PORT + id: 1362185 + state: TO_BE_ADDED + uuid: 01892489-ce9b-7f25-b1f5-d32a5ac6a423 + tether: + crossConnectId: ECX.05.00001836 + cabinetNumber: Demarc + systemName: TY4:01:002181 + patchPanel: PP:1240:1089399 + patchPanelPortA: '7' + patchPanelPortB: '8' + ibx: TY4 + demarcationPoint: + patchPanel: PP:Demarc:00002181 + patchPanelName: PP:Demarc:00002181 + patchPanelPortA: '5' + patchPanelPortB: '6' + ibx: TY4 + operation: + operationalStatus: UP + - href: https://api.equinix.com/fabric/v4/ports/6f0f3015-2d51-4b6e-a98c-1defb4fe88f1 + type: XF_PORT + uuid: 6f0f3015-2d51-4b6e-a98c-1defb4fe88f1 + name: 200558-SY4-CX-PRI-02 + physicalPortsSpeed: 10000 + physicalPortsType: 10GBASE_LR + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + package: + code: STANDARD + state: ACTIVE + cvpId: '2000348' + operation: + connectionCount: 1 + evplVCCount: 1 + accessVCCount: 0 + maintenanceStatus: SCHEDULED + lockEnabled: true + account: + accountNumber: 200558 + accountName: Gen-L2-Qa-01-Auto-200558 + orgId: 90946 + organizationName: gen-l2-qa-01-auto-200551. + ucmId: 2D26D682-B62E-495d-AFDF-698EC3B353F8 + globalCustId: 0017i000011X242AAC + changeLog: + createdDateTime: '2025-05-06T17:29:30.800Z' + updatedBy: API + updatedDateTime: '2025-05-06T17:29:40.300Z' + bandwidth: 10000 + availableBandwidth: 9500 + usedBandwidth: 500 + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SY + region: APAC + metroName: Sydney + metroCode: SY + ibx: SY4 + device: + name: sit-tb1-sy-e1.lab + redundancy: + group: '1' + priority: PRIMARY + demarcationPointIbx: SY4 + tetherIbx: SY4 + redundancy: + priority: PRIMARY + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + lagEnabled: true + settings: + buyout: false + physicalPorts: + - type: XF_PHYSICAL_PORT + id: 1362737 + state: ACTIVE + uuid: 01892489-ce07-7962-b676-b1a4d8091515 + tether: + crossConnectId: '22035616' + cabinetNumber: Demarc + systemName: SY4:01:002204 + patchPanel: PP:1240:1089399 + patchPanelPortA: '12' + patchPanelPortB: '14' + ibx: SY4 + demarcationPoint: + patchPanel: PP:Demarc:00002204 + patchPanelName: PP:Demarc:00002204 + patchPanelPortA: '17' + patchPanelPortB: '18' + ibx: SY4 + operation: + operationalStatus: UP + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400" - "401": + value: + - errorCode: EQ-3046115 + errorMessage: Invalid Path Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: pathparameter-portUuid + reason: Provide valid port Uuid + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3046117 + errorMessage: Unauthorized user. + correlationId: TEST + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "500": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Service Unavailable content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: portExample: - $ref: "#/components/examples/ports-500" + value: + - errorCode: EQ-3046030 + errorMessage: Internal error. + details: Internal system error userFailureExample: - $ref: "#/components/examples/ports-500-user-failure" + value: + - errorCode: IC-USR-014-01 + errorMessage: Error in getting user's profile post: tags: - Ports @@ -5661,99 +22205,1160 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/PortRequest" + $ref: '#/components/schemas/PortRequest' examples: COLOSinglePortNonLag: - $ref: "#/components/examples/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: '0x8100' + 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: - $ref: "#/components/examples/coloSinglePortLag" + value: + type: XF_PORT + connectivitySourceType: COLO + location: + metroCode: AT + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + account: + accountNumber: 16432 + project: + projectId: e275485c-7072-439f-943a-c923548b2be5 + package: + code: STANDARD + redundancy: + priority: PRIMARY + lagEnabled: true + physicalPorts: + - type: XF_PHYSICAL_PORT + demarcationPoint: + ibx: AT1 + cageUniqueSpaceId: AT1:02:FE50010 + cabinetUniqueSpaceId: '9999' + patchPanel: CD:9999:186947 + connectorType: SC + patchPanelPortA: '4' + patchPanelPortB: '5' + endCustomer: + isDisclosed: true + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + demarcationPointIbx: AT1 + notifications: + - type: TECHNICAL + registeredUsers: + - username + - type: NOTIFICATION + registeredUsers: + - user@equinix.com COLOUnlimitedPlusPortLag: - $ref: "#/components/examples/coloUnlimitedPlusPortLag" + value: + type: XF_PORT + connectivitySourceType: COLO + location: + metroCode: GV + package: + code: UNLIMITED_PLUS + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + account: + accountNumber: 270848 + project: + projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 + redundancy: + priority: PRIMARY + lagEnabled: true + physicalPorts: + - type: XF_PHYSICAL_PORT + demarcationPoint: + ibx: GV1 + cageUniqueSpaceId: GV1:01:002174 + cabinetUniqueSpaceId: Demarc + patchPanel: CP:Demarc:1259684 + connectorType: SC + endCustomer: + isDisclosed: false + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + demarcationPointIbx: GV1 + notifications: + - type: TECHNICAL + registeredUsers: + - jaguarsuser-port-order + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order COLOLagPortNewGroup: - $ref: "#/components/examples/coloLagPortNewGroup" + value: + type: XF_PORT + connectivitySourceType: COLO + location: + metroCode: TR + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + account: + accountNumber: 96127367 + package: + code: UNLIMITED + project: + projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 + redundancy: + priority: PRIMARY + lagEnabled: true + physicalPorts: + - type: XF_PHYSICAL_PORT + demarcationPoint: + ibx: TR1 + cageUniqueSpaceId: TR1:01:JSIT001 + cabinetUniqueSpaceId: DEM + patchPanel: PP:DEM:1265410 + connectorType: LC + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + demarcationPointIbx: TR1 + order: + signature: + signatory: SELF + delegate: + email: jaguars-test-user-001@equinix.com + purchaseOrder: + type: EXEMPTION + notifications: + - type: TECHNICAL + registeredUsers: + - jaguars-test-user-001 + - type: NOTIFICATION + registeredUsers: + - jaguars-test-user-001 COLOAddSecondaryPort: - $ref: "#/components/examples/coloAddSecondaryPort" + value: + type: XF_PORT + physicalPortsSpeed: 10000 + physicalPortsType: 1000BASE_LX + connectivitySourceType: COLO + location: + metroCode: GV + demarcationPointIbx: GV1 + package: + code: STANDARD + redundancy: + priority: SECONDARY + group: 1f6bdb37-f131-5925-c039-fe1785fad165 + lagEnabled: false + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + 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 + cabinetUniqueSpaceId: AM1:02:032575:0105 + cageUniqueSpaceId: AM1:02:032575 + patchPanel: PP:0105:1260379 + patchPanelPortA: '14' + patchPanelPortB: '15' + connectorType: LC COLOSinglePortNonLagDryRun: - $ref: "#/components/examples/COLOSinglePortNonLagCreateDryRun" + 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: '0x8100' + 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 COLOSinglePortLagDryRun: - $ref: "#/components/examples/COLOSinglePortLagCreateDryRun" + 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: '0x8100' + 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 REMOTESinglePortLag: - $ref: "#/components/examples/remoteSinglePortNewGroupLagRequest" + value: + type: XF_PORT + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + connectivitySourceType: REMOTE + physicalPortsCount: 1 + location: + metroCode: GV + demarcationPointIbx: GV1 + package: + code: STANDARD + lagEnabled: true + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + 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: - $ref: "#/components/examples/bmmrSinglePortLag" + value: + type: XF_PORT + connectivitySourceType: BMMR + location: + metroCode: SE + package: + code: STANDARD + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + account: + accountNumber: 200551 + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + redundancy: + priority: PRIMARY + lagEnabled: true + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + demarcationPointIbx: SE2 + bmmrType: SELF + notifications: + - type: TECHNICAL + registeredUsers: + - falconsExternalUser@seller.com + - type: NOTIFICATION + registeredUsers: + - falconsExternalUser@seller.com BMMRSinglePortNoLag: - $ref: "#/components/examples/bmmrSinglePortNoLag" + value: + type: XF_PORT + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + connectivitySourceType: BMMR + location: + metroCode: GV + demarcationPointIbx: GV1 + lagEnabled: false + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + project: + projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 + package: + code: STANDARD + 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: - $ref: "#/components/examples/bmmrAddSecondaryPort" + value: + type: XF_PORT + physicalPortsSpeed: 10000 + physicalPortsType: 1000BASE_LX + connectivitySourceType: BMMR + bmmrType: SELF + location: + metroCode: GV + demarcationPointIbx: GV1 + redundancy: + priority: SECONDARY + group: 1f6bdb37-f131-5925-c039-fe1785fad165 + lagEnabled: false + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + project: + projectId: '567' + package: + code: STANDARD + 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: - $ref: "#/components/examples/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: '0x8100' + 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 IXPublicPrivatePeeringPort: - $ref: "#/components/examples/createIXPublicPrivatePeeringPortRequest" + value: + type: XF_PORT + physicalPortsSpeed: 400000 + physicalPortsType: 400GBASE_LR4 + connectivitySourceType: COLO + location: + metroCode: GV + demarcationPointIbx: GV1 + lagEnabled: false + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + project: + projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 + account: + accountNumber: 270848 + notifications: + - registeredUsers: + - jaguarsuser-port-order + type: TECHNICAL + physicalPorts: + - demarcationPoint: + ibx: GV1 + cabinetUniqueSpaceId: Demarc + cageUniqueSpaceId: GV1:01:002174 + patchPanel: CP:Demarc:1259684 + connectorType: SC + serviceCode: IX IXPublicPeeringPort: - $ref: "#/components/examples/createIXPublicPeeringPortRequest" + value: + type: XF_PORT + physicalPortsSpeed: 400000 + physicalPortsType: 400GBASE_LR4 + connectivitySourceType: COLO + location: + metroCode: GV + demarcationPointIbx: GV1 + lagEnabled: false + encapsulation: + type: UNTAGGED + project: + projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 + account: + accountNumber: 270848 + notifications: + - registeredUsers: + - jaguarsuser-port-order + type: TECHNICAL + physicalPorts: + - demarcationPoint: + ibx: GV1 + cabinetUniqueSpaceId: Demarc + cageUniqueSpaceId: GV1:01:002174 + patchPanel: CP:Demarc:1259684 + connectorType: SC + serviceCode: IX required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Port" + $ref: '#/components/schemas/Port' examples: portDryRunExample: - $ref: "#/components/examples/PortCreateDryRunResponse" + value: + type: XF_PORT + physicalPortsType: 10GBASE_LR + physicalPortsSpeed: 10000 + physicalPortsCount: 1 + location: + metroCode: AM + demarcationPointIbx: AM1 + redundancy: + group: '1' + priority: PRIMARY + lagEnabled: true + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + package: + code: STANDARD + settings: + sharedPortType: false + project: + projectId: '567' + 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 bmmrPortDryRunExample: - $ref: "#/components/examples/bmmrSinglePortCreateDryRunResponse" + value: + type: XF_PORT + connectivitySourceType: BMMR + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + location: + metroCode: AT + demarcationPointIbx: AT1 + redundancy: + priority: PRIMARY + lagEnabled: false + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + package: + code: STANDARD + project: + projectId: b7c8d9e0-f1a2-4b3c-9d4e-5f6a7b8c9d0e + account: + accountNumber: 100001 + accountName: Test-Account + order: + purchaseOrder: + number: Fabric-PO-TEST-001 + amount: '1000' + startDate: '2025-01-01' + endDate: '2030-01-01' + type: EXISTING + signature: + signatory: SELF + delegate: + email: test-user@example.com + notifications: + - type: TECHNICAL + registeredUsers: + - test-technical-user + - type: NOTIFICATION + registeredUsers: + - test-notification-user + loas: + - uuid: a0b1c2d3-e4f5-4678-a6b7-c8d9e0f1a2b3 remotePortDryRunExample: - $ref: "#/components/examples/remoteSinglePortCreateDryRunResponse" - "202": + value: + type: XF_PORT + connectivitySourceType: REMOTE + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + location: + metroCode: AT + demarcationPointIbx: AT1 + redundancy: + priority: PRIMARY + lagEnabled: false + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + package: + code: STANDARD + project: + projectId: e3d4f5a6-7b8c-4d9e-a0b1-c2d3e4f56789 + account: + accountNumber: 100002 + accountName: Test-Account + order: + purchaseOrder: + number: Fabric-PO-TEST-002 + amount: '1000' + startDate: '2025-01-01' + endDate: '2030-01-01' + type: EXISTING + signature: + signatory: SELF + delegate: + email: test-user@example.com + notifications: + - type: TECHNICAL + registeredUsers: + - test-technical-user + - type: NOTIFICATION + registeredUsers: + - test-notification-user + loas: + - uuid: f1e2d3c4-b5a6-4978-8e0f-1a2b3c4d5e6f + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Port" + $ref: '#/components/schemas/Port' examples: COLOSinglePortNonLag: - $ref: "#/components/examples/coloSinglePortNonLagResponse" + value: + href: https://api.equinix.com/fabric/v4/ports/11abfba0-907f-460b-95ff-5a7bda4471ed + type: XF_PORT + uuid: 11abfba0-907f-460b-95ff-5a7bda4471ed + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + connectivitySourceType: COLO + project: + projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 + state: PENDING + order: + orderNumber: 1-233948565342 + uuid: d8ab29fe-e849-417d-b0a0-946e69dcd2ce + 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: + accountNumber: 96127367 + accountName: Jaguars_toronto__sig + ucmId: 86B71B7D-D0CC-4ee9-854D-A2C1AA7FA152 + changeLog: + createdBy: '923209' + createdDateTime: '2025-06-11T22:41:39.669Z' + location: + metroCode: TR + demarcationPointIbx: TR1 + redundancy: + priority: PRIMARY + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + lagEnabled: false + settings: + sharedPortType: false + package: + code: STANDARD + notifications: + - type: TECHNICAL + registeredUsers: + - jaguars-test-user-001 + - type: NOTIFICATION + registeredUsers: + - jaguars-test-user-001 + physicalPorts: + - demarcationPoint: + ibx: GV1 + cabinetUniqueSpaceId: Demarc + cageUniqueSpaceId: GV1:01:002174 + patchPanel: CP:Demarc:1259684 + connectorType: SC BMMRSinglePortLag: - $ref: "#/components/examples/bmmrSinglePortLagResponse" + value: + href: https://api.equinix.com/fabric/v4/ports/ed9d0b79-ff29-404a-b016-566435093afc + type: XF_PORT + uuid: ed9d0b79-ff29-404a-b016-566435093afc + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 0 + connectivitySourceType: BMMR + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + state: PENDING + order: + orderNumber: 1-289477804403 + uuid: b325f02c-69dd-41d2-838b-ea495c873e9d + account: + accountNumber: 200551 + accountName: gen-l2-qa-01-auto-200551 + ucmId: 83C58EBD-E231-4a8b-902E-0CFBE50E32C2 + changeLog: + createdBy: '1067822' + createdDateTime: '2025-06-21T00:15:48.414Z' + location: + metroCode: SE + demarcationPointIbx: SE2 + redundancy: + priority: PRIMARY + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + lagEnabled: true + package: + code: STANDARD + settings: + sharedPortType: false + notifications: + - type: TECHNICAL + registeredUsers: + - falconsExternalUser@seller.com + - type: NOTIFICATION + registeredUsers: + - falconsExternalUser@seller.com + additionalInfo: + - key: lagType + value: New REMOTESinglePortLag: - $ref: "#/components/examples/remoteSinglePortLagResponse" + value: + href: https://api.equinix.com/fabric/v4/ports/68adcd26-d66c-489d-9c72-8990b92a288e + type: XF_PORT + uuid: 68adcd26-d66c-489d-9c72-8990b92a288e + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + connectivitySourceType: REMOTE + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + state: PENDING + order: + orderNumber: 1-289477804403 + uuid: b325f02c-69dd-41d2-838b-ea495c873e9d + purchaseOrder: + type: EXEMPTION + account: + accountNumber: 200551 + accountName: gen-l2-qa-01-auto-200551 + ucmId: 83C58EBD-E231-4a8b-902E-0CFBE50E32C2 + changeLog: + createdBy: '1067822' + createdDateTime: '2025-06-21T00:15:48.414Z' + location: + metroCode: SE + demarcationPointIbx: SE2 + redundancy: + priority: PRIMARY + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + lagEnabled: true + package: + code: STANDARD + settings: + productCode: CX + sharedPortType: false + notifications: + - type: TECHNICAL + registeredUsers: + - falconsExternalUser@seller.com + - type: NOTIFICATION + registeredUsers: + - falconsExternalUser@seller.com + additionalInfo: + - key: lagType + value: New REMOTESinglePortLagWithOrderExemption: - $ref: "#/components/examples/remoteSinglePortLagWithPurchaseOrderExemption" + value: + type: XF_PORT + connectivitySourceType: REMOTE + location: + metroCode: AT + package: + code: STANDARD + settings: + sharedPortType: false + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + account: + accountNumber: 200551 + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + redundancy: + priority: PRIMARY + lagEnabled: true + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + demarcationPointIbx: AT1 + order: + purchaseOrder: + type: EXEMPTION + notifications: + - type: TECHNICAL + registeredUsers: + - falconsExternalUser@seller.com + - type: NOTIFICATION + registeredUsers: + - falconsExternalUser@seller.com + additionalInfo: + - key: lagType + value: New + loas: + - uuid: 2f78191c-0920-4f13-b1c7-2cef03d07570 IXPublicPrivatePeeringPort: - $ref: "#/components/examples/createIXPublicPrivatePeeringPortResponse" + value: + href: https://api.equinix.com/fabric/v4/ports/11abfba0-907f-460b-95ff-5a7bda4471ed + type: XF_PORT + uuid: 11abfba0-907f-460b-95ff-5a7bda4471ed + physicalPortsSpeed: 400000 + physicalPortsType: 400GBASE_LR4 + physicalPortsCount: 1 + connectivitySourceType: COLO + project: + projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 + state: PENDING + order: + orderNumber: 1-633948565342 + uuid: d8ab29fe-e849-417d-b0a0-946e69dcd2ce + account: + accountNumber: 270848 + accountName: Jaguars_toronto__sig + ucmId: 86B71B7D-D0CC-4ee9-854D-A2C1AA7FA152 + changeLog: + createdBy: '923209' + createdDateTime: '2025-06-11T22:41:39.669Z' + location: + metroCode: GV + demarcationPointIbx: GV1 + redundancy: + priority: PRIMARY + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + lagEnabled: false + settings: + sharedPortType: false + productCode: IX + notifications: + - type: TECHNICAL + registeredUsers: + - jaguars-test-user-001 + - type: NOTIFICATION + registeredUsers: + - jaguars-test-user-001 + physicalPorts: + - demarcationPoint: + ibx: GV1 + cabinetUniqueSpaceId: Demarc + cageUniqueSpaceId: GV1:01:002174 + patchPanel: CP:Demarc:1259684 + connectorType: SC IXPublicPeeringPort: - $ref: "#/components/examples/createIXPublicPeeringPortResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/ports/1babfba0-907f-460b-95ff-5a7bda4471ed + type: XF_PORT + uuid: 1babfba0-907f-460b-95ff-5a7bda4471ed + physicalPortsSpeed: 400000 + physicalPortsType: 400GBASE_LR4 + physicalPortsCount: 1 + connectivitySourceType: COLO + project: + projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 + state: PENDING + order: + orderNumber: 1-233948565342 + uuid: a8ab29fe-e849-417d-b0a0-946e69dcd2ce + account: + accountNumber: 270848 + accountName: Jaguars_toronto__sig + ucmId: 86B71B7D-D0CC-4ee9-854D-A2C1AA7FA152 + changeLog: + createdBy: '923209' + createdDateTime: '2025-06-11T22:41:39.669Z' + location: + metroCode: GV + demarcationPointIbx: GV1 + redundancy: + priority: PRIMARY + encapsulation: + type: UNTAGGED + lagEnabled: false + settings: + sharedPortType: false + productCode: IX + notifications: + - type: TECHNICAL + registeredUsers: + - jaguars-test-user-001 + - type: NOTIFICATION + registeredUsers: + - jaguars-test-user-001 + physicalPorts: + - demarcationPoint: + ibx: GV1 + cabinetUniqueSpaceId: Demarc + cageUniqueSpaceId: GV1:01:002174 + patchPanel: CP:Demarc:1259684 + connectorType: SC + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: validationError: - $ref: "#/components/examples/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-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 badRequest: - $ref: "#/components/examples/createPortBadRequest" - "401": + value: + - errorCode: EQ-3143004 + errorMessage: Json syntax error, please check request body + details: Unknown json property + correlationId: TEST + additionalInfo: + - property: encapsulation.type + reason: Unexpected value 'DOT1' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "500": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/ports/{portId}/physicalPorts/bulk: post: tags: @@ -5767,63 +23372,335 @@ paths: description: Port UUID required: true schema: - $ref: "#/components/schemas/PortUUID" + description: Port UUID + type: string + format: uuid requestBody: content: application/json: schema: - $ref: "#/components/schemas/BulkPhysicalPort" + $ref: '#/components/schemas/BulkPhysicalPort' examples: COLOAddToLag: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AllPhysicalPortsResponse" + $ref: '#/components/schemas/AllPhysicalPortsResponse' examples: COLOAddToLag: - $ref: "#/components/examples/coloAddToLagResponse" - "400": + 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 + uuid: bdfa360d-8ffb-4394-8905-56ea6ae3e87d + notifications: + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order + - 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 + uuid: bdfa360d-8ffb-4394-8905-56ea6ae3e87d + notifications: + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/port-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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-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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/ports/{portId}: get: tags: @@ -5837,46 +23714,202 @@ paths: description: Port UUID required: true schema: - $ref: "#/components/schemas/PortUUID" + description: Port UUID + type: string + format: uuid responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Port" + $ref: '#/components/schemas/Port' examples: portExample: - $ref: "#/components/examples/portByUUID" + value: + href: https://api.equinix.com/fabric/v4/ports/44c5712b-d704-4ca5-9b42-ee6be32ee06a + type: XF_PORT + uuid: 44c5712b-d704-4ca5-9b42-ee6be32ee06a + name: 270843-DA1-CX-PRI-33 + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + project: + projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 + package: + code: UNLIMITED + state: ACTIVE + cvpId: '2000833' + connectivitySourceType: COLO + operation: + operationalStatus: UP + connectionCount: 10 + evplVCCount: 10 + accessVCCount: 0 + account: + accountNumber: 270843 + accountName: ctr-sit-account1 + orgId: 93055 + organizationName: ctr-sit-account1-270843 + ucmId: 64726950-A62C-4749-98E2-5AA4CA44284F + globalCustId: 0016u000003JZ3XAAW + change: + uuid: ed41e367-e09d-4c2f-b6ab-30506de4437f + type: PORT_UPDATE + status: COMPLETED + data: + op: REPLACE + path: /encapsulation + value: + type: QINQ + tagProtocolId: '0x88a8' + createdDateTime: '2025-05-29T20:38:45.630759Z' + updatedDateTime: '2025-05-29T20:38:49.330822Z' + changeLog: + createdBy: qa-automation + createdDateTime: '2025-05-21T18:12:18.300Z' + updatedBy: qa-automation + updatedDateTime: '2025-05-29T20:38:48.900Z' + bandwidth: 1000 + availableBandwidth: 500 + usedBandwidth: 500 + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DA + region: AMER + metroName: Dallas + metroCode: DA + ibx: DA1 + device: + name: qa3-da-a1.lab + redundancy: + priority: PRIMARY + demarcationPointIbx: DA1 + tetherIbx: DA1 + redundancy: + priority: PRIMARY + encapsulation: + type: QINQ + tagProtocolId: '0x88a8' + lagEnabled: false + settings: + buyout: true + viewPortPermission: true + placeVcOrderPermission: true + physicalPorts: + - type: XF_PHYSICAL_PORT + id: 1426359 + state: ADDED + bandwidth: 0 + uuid: 0189244a-f3ac-7258-a8b4-3167af899305 + tether: + crossConnectId: '513213223' + ibx: DA1 + demarcationPoint: + ibx: DA1 + operation: + operationalStatus: UP maintenanceScheduledPortExample: - $ref: "#/components/examples/maintenanceScheduledPortByUUID" - "400": + value: + href: https://api.equinix.com/fabric/v4/ports/44c5712b-d704-4ca5-9b42-ee6be32ee06a + type: XF_PORT + uuid: 44c5712b-d704-4ca5-9b42-ee6be32ee06a + name: 270843-DA1-CX-PRI-33 + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + project: + projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 + package: + code: UNLIMITED + state: ACTIVE + connectivitySourceType: COLO + operation: + operationalStatus: UP + connectionCount: 10 + evplVCCount: 10 + accessVCCount: 0 + maintenanceStatus: SCHEDULED + lockEnabled: true + account: + accountNumber: 270843 + accountName: ctr-sit-account1 + orgId: 93055 + organizationName: ctr-sit-account1-270843 + ucmId: 64726950-A62C-4749-98E2-5AA4CA44284F + globalCustId: 0016u000003JZ3XAAW + changeLog: + createdBy: admin_user + createdDateTime: '2025-05-21T18:12:18.300Z' + updatedBy: test_user + updatedDateTime: '2025-05-29T20:38:48.900Z' + bandwidth: 1000 + availableBandwidth: 500 + usedBandwidth: 500 + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DA + region: AMER + metroName: Dallas + metroCode: DA + ibx: DA1 + demarcationPointIbx: DA1 + tetherIbx: DA1 + redundancy: + priority: PRIMARY + encapsulation: + type: QINQ + tagProtocolId: '0x88a8' + lagEnabled: false + physicalPorts: + - type: XF_PHYSICAL_PORT + state: ADDED + bandwidth: 0 + uuid: 0189244a-f3ac-7258-a8b4-3167af899305 + tether: + crossConnectId: '513213223' + ibx: DA1 + demarcationPoint: + ibx: DA1 + operation: + operationalStatus: UP + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400" - "403": + value: + - errorCode: EQ-3046115 + errorMessage: Invalid Path Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: pathparameter-portUuid + reason: Provide valid port Uuid + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "500": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH delete: tags: - Ports @@ -5889,7 +23922,9 @@ paths: description: Port UUID required: true schema: - $ref: "#/components/schemas/PortUUID" + description: Port UUID + type: string + format: uuid - name: dryRun in: query description: option to verify that API calls will succeed @@ -5898,48 +23933,165 @@ paths: type: boolean default: false responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Port" + $ref: '#/components/schemas/Port' examples: portDryRunExample: - $ref: "#/components/examples/portDryRunDelete" - "202": + value: + type: XF_PORT + uuid: e91484bb-4f65-4ab3-8f77-500dec2f855d + name: test-AT1-Dot1q-L-Secondary-108608 + physicalPortsType: 10GBASE_LR + physicalPortsSpeed: 10000 + physicalPortsCount: 1 + location: + metroCode: AM + demarcationPointIbx: AM1 + redundancy: + group: '1' + priority: PRIMARY + lagEnabled: true + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + package: + code: STANDARD + settings: + sharedPortType: false + project: + projectId: '567' + 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 + physicalPorts: + - 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' + '202': description: Accepted content: application/json: schema: - $ref: "#/components/schemas/Port" + $ref: '#/components/schemas/Port' examples: portExample: - $ref: "#/components/examples/portDelete" - "400": + 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: '0x8100' + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400" - "401": + value: + - errorCode: EQ-3046115 + errorMessage: Invalid Path Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: pathparameter-portUuid + reason: Provide valid port Uuid + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "404": + value: + - errorCode: EQ-3046117 + errorMessage: Unauthorized user. + correlationId: TEST + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' patch: tags: - Ports @@ -5952,7 +24104,9 @@ paths: description: Port UUID required: true schema: - $ref: "#/components/schemas/PortUUID" + description: Port UUID + type: string + format: uuid - name: dryRun in: query description: option to verify that API calls will succeed @@ -5964,65 +24118,244 @@ paths: content: application/json-patch+json: schema: - $ref: "#/components/schemas/PortUpdateRequest" + $ref: '#/components/schemas/PortUpdateRequest' examples: PortUpdateNameRequest: - $ref: "#/components/examples/portUpdateNameRequest" + value: + - op: replace + path: /name + value: 1234-ibx-port PortUpdateEncapsulationAndTagprotocolIdRequest: - $ref: "#/components/examples/portUpdateEncapsulationAndTagProtocolIdRequest" + value: + - op: replace + path: /encapsulation + value: + type: DOT1Q + tagProtocolId: '0x8100' PortUpdateNameDryRunRequest: - $ref: "#/components/examples/PortUpdateNameDryRunRequest" + value: + - op: replace + path: /name + value: 1234-ibx-port PortUpdateLagEnabledRequest: - $ref: "#/components/examples/portUpdateLagEnabledRequest" + value: + - op: replace + path: /lagEnabled + value: true required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AllPortsResponse" + $ref: '#/components/schemas/AllPortsResponse' examples: portDryRunExample: - $ref: "#/components/examples/PortUpdateDryRunResponse" - "202": + 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 + physicalPortsSpeed: 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: '0x8100' + 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 + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Port" + $ref: '#/components/schemas/Port' examples: portExample: - $ref: "#/components/examples/portPatchResponse202" - "400": + value: + href: https://api.equinix.com/fabric/v4/ports/44c5712b-d704-4ca5-9b42-ee6be32ee06a + type: XF_PORT + uuid: 08693250-e67f-431f-b1ac-d3204263876a + name: 290061-SV1-NE-Shared-CX-PRI-01 + physicalPortsSpeed: 10000 + physicalPortsType: 10GBASE_LR + physicalPortsCount: 1 + project: + projectId: '377533000114703' + state: REPROVISIONING + cvpId: '2001190' + account: + accountNumber: 290061 + ucmId: BD8EB6F3-F8EF-40dc-8AAF-032B85804920 + change: + type: PORT_UPDATE + status: REQUESTED + data: + op: REPLACE + path: /encapsulation + value: + type: DOT1Q + tagProtocolId: '0x8100' + bandwidth: 10000 + location: + metroName: Silicon Valley + metroCode: SV + device: + name: qa3-sv-em-e3.lab + redundancy: + priority: PRIMARY + configModel: UPF + demarcationPointIbx: SV5 + encapsulation: + type: QINQ + tagProtocolId: '0x9100' + lagEnabled: true + settings: + buyout: false + additionalInfo: + - key: crossConnectId + value: 21918108-A + package: + code: STANDARD + physicalPorts: + - tether: + crossConnectId: 21918108-A + patchPanel: CP:Demarc:1257694 + patchPanelPortA: '21' + patchPanelPortB: '22' + demarcationPoint: + patchPanelPortA: '18' + patchPanelPortB: '19' + ibx: SV1 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidUUID: - $ref: "#/components/examples/400" + value: + - errorCode: EQ-3046115 + errorMessage: Invalid Path Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: pathparameter-portUuid + reason: Provide valid port Uuid ResourceUsedError: - $ref: "#/components/examples/portPatchMultipleConnections400Response" - "403": + value: + - errorCode: EQ-3143253 + errorMessage: Port is used by one or more Connections, connectors, subscriptions and/or tokens + details: There are 9 Connections/ connectors/ subscriptions/ tokens associated to this port + correlationId: TEST + additionalInfo: + - property: /uuid + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "500": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3143001 + errorMessage: Internal Error + details: Internal system error + correlationId: 5c340fe0-48bd-11f0-9332-c344b6c9d7d7 + - errorCode: IC-USR-014-01 + errorMessage: Error in getting user's profile /fabric/v4/ports/{portUuid}/linkProtocols: get: tags: @@ -6050,39 +24383,229 @@ paths: description: Port UUID required: true schema: - $ref: "#/components/schemas/PortUUID" + description: Port UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Get Vlans content: application/json: schema: - $ref: "#/components/schemas/LinkProtocolGetResponse" + $ref: '#/components/schemas/LinkProtocolGetResponse' examples: LinkProtocolQ1NQResponse: - $ref: "#/components/examples/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' LinkProtocolDOT1QResponse: - $ref: "#/components/examples/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' LinkProtocolVlanRangeResponse: - $ref: "#/components/examples/LinkProtocolGetVlanRangeResponseExample" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_portId" - "403": + 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': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403-port-access" + value: + - errorCode: EQ-3035002 + errorMessage: Access Forbidden + correlationId: UnAuthorized User- Cannot perform action /fabric/v4/ports/search: post: tags: @@ -6090,75 +24613,357 @@ paths: 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" + $ref: '#/components/schemas/PortV4SearchRequest' examples: PortSearchDirection: - $ref: "#/components/examples/portSearchByProjectId" + value: + filter: + or: + - and: + - property: /state + operator: '=' + values: + - ACTIVE + - REPROVISIONING + - property: /settings/productCode + operator: '=' + values: + - CX + - property: /project/projectId + operator: '=' + values: + - 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 + pagination: + limit: 1000 + offset: 0 + sort: + - property: /device/name + direction: DESC PortSearchOptionalFilter: - $ref: "#/components/examples/portSearchByOptionalFilters" + value: + filter: + or: + - and: + - property: /device/name + operator: '=' + values: + - qa3-sv-em-e3.lab + - property: /physicalPorts/tether/crossConnectId + operator: '=' + values: + - 21918108-A + - property: /physicalPorts/interface/name + operator: '=' + values: + - et-0/0/0 + - property: /uuid + operator: '=' + values: + - 08693250-e67f-431f-b1ac-d3204263876a + - property: /name + operator: LIKE + values: + - port-name + - property: /account/orgId + operator: '=' + values: + - '94513' + - property: /account/accountNumber + operator: '=' + values: + - '290061' + - property: /location/metroCode + operator: IN + values: + - SV + pagination: + limit: 1000 + offset: 0 + sort: + - property: /device/name + direction: DESC PortSearchRangeOperators: - $ref: "#/components/examples/portSearchRangeOperators" + value: + filter: + or: + - and: + - property: /changeLog/createdDateTime + operator: BETWEEN + values: + - '2023-06-27T15:05:37Z' + - '2023-07-27T15:05:37Z' + - property: /badwidth + operator: '>=' + values: + - '1000' + pagination: + limit: 1000 + offset: 0 + sort: + - property: /changeLog/createdDateTime + direction: DESC PortSearchByMaintenanceStatus: - $ref: "#/components/examples/portSearchByMaintenanceStatus" + value: + filter: + and: + - property: /operation/maintenanceStatus + operator: IN + values: + - SCHEDULED + - COMPLETED + - property: /operation/lockEnabled + operator: IN + values: + - 'true' + pagination: + limit: 25 + offset: 0 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AllPortsResponse" + $ref: '#/components/schemas/AllPortsResponse' examples: portExample: - $ref: "#/components/examples/ports" - "400": + value: + pagination: + offset: 0 + limit: 1000 + total: 2 + data: + - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-02db-2dbc-ace0-30fa5c00ad04 + type: XF_PORT + uuid: c4d93b39-02db-2dbc-ace0-30fa5c00ad04 + name: gen-l2-qa-01-auto-TY4-L-Qinq-STD-SEC-10G-JUN-598 + physicalPortsSpeed: 10000 + physicalPortsType: 10GBASE_LR + connectivitySourceType: COLO + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + package: + code: STANDARD + state: REPROVISIONING + cvpId: '1616554' + operation: + connectionCount: 0 + evplVCCount: 0 + accessVCCount: 0 + account: + accountNumber: 200559 + accountName: gen-l2-qa-01-auto-200559 + orgId: 90946 + organizationName: gen-l2-qa-01-auto-200551. + ucmId: 500DFED2-EBDB-480d-896C-C7870E52D0D8 + globalCustId: 0017i000011X242AAC + changeLog: + createdBy: vvyugovskiy-IMPORT_JOB + createdDateTime: '2021-06-16T01:46:52Z' + updatedBy: Order-to-activation + updatedDateTime: '2025-04-07T23:03:08.900Z' + bandwidth: 10000 + availableBandwidth: 10000 + usedBandwidth: 0 + location: + metroHref: https://api.equinix.com/fabric/v4/metros/TY + region: APAC + metroName: Tokyo + metroCode: TY + ibx: TY4 + device: + name: sit-tb1-ty-a2.lab + redundancy: + priority: SECONDARY + demarcationPointIbx: TY4 + tetherIbx: TY4 + redundancy: + priority: SECONDARY + encapsulation: + type: QINQ + tagProtocolId: '0x9100' + lagEnabled: false + settings: + buyout: false + physicalPorts: + - type: XF_PHYSICAL_PORT + id: 1362185 + state: TO_BE_ADDED + uuid: 01892489-ce9b-7f25-b1f5-d32a5ac6a423 + tether: + crossConnectId: ECX.05.00001836 + cabinetNumber: Demarc + systemName: TY4:01:002181 + patchPanel: PP:1240:1089399 + patchPanelPortA: '7' + patchPanelPortB: '8' + ibx: TY4 + demarcationPoint: + patchPanel: PP:Demarc:00002181 + patchPanelName: PP:Demarc:00002181 + patchPanelPortA: '5' + patchPanelPortB: '6' + ibx: TY4 + operation: + operationalStatus: UP + - href: https://api.equinix.com/fabric/v4/ports/6f0f3015-2d51-4b6e-a98c-1defb4fe88f1 + type: XF_PORT + uuid: 6f0f3015-2d51-4b6e-a98c-1defb4fe88f1 + name: 200558-SY4-CX-PRI-02 + physicalPortsSpeed: 10000 + physicalPortsType: 10GBASE_LR + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + package: + code: STANDARD + state: ACTIVE + cvpId: '2000348' + operation: + connectionCount: 1 + evplVCCount: 1 + accessVCCount: 0 + maintenanceStatus: SCHEDULED + lockEnabled: true + account: + accountNumber: 200558 + accountName: Gen-L2-Qa-01-Auto-200558 + orgId: 90946 + organizationName: gen-l2-qa-01-auto-200551. + ucmId: 2D26D682-B62E-495d-AFDF-698EC3B353F8 + globalCustId: 0017i000011X242AAC + changeLog: + createdDateTime: '2025-05-06T17:29:30.800Z' + updatedBy: API + updatedDateTime: '2025-05-06T17:29:40.300Z' + bandwidth: 10000 + availableBandwidth: 9500 + usedBandwidth: 500 + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SY + region: APAC + metroName: Sydney + metroCode: SY + ibx: SY4 + device: + name: sit-tb1-sy-e1.lab + redundancy: + group: '1' + priority: PRIMARY + demarcationPointIbx: SY4 + tetherIbx: SY4 + redundancy: + priority: PRIMARY + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + lagEnabled: true + settings: + buyout: false + physicalPorts: + - type: XF_PHYSICAL_PORT + id: 1362737 + state: ACTIVE + uuid: 01892489-ce07-7962-b676-b1a4d8091515 + tether: + crossConnectId: '22035616' + cabinetNumber: Demarc + systemName: SY4:01:002204 + patchPanel: PP:1240:1089399 + patchPanelPortA: '12' + patchPanelPortB: '14' + ibx: SY4 + demarcationPoint: + patchPanel: PP:Demarc:00002204 + patchPanelName: PP:Demarc:00002204 + patchPanelPortA: '17' + patchPanelPortB: '18' + ibx: SY4 + operation: + operationalStatus: UP + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: invalidUuid: - $ref: "#/components/examples/400" + value: + - errorCode: EQ-3046115 + errorMessage: Invalid Path Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: pathparameter-portUuid + reason: Provide valid port Uuid invalidProjectIdRequest: - $ref: "#/components/examples/portSearchInvalidProjectRequest" + value: + - errorCode: EQ-3046110 + errorMessage: ProjectID required. + details: ProjectId and ports are not found for the user + correlationId: TEST + additionalInfo: + - property: /project/projectId + reason: ' before searching for ports, assign project and ports' invalidRequest: - $ref: "#/components/examples/portSearchInvalidRequest" + value: + - errorCode: EQ-3046116 + errorMessage: JSON syntax error. + details: Unknown json property + correlationId: TEST + additionalInfo: + - property: filter.or.[0].and.[1].property + reason: Unexpected value '/settings/productCod' invalidSearchFieldProperty: - $ref: "#/components/examples/portSearchInvalidSearchFieldProperty" + value: + - errorCode: EQ-3046116 + errorMessage: JSON syntax error. + details: Please refer the contracts for correct fields + correlationId: TEST invalidSearchFieldArgument: - $ref: "#/components/examples/portSearchInvalidSearchFieldArgument" - "401": + value: + - errorCode: EQ-3046112 + errorMessage: Invalid argument value. + details: Please refer the contracts for correct fields + correlationId: TEST + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "404": + value: + - errorCode: EQ-3046117 + errorMessage: Unauthorized user. + correlationId: TEST + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Service Unavailable content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: portExample: - $ref: "#/components/examples/ports-500" + value: + - errorCode: EQ-3046030 + errorMessage: Internal error. + details: Internal system error userFailureExample: - $ref: "#/components/examples/ports-500-user-failure" + value: + - errorCode: IC-USR-014-01 + errorMessage: Error in getting user's profile /fabric/v4/portPackages: get: tags: @@ -6166,53 +24971,102 @@ paths: summary: List Port Packages description: Get All Port Packages returns details of all available port packages for the specified user credentials operationId: getPortPackages - parameters: [] responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AllPortPackagesResponse" + $ref: '#/components/schemas/AllPortPackagesResponse' examples: portPackagesExample: - $ref: "#/components/examples/port-packages" - "401": + value: + data: + - href: /fabric/v4/portPackages/XF_UNLIMITED_PLUS + type: PORT_PACKAGE + code: XF_UNLIMITED_PLUS + vcBandwidthMax: 100000 + vcRemoteSupported: true + supportedServiceTypes: + - MSP + supportedSourceTypes: + - COLO + supportedMetros: + - SV + - DA + - href: /fabric/v4/portPackages/XF_UNLIMITED + type: PORT_PACKAGE + code: XF_UNLIMITED + vcBandwidthMax: 100000 + vcRemoteSupported: false + supportedServiceTypes: + - MSP + supportedSourceTypes: + - REMOTE + - COLO + - href: /fabric/v4/portPackages/XF_STANDARD + type: PORT_PACKAGE + code: XF_STANDARD + vcBandwidthMax: 100000 + vcRemoteSupported: false + supportedServiceTypes: + - MSP + supportedSourceTypes: + - BMMR + - REMOTE + - COLO + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: portPackagesInternalErrorExample: - $ref: "#/components/examples/port-packages-500" + value: + - errorCode: EQ-3143001 + errorMessage: Internal Error + details: Internal system error + correlationId: 80066c00-0f20-11f0-8367-d5075ee362a7 /fabric/v4/connections/{connectionId}/routeAggregations: get: tags: @@ -6226,73 +25080,125 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetAllConnectionRouteAggregationsResponse" + $ref: '#/components/schemas/GetAllConnectionRouteAggregationsResponse' examples: ConnectionRouteAggregationsResponse: - $ref: "#/components/examples/ConnectionRouteAggregationsGetAll" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 4 + 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_IPv4_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_IPv4_PREFIX_AGGREGATION + uuid: 65d74639-8f48-4e10-9684-45d364645e97 + attachmentStatus: ATTACHED + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/connections/{connectionId}/routeAggregations/{routeAggregationId}: get: tags: @@ -6306,79 +25212,116 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteAggregationData" + $ref: '#/components/schemas/ConnectionRouteAggregationData' examples: ConnectionRouteAggregationAttachResponse: - $ref: "#/components/examples/AttachConnectionRouteAggregationsResponse" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 put: tags: - Route Aggregations @@ -6391,77 +25334,110 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteAggregationData" + $ref: '#/components/schemas/ConnectionRouteAggregationData' examples: ConnectionRouteAggregationAttachResponse: - $ref: "#/components/examples/AttachConnectionRouteAggregationsResponse" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: TransientState: - $ref: "#/components/examples/400_transient_state" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 delete: tags: - Route Aggregations @@ -6474,77 +25450,110 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteAggregationData" + $ref: '#/components/schemas/ConnectionRouteAggregationData' examples: ConnectionRouteAggregationDetachResponse: - $ref: "#/components/examples/DetachConnectionRouteAggregationResponse" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_transient_state" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/connections/{connectionId}/routeFilters: get: tags: @@ -6558,73 +25567,129 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetAllConnectionRouteFiltersResponse" + $ref: '#/components/schemas/GetAllConnectionRouteFiltersResponse' examples: ConnectionRouteFiltersResponse: - $ref: "#/components/examples/ConnectionRouteFiltersGetAll" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 4 + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}: get: tags: @@ -6638,79 +25703,117 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteFilterData" + $ref: '#/components/schemas/ConnectionRouteFilterData' examples: ConnectionRouteFilterAttachResponse: - $ref: "#/components/examples/AttachConnectionRouteFiltersResponse" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 put: tags: - Route Filters @@ -6723,90 +25826,131 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteFiltersBase" + $ref: '#/components/schemas/ConnectionRouteFiltersBase' examples: ConnectionRouteFilterAttachInboundExample: - $ref: "#/components/examples/AttachConnectionRouteFilterInbound" + value: + direction: INBOUND ConnectionRouteFilterAttachOutboundExample: - $ref: "#/components/examples/AttachConnectionRouteFilterOutbound" + value: + direction: OUTBOUND required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteFilterData" + $ref: '#/components/schemas/ConnectionRouteFilterData' examples: ConnectionRouteFilterAttachResponse: - $ref: "#/components/examples/AttachConnectionRouteFiltersResponse" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidDirection: - $ref: "#/components/examples/400_invalid_direction" + value: + - errorCode: EQ-3044001 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: direction TransientState: - $ref: "#/components/examples/400_transient_state" - "401": + value: + - errorCode: EQ-3044008 + errorMessage: Cannot attach or detach route filter with connection in transient state + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Cannot attach or detach route filter with connection in transient state + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 delete: tags: - Route Filters @@ -6819,79 +25963,118 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteFilterData" + $ref: '#/components/schemas/ConnectionRouteFilterData' examples: ConnectionRouteFilterDetachInboundResponse: - $ref: "#/components/examples/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 ConnectionRouteFilterDetachOutboundResponse: - $ref: "#/components/examples/DetachConnectionRouteFilterOutboundResponse" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_transient_state" - "401": + value: + - errorCode: EQ-3044008 + errorMessage: Cannot attach or detach route filter with connection in transient state + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Cannot attach or detach route filter with connection in transient state + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters: post: tags: @@ -6899,82 +26082,136 @@ paths: summary: Create Route Filter description: This API provides capability to create a Route Filter operationId: createRouteFilter - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersBase" + $ref: '#/components/schemas/RouteFiltersBase' examples: RouteFilterBgpIpv4Prefix: - $ref: "#/components/examples/RouteFilterCreateBgpIpv4Prefix" + value: + type: BGP_IPv4_PREFIX_FILTER + name: My-route-filter-v4 + description: Test filter + project: + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 RouteFilterBgpIpv6Prefix: - $ref: "#/components/examples/RouteFilterCreateBgpIpv6Prefix" + value: + type: BGP_IPv6_PREFIX_FILTER + name: My-route-filter-v6 + description: Test filter + project: + projectId: '567' required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersData" + $ref: '#/components/schemas/RouteFiltersData' examples: GetSpecificRouteFilterResponse: - $ref: "#/components/examples/RouteFilterCreateBgpIpv4PrefixResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: TransientState: - $ref: "#/components/examples/400_transient_state" - "401": + value: + - errorCode: EQ-3044008 + errorMessage: Cannot attach or detach route filter with connection in transient state + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Cannot attach or detach route filter with connection in transient state + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}: get: tags: @@ -6988,73 +26225,124 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersData" + $ref: '#/components/schemas/RouteFiltersData' examples: GetSpecificRouteFilterResponse: - $ref: "#/components/examples/RouteFilterCreateBgpIpv4PrefixResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 delete: tags: - Route Filters @@ -7067,71 +26355,126 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersData" + $ref: '#/components/schemas/RouteFiltersData' examples: RouteFilterDeleteBgpIpv4PrefixResponse: - $ref: "#/components/examples/RouteFilterDeleteBgpIpv4PrefixResponse" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_attached_connection" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 patch: tags: - Route Filters @@ -7144,86 +26487,139 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersPatchRequest" + $ref: '#/components/schemas/RouteFiltersPatchRequest' examples: RouteFilterNamePatchExample: - $ref: "#/components/examples/PatchRouteFilterName" + value: + - op: replace + path: /name + value: My-route-filter-v4-updated application/json-patch+json: schema: - $ref: "#/components/schemas/RouteFiltersPatchRequest" + $ref: '#/components/schemas/RouteFiltersPatchRequest' examples: RouteFilterNamePatchExample: - $ref: "#/components/examples/PatchRouteFilterName" + value: + - op: replace + path: /name + value: My-route-filter-v4-updated required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersData" + $ref: '#/components/schemas/RouteFiltersData' examples: RouteFilterNamePatchResponse: - $ref: "#/components/examples/RouteFilterNamePatchResponse" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation" - "401": + value: + - errorCode: EQ-3044011 + errorMessage: Invalid argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Only replace name operation is supported. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}/changes: get: tags: @@ -7237,7 +26633,9 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: offset in: query description: offset @@ -7253,62 +26651,126 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Fabric Route Filter Change object content: application/json: schema: - $ref: "#/components/schemas/RouteFilterChangeDataResponse" + $ref: '#/components/schemas/RouteFilterChangeDataResponse' examples: RouteFilterChangesResponse: - $ref: "#/components/examples/RouteFilterGetAllChangesResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: replace + path: /name + value: + type: BGP_IPv4_PREFIX_FILTER + name: My-route-filter-v4-updated + description: Test filter + project: + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}/changes/{changeId}: get: tags: @@ -7322,70 +26784,115 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: changeId in: path description: Routing Protocol Change UUID required: true schema: - $ref: "#/components/schemas/ChangeId_1" + description: Route Filters Change UUID + type: string + format: uuid + example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: - "200": + '200': description: Fabric Route Filter Change object content: application/json: schema: - $ref: "#/components/schemas/RouteFilterChangeData" + $ref: '#/components/schemas/RouteFilterChangeData' examples: RouteFilterChangeResponse: - $ref: "#/components/examples/RouteFilterGetChangeResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + type: BGP_IPv4_PREFIX_FILTER + name: My-route-filter-v4 + description: Test filter + project: + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}/connections: get: tags: @@ -7399,73 +26906,115 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetRouteFilterGetConnectionsResponse" + $ref: '#/components/schemas/GetRouteFilterGetConnectionsResponse' examples: RouteFilterGetConnectionsResponse: - $ref: "#/components/examples/RouteFilterGetConnectionsResponse" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/search: post: tags: @@ -7473,86 +27022,212 @@ paths: summary: Search Route Filters description: This API provides capability to search Route Filters operationId: searchRouteFilters - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersSearchRequest" + $ref: '#/components/schemas/RouteFiltersSearchRequest' examples: searchRouteFiltersAndRequest: - $ref: "#/components/examples/SearchRouteFiltersAndRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_FILTER + - property: /state + operator: IN + values: + - PROVISIONED + - PROVISIONING + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC searchRouteFiltersOrRequest: - $ref: "#/components/examples/SearchRouteFiltersOrRequest" + value: + filter: + or: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_FILTER + - property: /name + operator: LIKE + values: + - '%Route_Filter_Demo%' + - property: /project/projectId + operator: IN + values: + - dadd3ab6-c0af-430c-8216-43d44f08c1c5 + - 4f08c1c6-c0af-430c-8216-43d44f08c1c5 + pagination: + offset: 1 + limit: 2 + sort: + - property: /changeLog/updatedDateTime + direction: DESC searchRouteFiltersNestedRequest: - $ref: "#/components/examples/SearchRouteFiltersNestedRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_FILTER + - property: /changeLog/createdDateTime + operator: '>' + values: + - '2025-03-28T04:12:36.607Z' + - or: + - property: /name + operator: LIKE + values: + - '%Demo%' + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersSearchResponse" + $ref: '#/components/schemas/RouteFiltersSearchResponse' examples: SearchRouteFiltersResponse: - $ref: "#/components/examples/SearchRouteFiltersResponse" - "400": + value: + pagination: + offset: 1 + limit: 2 + total: 10 + next: /search?offset=3&limit=2 + previous: /search?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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules: get: tags: @@ -7566,7 +27241,9 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: offset in: query description: offset @@ -7582,57 +27259,115 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetRouteFilterRulesResponse" + $ref: '#/components/schemas/GetRouteFilterRulesResponse' examples: getAllRouteFilterRules: - $ref: "#/components/examples/RouteFilterRulesGetAll" - "400": + 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: BGP_IPv4_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: BGP_IPv4_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' + '400': description: Resource not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044201 + errorMessage: Route filter rule Id not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter Rule ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 post: tags: - Route Filter Rules @@ -7645,83 +27380,164 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesBase" + $ref: '#/components/schemas/RouteFilterRulesBase' examples: RouteFilterRuleBgpIpv4Prefix: - $ref: "#/components/examples/RouteFilterRuleCreateBgpIpv4Prefix" + value: + name: Private-subnet-filter + description: Test rule + prefix: 192.168.0.0/24 + prefixMatch: exact RouteFilterRuleBgpIpv6Prefix: - $ref: "#/components/examples/RouteFilterRuleCreateBgpIpv6Prefix" + value: + name: Private-subnet-filter + description: Test rule + prefix: 2001:7a9::34f4:0:f3dd:1/126 + prefixMatch: orlonger required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesData" + $ref: '#/components/schemas/RouteFilterRulesData' examples: GetSpecificRouteFilterRuleIpv4Response: - $ref: "#/components/examples/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' GetSpecificRouteFilterRuleIpv6Response: - $ref: "#/components/examples/RouteFilterRuleCreateBgpIpv6PrefixResponse" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidType: - $ref: "#/components/examples/400_bad_request" + value: + - errorCode: EQ-3044013 + errorMessage: Invalid argument value passed + additionalInfo: + - property: prefixMatch + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter Rule ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "415": + $ref: '#/components/schemas/ErrorList' + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}: get: tags: @@ -7735,264 +27551,509 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: - $ref: "#/components/schemas/RouteFilterRuleId" + description: Route Filter Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesData" + $ref: '#/components/schemas/RouteFilterRulesData' examples: GetSpecificRouteFilterRuleIpv4Response: - $ref: "#/components/examples/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' GetSpecificRouteFilterRuleIpv6Response: - $ref: "#/components/examples/RouteFilterRuleCreateBgpIpv6PrefixResponse" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidType: - $ref: "#/components/examples/400_bad_request" + value: + - errorCode: EQ-3044013 + errorMessage: Invalid argument value passed + additionalInfo: + - property: prefixMatch + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" - put: + value: + - errorCode: EQ-3044011 + 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 + delete: tags: - Route Filter Rules - summary: Replace Route Filter Rule - description: This API provides capability to replace a Route Filter Rule completely - operationId: replaceRouteFilterRuleByUuid + 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" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - 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 + description: Route Filter Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesData" + $ref: '#/components/schemas/RouteFilterRulesData' examples: - RouteFilterRuleIpv4ReplaceResponse: - $ref: "#/components/examples/RouteFilterRuleReplaceIpv4Response" - routeFilterRuleIpv6ReplaceResponse: - $ref: "#/components/examples/RouteFilterRuleReplaceIpv6Response" - "400": + RouteFilterDeleteBgpIpv4PrefixResponse: + 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' + routeFilterDeleteBgpIpv6PrefixResponse: + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: - InvalidType: - $ref: "#/components/examples/400_bad_request" - InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" - delete: + value: + - errorCode: EQ-3044011 + 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 + put: tags: - Route Filter Rules - summary: Delete Route Filter Rule - description: This API provides capability to delete a Route Filter Rule - operationId: deleteRouteFilterRuleByUuid + 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" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: - $ref: "#/components/schemas/RouteFilterRuleId" + description: Route Filter Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RouteFilterRulesBase' + examples: + RouteFilterIpv4ReplaceExample: + value: + name: Private-subnet-filter-update + description: Test rule + prefix: 192.168.0.0/24 + prefixMatch: exact + RouteFilterIpv6ReplaceExample: + value: + name: Private-subnet-filter-update + description: Test rule + prefix: 2001:7a9::34f4:0:f3dd:1/126 + prefixMatch: exact + required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesData" + $ref: '#/components/schemas/RouteFilterRulesData' examples: - RouteFilterDeleteBgpIpv4PrefixResponse: - $ref: "#/components/examples/RouteFilterRuleDeleteBgpIpv4PrefixResponse" - routeFilterDeleteBgpIpv6PrefixResponse: - $ref: "#/components/examples/RouteFilterRuleDeleteBgpIpv6PrefixResponse" - "400": + RouteFilterRuleIpv4ReplaceResponse: + 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' + routeFilterRuleIpv6ReplaceResponse: + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: - example: - $ref: "#/components/examples/400_transient_filter" - "401": + InvalidType: + value: + - errorCode: EQ-3044013 + errorMessage: Invalid argument value passed + additionalInfo: + - property: prefixMatch + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + InvalidId: + value: + - errorCode: EQ-3044201 + errorMessage: Route filter rule Id not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 patch: tags: - Route Filter Rules @@ -8005,104 +28066,200 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: - $ref: "#/components/schemas/RouteFilterRuleId" + description: Route Filter Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesPatchRequest" + $ref: '#/components/schemas/RouteFilterRulesPatchRequest' examples: RouteFilterRuleName: - $ref: "#/components/examples/PatchRouteFilterRuleName" + value: + - op: replace + path: /name + value: test-route-filter-name-patch RouteFilterRulePrefix: - $ref: "#/components/examples/PatchRouteFilterRulePrefix" + value: + - op: replace + path: /prefix + value: 192.168.0.0/30 RouteFilterRulePrefixMatch: - $ref: "#/components/examples/PatchRouteFilterRulePrefixMatch" + value: + - op: replace + path: /prefixMatch + value: orlonger application/json-patch+json: schema: - $ref: "#/components/schemas/RouteFilterRulesPatchRequest" + $ref: '#/components/schemas/RouteFilterRulesPatchRequest' examples: RouteFilterRuleName: - $ref: "#/components/examples/PatchRouteFilterRuleName" + value: + - op: replace + path: /name + value: test-route-filter-name-patch RouteFilterRulePrefix: - $ref: "#/components/examples/PatchRouteFilterRulePrefix" + value: + - op: replace + path: /prefix + value: 192.168.0.0/30 RouteFilterRulePrefixMatch: - $ref: "#/components/examples/PatchRouteFilterRulePrefixMatch" + value: + - op: replace + path: /prefixMatch + value: orlonger required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesData" + $ref: '#/components/schemas/RouteFilterRulesData' examples: RouteFilterRuleIpv4ReplaceResponse: - $ref: "#/components/examples/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' routeFilterRuleIpv6ReplaceResponse: - $ref: "#/components/examples/RouteFilterRuleReplaceIpv6Response" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidType: - $ref: "#/components/examples/400_bad_request" + value: + - errorCode: EQ-3044013 + errorMessage: Invalid argument value passed + additionalInfo: + - property: prefixMatch + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044201 + errorMessage: Route filter rule Id not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}/changes: get: tags: @@ -8116,13 +28273,17 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: - $ref: "#/components/schemas/RouteFilterRuleId" + description: Route Filter Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b - name: offset in: query description: offset @@ -8138,62 +28299,140 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Fabric Route Filter Rule Change object content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesChangeDataResponse" + $ref: '#/components/schemas/RouteFilterRulesChangeDataResponse' examples: RouteFilterRuleChangesResponse: - $ref: "#/components/examples/RouteFilterRulesGetAllChangesResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + name: Private-subnet-filter + description: Test rule + prefix: 192.168.0.0/25 + prefixMatch: exact + - 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: replace + path: /prefixMatch + value: + name: Private-subnet-filter + description: Test rule + prefix: 192.168.0.0/25 + prefixMatch: orlonger + - 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: replace + path: /prefixMatch + value: + name: Private-subnet-filter + description: Test rule + prefix: 192.168.0.0/25 + prefixMatch: exact + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}/changes/{changeId}: get: tags: @@ -8207,76 +28446,122 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: - $ref: "#/components/schemas/RouteFilterRuleId" + description: Route Filter Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b - name: changeId in: path description: Route Filter Rule Change UUID required: true schema: - $ref: "#/components/schemas/ChangeId_2" + description: Route Filter Rule Change UUID + type: string + format: uuid + example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: - "200": + '200': description: Fabric Route Filter Change object content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesChangeData" + $ref: '#/components/schemas/RouteFilterRulesChangeData' examples: RouteFilterChangeResponse: - $ref: "#/components/examples/RouteFilterRuleGetChangeResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + name: Private-subnet-filter + description: Test rule + prefix: 192.168.0.0/25 + prefixMatch: exact + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/bulk: post: tags: @@ -8290,77 +28575,149 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesPostRequest" + $ref: '#/components/schemas/RouteFilterRulesPostRequest' required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetRouteFilterRulesResponse" + $ref: '#/components/schemas/GetRouteFilterRulesResponse' examples: getAllRouteFilterRules: - $ref: "#/components/examples/RouteFilterRulesBulkResponse" - "400": + 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: BGP_IPv4_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: BGP_IPv4_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' + '400': description: Resource not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044201 + errorMessage: Route filter rule Id not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400" - "415": + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/search: post: tags: @@ -8374,76 +28731,186 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesSearchRequest" + $ref: '#/components/schemas/RouteFilterRulesSearchRequest' examples: SearchRouteFilterRulesAndRequest: - $ref: "#/components/examples/SearchRouteFilterRulesAndRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_FILTER_RULE + - property: /state + operator: '=' + values: + - PROVISIONED + - or: + - property: /name + operator: LIKE + values: + - '%Demo%' + - property: /name + operator: LIKE + values: + - '%Production%' + - or: + - property: /state + operator: '=' + values: + - PROVISIONED + - and: + - property: /prefix + operator: '=' + values: + - 192.168.2.0/24 + - property: /prefixMatch + operator: '=' + values: + - exact + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC SearchRouteFilterRulesOrRequest: - $ref: "#/components/examples/SearchRouteFilterRulesOrRequest" + value: + filter: + or: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_FILTER_RULE + - property: /state + operator: '=' + values: + - PROVISIONED + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesSearchResponse" + $ref: '#/components/schemas/RouteFilterRulesSearchResponse' examples: SearchRouteFilterRulesResponse: - $ref: "#/components/examples/SearchRouteFilterRulesResponse" - "400": + value: + pagination: + offset: 1 + limit: 2 + total: 10 + next: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/search?offset=3&limit=2 + previous: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/search?offset=0&limit=2 + 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: Route_Filter_Rule_Demo1 + description: Test rule1 + prefixMatch: exact + action: PERMIT + prefix: 192.168.10.0/24 + state: PROVISIONED + 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: Route_Filter_Rule_Demo2 + description: Test rule2 + prefixMatch: orlonger + action: PERMIT + prefix: 192.168.20.0/24 + state: PROVISIONED + changelog: + createdBy: testuser + createdByEmail: testuser@equinix.com + createdByFullName: testuser testuser + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter Rule ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "415": + $ref: '#/components/schemas/ErrorList' + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/routeAggregations: post: tags: @@ -8451,80 +28918,128 @@ paths: summary: Create Route Aggregation description: This API provides capability to create a Route Aggregation operationId: createRouteAggregation - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsBase" + $ref: '#/components/schemas/RouteAggregationsBase' examples: RouteAggregationBgpIpv4Prefix: - $ref: "#/components/examples/RouteAggregationCreateBgpIpv4Prefix" + value: + type: BGP_IPv4_PREFIX_AGGREGATION + name: My-route-aggregation-v4 + description: Test aggregation + project: + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsData" + $ref: '#/components/schemas/RouteAggregationsData' examples: GetSpecificRouteAggregationResponse: - $ref: "#/components/examples/RouteAggregationCreateBgpIpv4PrefixResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: TransientState: - $ref: "#/components/examples/400_transient_state" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}: get: tags: @@ -8538,73 +29053,123 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsData" + $ref: '#/components/schemas/RouteAggregationsData' examples: GetSpecificRouteAggregationResponse: - $ref: "#/components/examples/RouteAggregationCreateBgpIpv4PrefixResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 delete: tags: - Route Aggregations @@ -8617,71 +29182,125 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsData" + $ref: '#/components/schemas/RouteAggregationsData' examples: RouteAggregationDeleteBgpIpv4PrefixResponse: - $ref: "#/components/examples/RouteAggregationDeleteBgpIpv4PrefixResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_attached_connection" - "401": + value: + - errorCode: EQ-3044007 + errorMessage: Cannot delete route aggregation still attached to a connection + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Cannot delete Route Aggregation still attached to a Connection + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 patch: tags: - Route Aggregations @@ -8694,86 +29313,138 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsPatchRequest" + $ref: '#/components/schemas/RouteAggregationsPatchRequest' examples: RouteAggregationNamePatchExample: - $ref: "#/components/examples/PatchRouteAggregationName" + value: + - op: replace + path: /name + value: My-route-aggregation-v4-updated application/json-patch+json: schema: - $ref: "#/components/schemas/RouteAggregationsPatchRequest" + $ref: '#/components/schemas/RouteAggregationsPatchRequest' examples: RouteAggregationNamePatchExample: - $ref: "#/components/examples/PatchRouteAggregationName" + value: + - op: replace + path: /name + value: My-route-aggregation-v4-updated required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsData" + $ref: '#/components/schemas/RouteAggregationsData' examples: RouteAggregationNamePatchResponse: - $ref: "#/components/examples/RouteAggregationNamePatchResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation" - "401": + value: + - errorCode: EQ-3044011 + errorMessage: Invalid argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Only replace name operation is supported. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}/changes: get: tags: @@ -8787,7 +29458,9 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: offset in: query description: offset @@ -8803,62 +29476,126 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Fabric Route Aggregation Change object content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationChangeDataResponse" + $ref: '#/components/schemas/RouteAggregationChangeDataResponse' examples: RouteAggregationChangesResponse: - $ref: "#/components/examples/RouteAggregationGetAllChangesResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: replace + path: /name + value: + type: BGP_IPv4_PREFIX_AGGREGATION + name: My-route-aggregations-v4-updated + description: Test Aggregation + project: + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}/changes/{changeId}: get: tags: @@ -8872,70 +29609,115 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: changeId in: path description: Routing Protocol Change UUID required: true schema: - $ref: "#/components/schemas/ChangeId_3" + description: Route Aggregations Change UUID + type: string + format: uuid + example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: - "200": + '200': description: Fabric Route Aggregation Change object content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationChangeData" + $ref: '#/components/schemas/RouteAggregationChangeData' examples: RouteAggregationChangeResponse: - $ref: "#/components/examples/RouteAggregationGetChangeResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + type: BGP_IPv4_PREFIX_AGGREGATION + name: My-route-aggregation-v4 + description: Test aggregation + project: + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}/connections: get: tags: @@ -8949,73 +29731,115 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetRouteAggregationGetConnectionsResponse" + $ref: '#/components/schemas/GetRouteAggregationGetConnectionsResponse' examples: RouteAggregationGetConnectionsResponse: - $ref: "#/components/examples/RouteAggregationGetConnectionsResponse" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/search: post: tags: @@ -9023,86 +29847,210 @@ paths: summary: Search Route Aggregations description: This API provides capability to search Route Aggregations operationId: searchRouteAggregations - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsSearchRequest" + $ref: '#/components/schemas/RouteAggregationsSearchRequest' examples: searchRouteAggregationsAndRequest: - $ref: "#/components/examples/SearchRouteAggregationsAndRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_AGGREGATION + - property: /state + operator: IN + values: + - PROVISIONED + - DEPROVISIONING + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC searchRouteAggregationsOrRequest: - $ref: "#/components/examples/SearchRouteAggregationsOrRequest" + value: + filter: + or: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_AGGREGATION + - property: /name + operator: LIKE + values: + - '%Route_Aggregation_Demo%' + - property: /project/projectId + operator: IN + values: + - dadd3ab6-c0af-430c-8216-43d44f08c1c5 + - 8c1c5ab6-c0af-d44f-430c-43d44f08c1c5 + pagination: + offset: 1 + limit: 2 + sort: + - property: /changeLog/updatedDateTime + direction: DESC searchRouteAggregationsNestedRequest: - $ref: "#/components/examples/SearchRouteAggregationsNestedRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_AGGREGATION + - property: /changeLog/createdDateTime + operator: '>' + values: + - '2025-03-28T04:12:36.607Z' + - or: + - property: /name + operator: LIKE + values: + - '%Demo%' + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsSearchResponse" + $ref: '#/components/schemas/RouteAggregationsSearchResponse' examples: SearchRouteAggregationsResponse: - $ref: "#/components/examples/SearchRouteAggregationsResponse" - "400": + value: + pagination: + offset: 1 + limit: 2 + total: 10 + next: /search?offset=3&limit=2 + previous: /search?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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules: get: tags: @@ -9116,7 +30064,9 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: offset in: query description: offset @@ -9132,57 +30082,111 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetRouteAggregationRulesResponse" + $ref: '#/components/schemas/GetRouteAggregationRulesResponse' examples: getAllRouteAggregationRules: - $ref: "#/components/examples/RouteAggregationRulesGetAll" - "400": + 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: BGP_IPv4_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: BGP_IPv4_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' + '400': description: Resource not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044401 + errorMessage: Route aggregation rule ID not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation Rule ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 post: tags: - Route Aggregation Rules @@ -9195,79 +30199,131 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesBase" + $ref: '#/components/schemas/RouteAggregationRulesBase' examples: RouteAggregationRuleBgpIpv4Prefix: - $ref: "#/components/examples/RouteAggregationRuleCreateBgpIpv4Prefix" + value: + name: Private-subnet-aggregation + description: Test rule + prefix: 192.168.0.0/24 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesData" + $ref: '#/components/schemas/RouteAggregationRulesData' examples: GetSpecificRouteAggregationRuleIpv4Response: - $ref: "#/components/examples/RouteAggregationRuleCreateBgpIpv4PrefixResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidType: - $ref: "#/components/examples/400_bad_request" + value: + - errorCode: EQ-3044413 + errorMessage: Invalid argument value passed + additionalInfo: + - property: /prefix + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044401 + errorMessage: Route aggregation rule ID not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation Rule ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "415": + $ref: '#/components/schemas/ErrorList' + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}: get: tags: @@ -9281,256 +30337,420 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: - $ref: "#/components/schemas/RouteAggregationRuleId" + description: Route Aggregation Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesData" + $ref: '#/components/schemas/RouteAggregationRulesData' examples: GetSpecificRouteAggregationRuleIpv4Response: - $ref: "#/components/examples/RouteAggregationRuleCreateBgpIpv4PrefixResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidType: - $ref: "#/components/examples/400_bad_request" + value: + - errorCode: EQ-3044413 + errorMessage: Invalid argument value passed + additionalInfo: + - property: /prefix + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044401 + errorMessage: Route aggregation rule ID not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" - put: + value: + - errorCode: EQ-3044308 + 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 + delete: tags: - Route Aggregation Rules - summary: Replace Route Aggregation Rule - description: This API provides capability to replace a Route Aggregation Rule completely - operationId: replaceRouteAggregationRuleByUuid + summary: Delete Route Aggregation Rule + 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" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - 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 + description: Route Aggregation Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesData" + $ref: '#/components/schemas/RouteAggregationRulesData' examples: - RouteAggregationRuleIpv4ReplaceResponse: - $ref: "#/components/examples/RouteAggregationRuleReplaceIpv4Response" - "400": + RouteAggregationDeleteBgpIpv4PrefixResponse: + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: - InvalidType: - $ref: "#/components/examples/400_bad_request" - InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" - delete: + value: + - errorCode: EQ-3044308 + 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 + put: tags: - Route Aggregation Rules - summary: Delete Route Aggregation Rule - description: This API provides capability to delete a Route aggregation Rule - operationId: deleteRouteAggregationRuleByUuid + summary: Replace Route Aggregation Rule + 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" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: - $ref: "#/components/schemas/RouteAggregationRuleId" + description: Route Aggregation Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RouteAggregationRulesBase' + examples: + RouteaggregationIpv4ReplaceExample: + value: + name: Private-subnet-aggregation-update + description: Test rule + prefix: 192.168.0.0/24 + required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesData" + $ref: '#/components/schemas/RouteAggregationRulesData' examples: - RouteAggregationDeleteBgpIpv4PrefixResponse: - $ref: "#/components/examples/RouteAggregationRuleDeleteBgpIpv4PrefixResponse" - "400": + RouteAggregationRuleIpv4ReplaceResponse: + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: - example: - $ref: "#/components/examples/400_transient_aggregation" - "401": + InvalidType: + value: + - errorCode: EQ-3044413 + errorMessage: Invalid argument value passed + additionalInfo: + - property: /prefix + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + InvalidId: + value: + - errorCode: EQ-3044401 + errorMessage: Route aggregation rule ID not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 patch: tags: - Route Aggregation Rules @@ -9543,98 +30763,164 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: - $ref: "#/components/schemas/RouteAggregationRuleId" + description: Route Aggregation Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesPatchRequest" + $ref: '#/components/schemas/RouteAggregationRulesPatchRequest' examples: RouteaggregationRuleName: - $ref: "#/components/examples/PatchRouteAggregationRuleName" + value: + - op: replace + path: /name + value: test-route-aggregation-name-patch RouteaggregationRulePrefix: - $ref: "#/components/examples/PatchRouteAggregationRulePrefix" + value: + - op: replace + path: /prefix + value: 192.168.0.0/30 application/json-patch+json: schema: - $ref: "#/components/schemas/RouteAggregationRulesPatchRequest" + $ref: '#/components/schemas/RouteAggregationRulesPatchRequest' examples: RouteaggregationRuleName: - $ref: "#/components/examples/PatchRouteAggregationRuleName" + value: + - op: replace + path: /name + value: test-route-aggregation-name-patch RouteaggregationRulePrefix: - $ref: "#/components/examples/PatchRouteAggregationRulePrefix" + value: + - op: replace + path: /prefix + value: 192.168.0.0/30 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesData" + $ref: '#/components/schemas/RouteAggregationRulesData' examples: RouteAggregationRuleIpv4ReplaceResponse: - $ref: "#/components/examples/RouteAggregationRuleReplaceIpv4Response" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidType: - $ref: "#/components/examples/400_bad_request" + value: + - errorCode: EQ-3044413 + errorMessage: Invalid argument value passed + additionalInfo: + - property: /prefix + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044401 + errorMessage: Route aggregation rule ID not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes: get: tags: @@ -9648,13 +30934,17 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: - $ref: "#/components/schemas/RouteAggregationRuleId" + description: Route Aggregation Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b - name: offset in: query description: offset @@ -9670,62 +30960,107 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Fabric Route Aggregation Rule Change object content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesChangeDataResponse" + $ref: '#/components/schemas/RouteAggregationRulesChangeDataResponse' examples: RouteAggregationRuleChangesResponse: - $ref: "#/components/examples/RouteAggregationRulesGetAllChangesResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + name: Private-subnet-aggregation + description: Test rule + prefix: 192.168.0.0/25 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes/{changeId}: get: tags: @@ -9739,76 +31074,121 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: - $ref: "#/components/schemas/RouteAggregationRuleId" + description: Route Aggregation Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b - name: changeId in: path description: Route Aggregation Rule Change UUID required: true schema: - $ref: "#/components/schemas/ChangeId_4" + description: Route Aggregation Rule Change UUID + type: string + format: uuid + example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: - "200": + '200': description: Fabric Route Aggregation Change object content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesChangeData" + $ref: '#/components/schemas/RouteAggregationRulesChangeData' examples: RouteAggregationChangeResponse: - $ref: "#/components/examples/RouteAggregationRuleGetChangeResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + name: Private-subnet-aggregation + description: Test rule + prefix: 192.168.0.0/25 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/bulk: post: tags: @@ -9822,77 +31202,145 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesPostRequest" + $ref: '#/components/schemas/RouteAggregationRulesPostRequest' required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetRouteAggregationRulesResponse" + $ref: '#/components/schemas/GetRouteAggregationRulesResponse' examples: getAllRouteAggregationRules: - $ref: "#/components/examples/RouteAggregationRulesBulkResponse" - "400": + 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: BGP_IPv4_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: BGP_IPv4_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' + '400': description: Resource not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044401 + errorMessage: Route aggregation rule ID not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400" - "415": + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/search: post: tags: @@ -9906,76 +31354,173 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesSearchRequest" + $ref: '#/components/schemas/RouteAggregationRulesSearchRequest' examples: SearchRouteAggregationRulesAndRequest: - $ref: "#/components/examples/SearchRouteAggregationRulesAndRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_AGGREGATION_RULE + - property: /state + operator: '=' + values: + - PROVISIONED + - or: + - property: /name + operator: LIKE + values: + - '%Demo%' + - property: /name + operator: LIKE + values: + - '%Production%' + - or: + - property: /prefix + operator: '=' + values: + - 192.168.2.0/24 + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC SearchRouteAggregationRulesOrRequest: - $ref: "#/components/examples/SearchRouteAggregationRulesOrRequest" + value: + filter: + or: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_AGGREGATION_RULE + - property: /state + operator: '=' + values: + - PROVISIONED + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesSearchResponse" + $ref: '#/components/schemas/RouteAggregationRulesSearchResponse' examples: SearchRouteAggregationRulesResponse: - $ref: "#/components/examples/SearchRouteAggregationRulesResponse" - "400": + value: + pagination: + offset: 1 + limit: 2 + total: 10 + next: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/search?offset=3&limit=2 + previous: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/search?offset=0&limit=2 + 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: Route_Aggregation_Rule_Demo1 + description: Test rule1 + prefix: 192.168.10.0/24 + state: PROVISIONED + 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: Route_Aggregation_Rule_Demo2 + description: Test rule2 + prefix: 192.168.20.0/24 + state: PROVISIONED + changeLog: + createdBy: testuser + createdByEmail: testuser@equinix.com + createdByFullName: testuser testuser + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation Rule ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "415": + $ref: '#/components/schemas/ErrorList' + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/routers: post: tags: @@ -9995,80 +31540,231 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/CloudRouterPostRequest" + $ref: '#/components/schemas/CloudRouterPostRequest' examples: CreateLabPackage: - $ref: "#/components/examples/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' CreateProPackage: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 required: true responses: - "200": + '200': description: Fabric Cloud Router object content: application/json: schema: - $ref: "#/components/schemas/CloudRouter" + $ref: '#/components/schemas/CloudRouter' examples: cloudRouterResponse: - $ref: "#/components/examples/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' cloudRouterResponseForMarketplaceSubscription: - $ref: "#/components/examples/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' cloudRouterResponseDryRun: - $ref: "#/components/examples/CloudRouterResponseExampleDryRun" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: invalidPackage: - $ref: "#/components/examples/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 invalidName: - $ref: "#/components/examples/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 invalidAccount: - $ref: "#/components/examples/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 maxLabFcrReached: - $ref: "#/components/examples/400_max_lab_fcr_demo" - "401": + value: + - errorCode: EQ-3040060 + errorMessage: Create request rejected + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Only 3 Lab Fabric Cloud Routers allowed per Organization + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3040047 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3040030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/routers/{routerId}: get: tags: @@ -10082,55 +31778,141 @@ paths: description: Cloud Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Fabric Cloud Router object content: application/json: schema: - $ref: "#/components/schemas/CloudRouterReadResponse" + $ref: '#/components/schemas/CloudRouterReadResponse' examples: cloudRouterResponse: - $ref: "#/components/examples/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' cloudRouterResponseMarketplace: - $ref: "#/components/examples/CloudRouterResponseExampleMarketplace" - "401": + 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' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3040047 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3040020 + errorMessage: Fabric Cloud Router not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric Cloud Router not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3040030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error delete: tags: - Cloud Routers @@ -10143,57 +31925,83 @@ paths: description: Cloud Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "204": + '204': description: Deleted Cloud Router Successfully - "400": + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: invalidState: - $ref: "#/components/examples/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. GatewayAttached: - $ref: "#/components/examples/400_attached_to_gateway" - "401": + value: + - errorCode: EQ-3000039 + errorMessage: Gateway must be detached before deleting Fabric Cloud Router. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01586 + details: User must detach Gateway before deleting a Fabric Cloud Router. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3040047 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3040020 + errorMessage: Fabric Cloud Router not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric Cloud Router not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3040030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error patch: tags: - Cloud Routers @@ -10206,171 +32014,186 @@ paths: description: Cloud Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/CloudRouterUpdateRequest" + $ref: '#/components/schemas/CloudRouterUpdateRequest' examples: UpdatePackage: - $ref: "#/components/examples/UpdatePackage" + value: + - op: replace + path: /package/code + value: PREMIUM UpdateName: - $ref: "#/components/examples/UpdateName" + value: + - op: replace + path: /name + value: Router-name-2 UpdateNotificationEmail: - $ref: "#/components/examples/UpdateNotifications" + value: + - op: replace + path: /notifications + value: + - type: ALL + emails: + - testEmail1@equinix.com + - testEmail2@equinix.com UpdateTermLength: - $ref: "#/components/examples/UpdateTermLength" + value: + - op: replace + path: /order/termLength + value: 12 UpdatePackageAndTermLength: - $ref: "#/components/examples/UpdatePackageAndTermLength" + value: + - op: replace + path: /package/code + value: PREMIUM + - op: replace + path: /order/termLength + value: 12 required: true responses: - "200": + '200': description: Fabric Cloud Router object content: application/json: schema: - $ref: "#/components/schemas/CloudRouter" + $ref: '#/components/schemas/CloudRouter' examples: cloudRouterResponse: - $ref: "#/components/examples/CloudRouterPatchResponseExample" - "400": + 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' + data: + - op: replace + path: /package/code + value: PREMIUM + - op: replace + path: /order/termLength + value: 12 + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation" - "401": + value: + - errorCode: EQ-3040054 + errorMessage: Invalid Argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Only replace name, replace package and replace notifications operations are supported. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3040047 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3040020 + errorMessage: Fabric Cloud Router not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric Cloud Router not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3040030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/routers/{routerId}/actions: - get: - tags: - - Cloud Routers - summary: Get Route Table Actions - description: This API provides capability to fetch all actions for a given cloud router - operationId: getCloudRouterActions - parameters: - - name: routerId - in: path - description: Router UUID - required: true - schema: - $ref: "#/components/schemas/RouterId" - - name: state - in: query - description: Action state - schema: - $ref: "#/components/schemas/ActionState" - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/CloudRouterActionsSearchResponse" - examples: - routerActionExample: - $ref: "#/components/examples/CloudRouterActionSearchResponse" - "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 @@ -10383,175 +32206,452 @@ paths: description: Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/CloudRouterActionRequest" + $ref: '#/components/schemas/CloudRouterActionRequest' examples: RouteEntriesStatusUpdate: - $ref: "#/components/examples/RouteEntriesStatusUpdate" + value: + type: ROUTE_TABLE_ENTRY_UPDATE ReceivedRouteEntriesStatusUpdate: - $ref: "#/components/examples/ReceivedRouteEntriesStatusUpdate" + value: + type: RECEIVED_ROUTE_ENTRY_UPDATE + connection: + uuid: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 AdvertisedRouteEntriesStatusUpdate: - $ref: "#/components/examples/AdvertisedRouteEntriesStatusUpdate" + value: + type: ADVERTISED_ROUTE_ENTRY_UPDATE + connection: + uuid: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterActionResponse" + $ref: '#/components/schemas/CloudRouterActionResponse' examples: cloudRouterActionExample: - $ref: "#/components/examples/CloudRouterActionResponse" + value: + type: ROUTE_TABLE_ENTRY_UPDATE + uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 + state: PENDING + changeLog: + createdDateTime: '2020-05-21T10:30:00Z' receivedRouteEntriesExample: - $ref: "#/components/examples/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' advertisedRouteEntriesExample: - $ref: "#/components/examples/CloudRouterAdvertisedRoutesActionResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation" - "401": + value: + - errorCode: EQ-3043002 + errorMessage: Invalid argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid argument passed + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router action not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router action not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - /fabric/v4/routers/{routerId}/actions/search: - post: + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error + get: tags: - Cloud Routers - summary: Search Route Table Actions - description: This API provides capability to search route table actions for a given cloud router - operationId: searchRouterActions + summary: Get Route Table Actions + description: This API provides capability to fetch all actions for a given cloud router + operationId: getCloudRouterActions parameters: - name: routerId in: path description: Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CloudRouterActionsSearchRequest" - examples: - CloudRouterActionsSearchByType: - $ref: "#/components/examples/CloudRouterActionsSearchByType" - required: true + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + - name: state + in: query + description: Action state + schema: + $ref: '#/components/schemas/CloudRouterActionState' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterActionsSearchResponse" + $ref: '#/components/schemas/CloudRouterActionsSearchResponse' examples: routerActionExample: - $ref: "#/components/examples/CloudRouterActionSearchResponse" - "400": + value: + pagination: + offset: 0 + limit: 1 + total: 2 + prev: null + next: null + data: + - href: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9 + uuid: 1e9414f1-763e-4c0a-86c6-0bc8336048d9 + type: RECEIVED_ROUTE_ENTRY_UPDATE + state: SUCCEEDED + connection: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 3066ab1d-af87-49d7-8a14-c9bdb57ac809 + type: IP_VC + operation: + bgpIpv4RoutesCount: 6 + bgpIpv6RoutesCount: 6 + distinctIpv4PrefixesCount: 4 + distinctIpv6PrefixesCount: 4 + changeLog: + createdDateTime: '2024-01-01T01:00:00Z' + updatedDateTime: '2024-01-01T01:01:00Z' + - href: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9 + uuid: 1e9414f1-763e-4c0a-86c6-0bc8336048d9 + type: ROUTE_TABLE_ENTRY_UPDATE + state: SUCCEEDED + router: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 3066ab1d-af87-49d7-8a14-c9bdb57ac809 + type: XF_ROUTER + operation: + bgpIpv4RoutesCount: 6 + bgpIpv6RoutesCount: 6 + distinctIpv4PrefixesCount: 4 + distinctIpv6PrefixesCount: 4 + changeLog: + createdDateTime: '2024-01-01T01:00:00Z' + updatedDateTime: '2024-01-01T01:01:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_sorting" - "401": + value: + - errorCode: EQ-3043002 + errorMessage: Invalid argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid argument passed + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router action not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router action not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error + /fabric/v4/routers/{routerId}/actions/search: + post: + tags: + - Cloud Routers + summary: Search Route Table Actions + description: This API provides capability to search route table actions for a given cloud router + operationId: searchRouterActions + parameters: + - name: routerId + in: path + description: Router UUID + required: true + schema: + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CloudRouterActionsSearchRequest' + examples: + CloudRouterActionsSearchByType: + value: + filter: + and: + - property: /type + operator: '=' + values: + - ROUTE_TABLE_ENTRY_UPDATE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime + required: true + responses: + '200': + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/CloudRouterActionsSearchResponse' + examples: + routerActionExample: + value: + pagination: + offset: 0 + limit: 1 + total: 2 + prev: null + next: null + data: + - href: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9 + uuid: 1e9414f1-763e-4c0a-86c6-0bc8336048d9 + type: RECEIVED_ROUTE_ENTRY_UPDATE + state: SUCCEEDED + connection: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 3066ab1d-af87-49d7-8a14-c9bdb57ac809 + type: IP_VC + operation: + bgpIpv4RoutesCount: 6 + bgpIpv6RoutesCount: 6 + distinctIpv4PrefixesCount: 4 + distinctIpv6PrefixesCount: 4 + changeLog: + createdDateTime: '2024-01-01T01:00:00Z' + updatedDateTime: '2024-01-01T01:01:00Z' + - href: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9 + uuid: 1e9414f1-763e-4c0a-86c6-0bc8336048d9 + type: ROUTE_TABLE_ENTRY_UPDATE + state: SUCCEEDED + router: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 3066ab1d-af87-49d7-8a14-c9bdb57ac809 + type: XF_ROUTER + operation: + bgpIpv4RoutesCount: 6 + bgpIpv6RoutesCount: 6 + distinctIpv4PrefixesCount: 4 + distinctIpv6PrefixesCount: 4 + changeLog: + createdDateTime: '2024-01-01T01:00:00Z' + updatedDateTime: '2024-01-01T01:01:00Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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. + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router action not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router action not found + '415': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error /fabric/v4/routers/{routerId}/actions/{actionId}: get: tags: @@ -10565,250 +32665,464 @@ paths: description: Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: actionId in: path description: Action UUID required: true schema: - $ref: "#/components/schemas/ActionId_1" + description: Action UUID + type: string + format: uuid + example: 457400f8-d360-11e9-bb65-2a2ae2dbcced - name: state in: query description: Action state schema: - $ref: "#/components/schemas/ActionState" + $ref: '#/components/schemas/CloudRouterActionState' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterActionResponse" + $ref: '#/components/schemas/CloudRouterActionResponse' examples: searchResponseExample: - $ref: "#/components/examples/CloudRouterActionResponse" - "400": + value: + type: ROUTE_TABLE_ENTRY_UPDATE + uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 + state: PENDING + changeLog: + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation" - "401": + value: + - errorCode: EQ-3043002 + errorMessage: Invalid argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid argument passed + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router action not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router action not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error /fabric/v4/routers/{routerId}/commands: - get: + post: tags: - Cloud Routers - summary: Get Commands - description: This API provides capability to fetch all commands - operationId: getAllCloudRouterCommands + summary: Create 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" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CloudRouterCommandPostRequest' + examples: + InitiatePingCommand: + 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 + InitiateTracerouteCommand: + value: + type: TRACEROUTE_COMMAND + name: traceroute-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 + probes: 3 + hopsMax: 20 + required: true responses: - "200": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetAllCloudRouterCommands" + $ref: '#/components/schemas/CloudRouterCommand' examples: - getAllCommandsExample: - $ref: "#/components/examples/GetAllPingCommandResponse" - "400": + initiatePingCommandsExample: + 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' + initiateTracerouteCommandsExample: + value: + href: https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00 + type: TRACEROUTE_COMMAND + uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 + name: traceroute-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 + probes: 3 + hopsMax: 20 + changeLog: + createdBy: testuser + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation_commands" - "401": + value: + - errorCode: EQ-3043002 + errorMessage: Invalid argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid argument passed + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403_commands" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_commands" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router command not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router command not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415_commands" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_commands" - post: + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error + get: tags: - Cloud Routers - summary: Create Command - description: This API provides capability to initiate Command - operationId: createCloudRouterCommand + 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" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CloudRouterCommandPostRequest" - examples: - InitiatePingCommand: - $ref: "#/components/examples/PostRequestPingCommand" - InitiateTracerouteCommand: - $ref: "#/components/examples/PostRequestTracerouteCommand" - required: true + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterCommand" + $ref: '#/components/schemas/GetAllCloudRouterCommands' examples: - initiatePingCommandsExample: - $ref: "#/components/examples/PostResponsePingCommand" - initiateTracerouteCommandsExample: - $ref: "#/components/examples/PostResponseTracerouteCommand" - "400": + getAllCommandsExample: + 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 + 108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms + 108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms + 108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms + 108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms + --- 8.8.8.8 ping statistics --- + 4 packets transmitted, 4 packets received, 0.0% packet loss + round-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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation_commands" - "401": + value: + - errorCode: EQ-3043002 + errorMessage: Invalid argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid argument passed + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403_commands" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_commands" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router command not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router command not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415_commands" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_commands" + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error /fabric/v4/routers/{routerId}/commands/search: post: tags: @@ -10822,80 +33136,187 @@ paths: description: Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/CloudRouterCommandSearchRequest" + $ref: '#/components/schemas/CloudRouterCommandSearchRequest' examples: SearchByState: - $ref: "#/components/examples/SearchByStateRequest" + value: + filter: + and: + - property: /state + operator: '=' + values: + - SUCCEEDED + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterCommandSearchResponse" + $ref: '#/components/schemas/CloudRouterCommandSearchResponse' examples: searchCommandsExample: - $ref: "#/components/examples/SearchResponse" - "400": + 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 + 108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms + 108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms + 108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms + 108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms + --- 8.8.8.8 ping statistics --- + 4 packets transmitted, 4 packets received, 0.0% packet loss + round-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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_sorting_commands" - "401": + 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. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403_commands" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_commands" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router command not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router command not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415_commands" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_commands" + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error /fabric/v4/routers/{routerId}/commands/{commandId}: get: tags: @@ -10909,79 +33330,195 @@ paths: description: Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: commandId in: path description: Command UUID required: true schema: - $ref: "#/components/schemas/CommandId" + description: Command UUID + type: string + format: uuid + example: 37c10edc-ba2e-4240-a850-8a48f9c47d00 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterCommand" + $ref: '#/components/schemas/CloudRouterCommand' examples: getCommandExample: - $ref: "#/components/examples/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 + 108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms + 108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms + 108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms + 108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms + --- 8.8.8.8 ping statistics --- + 4 packets transmitted, 4 packets received, 0.0% packet loss + round-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' getTracerouteCommandWithErrorExample: - $ref: "#/components/examples/GetResponseTracerouteCommandWithError" - "400": + value: + href: https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00 + type: TRACEROUTE_COMMAND + uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 + name: traceroute-test-1 + description: Testing FCR-SV-1 + state: FAILED + project: + projectId: b11d4cb5-978a-418a-8b13-bf19abb97938 + request: + destination: 8.8.8.8 + sourceConnection: + uuid: 1da3778c-6aa3-4e47-b2fe-83a0773dde18 + timeout: 2 + probes: 3 + hopsMax: 20 + response: + errors: + - errorCode: EQ-3041105 + errorMessage: Request timeout. + correlationId: 86c57a79-06fb-4ba3-b496-5387f3b45380 + details: Request timeout after 480 seconds. + additionalInfo: + - reason: Request timeout after 480 seconds. + changeLog: + createdBy: testuser + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation_commands" - "401": + value: + - errorCode: EQ-3043002 + errorMessage: Invalid argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid argument passed + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403_commands" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_commands" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router command not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router command not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415_commands" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_commands" + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error delete: tags: - Cloud Routers @@ -10994,61 +33531,86 @@ paths: description: Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: commandId in: path description: Command UUID required: true schema: - $ref: "#/components/schemas/CommandId" + description: Command UUID + type: string + format: uuid + example: 37c10edc-ba2e-4240-a850-8a48f9c47d00 responses: - "204": + '204': description: Deleted command successfully - "400": + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_state_commands" - "401": + 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. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403_commands" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_commands" - "500": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router command not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router command not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_commands" + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error /fabric/v4/routers/{routerId}/routes/search: post: tags: @@ -11062,88 +33624,199 @@ paths: description: Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteTableEntrySearchRequest" + $ref: '#/components/schemas/RouteTableEntrySearchRequest' examples: SearchFilterByNextHop: - $ref: "#/components/examples/SearchFilterByNextHop" + value: + filter: + and: + - property: /nextHop + operator: '=' + values: + - 10.10.10.5 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterByPrefix: - $ref: "#/components/examples/SearchFilterByPrefix" + value: + filter: + and: + - property: /prefix + operator: '=' + values: + - 192.168.10.0/24 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterByType: - $ref: "#/components/examples/SearchFilterByType" + value: + filter: + and: + - property: /type + operator: '=' + values: + - IPv4_BGP_ROUTE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterByStatus: - $ref: "#/components/examples/SearchFilterByStatus" + value: + filter: + and: + - property: /state + operator: '=' + values: + - ACTIVE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterOrAnd: - $ref: "#/components/examples/SearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /type + operator: LIKE + values: + - IPv4_BGP_ROUTE + - property: /type + operator: LIKE + values: + - abc required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteTableEntrySearchResponse" + $ref: '#/components/schemas/RouteTableEntrySearchResponse' examples: activeRoutesResponse: - $ref: "#/components/examples/CloudRouterActiveRoutesSearchResponse" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + data: + - type: IPv4_BGP_ROUTE + protocolType: BGP + state: ACTIVE + prefix: 192.168.10.0/24 + nextHop: 10.10.10.5 + asPath: + - '20001' + changeLog: + createdBy: johnsmith + createdByFullName: John Smith + createdByEmail: john.smith@example.com + createdDateTime: '2020-11-06T07:00:00Z' + updatedBy: johnsmith + updatedByFullName: John Smith + updatedByEmail: john.smith@example.com + updatedDateTime: '2020-11-06T07:00:00Z' + deletedBy: johnsmith + deletedByFullName: John Smith + deletedByEmail: john.smith@example.com + deletedDateTime: '2020-11-06T07:00:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_sorting" - "401": + 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. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router action not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router action not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error /fabric/v4/routers/{routerId}/validate: post: tags: @@ -11157,39 +33830,72 @@ paths: description: Cloud Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ValidateRequest" + $ref: '#/components/schemas/ValidateRequest' examples: ValidateDirectIpv4: - $ref: "#/components/examples/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 ValidateDirectIpv6: - $ref: "#/components/examples/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 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ValidateSubnetResponse" + $ref: '#/components/schemas/ValidateSubnetResponse' examples: ValidateSubnet: - $ref: "#/components/examples/Response-200" - "400": + value: + additionalInfo: + - key: message + value: The provided subnet is valid. + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: Bad Request: - $ref: "#/components/examples/error-400" + value: + - errorCode: EQ-2041022 + errorMessage: Invalid argument value passed. + correlationId: 5f9f9ab9-a6cb-4e8a-aa34-105cd4cb6cc8 Subnet Overlapping: - $ref: "#/components/examples/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 /fabric/v4/routers/{routerId}/routeFilters/search: post: tags: @@ -11203,82 +33909,157 @@ paths: description: Cloud Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/CloudRouterRouteFiltersSearchBase" + $ref: '#/components/schemas/CloudRouterRouteFiltersSearchBase' examples: searchRouteFiltersRequest: - $ref: "#/components/examples/CloudRouterSearchRouteFiltersRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_FILTER + - property: /direction + operator: '=' + values: + - INBOUND + - property: /attachmentStatus + operator: '=' + values: + - ATTACHED + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterRouteFiltersSearchResponse" + $ref: '#/components/schemas/CloudRouterRouteFiltersSearchResponse' examples: SearchRouteFiltersResponse: - $ref: "#/components/examples/CloudRouterSearchRouteFiltersResponse" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 2 + next: /search?offset=3&limit=2 + previous: /search?offset=0&limit=2 + data: + - href: https://api.equinix.com/fabric/v4/connections/57f82f8c-d899-4a21-93ae-5cfe33c50556/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d + type: BGP_IPv4_PREFIX_FILTER + uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d + direction: INBOUND + attachmentStatus: ATTACHED + changeLog: + createdBy: testuser + createdDateTime: '2020-05-21T10:30:00Z' + - href: https://api.equinix.com/fabric/v4/connections/500589e0-4196-4839-8d43-a0c073b4d747/routeFilters/4ed45b37-2b26-49de-ab35-4ad039586c7a + type: BGP_IPv4_PREFIX_FILTER + uuid: 4ed45b37-2b26-49de-ab35-4ad039586c7a + direction: INBOUND + attachmentStatus: ATTACHED + changeLog: + createdBy: testuser + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routers/{routerId}/routeAggregations/search: post: tags: @@ -11292,82 +34073,151 @@ paths: description: Cloud Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/CloudRouterRouteAggregationsSearchBase" + $ref: '#/components/schemas/CloudRouterRouteAggregationsSearchBase' examples: searchRouteAggregationsRequest: - $ref: "#/components/examples/CloudRouterSearchRouteAggregationsRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_AGGREGATION + - property: /attachmentStatus + operator: '=' + values: + - ATTACHED + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterRouteAggregationsSearchResponse" + $ref: '#/components/schemas/CloudRouterRouteAggregationsSearchResponse' examples: SearchRouteAggregationsResponse: - $ref: "#/components/examples/CloudRouterSearchRouteAggregationsResponse" - "400": + value: + pagination: + offset: 1 + limit: 2 + total: 10 + next: /search?offset=3&limit=2 + previous: /search?offset=0&limit=2 + data: + - href: https://api.equinix.com/fabric/v4/connections/57f82f8c-d899-4a21-93ae-5cfe33c50556/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d + type: BGP_IPv4_PREFIX_AGGREGATION + uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d + attachmentStatus: ATTACHED + changeLog: + createdBy: testuser + createdDateTime: '2020-05-21T10:30:00Z' + - href: https://api.equinix.com/fabric/v4/connections/500589e0-4196-4839-8d43-a0c073b4d747/routeAggregations/4ed45b37-2b26-49de-ab35-4ad039586c7a + type: BGP_IPv4_PREFIX_AGGREGATION + uuid: 4ed45b37-2b26-49de-ab35-4ad039586c7a + attachmentStatus: ATTACHED + changeLog: + createdBy: testuser + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routers/search: post: tags: @@ -11375,75 +34225,188 @@ paths: 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" + $ref: '#/components/schemas/CloudRouterSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/SearchFilterByStatus" + 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 SearchFilterByNameAndMetroName: - $ref: "#/components/examples/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 SearchFilterOrAnd: - $ref: "#/components/examples/SearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /uuid + operator: LIKE + values: + - 676a0c3f-a785-4294-87bc-25fe9318a620% + - property: /name + operator: LIKE + values: + - abc + - property: /project/projectId + operator: '=' + values: + - '995072000433550' required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/SearchResponse" + $ref: '#/components/schemas/SearchResponse' examples: Example: - $ref: "#/components/examples/search-example" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_sorting" - "401": + 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. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3040047 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3040030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/routerPackages: get: tags: @@ -11467,51 +34430,123 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Fabric Cloud Router Packages content: application/json: schema: - $ref: "#/components/schemas/PackageResponse" + $ref: '#/components/schemas/PackageResponse' examples: Example: - $ref: "#/components/examples/ListFCRPackagesResponse" - "401": + 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' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3040047 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3040030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/routerPackages/{routerPackageCode}: get: tags: @@ -11525,65 +34560,102 @@ paths: description: Equinix-assigned Cloud Router package identifier required: true schema: - $ref: "#/components/schemas/RouterPackageCode" + $ref: '#/components/schemas/RouterPackageCode' responses: - "200": + '200': description: Fabric Cloud Router Package details content: application/json: schema: - $ref: "#/components/schemas/CloudRouterPackage" - "400": + $ref: '#/components/schemas/CloudRouterPackage' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: invalidPackage: - $ref: "#/components/examples/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 invalidName: - $ref: "#/components/examples/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 invalidAccount: - $ref: "#/components/examples/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 maxLabFcrReached: - $ref: "#/components/examples/400_max_lab_fcr_demo" - "401": + value: + - errorCode: EQ-3040060 + errorMessage: Create request rejected + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Only 3 Lab Fabric Cloud Routers allowed per Organization + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3040047 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3040030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/health: get: tags: @@ -11591,17 +34663,42 @@ paths: summary: Get Service Status description: Retrieves the operational health status of all Equinix Fabric services, enabling customers to monitor service availability and detect potential disruptions across regions where they have a presence. Supports an optional query parameter to filter results by customer operationId: getStatus - parameters: [] responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/HealthResponse" + $ref: '#/components/schemas/HealthResponse' examples: metroExample: - $ref: "#/components/examples/healthResponse" + value: + href: https://api.equinix.com/fabric/v4/health + version: '4.4' + release: 2022.4.0 + 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' /fabric/v4/connections/validate: post: tags: @@ -11609,73 +34706,411 @@ paths: 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" + $ref: '#/components/schemas/ValidateRequest' examples: Alibaba-ValidateAuthKey: - $ref: "#/components/examples/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 Aws-ValidateAuthKey: - $ref: "#/components/examples/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 Azure-ValidateAuthKey: - $ref: "#/components/examples/Request_Azure" + value: + filter: + and: + - property: /zSide/accessPoint/authenticationKey + operator: '=' + values: + - xxx-xxx-xxx + - property: /zSide/accessPoint/profile/uuid + operator: '=' + values: + - xxx-xxx-xxx Google-ValidateAuthKey: - $ref: "#/components/examples/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 IBM-1.0-ValidateAuthKey: - $ref: "#/components/examples/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 IBM-2.0-ValidateAuthKey: - $ref: "#/components/examples/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 Oracle-ValidateAuthKey: - $ref: "#/components/examples/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-ValidateVlanAvailability: - $ref: "#/components/examples/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-ValidateVlanAvailability: - $ref: "#/components/examples/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' required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionResponse" + $ref: '#/components/schemas/ConnectionResponse' examples: Alibaba-ValidateAuthKey: - $ref: "#/components/examples/Response-Alibaba" + value: + additionalInfo: + - key: message + value: Authorization key provided is valid Aws-ValidateAuthKey: - $ref: "#/components/examples/Response-Aws" + value: + additionalInfo: + - key: message + value: Authorization key provided is valid Azure-ValidateAuthKey-no-existing-connections: - $ref: "#/components/examples/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 Azure-ValidateAuthKey-1-existing-Dot1q-connection: - $ref: "#/components/examples/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 Azure-ValidateAuthKey-1-existing-Qinq-connection: - $ref: "#/components/examples/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 Azure-ValidateAuthKey-2-existing-Dot1q-connection: - $ref: "#/components/examples/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 Google-ValidateAuthKey: - $ref: "#/components/examples/Response-Google" + value: + additionalInfo: + - key: message + value: Authorization key provided is valid IBM-1.0-ValidateAuthKey: - $ref: "#/components/examples/Response-IBM-1" + value: + additionalInfo: + - key: message + value: Authorization key provided is valid IBM-2.0-ValidateAuthKey: - $ref: "#/components/examples/Response-IBM-2" + value: + additionalInfo: + - key: message + value: Authorization key provided is valid Oracle-ValidateAuthKey: - $ref: "#/components/examples/Response-Oracle" + value: + additionalInfo: + - key: message + value: Authorization key provided is valid + data: + - bandwidth: 1000 Dot1q-ValidateAuthKey: - $ref: "#/components/examples/Response-Dot1q-Vlan" + value: + additionalInfo: + - key: message + value: vlanTag(s) provided is available Qinq-ValidateAuthKey: - $ref: "#/components/examples/Response-Qinq-Vlan" - "400": + value: + additionalInfo: + - key: message + value: vlanTag(s) provided is available + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: Bad Request: - $ref: "#/components/examples/error-400" + value: + - errorCode: EQ-3142308 + errorMessage: Authentication key is required + additionalInfo: + - property: /zSide/accessPoint/authenticationKey /fabric/v4/networks: post: tags: @@ -11695,123 +35130,696 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/NetworkPostRequest" + $ref: '#/components/schemas/NetworkPostRequest' examples: Create-Global-EVPLAN-Network: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 NetworkDryRunCreate: - $ref: "#/components/examples/CreateNetworkDryRunResponse" + value: + type: EVPLAN + name: My-EVPLAN-1 + scope: GLOBAL + project: + projectId: z1a596ed-s24a-097c-12a8-44e00000ee11 + notifications: + - type: ALL + emails: + - test@equinix.com required: true responses: - "201": + '201': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Network" + $ref: '#/components/schemas/Network' examples: EVPLAN-Global-Network: - $ref: "#/components/examples/Create-Global-EVPLAN-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-03T19:37:29.326Z' + links: + - href: http://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 EVPLAN-Regional-Network: - $ref: "#/components/examples/Create-Regional-EVPLAN-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-03T19:21:43.145Z' + links: + - href: http://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 EVPLAN-Local-Network: - $ref: "#/components/examples/Create-Local-EVPLAN-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-03T19:43:20.145Z' + links: + - href: http://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 EPLAN-Global-Network: - $ref: "#/components/examples/Create-Global-EPLAN-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-03T20:52:23.469Z' + links: + - href: http://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 EPLAN-Regional-Network: - $ref: "#/components/examples/Create-Regional-EPLAN-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-03T19:21:43.145Z' + links: + - href: http://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 EPLAN-Local-Network: - $ref: "#/components/examples/Create-Local-EPLAN-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-03T20:55:57.858Z' + links: + - href: http://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 EVPTREE-Global-Network: - $ref: "#/components/examples/Create-Global-EVPTREE-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-05T21:17:46.656Z' + links: + - href: http://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 EVPTREE-Regional-Network: - $ref: "#/components/examples/Create-Regional-EVPTREE-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-05T20:57:07.206Z' + links: + - href: http://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 EVPTREE-Local-Network: - $ref: "#/components/examples/Create-Local-EVPTREE-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-05T21:22:30.984Z' + links: + - href: http://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 EPTREE-Global-Network: - $ref: "#/components/examples/Create-Global-EPTREE-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-05T21:37:08.370Z' + links: + - href: http://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 EPTREE-Regional-Network: - $ref: "#/components/examples/Create-Regional-EPTREE-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-06T00:23:29.030Z' + links: + - href: http://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 EPTREE-Local-Network: - $ref: "#/components/examples/Create-Local-EPTREE-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-06T00:30:42.972Z' + links: + - href: http://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 networkDryRun: - $ref: "#/components/examples/CreateNetworkDryRunResponse" - "202": + value: + type: EVPLAN + name: My-EVPLAN-1 + scope: GLOBAL + project: + projectId: z1a596ed-s24a-097c-12a8-44e00000ee11 + notifications: + - type: ALL + emails: + - test@equinix.com + '202': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/Network" + $ref: '#/components/schemas/Network' examples: networkResponse: - $ref: "#/components/examples/NetworkPostResponseExample" - "400": + 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' + updatedBy: testuser + updatedDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400" - "401": + value: + - errorCode: EQ-3152001 + errorMessage: Invalid input + details: Max 24 characters are allowed for Network Name + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /name + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3152006 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/networks/{networkId}: get: tags: @@ -11825,44 +35833,85 @@ paths: description: Network UUID required: true schema: - $ref: "#/components/schemas/NetworkId" + description: Network UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/Network" + $ref: '#/components/schemas/Network' examples: networkResponse: - $ref: "#/components/examples/NetworkGetResponseExample" - "401": + 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' + updatedBy: testuser + updatedDateTime: '2020-05-21T10:30:00Z' + links: + - href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/connections + rel: getConnectionsByNetworkUuid + method: GET + contentType: application/json + authenticate: true + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3152005 + errorMessage: Fabric Network not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric network not found or already deleted delete: tags: - Networks @@ -11875,53 +35924,97 @@ paths: description: Network UUID required: true schema: - $ref: "#/components/schemas/NetworkId" + description: Network UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '202': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/Network" + $ref: '#/components/schemas/Network' examples: networkResponse: - $ref: "#/components/examples/NetworkDeleteResponseExample" - "400": + 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' + updatedBy: testuser1 + updatedDateTime: '2020-05-21T10:30:00Z' + deletedBy: testuser1 + deletedDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_state" - "401": + value: + - errorCode: EQ-3152003 + errorMessage: Cannot perform action. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Given Fabric Network in transient state + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3152005 + errorMessage: Fabric Network not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric network not found or already deleted patch: tags: - Networks @@ -11934,73 +36027,136 @@ paths: description: Network UUID required: true schema: - $ref: "#/components/schemas/NetworkId" + description: Network UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/NetworkUpdateRequest" + $ref: '#/components/schemas/NetworkUpdateRequest' examples: UpdateName: - $ref: "#/components/examples/UpdateNetworkName" + value: + - op: replace + path: /name + value: NewName UpdateNotificationEmail: - $ref: "#/components/examples/UpdateNetworkNotifications" + value: + - op: replace + path: /notifications + value: + - type: ALL + emails: + - test1@test.com + - test2@test.com required: true responses: - "200": + '200': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/Network" + $ref: '#/components/schemas/Network' examples: networkResponse: - $ref: "#/components/examples/NetworkPatchResponseExample" - "400": + 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' + updatedBy: testuser + updatedDateTime: '2020-05-21T10:30:00Z' + links: + - href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/connections + rel: getConnectionsByNetworkUuid + method: GET + contentType: application/json + authenticate: true + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_state" - "401": + value: + - errorCode: EQ-3152003 + errorMessage: Cannot perform action. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Given Fabric Network in transient state + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3152005 + errorMessage: Fabric Network not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric network not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" + value: + - errorCode: EQ-3152006 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. /fabric/v4/networks/search: post: tags: @@ -12008,64 +36164,146 @@ paths: summary: Search Networks description: The API provides capability to search 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" + $ref: '#/components/schemas/NetworkSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/SearchFilterByStatus" + value: + filter: + and: + - property: /operation/equinixStatus + operator: '=' + values: + - PROVISIONED + - property: /project/projectId + operator: '=' + values: + - '1234567' + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterOrAnd: - $ref: "#/components/examples/SearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /uuid + operator: LIKE + values: + - 92dc376a-a932-43aa-a6a2-c806dedbd784% + - property: /name + operator: LIKE + values: + - abc% + - property: /project/projectId + operator: '=' + values: + - '1234567' required: true responses: - "200": + '200': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/NetworkSearchResponse" + $ref: '#/components/schemas/NetworkSearchResponse' examples: networkResponse: - $ref: "#/components/examples/NetworkSearchResponseExample" - "400": + 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' + updatedBy: testuser1 + updatedDateTime: '2020-05-21T10:30:00Z' + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_sorting" - "401": + value: + - errorCode: EQ-3152002 + errorMessage: Invalid value for sorting direction. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" + value: + - errorCode: EQ-3152006 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. /fabric/v4/networks/{networkId}/connections: get: tags: @@ -12079,53 +36317,81 @@ paths: description: Network UUID required: true schema: - $ref: "#/components/schemas/NetworkId" + description: Network UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/NetworkConnections" + $ref: '#/components/schemas/NetworkConnections' examples: networkResponse: - $ref: "#/components/examples/GetNetworkConnectionExample" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_uuid" - "401": + value: + - errorCode: EQ-3152004 + errorMessage: Invalid inlput + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Network does not exists with gievn uuid + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" + value: + - errorCode: EQ-3152006 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. /fabric/v4/networks/{networkId}/changes: get: tags: @@ -12139,53 +36405,87 @@ paths: description: Network UUID required: true schema: - $ref: "#/components/schemas/NetworkId" + description: Network UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/NetworkChangeResponse" + $ref: '#/components/schemas/NetworkChangeResponse' examples: networkResponse: - $ref: "#/components/examples/NetworkChangeResponseExample" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_uuid" - "401": + value: + - errorCode: EQ-3152004 + errorMessage: Invalid inlput + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Network does not exists with gievn uuid + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" + value: + - errorCode: EQ-3152006 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. /fabric/v4/networks/{networkId}/changes/{changeId}: get: tags: @@ -12199,59 +36499,85 @@ paths: description: Network UUID required: true schema: - $ref: "#/components/schemas/NetworkId" + description: Network UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: changeId in: path description: Network Change UUID required: true schema: - $ref: "#/components/schemas/ChangeId_5" + description: Network Change UUID + type: string + format: uuid + example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: - "200": + '200': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/NetworkChange" + $ref: '#/components/schemas/NetworkChange' examples: networkResponse: - $ref: "#/components/examples/NetworkGetChangeResponseExample" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_uuid" - "401": + value: + - errorCode: EQ-3152004 + errorMessage: Invalid inlput + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Network does not exists with gievn uuid + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3152005 + errorMessage: Fabric Network not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric network not found or already deleted /fabric/v4/timeServices: post: tags: @@ -12259,264 +36585,606 @@ paths: 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" + $ref: '#/components/schemas/precisionTimeServiceRequest' examples: ntpStandard: - $ref: "#/components/examples/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 ptpStandard: - $ref: "#/components/examples/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 ntpEnterprise: - $ref: "#/components/examples/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 ptpEnterprise: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: PTP + domain: 127 + priority1: 0 + priority2: 1 + logAnnounceInterval: 1 + logSyncInterval: -4 + logDelayReqInterval: -4 + transportMode: UNICAST + grantTime: 300 ptpEnterpriseWithAdvancedConfiguration: - $ref: "#/components/examples/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: PTP + domain: 127 + priority1: 0 + priority2: 1 + logAnnounceInterval: 1 + logSyncInterval: -4 + logDelayReqInterval: -4 + transportMode: UNICAST + grantTime: 300 ntpEnterpriseWithAdvancedConfiguration: - $ref: "#/components/examples/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: YmFzZTY0X3ByaW50YWJsZV9rZXk= + - type: HEX + keyNumber: 65535 + key: YTFhMWExYTFhMWExYTE= required: true responses: - "202": + '202': description: Successful Accepted operation content: application/json: schema: - $ref: "#/components/schemas/precisionTimeServiceResponse" + $ref: '#/components/schemas/precisionTimeServiceResponse' examples: ntpStandard: - $ref: "#/components/examples/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' ntpEnterprise: - $ref: "#/components/examples/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: YmFzZTY0X3ByaW50YWJsZV9rZXk= + - type: HEX + keyNumber: 65535 + key: YTFhMWExYTFhMWExYTE= + account: + accountNumber: 123456 + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2024-08-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2024-08-24T06:51:46Z' ptpStandard: - $ref: "#/components/examples/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: PTP + 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' ptpEnterprise: - $ref: "#/components/examples/ptpEnterpriseCreateResponse" - "400": + 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: PTP + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidName: - $ref: "#/components/examples/400-Invalid-Name" + value: + - errorCode: EQ-4800010 + errorMessage: Validation Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: /name + reason: Invalid name provided ValidateName: - $ref: "#/components/examples/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 DuplicateName: - $ref: "#/components/examples/400-Duplicate-Name" + value: + - errorCode: EQ-4800101 + errorMessage: Service name is already in use + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryConnectionUuid: - $ref: "#/components/examples/400-Mandatory-ConnectionUUid" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field ConnectionUUid is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionUuidFormat: - $ref: "#/components/examples/400-Invalid-ConnectionUuid-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid connection uuid format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionStatus: - $ref: "#/components/examples/400-Invalid-Connection-Status" + value: + - errorCode: EQ-4800102 + errorMessage: Connection should be in Pending Approval state + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateConnectionUuid: - $ref: "#/components/examples/400-Validate-ConnectionUuid" + value: + - errorCode: EQ-4800103 + errorMessage: Connection does not belong to this user + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionLocation: - $ref: "#/components/examples/400-Invalid-Connection-Location" + value: + - errorCode: EQ-4800104 + errorMessage: Connection location is not supported by EPT + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackageType: - $ref: "#/components/examples/400-Mandatory-PackageType" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field Package Type is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackageType: - $ref: "#/components/examples/400-Invalid-PackageType" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Package Type - Allowed types are PTP, NTP + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackageType: - $ref: "#/components/examples/400-Invalid-Connection-PackageType" + value: + - errorCode: EQ-4800105 + errorMessage: Connection Package type is different + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackage: - $ref: "#/components/examples/400-Mandatory-Package" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field Package is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackage: - $ref: "#/components/examples/400-Invalid-Package" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Package - Allowed packages are STANDARD, ENTERPRISE + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackage: - $ref: "#/components/examples/400-Invalid-Connection-Package" + value: + - errorCode: EQ-4800106 + errorMessage: Connection Package is different + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPrimaryIP: - $ref: "#/components/examples/400-Mandatory-PrimaryIP" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field PrimaryIP is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPrimaryIPFormat: - $ref: "#/components/examples/400-Invalid-PrimaryIP-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid PrimaryIP format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePrimaryIP: - $ref: "#/components/examples/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 MandatorySecondaryIP: - $ref: "#/components/examples/400-Mandatory-SecondaryIP" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field SecondaryIP is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidSecondaryIPFormat: - $ref: "#/components/examples/400-Invalid-SecondaryIP-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid SecondaryIP format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateSecondaryIP: - $ref: "#/components/examples/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 ValidateSameSubnet: - $ref: "#/components/examples/400-Validate-SameSubnet" + value: + - errorCode: EQ-4800108 + errorMessage: Primary and Secondary IPs should be in the same subnet + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryNetworkMask: - $ref: "#/components/examples/400-Mandatory-NetworkMask" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field NetworkMask is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidNetworkMaskFormat: - $ref: "#/components/examples/400-Invalid-NetworkMask-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid NetworkMask format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateNetworkMask: - $ref: "#/components/examples/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 InvalidDefaultGatewayFormat: - $ref: "#/components/examples/400-Invalid-DefaultGateway-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid DefaultGateway + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateDefaultGateway: - $ref: "#/components/examples/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 InvalidTimeScale: - $ref: "#/components/examples/400-Invalid-TimeScale" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid TimeScale - Allowed values are ARB, PTP + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidDomain: - $ref: "#/components/examples/400-Invalid-Domain" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Domain- Allowed values are from 0 to 127 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority1: - $ref: "#/components/examples/400-Invalid-Priority1" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Priority1 - Allowed values are 0 to 248 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority2: - $ref: "#/components/examples/400-Invalid-Priority2" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Priority2 - Allowed values are 0 to 248 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogAnnounceInterval: - $ref: "#/components/examples/400-Invalid-LogAnnounceInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid LogAnnounceInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogAnnounceIntervalRange: - $ref: "#/components/examples/400-Validate-LogAnnounceInterval-Range" + value: + - errorCode: EQ-4800111 + errorMessage: Invalid LogAnnounceInterval range - Allowed range is -3 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogSyncInterval: - $ref: "#/components/examples/400-Invalid-LogSyncInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid LogSyncInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogSyncIntervalRange: - $ref: "#/components/examples/400-Validate-LogSyncInterval-Range" + value: + - errorCode: EQ-4800112 + errorMessage: Invalid LogSyncInterval range - Allowed range is -5 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogDelayReqInterval: - $ref: "#/components/examples/400-Invalid-LogDelayReqInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid logDelayReqInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogDelayReqIntervalRange: - $ref: "#/components/examples/400-Validate-LogDelayReqInterval-Range" + value: + - errorCode: EQ-4800112 + errorMessage: Invalid logDelayReqInterval range - Allowed range is -5 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidTransportMode: - $ref: "#/components/examples/400-Invalid-TransportMode" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid TransportMode - Allowed values are Multicast, Unicast, Hybrid + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidGrantTime: - $ref: "#/components/examples/400-Invalid-GrantTime" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid GrantTime + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateGrantTimeRange: - $ref: "#/components/examples/400-Validate-GrantTime-Range" + value: + - errorCode: EQ-4800113 + errorMessage: Invalid GrantTime range - Allowed range is 30 to 7200 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidType: - $ref: "#/components/examples/400-Invalid-Type" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Type - Allowed values are ASCII, HEX + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidId: - $ref: "#/components/examples/400-Invalid-Id" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Id - Only Integers are allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPassword: - $ref: "#/components/examples/400-Invalid-Password" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Password + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePassword: - $ref: "#/components/examples/400-Validate-Password" - "401": + value: + - errorCode: EQ-4800114 + errorMessage: Only HEX allowed, chars value length should between 10 - 40 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/timeServices/{serviceId}: - get: - tags: - - Precision Time Services - summary: Get Time 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 Services @@ -12529,238 +37197,942 @@ paths: description: Service UUID required: true schema: - $ref: "#/components/schemas/ServiceId" + description: Precision Time Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/precisionTimeServiceRequest" + $ref: '#/components/schemas/precisionTimeServiceRequest' examples: ntpStandard: - $ref: "#/components/examples/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 ptpStandard: - $ref: "#/components/examples/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 ntpEnterpriseWithAdvanceConfiguration: - $ref: "#/components/examples/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: YmFzZTY0X3ByaW50YWJsZV9rZXk= + - type: HEX + keyNumber: 65535 + key: YTFhMWExYTFhMWExYTE= ptpEnterpriseWithAdvanceConfiguration: - $ref: "#/components/examples/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: PTP + domain: 127 + priority1: 0 + priority2: 1 + logAnnounceInterval: 1 + logSyncInterval: -4 + logDelayReqInterval: -4 + transportMode: UNICAST + grantTime: 300 required: true responses: - "202": + '202': description: Successful Accepted operation content: application/json: schema: - $ref: "#/components/schemas/precisionTimeServiceResponse" + $ref: '#/components/schemas/precisionTimeServiceResponse' examples: ntpStandard: - $ref: "#/components/examples/ntpStandardConfigureResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidName: - $ref: "#/components/examples/400-Invalid-Name" + value: + - errorCode: EQ-4800010 + errorMessage: Validation Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: /name + reason: Invalid name provided ValidateName: - $ref: "#/components/examples/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 DuplicateName: - $ref: "#/components/examples/400-Duplicate-Name" + value: + - errorCode: EQ-4800101 + errorMessage: Service name is already in use + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryConnectionUuid: - $ref: "#/components/examples/400-Mandatory-ConnectionUUid" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field ConnectionUUid is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionUuidFormat: - $ref: "#/components/examples/400-Invalid-ConnectionUuid-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid connection uuid format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionStatus: - $ref: "#/components/examples/400-Invalid-Connection-Status" + value: + - errorCode: EQ-4800102 + errorMessage: Connection should be in Pending Approval state + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateConnectionUuid: - $ref: "#/components/examples/400-Validate-ConnectionUuid" + value: + - errorCode: EQ-4800103 + errorMessage: Connection does not belong to this user + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionLocation: - $ref: "#/components/examples/400-Invalid-Connection-Location" + value: + - errorCode: EQ-4800104 + errorMessage: Connection location is not supported by EPT + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackageType: - $ref: "#/components/examples/400-Mandatory-PackageType" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field Package Type is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackageType: - $ref: "#/components/examples/400-Invalid-PackageType" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Package Type - Allowed types are PTP, NTP + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackageType: - $ref: "#/components/examples/400-Invalid-Connection-PackageType" + value: + - errorCode: EQ-4800105 + errorMessage: Connection Package type is different + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackage: - $ref: "#/components/examples/400-Mandatory-Package" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field Package is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackage: - $ref: "#/components/examples/400-Invalid-Package" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Package - Allowed packages are STANDARD, ENTERPRISE + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackage: - $ref: "#/components/examples/400-Invalid-Connection-Package" + value: + - errorCode: EQ-4800106 + errorMessage: Connection Package is different + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPrimaryIP: - $ref: "#/components/examples/400-Mandatory-PrimaryIP" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field PrimaryIP is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPrimaryIPFormat: - $ref: "#/components/examples/400-Invalid-PrimaryIP-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid PrimaryIP format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePrimaryIP: - $ref: "#/components/examples/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 MandatorySecondaryIP: - $ref: "#/components/examples/400-Mandatory-SecondaryIP" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field SecondaryIP is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidSecondaryIPFormat: - $ref: "#/components/examples/400-Invalid-SecondaryIP-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid SecondaryIP format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateSecondaryIP: - $ref: "#/components/examples/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 ValidateSameSubnet: - $ref: "#/components/examples/400-Validate-SameSubnet" + value: + - errorCode: EQ-4800108 + errorMessage: Primary and Secondary IPs should be in the same subnet + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryNetworkMask: - $ref: "#/components/examples/400-Mandatory-NetworkMask" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field NetworkMask is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidNetworkMaskFormat: - $ref: "#/components/examples/400-Invalid-NetworkMask-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid NetworkMask format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateNetworkMask: - $ref: "#/components/examples/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 InvalidDefaultGatewayFormat: - $ref: "#/components/examples/400-Invalid-DefaultGateway-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid DefaultGateway + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateDefaultGateway: - $ref: "#/components/examples/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 InvalidTimeScale: - $ref: "#/components/examples/400-Invalid-TimeScale" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid TimeScale - Allowed values are ARB, PTP + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidDomain: - $ref: "#/components/examples/400-Invalid-Domain" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Domain- Allowed values are from 0 to 127 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority1: - $ref: "#/components/examples/400-Invalid-Priority1" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Priority1 - Allowed values are 0 to 248 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority2: - $ref: "#/components/examples/400-Invalid-Priority2" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Priority2 - Allowed values are 0 to 248 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogAnnounceInterval: - $ref: "#/components/examples/400-Invalid-LogAnnounceInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid LogAnnounceInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogAnnounceIntervalRange: - $ref: "#/components/examples/400-Validate-LogAnnounceInterval-Range" + value: + - errorCode: EQ-4800111 + errorMessage: Invalid LogAnnounceInterval range - Allowed range is -3 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogSyncInterval: - $ref: "#/components/examples/400-Invalid-LogSyncInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid LogSyncInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogSyncIntervalRange: - $ref: "#/components/examples/400-Validate-LogSyncInterval-Range" + value: + - errorCode: EQ-4800112 + errorMessage: Invalid LogSyncInterval range - Allowed range is -5 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogDelayReqInterval: - $ref: "#/components/examples/400-Invalid-LogDelayReqInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid logDelayReqInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogDelayReqIntervalRange: - $ref: "#/components/examples/400-Validate-LogDelayReqInterval-Range" + value: + - errorCode: EQ-4800112 + errorMessage: Invalid logDelayReqInterval range - Allowed range is -5 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidTransportMode: - $ref: "#/components/examples/400-Invalid-TransportMode" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid TransportMode - Allowed values are Multicast, Unicast, Hybrid + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidGrantTime: - $ref: "#/components/examples/400-Invalid-GrantTime" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid GrantTime + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateGrantTimeRange: - $ref: "#/components/examples/400-Validate-GrantTime-Range" + value: + - errorCode: EQ-4800113 + errorMessage: Invalid GrantTime range - Allowed range is 30 to 7200 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidType: - $ref: "#/components/examples/400-Invalid-Type" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Type - Allowed values are ASCII, HEX + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidId: - $ref: "#/components/examples/400-Invalid-Id" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Id - Only Integers are allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPassword: - $ref: "#/components/examples/400-Invalid-Password" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Password + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePassword: - $ref: "#/components/examples/400-Validate-Password" - "401": + value: + - errorCode: EQ-4800114 + errorMessage: Only HEX allowed, chars value length should between 10 - 40 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3040020 + errorMessage: Fabric Precision Time Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric Precision Time Service not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - delete: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH + get: tags: - Precision Time Services - summary: Delete Time Service by ID - description: The API provides capability to delete Precision Time Service by service id - operationId: deleteTimeServiceById + summary: Get Time 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" + description: Precision Time Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": - description: Successful Delete + '200': + description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/precisionTimeServiceResponse" + $ref: '#/components/schemas/precisionTimeServiceResponse' examples: - ntpStandard: - $ref: "#/components/examples/ntpStandardDeletingResponse" - "401": + ntpStandardOriginPort: + 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 + operation: + operationalStatus: UP + 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' + ntpStandardOriginVirtualDevice: + 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 + operation: + operationalStatus: UP + 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' + ntpStandardOriginCloudRouter: + 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 + operation: + operationalStatus: UP + 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' + ntpEnterpriseOriginPort: + 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 + operation: + operationalStatus: UP + 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' + ntpEnterpriseWithAdvConfigOriginPort: + 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 + operation: + operationalStatus: UP + 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= + - type: HEX + keyNumber: 65535 + key: YTFhMWExYTFhMWExYTE= + 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' + ntpEnterpriseWithAdvConfigOriginVirtualDevice: + 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 + operation: + operationalStatus: UP + 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= + - type: HEX + keyNumber: 65535 + key: YTFhMWExYTFhMWExYTE= + 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' + ntpEnterpriseWithAdvConfigOriginCloudRouter: + 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 + operation: + operationalStatus: UP + 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= + - type: HEX + keyNumber: 65535 + key: YTFhMWExYTFhMWExYTE= + 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' + ptpStandardOriginPort: + 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 + operation: + operationalStatus: UP + 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' + ptpEnterpriseOriginPort: + 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 + operation: + operationalStatus: UP + 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: PTP + 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' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3040020 + errorMessage: Fabric Precision Time Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric Precision Time Service not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH patch: tags: - Precision Time Services @@ -12773,176 +38145,545 @@ paths: description: Service UUID required: true schema: - $ref: "#/components/schemas/ServiceId" + description: Precision Time Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json-patch+json: schema: - maxItems: 1 - minItems: 1 type: array + minItems: 1 + maxItems: 1 items: - $ref: "#/components/schemas/precisionTimeChangeOperation" + $ref: '#/components/schemas/precisionTimeChangeOperation' examples: updateName: - $ref: "#/components/examples/updateName" + value: + - op: replace + path: /name + value: Updated-Service-Name updatePackageCode: - $ref: "#/components/examples/updatePackageCode" + value: + - op: replace + path: /package/code + value: NTP_ENTERPRISE updateNetworkInformation: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/updateNtpAdvancedConfiguration" + value: + - op: replace + path: /ntpAdvancedConfiguration + value: + - type: ASCII + keyNumber: 65534 + key: YmFzZTY0X3ByaW50YWJsZV9rZXk= + - type: HEX + keyNumber: 65535 + key: YTFhMWExYTFhMWExYTE= required: true responses: - "202": + '202': description: Successful Accepted operation content: application/json: schema: - $ref: "#/components/schemas/precisionTimeServiceResponse" + $ref: '#/components/schemas/precisionTimeServiceResponse' examples: ntpStandard: - $ref: "#/components/examples/ntpStandardReprovisionResponse" - "400": + 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 + operation: + operationalStatus: UP + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidName: - $ref: "#/components/examples/400-Invalid-Name" + value: + - errorCode: EQ-4800010 + errorMessage: Validation Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: /name + reason: Invalid name provided ValidateName: - $ref: "#/components/examples/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 DuplicateName: - $ref: "#/components/examples/400-Duplicate-Name" + value: + - errorCode: EQ-4800101 + errorMessage: Service name is already in use + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryConnectionUuid: - $ref: "#/components/examples/400-Mandatory-ConnectionUUid" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field ConnectionUUid is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionUuidFormat: - $ref: "#/components/examples/400-Invalid-ConnectionUuid-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid connection uuid format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionStatus: - $ref: "#/components/examples/400-Invalid-Connection-Status" + value: + - errorCode: EQ-4800102 + errorMessage: Connection should be in Pending Approval state + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateConnectionUuid: - $ref: "#/components/examples/400-Validate-ConnectionUuid" + value: + - errorCode: EQ-4800103 + errorMessage: Connection does not belong to this user + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionLocation: - $ref: "#/components/examples/400-Invalid-Connection-Location" + value: + - errorCode: EQ-4800104 + errorMessage: Connection location is not supported by EPT + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackageType: - $ref: "#/components/examples/400-Mandatory-PackageType" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field Package Type is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackageType: - $ref: "#/components/examples/400-Invalid-PackageType" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Package Type - Allowed types are PTP, NTP + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackageType: - $ref: "#/components/examples/400-Invalid-Connection-PackageType" + value: + - errorCode: EQ-4800105 + errorMessage: Connection Package type is different + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackage: - $ref: "#/components/examples/400-Mandatory-Package" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field Package is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackage: - $ref: "#/components/examples/400-Invalid-Package" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Package - Allowed packages are STANDARD, ENTERPRISE + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackage: - $ref: "#/components/examples/400-Invalid-Connection-Package" + value: + - errorCode: EQ-4800106 + errorMessage: Connection Package is different + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPrimaryIP: - $ref: "#/components/examples/400-Mandatory-PrimaryIP" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field PrimaryIP is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPrimaryIPFormat: - $ref: "#/components/examples/400-Invalid-PrimaryIP-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid PrimaryIP format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePrimaryIP: - $ref: "#/components/examples/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 MandatorySecondaryIP: - $ref: "#/components/examples/400-Mandatory-SecondaryIP" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field SecondaryIP is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidSecondaryIPFormat: - $ref: "#/components/examples/400-Invalid-SecondaryIP-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid SecondaryIP format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateSecondaryIP: - $ref: "#/components/examples/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 ValidateSameSubnet: - $ref: "#/components/examples/400-Validate-SameSubnet" + value: + - errorCode: EQ-4800108 + errorMessage: Primary and Secondary IPs should be in the same subnet + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryNetworkMask: - $ref: "#/components/examples/400-Mandatory-NetworkMask" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field NetworkMask is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidNetworkMaskFormat: - $ref: "#/components/examples/400-Invalid-NetworkMask-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid NetworkMask format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateNetworkMask: - $ref: "#/components/examples/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 InvalidDefaultGatewayFormat: - $ref: "#/components/examples/400-Invalid-DefaultGateway-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid DefaultGateway + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateDefaultGateway: - $ref: "#/components/examples/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 InvalidTimeScale: - $ref: "#/components/examples/400-Invalid-TimeScale" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid TimeScale - Allowed values are ARB, PTP + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidDomain: - $ref: "#/components/examples/400-Invalid-Domain" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Domain- Allowed values are from 0 to 127 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority1: - $ref: "#/components/examples/400-Invalid-Priority1" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Priority1 - Allowed values are 0 to 248 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority2: - $ref: "#/components/examples/400-Invalid-Priority2" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Priority2 - Allowed values are 0 to 248 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogAnnounceInterval: - $ref: "#/components/examples/400-Invalid-LogAnnounceInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid LogAnnounceInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogAnnounceIntervalRange: - $ref: "#/components/examples/400-Validate-LogAnnounceInterval-Range" + value: + - errorCode: EQ-4800111 + errorMessage: Invalid LogAnnounceInterval range - Allowed range is -3 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogSyncInterval: - $ref: "#/components/examples/400-Invalid-LogSyncInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid LogSyncInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogSyncIntervalRange: - $ref: "#/components/examples/400-Validate-LogSyncInterval-Range" + value: + - errorCode: EQ-4800112 + errorMessage: Invalid LogSyncInterval range - Allowed range is -5 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogDelayReqInterval: - $ref: "#/components/examples/400-Invalid-LogDelayReqInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid logDelayReqInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogDelayReqIntervalRange: - $ref: "#/components/examples/400-Validate-LogDelayReqInterval-Range" + value: + - errorCode: EQ-4800112 + errorMessage: Invalid logDelayReqInterval range - Allowed range is -5 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidTransportMode: - $ref: "#/components/examples/400-Invalid-TransportMode" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid TransportMode - Allowed values are Multicast, Unicast, Hybrid + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidGrantTime: - $ref: "#/components/examples/400-Invalid-GrantTime" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid GrantTime + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateGrantTimeRange: - $ref: "#/components/examples/400-Validate-GrantTime-Range" + value: + - errorCode: EQ-4800113 + errorMessage: Invalid GrantTime range - Allowed range is 30 to 7200 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidType: - $ref: "#/components/examples/400-Invalid-Type" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Type - Allowed values are ASCII, HEX + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidId: - $ref: "#/components/examples/400-Invalid-Id" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Id - Only Integers are allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPassword: - $ref: "#/components/examples/400-Invalid-Password" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Password + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePassword: - $ref: "#/components/examples/400-Validate-Password" - "401": + value: + - errorCode: EQ-4800114 + errorMessage: Only HEX allowed, chars value length should between 10 - 40 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3040020 + errorMessage: Fabric Precision Time Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric Precision Time Service not found or already deleted + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH + delete: + tags: + - Precision Time Services + summary: Delete Time Service 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: + description: Precision Time Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + responses: + '202': + description: Successful Delete + content: + application/json: + schema: + $ref: '#/components/schemas/precisionTimeServiceResponse' + examples: + ntpStandard: + 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 + operation: + operationalStatus: UP + 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' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3040020 + errorMessage: Fabric Precision Time Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric Precision Time Service not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/timeServices/search: post: tags: @@ -12950,75 +38691,191 @@ paths: 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" + $ref: '#/components/schemas/TimeServicesSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/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 SearchFilterByNameAndProtocol: - $ref: "#/components/examples/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 SearchFilterOrAnd: - $ref: "#/components/examples/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' required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceSearchResponse" + $ref: '#/components/schemas/ServiceSearchResponse' examples: Example: - $ref: "#/components/examples/serviceSearchResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/service_400_invalid_sorting" - "401": + 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. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/timeServices/{serviceId}/connections: get: tags: @@ -13032,53 +38889,84 @@ paths: description: Service UUID required: true schema: - $ref: "#/components/schemas/ServiceId" + description: Precision Time Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Return Time Service Connection content: application/json: schema: - $ref: "#/components/schemas/precisionTimeServiceConnectionsResponse" + $ref: '#/components/schemas/precisionTimeServiceConnectionsResponse' examples: example: - $ref: "#/components/examples/serviceConnectionsResponse" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/timeServicePackages: get: tags: @@ -13086,35 +38974,106 @@ paths: summary: Get Packages description: The API provides capability to get timing service's packages operationId: getTimeServicesPackages - parameters: [] responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/precisionTimeServicePackagesResponse" - examples: - example: - $ref: "#/components/examples/servicePackagesResponse" - "415": + $ref: '#/components/schemas/precisionTimeServicePackagesResponse' + examples: + example: + 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' + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/timeServicePackages/{packageCode}: get: tags: @@ -13135,33 +39094,58 @@ paths: - PTP_STANDARD - PTP_ENTERPRISE responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/precisionTimePackageResponse" + $ref: '#/components/schemas/precisionTimePackageResponse' examples: example: - $ref: "#/components/examples/servicePackageResponse" - "415": + 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' + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/marketplaceSubscriptions/{subscriptionId}: get: tags: @@ -13175,54 +39159,226 @@ paths: description: Subscription UUID required: true schema: - $ref: "#/components/schemas/SubscriptionId" + description: Subscription Id + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/SubscriptionResponse" + $ref: '#/components/schemas/SubscriptionResponse' + examples: + example: + 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' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/subscription-response" - "401": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH + /fabric/v4/streams: + post: + tags: + - Streams + summary: Create Stream + description: This API provides capability to create user's stream + operationId: createStreams + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StreamPostRequest' + examples: + CreateStream: + value: + type: TELEMETRY_STREAM + name: splunk1 + description: subscription-1 + project: + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 + account: + accountNumber: 123456 + notifications: + - type: ALL + emails: + - johndoe@equinix.com + required: true + responses: + '202': + description: Stream object + content: + application/json: + schema: + $ref: '#/components/schemas/Stream' + examples: + StreamSubscriptionResponse: + 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 + account: + accountNumber: 123456 + notifications: + - type: ALL + emails: + - johndoe@equinix.com + state: PROVISIONED + assetsCount: 1 + streamSubscriptionsCount: 2 + alertRulesCount: 3 + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - /fabric/v4/streams: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error get: tags: - Streams @@ -13245,119 +39401,84 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetAllStreamResponse" + $ref: '#/components/schemas/GetAllStreamResponse' examples: Example: - $ref: "#/components/examples/stream-get-all-example" - "401": + 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 + alertRulesCount: 3 + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '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" + $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": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/streams/search: post: tags: @@ -13365,62 +39486,117 @@ paths: summary: Search Streams description: This API provides capability to search streams operationId: searchStreams - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/StreamSearchRequest" + $ref: '#/components/schemas/StreamSearchRequest' examples: SearchStreams: - $ref: "#/components/examples/StreamSearchRequestExample" + value: + filter: + and: + - property: /project/projectId + operator: IN + values: + - 2f7f1a59-2dbf-43f8-b1a4-3c1f4e4b55b5 + - or: + - property: /uuid + operator: IN + values: + - 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 + - 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + - property: /state + operator: '=' + values: + - PROVISIONED + sort: + - direction: DESC + property: /changeLog/createdDateTime + pagination: + offset: 0 + limit: 20 required: false responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/SearchStreamResponse" + $ref: '#/components/schemas/SearchStreamResponse' examples: Example: - $ref: "#/components/examples/stream-search-all-example" - "401": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + data: + - href: https://api.equinix.com/fabric/v4/streams/12f4d4a1-c7cb-4def-9f77-5ce93c19d999 + uuid: 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 + type: TELEMETRY_STREAM + name: stream-dev-01 + description: Observability stream for project assets + project: + projectId: 2f7f1a59-2dbf-43f8-b1a4-3c1f4e4b55b5 + state: PROVISIONED + assetsCount: 3 + streamSubscriptionsCount: 1 + alertRulesCount: 2 + changeLog: + createdDateTime: '2026-06-17T10:15:30Z' + updatedDateTime: '2026-06-18T10:15:30Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/streams/{streamId}: get: tags: @@ -13434,207 +39610,317 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 responses: - "200": + '200': description: Stream object content: application/json: schema: - $ref: "#/components/schemas/Stream" + $ref: '#/components/schemas/Stream' examples: StreamSubscriptionResponse: - $ref: "#/components/examples/StreamResponseExample" - "400": + 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 + account: + accountNumber: 123456 + notifications: + - type: ALL + emails: + - johndoe@equinix.com + state: PROVISIONED + assetsCount: 1 + streamSubscriptionsCount: 2 + alertRulesCount: 3 + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - put: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error + delete: tags: - Streams - summary: Update Stream - description: This API provides capability to update user's stream - operationId: updateStreamByUuid + 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" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/StreamPutRequest" - examples: - UpdateStream: - $ref: "#/components/examples/StreamPutRequestExample" - required: true + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 responses: - "202": + '202': description: Stream object content: application/json: schema: - $ref: "#/components/schemas/Stream" + $ref: '#/components/schemas/Stream' examples: - StreamResponse: - $ref: "#/components/examples/StreamResponseExample" - "400": + StreamSubscriptionResponse: + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $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": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - delete: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error + put: tags: - Streams - summary: Delete Stream - description: This API provides capability to delete user's stream - operationId: deleteStreamByUuid + 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" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StreamPutRequest' + examples: + UpdateStream: + value: + name: splunk1 + description: subscription 1 + required: true responses: - "202": + '202': description: Stream object content: application/json: schema: - $ref: "#/components/schemas/Stream" + $ref: '#/components/schemas/Stream' examples: - StreamSubscriptionResponse: - $ref: "#/components/examples/StreamDeleteRequestExample" - "400": + StreamResponse: + 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 + account: + accountNumber: 123456 + notifications: + - type: ALL + emails: + - johndoe@equinix.com + state: PROVISIONED + assetsCount: 1 + streamSubscriptionsCount: 2 + alertRulesCount: 3 + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/streamAssets/search: post: tags: @@ -13642,68 +39928,116 @@ paths: summary: Search Stream Assets description: This API provides capability to search stream assets operationId: searchStreamAssets - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/StreamAssetSearchRequest" + $ref: '#/components/schemas/StreamAssetSearchRequest' examples: SearchStreamAssets: - $ref: "#/components/examples/StreamAssetSearchRequestExample" + value: + filter: + and: + - property: /uuid + operator: IN + values: + - 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + - 9ac8ecfe-c7cb-4def-9f77-5ce93c19d83e + - property: /streamUuid + operator: '=' + values: + - 4719e319-65ae-4001-aabf-ca5f107b9b29 + - property: /attachmentStatus + operator: IN + values: + - ATTACHED + - ATTACHING + sort: + - direction: DESC + property: /uuid + pagination: + offset: 0 + limit: 20 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/SearchStreamAssetResponse" + $ref: '#/components/schemas/SearchStreamAssetResponse' examples: Example: - $ref: "#/components/examples/stream-asset-search-all-example" - "400": + 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 + streamUuid: e784aa26-8276-48b7-bb42-a6d9def0a424 + type: XF_PORT + metricsEnabled: false + attachmentStatus: ATTACHED + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/streams/{streamId}/{asset}/{assetId}: get: tags: @@ -13717,71 +40051,97 @@ paths: description: asset UUID required: true schema: - $ref: "#/components/schemas/AssetId_1" + description: Stream Asset UUID + type: string + format: uuid + example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - name: asset in: path description: asset required: true schema: - $ref: "#/components/schemas/Asset" + $ref: '#/components/schemas/Asset' - name: streamId in: path description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 responses: - "200": + '200': description: Stream asset object content: application/json: schema: - $ref: "#/components/schemas/StreamAsset" + $ref: '#/components/schemas/StreamAsset' examples: StreamSubscriptionResponse: - $ref: "#/components/examples/StreamConnectionAssetResponseExample" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error put: tags: - Streams @@ -13794,89 +40154,120 @@ paths: description: asset UUID required: true schema: - $ref: "#/components/schemas/AssetId_1" + description: Stream Asset UUID + type: string + format: uuid + example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - name: asset in: path description: asset required: true schema: - $ref: "#/components/schemas/Asset" + $ref: '#/components/schemas/Asset' - name: streamId in: path description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 requestBody: content: application/json: schema: - $ref: "#/components/schemas/StreamAssetPutRequest" + $ref: '#/components/schemas/StreamAssetPutRequest' examples: UpdateStream: - $ref: "#/components/examples/StreamAssetPutRequestExample" + value: + metricsEnabled: false required: true responses: - "202": + '202': description: Stream object content: application/json: schema: - $ref: "#/components/schemas/StreamAsset" + $ref: '#/components/schemas/StreamAsset' examples: StreamAssetResponse: - $ref: "#/components/examples/StreamRouterAssetAttachResponseExample" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error delete: tags: - Streams @@ -13889,71 +40280,97 @@ paths: description: asset UUID required: true schema: - $ref: "#/components/schemas/AssetId_1" + description: Stream Asset UUID + type: string + format: uuid + example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - name: asset in: path description: asset required: true schema: - $ref: "#/components/schemas/Asset" + $ref: '#/components/schemas/Asset' - name: streamId in: path description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 responses: - "202": + '202': description: Stream object content: application/json: schema: - $ref: "#/components/schemas/StreamAsset" + $ref: '#/components/schemas/StreamAsset' examples: StreamAssetResponse: - $ref: "#/components/examples/StreamRouterAssetDetachResponseExample" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/streams/{streamId}/devices/{deviceId}: get: tags: @@ -13967,65 +40384,104 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: deviceId in: path description: Network Edge Device UUID required: true schema: - $ref: "#/components/schemas/DeviceId" + description: Network Edge Device UUID + type: string + format: uuid + example: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d responses: - "200": + '200': description: Stream Network Edge Device asset object content: application/json: schema: - $ref: "#/components/schemas/StreamAsset" + $ref: '#/components/schemas/StreamAsset' examples: StreamDeviceAssetResponse: - $ref: "#/components/examples/StreamDeviceAssetResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d + uuid: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d + type: VIRTUAL_DEVICE + metricsEnabled: true + attachmentStatus: ATTACHED + interfaces: + - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3 + id: 3 + uuid: 1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b + type: DATA + state: ASSIGNED + attachmentStatus: ATTACHED + - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5 + id: 5 + uuid: 4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d + type: DATA + state: ASSIGNED + attachmentStatus: ATTACHED + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error put: tags: - Streams @@ -14039,83 +40495,130 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: deviceId in: path description: Network Edge Device UUID required: true schema: - $ref: "#/components/schemas/DeviceId" + description: Network Edge Device UUID + type: string + format: uuid + example: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d requestBody: content: application/json: schema: - $ref: "#/components/schemas/StreamDevicePutRequest" + $ref: '#/components/schemas/StreamDevicePutRequest' examples: UpdateStreamDevice: - $ref: "#/components/examples/StreamDevicePutRequestExample" + value: + metricsEnabled: true + interfaces: + - id: 3 + - id: 5 required: true responses: - "202": + '202': description: Stream Network Edge Device asset object content: application/json: schema: - $ref: "#/components/schemas/StreamAsset" + $ref: '#/components/schemas/StreamAsset' examples: StreamDeviceAssetResponse: - $ref: "#/components/examples/StreamDeviceAssetAttachResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d + uuid: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d + type: VIRTUAL_DEVICE + metricsEnabled: true + attachmentStatus: ATTACHING + interfaces: + - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3 + id: 3 + uuid: 1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b + type: DATA + state: ASSIGNED + attachmentStatus: ATTACHING + - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5 + id: 5 + uuid: 4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d + type: DATA + state: ASSIGNED + attachmentStatus: ATTACHING + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error delete: tags: - Streams @@ -14128,139 +40631,105 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: deviceId in: path description: Network Edge Device UUID required: true schema: - $ref: "#/components/schemas/DeviceId" + description: Network Edge Device UUID + type: string + format: uuid + example: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d responses: - "202": + '202': description: Stream Network Edge Device asset object content: application/json: schema: - $ref: "#/components/schemas/StreamAsset" + $ref: '#/components/schemas/StreamAsset' examples: StreamDeviceAssetResponse: - $ref: "#/components/examples/StreamDeviceAssetDetachResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d + uuid: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d + type: VIRTUAL_DEVICE + metricsEnabled: true + attachmentStatus: DETACHING + interfaces: + - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3 + id: 3 + uuid: 1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b + type: DATA + state: ASSIGNED + attachmentStatus: DETACHING + - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5 + id: 5 + uuid: 4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d + type: DATA + state: ASSIGNED + attachmentStatus: DETACHING + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /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 @@ -14273,255 +40742,599 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 requestBody: content: application/json: schema: - $ref: "#/components/schemas/StreamSubscriptionPostRequest" + $ref: '#/components/schemas/StreamSubscriptionPostRequest' examples: CreateStreamSubscription_Splunk_Simple: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleSimpleDefaultSplunk" + value: + type: STREAM_SUBSCRIPTION + name: splunk1 + description: subscription-1 + enabled: true + sink: + uri: https://http-inputs-.splunkcloud.com:/services/collector/event + type: SPLUNK_HEC + credential: + type: ACCESS_TOKEN + accessToken: Splunk + settings: + source: Equinix + eventIndex: idx-hec-event + metricIndex: idx-hec-metric CreateStreamSubscription_Splunk: - $ref: "#/components/examples/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://http-inputs-.splunkcloud.com:/services/collector/event + type: SPLUNK_HEC + credential: + type: ACCESS_TOKEN + accessToken: Splunk + settings: + source: Equinix + eventIndex: idx-hec-event + metricIndex: idx-hec-metric CreateStreamSubscription_Slack: - $ref: "#/components/examples/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 CreateStreamSubscription_Pagerduty: - $ref: "#/components/examples/StreamSubscriptionPostRequestExamplePagerduty" + value: + type: STREAM_SUBSCRIPTION + name: pagerduty + description: subscription-1 + enabled: true + metricSelector: + include: + - equinix.fabric.connection.* + eventSelector: + include: + - equinix.fabric.connection.* + sink: + host: https://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 CreateStreamSubscription_Datadog: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleDatadog" + value: + type: STREAM_SUBSCRIPTION + name: datadog + description: subscription-1 + enabled: true + metricSelector: + include: + - equinix.fabric.connection.* + sink: + host: https://.datadoghq.com + type: DATADOG + credential: + type: API_KEY + apiKey: my-api-key + settings: + source: Equinix + applicationKey: my-application-key + eventUri: https://.datadoghq.com/api/v1/events + metricUri: https://.datadoghq.com/api/v2/series CreateStreamSubscription_Dynatrace: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleDynatrace" + value: + type: STREAM_SUBSCRIPTION + name: dynatrace-subscription + description: subscription-1 + enabled: true + metricSelector: + include: + - equinix.fabric.connection.* + sink: + type: DYNATRACE + credential: + type: API_TOKEN + apiToken: + settings: + eventUri: https://.live.dynatrace.com/platform/ingest/v1/events + metricUri: https://.live.dynatrace.com/api/v2/metrics/ingest CreateStreamSubscription_Microsoft_Teams: - $ref: "#/components/examples/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 CreateStreamSubscription_Servicenow: - $ref: "#/components/examples/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 CreateStreamSubscription_Generic_Webhook_No_Auth: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleGenericWebhookNoAuth" + value: + type: STREAM_SUBSCRIPTION + name: webhook + description: subscription-1 + enabled: true + sink: + type: WEBHOOK + settings: + eventUri: https://xxxxxx + metricUri: https://xxxxxx + format: CLOUDEVENT CreateStreamSubscription_Generic_Webhook_With_ApiKey: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleGenericWebhookApiKey" + value: + type: STREAM_SUBSCRIPTION + name: webhook + description: subscription-1 + enabled: true + sink: + type: WEBHOOK + settings: + eventUri: https://xxxxxx + metricUri: https://xxxxxx + format: CLOUDEVENT + credential: + type: API_KEY + apiKey: CreateStreamSubscription_Generic_Webhook_With_AccessToken: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleGenericWebhookAccessToken" + value: + type: STREAM_SUBSCRIPTION + name: webhook + description: subscription-1 + enabled: true + sink: + type: WEBHOOK + settings: + eventUri: https://xxxxxx + metricUri: https://xxxxxx + format: CLOUDEVENT + credential: + type: ACCESS_TOKEN + accessToken: CreateStreamSubscription_Generic_Webhook_With_Username_Password: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleGenericWebhookUsernamePassword" + value: + type: STREAM_SUBSCRIPTION + name: webhook + description: subscription-1 + enabled: true + sink: + type: WEBHOOK + settings: + eventUri: https://xxxxxx + metricUri: https://xxxxxx + format: CLOUDEVENT + credential: + type: USERNAME_PASSWORD + username: + password: CreateStreamSubscription_Grafana_Webhook: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleGrafanaWebhook" + value: + type: STREAM_SUBSCRIPTION + name: webhook + description: subscription-1 + enabled: true + metricSelector: + include: + - equinix.fabric.connection.* + sink: + type: WEBHOOK + settings: + eventUri: https:///otlp/v1/logs + metricUri: https:///otlp/v1/metrics + format: OPENTELEMETRY + credential: + type: API_KEY + apiKey: : CreateStreamSubscription_Google_PubSub: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleGooglePubSub" + value: + type: STREAM_SUBSCRIPTION + name: gcp-pubsub + description: subscription-1 + enabled: true + metricSelector: + include: + - equinix.fabric.connection.* + sink: + type: GOOGLE_PUBSUB + uri: https://pubsub.googleapis.com/v1/projects//topics/:publish + credential: + type: ACCESS_TOKEN + accessToken: required: true responses: - "202": + '202': description: Stream Subscription object content: application/json: schema: - $ref: "#/components/schemas/StreamSubscription" + $ref: '#/components/schemas/StreamSubscription' examples: StreamSubscriptionResponse: - $ref: "#/components/examples/StreamSubscriptionResponseExample" - "400": + 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://http-inputs-.splunkcloud.com:/services/collector/event + 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 + operation: + eventsDeliveredCount: 0 + metricsDeliveredCount: 0 + alertsDeliveredCount: 0 + errors: [] + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - /fabric/v4/streams/{streamId}/subscriptions/{subscriptionId}: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error get: tags: - Stream Subscriptions - summary: Get Subscription - description: This API provides capability to delete user's get Stream Subscriptions - operationId: getStreamSubscriptionByUuid + 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: subscriptionId - in: path - description: Stream Subscription UUID - required: true + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 + - name: offset + in: query + description: offset + required: false schema: - $ref: "#/components/schemas/StreamSubscriptionId" + 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 Subscription object + '200': + description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/StreamSubscription" + $ref: '#/components/schemas/GetAllStreamSubscriptionResponse' examples: - StreamSubscriptionResponse: - $ref: "#/components/examples/StreamSubscriptionResponseExample" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - "401": + 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 + operation: + eventsDeliveredCount: 0 + metricsDeliveredCount: 0 + alertsDeliveredCount: 0 + errors: [] + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - put: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error + /fabric/v4/streams/{streamId}/subscriptions/{subscriptionId}: + get: tags: - Stream Subscriptions - summary: Update Subscription - description: This API provides capability to update user's Stream Subscriptions - operationId: updateStreamSubscriptionByUuid + 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" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - 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 + description: Stream Subscription UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '200': description: Stream Subscription object content: application/json: schema: - $ref: "#/components/schemas/StreamSubscription" + $ref: '#/components/schemas/StreamSubscription' examples: StreamSubscriptionResponse: - $ref: "#/components/examples/StreamSubscriptionResponseExample" - "400": + 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://http-inputs-.splunkcloud.com:/services/collector/event + 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 + operation: + eventsDeliveredCount: 0 + metricsDeliveredCount: 0 + alertsDeliveredCount: 0 + errors: [] + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '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" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error delete: tags: - Stream Subscriptions @@ -14534,208 +41347,421 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: subscriptionId in: path description: Stream Subscription UUID required: true schema: - $ref: "#/components/schemas/StreamSubscriptionId" + description: Stream Subscription UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '202': description: Stream Subscription object content: application/json: schema: - $ref: "#/components/schemas/StreamSubscription" + $ref: '#/components/schemas/StreamSubscription' examples: StreamSubscriptionResponse: - $ref: "#/components/examples/StreamSubscriptionDeleteResponseExample" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - /fabric/v4/streamSubscriptions/search: - post: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error + put: tags: - Stream Subscriptions - summary: Search Stream Subscriptions - description: This API provides capability to search stream subscriptions - operationId: searchStreamSubscriptions - parameters: [] + 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: + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 + - name: subscriptionId + in: path + description: Stream Subscription UUID + required: true + schema: + description: Stream Subscription UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/StreamSubscriptionSearchRequest" + $ref: '#/components/schemas/StreamSubscriptionPutRequest' examples: - SearchStreamSubscriptions: - $ref: "#/components/examples/StreamSubscriptionSearchRequestExample" + UpdateSubscription: + 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: my-access-token + settings: + source: Equinix + eventIndex: idx-hec-event + metricIndex: idx-hec-metric + batchEnabled: false + batchSizeMax: 50 + batchWaitTimeMax: 5 required: true responses: - "200": - description: Successful operation + '202': + description: Stream Subscription object content: application/json: schema: - $ref: "#/components/schemas/SearchStreamSubscriptionResponse" + $ref: '#/components/schemas/StreamSubscription' examples: - Example: - $ref: "#/components/examples/stream-subscription-search-all-example" - "400": + StreamSubscriptionResponse: + 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://http-inputs-.splunkcloud.com:/services/collector/event + 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 + operation: + eventsDeliveredCount: 0 + metricsDeliveredCount: 0 + alertsDeliveredCount: 0 + errors: [] + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - /fabric/v4/streams/{streamId}/alertRules: - get: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error + /fabric/v4/streamSubscriptions/search: + post: 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 + - Stream Subscriptions + summary: Search Stream Subscriptions + description: This API provides capability to search stream subscriptions + operationId: searchStreamSubscriptions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StreamSubscriptionSearchRequest' + examples: + SearchStreamSubscriptions: + value: + filter: + and: + - property: /streamUuid + operator: '=' + values: + - 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 + - or: + - property: /uuid + operator: '=' + values: + - 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + - property: /name + operator: ILIKE + values: + - demo% + sort: + - direction: DESC + property: /changeLog/createdDateTime + pagination: + offset: 0 + limit: 20 + required: true responses: - "200": - description: Stream Alert Rules object + '200': + description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetAllStreamAlertRuleResponse" + $ref: '#/components/schemas/SearchStreamSubscriptionResponse' examples: - GetAllStreamAlertRuleResponse: - $ref: "#/components/examples/stream-alert-rules-get-all-example" - "401": + Example: + value: + pagination: + offset: 0 + limit: 20 + total: 1 + data: + - href: https://api.equinix.com/fabric/v4/streams/12f4d4a1-c7cb-4def-9f77-5ce93c19d999/subscriptions/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + uuid: 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + type: STREAM_SUBSCRIPTION + name: demo-subscription + description: Subscription for demo stream events + state: PROVISIONED + enabled: true + metricSelector: + include: + - equinix.fabric.connection.* + eventSelector: + include: + - equinix.fabric.connection.* + sink: + uri: https://hooks.example.com/fabric + type: WEBHOOK + batchEnabled: false + batchSizeMax: 50 + batchWaitTimeMax: 5 + operation: + eventsDeliveredCount: 12 + metricsDeliveredCount: 4 + alertsDeliveredCount: 0 + errors: [] + changeLog: + createdDateTime: '2026-06-17T10:15:30Z' + updatedDateTime: '2026-06-18T10:15:30Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error + /fabric/v4/streams/{streamId}/alertRules: post: tags: - Stream Alert Rules @@ -14748,70 +41774,257 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 requestBody: content: application/json: schema: - $ref: "#/components/schemas/AlertRulePostRequest" + $ref: '#/components/schemas/AlertRulePostRequest' examples: CreateStreamAlertRules: - $ref: "#/components/examples/StreamAlertRulePostRequestExample" + value: + name: metric-alert-1 + type: METRIC_ALERT + description: metric-alert-1 + enabled: true + metricSelector: + include: + - equinix.fabric.connection.bandwidth_tx.usage + resourceSelector: + include: + - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b + detectionMethod: + type: THRESHOLD + windowSize: PT15M + warningThreshold: '35000000' + criticalThreshold: '45000000' CreateStreamSmartAlertRules: - $ref: "#/components/examples/StreamSmartAlertRulePostRequestExample" + value: + name: metric-alert-1 + type: METRIC_ALERT + description: metric-alert-1 + enabled: true + metricSelector: + include: + - equinix.fabric.metro.sv_sy.latency + resourceSelector: + include: + - /fabric/v4/metros/SV + detectionMethod: + type: OUTLIER required: true responses: - "202": + '202': description: Stream Alert Rules object content: application/json: schema: - $ref: "#/components/schemas/StreamAlertRule" + $ref: '#/components/schemas/StreamAlertRule' examples: StreamAlertRuleRequestResponse: - $ref: "#/components/examples/StreamAlertRuleResponseExample" - "400": + 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 + metricSelector: + include: + - equinix.fabric.connection.bandwidth_tx.usage + resourceSelector: + include: + - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b + detectionMethod: + type: THRESHOLD + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error + 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: + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 + - 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/GetAllStreamAlertRuleResponse' + examples: + GetAllStreamAlertRuleResponse: + 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 + metricSelector: + include: + - equinix.fabric.connection.bandwidth_tx.usage + resourceSelector: + include: + - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b + detectionMethod: + type: THRESHOLD + windowSize: PT15M + operand: ABOVE + warningThreshold: '35000000' + criticalThreshold: '45000000' + changeLog: + createdBy: user + createdDateTime: '2024-05-06T16:21:18.545214Z' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/streams/{streamId}/alertRules/{alertRuleId}: get: tags: @@ -14825,65 +42038,110 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: alertRuleId in: path description: alert rule UUID required: true schema: - $ref: "#/components/schemas/AlertRuleId" + description: Stream Alert Rule UUID + type: string + format: uuid + example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 responses: - "200": + '200': description: Stream Alert Rules object content: application/json: schema: - $ref: "#/components/schemas/StreamAlertRule" + $ref: '#/components/schemas/StreamAlertRule' examples: StreamAlertRuleResponse: - $ref: "#/components/examples/StreamAlertRuleResponseExample" - "400": + 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 + metricSelector: + include: + - equinix.fabric.connection.bandwidth_tx.usage + resourceSelector: + include: + - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b + detectionMethod: + type: THRESHOLD + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error put: tags: - Stream Alert Rules @@ -14896,83 +42154,148 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: alertRuleId in: path description: alert rule UUID required: true schema: - $ref: "#/components/schemas/AlertRuleId" + description: Stream Alert Rule UUID + type: string + format: uuid + example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 requestBody: content: application/json: schema: - $ref: "#/components/schemas/AlertRulePutRequest" + $ref: '#/components/schemas/AlertRulePutRequest' examples: UpdateStreamAlertRules: - $ref: "#/components/examples/StreamAlertRulePutRequestExample" + value: + name: metric-alert-1 + type: METRIC_ALERT + description: metric-alert-1 + enabled: true + metricSelector: + include: + - equinix.fabric.connection.bandwidth_tx.usage + resourceSelector: + include: + - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b + detectionMethod: + type: THRESHOLD + windowSize: PT15M + operand: ABOVE + warningThreshold: '35000000' + criticalThreshold: '45000000' required: true responses: - "202": + '202': description: Stream Alert Rules object content: application/json: schema: - $ref: "#/components/schemas/StreamAlertRule" + $ref: '#/components/schemas/StreamAlertRule' examples: StreamAlertRuleRequestResponse: - $ref: "#/components/examples/StreamAlertRuleResponseExample" - "400": + 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 + metricSelector: + include: + - equinix.fabric.connection.bandwidth_tx.usage + resourceSelector: + include: + - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b + detectionMethod: + type: THRESHOLD + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error delete: tags: - Stream Alert Rules @@ -14985,65 +42308,110 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: alertRuleId in: path description: alert rule UUID required: true schema: - $ref: "#/components/schemas/AlertRuleId" + description: Stream Alert Rule UUID + type: string + format: uuid + example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 responses: - "202": + '202': description: Stream Alert Rules object content: application/json: schema: - $ref: "#/components/schemas/StreamAlertRule" + $ref: '#/components/schemas/StreamAlertRule' examples: StreamAlertRuleDeleteResponse: - $ref: "#/components/examples/StreamAlertRuleDeleteResponseExample" - "400": + 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 + metricSelector: + include: + - equinix.fabric.connection.bandwidth_tx.usage + resourceSelector: + include: + - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b + detectionMethod: + type: THRESHOLD + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/companyProfiles: post: tags: @@ -15051,38 +42419,37 @@ paths: summary: Create Company Profile description: Create a new company profile Beta operationId: createCompanyProfile - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/CompanyProfileRequest" + $ref: '#/components/schemas/CompanyProfileRequest' required: true responses: - "202": + '202': description: Company profile created and pending for approval content: application/json: schema: - $ref: "#/components/schemas/CompanyProfileResponse" - "400": + $ref: '#/components/schemas/CompanyProfileResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}: get: tags: @@ -15098,30 +42465,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CompanyProfileResponse" - "400": + $ref: '#/components/schemas/CompanyProfileResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' delete: tags: - Company Profiles @@ -15136,30 +42503,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CompanyProfileResponse" - "400": + $ref: '#/components/schemas/CompanyProfileResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/search: post: tags: @@ -15179,27 +42546,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/CompanyProfileSearchRequest" + $ref: '#/components/schemas/CompanyProfileSearchRequest' required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CompanyProfileSearchResponse" - "400": + $ref: '#/components/schemas/CompanyProfileSearchResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/serviceProfiles: get: tags: @@ -15215,30 +42582,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceProfileListResponse" - "400": + $ref: '#/components/schemas/ServiceProfileListResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/serviceProfiles/{serviceProfileId}: put: tags: @@ -15260,30 +42627,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AttachServiceProfileResponse" - "400": + $ref: '#/components/schemas/AttachServiceProfileResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' delete: tags: - Company Profiles @@ -15304,30 +42671,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AttachServiceProfileResponse" - "400": + $ref: '#/components/schemas/AttachServiceProfileResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/tags: get: tags: @@ -15343,30 +42710,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/TagListResponse" - "400": + $ref: '#/components/schemas/TagListResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/tags/{tagId}: put: tags: @@ -15388,30 +42755,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AttachTagResponse" - "400": + $ref: '#/components/schemas/AttachTagResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' delete: tags: - Company Profiles @@ -15432,30 +42799,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AttachTagResponse" - "400": + $ref: '#/components/schemas/AttachTagResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/privateServices: get: tags: @@ -15471,30 +42838,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/PrivateServiceListResponse" - "400": + $ref: '#/components/schemas/PrivateServiceListResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/privateServices/{privateServiceId}: put: tags: @@ -15516,30 +42883,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AttachPrivateServiceResponse" - "400": + $ref: '#/components/schemas/AttachPrivateServiceResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' delete: tags: - Company Profiles @@ -15560,30 +42927,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AttachPrivateServiceResponse" - "400": + $ref: '#/components/schemas/AttachPrivateServiceResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/logos: post: tags: @@ -15591,44 +42958,43 @@ paths: summary: Create Logo description: Create Logo for Equinix Fabric™ Company Profile operationId: createLogo - parameters: [] requestBody: content: multipart/form-data: schema: - $ref: "#/components/schemas/LogoRequest" + $ref: '#/components/schemas/LogoRequest' required: true responses: - "201": + '201': description: Successful Create operation content: application/json: schema: - $ref: "#/components/schemas/LogoResponse" - "400": + $ref: '#/components/schemas/LogoResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/logos/{uuid}: get: tags: @@ -15645,43 +43011,43 @@ paths: type: string format: uuid responses: - "200": + '200': description: Successful Get operation content: multipart/mixed: schema: type: string format: binary - "400": + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' delete: tags: - Logos @@ -15697,36 +43063,36 @@ paths: type: string format: uuid responses: - "202": + '202': description: Successful Delete operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/LogoResponse" - "401": + $ref: '#/components/schemas/LogoResponse' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/loas: post: tags: @@ -15734,87 +43100,270 @@ paths: summary: Create Loa description: The API provides capability to create a new Loa operationId: createLoa - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/CreateLoa" + $ref: '#/components/schemas/CreateLoa' examples: IssueLoa-OnCageWithCageId: - $ref: "#/components/examples/IssueLoaOnCageWithCageId" + value: + type: CAGE_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + expirationDateTime: '2026-12-31T23:59:59Z' + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + demarcationPoint: + cageUniqueSpaceId: AM7:0G:0202 IssueLoa-OnPatchPanelPort: - $ref: "#/components/examples/IssueLoaOnPatchPanelPort" + value: + type: PATCH_PANEL_PORT_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for patch panel port access to Equinix at SV1 + authorizedProductType: XC + expirationDateTime: '2026-12-31T23:59:59Z' + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 24 + connectorType: SC IssueLoa-OnPatchPanel: - $ref: "#/components/examples/IssueLoaOnPatchPanel" + value: + type: PATCH_PANEL_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for patch panel access to Equinix at SV1 + authorizedProductType: XC + expirationDateTime: '2026-12-31T23:59:59Z' + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + demarcationPoint: + patchPanelId: CP:Demarc:1259684 RequestLoa-OnCage: - $ref: "#/components/examples/RequestLoaOnCage" + value: + type: CAGE_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for patch panel port access to Equinix at SV1 + authorizedProductType: XC + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + location: + ibxCode: SV11 RequestLoa-OnPatchPanel: - $ref: "#/components/examples/RequestLoaOnPatchPanel" + value: + type: PATCH_PANEL_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for patch panel port access to Equinix at SV1 + authorizedProductType: XC + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + location: + ibxCode: SV11 RequestLoa-OnPatchPanelPort: - $ref: "#/components/examples/RequestLoaOnPatchPanelPort" + value: + type: PATCH_PANEL_PORT_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for patch panel port access to Equinix at SV1 + authorizedProductType: XC + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + location: + ibxCode: SV11 required: true responses: - "202": + '202': description: Accepted content: application/json: schema: - $ref: "#/components/schemas/LoaResponse" + $ref: '#/components/schemas/LoaResponse' examples: ByRequestor: - $ref: "#/components/examples/LoaCreateResponseByRequestor" + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: PATCH_PANEL_PORT_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + state: PENDING_AUTHORIZATION + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + location: + ibxCode: SV1 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org1.com ByIssuerWithCageType: - $ref: "#/components/examples/LoaCreateResponseByIssuerWithCageType" + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: CAGE_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + state: PENDING_ACCEPTANCE + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + demarcationPoint: + cageUniqueSpaceId: SV1:01:10:200 + location: + ibxCode: SV1 + changeLog: + createdDateTime: '2025-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com ByIssuerWithPatchPanelPortType: - $ref: "#/components/examples/LoaCreateResponseByIssuerWithPatchPanelPortType" + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: PATCH_PANEL_PORT_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + state: PENDING_ACCEPTANCE + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 23 + connectorType: SC + location: + ibxCode: SV1 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com ByIssuerWithPatchPanelType: - $ref: "#/components/examples/LoaCreateResponseByIssuerWithPatchPanelType" - "400": + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: PATCH_PANEL_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + state: PENDING_ACCEPTANCE + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + location: + ibxCode: SV1 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_400" - "401": + value: + - errorCode: EQ-3070103 + errorMessage: Loa does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/loas/{loaId}: get: tags: @@ -15828,62 +43377,121 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 responses: - "200": + '200': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/LoaResponse" + $ref: '#/components/schemas/LoaResponse' examples: LoaExample: - $ref: "#/components/examples/LoaResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: PATCH_PANEL_PORT_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + state: INACTIVE + expirationDateTime: '2024-12-31T23:59:59Z' + operation: + consumersCount: 10 + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + demarcationPoint: + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0105 + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 23 + connectorType: SC + location: + ibxCode: SV1 + changeLog: + createdDateTime: '2025-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_400" - "401": + value: + - errorCode: EQ-3070103 + errorMessage: Loa does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request patch: tags: - Loas @@ -15896,71 +43504,130 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/LoaUpdate" + $ref: '#/components/schemas/LoaUpdate' examples: LoaPatchRequest: - $ref: "#/components/examples/LoaPatchRequest" + value: + - op: replace + path: /demarcationPoint/patchPanelId + value: CP:Demarc:1259685 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/LoaResponse" + $ref: '#/components/schemas/LoaResponse' examples: PatchLoaResponse: - $ref: "#/components/examples/LoaPatchResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: PATCH_PANEL_PORT_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + state: INACTIVE + operation: + consumersCount: 1 + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 23 + connectorType: SC + location: + ibxCode: SV1 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_400" - "401": + value: + - errorCode: EQ-3070103 + errorMessage: Loa does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/loas/{loaId}/actions: post: tags: @@ -15974,85 +43641,166 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 requestBody: content: application/json: schema: - $ref: "#/components/schemas/LoaActionRequest" + $ref: '#/components/schemas/LoaActionRequest' examples: AuthorizeLoa: - $ref: "#/components/examples/AuthorizeLoaActionRequest" + value: + type: LOA_ISSUER_AUTHORIZATION + data: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 23 + connectorType: SC + expirationDateTime: '2026-08-07T07:00:00Z' AcceptLoa: - $ref: "#/components/examples/AcceptLoaActionRequest" + value: + type: LOA_REQUESTOR_ACCEPTANCE CopyLoa: - $ref: "#/components/examples/CopyLoaActionRequest" + value: + type: LOA_COPY_LINK SendLoa: - $ref: "#/components/examples/SendLoaActionRequest" + value: + type: LOA_SEND_EMAIL_NOTIFICATION CancelLoa: - $ref: "#/components/examples/CancelLoaActionRequest" + value: + type: LOA_CANCEL required: true responses: - "202": + '202': description: Accepted content: application/json: schema: - $ref: "#/components/schemas/LoaActionResponse" + $ref: '#/components/schemas/LoaActionResponse' examples: AuthorizeLoa: - $ref: "#/components/examples/AuthorizeLoaActionResponse" + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: LOA_ISSUER_AUTHORIZATION + state: COMPLETED + data: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 23 + connectorType: SC + expirationDateTime: '2026-08-07T07:00:00Z' + changeLog: + createdDateTime: '2026-06-24T06:50:46Z' + createdBy: user + createdByEmail: user@org1.com AcceptLoa: - $ref: "#/components/examples/AcceptLoaActionResponse" + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: LOA_REQUESTOR_ACCEPTANCE + state: COMPLETED + changeLog: + createdDateTime: '2025-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com SendLoa: - $ref: "#/components/examples/SendLoaActionResponse" + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: LOA_SEND_EMAIL_NOTIFICATION + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com CopyLoa: - $ref: "#/components/examples/CopyLoaActionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: LOA_COPY_LINK + state: COMPLETED + data: + portalUrl: https://portal.equinix.com/fabric/loa/inventory/issuer/29cc7878-54e3-4e1a-8651-87a61354bac2/authorize + changeLog: + createdDateTime: '2026-06-24T06:50:46Z' + createdBy: user + createdByEmail: user@org1.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_Action_400" - "401": + value: + - errorCode: EQ-3070107 + errorMessage: Loa Action does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa Action does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_Action_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa Action not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa 3070101 does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/loas/{loaId}/actions/{actionId}: get: tags: @@ -16066,68 +43814,114 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 - name: actionId in: path description: Action UUID required: true schema: - $ref: "#/components/schemas/ActionId_2" + description: Action UUID + type: string + format: uuid + example: 30cc7878-54e3-4e1a-8651-87a61354bad4 responses: - "200": + '200': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/LoaActionResponse" + $ref: '#/components/schemas/LoaActionResponse' examples: AuthorizeLoaActionExample: - $ref: "#/components/examples/AuthorizeLoaActionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: LOA_ISSUER_AUTHORIZATION + state: COMPLETED + data: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 23 + connectorType: SC + expirationDateTime: '2026-08-07T07:00:00Z' + changeLog: + createdDateTime: '2026-06-24T06:50:46Z' + createdBy: user + createdByEmail: user@org1.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_Action_400" - "401": + value: + - errorCode: EQ-3070107 + errorMessage: Loa Action does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa Action does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_Action_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa Action not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa 3070101 does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/loas/search: post: tags: @@ -16135,73 +43929,175 @@ paths: summary: Search Loas description: The API provides capability to get list of user's Loa using search criteria, including optional filtering, pagination and sorting operationId: searchLoa - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/LoaSearchRequest" + $ref: '#/components/schemas/LoaSearchRequest' examples: SearchByNameWithType: - $ref: "#/components/examples/LoaSearchByNameWithType" + summary: A named loa of a given type + value: + filter: + and: + - property: /name + operator: ILIKE + values: + - LOA-Equinix-SV1 + - property: /type + operator: '=' + values: + - PATCH_PANEL_PORT_LOA + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC SearchByStateWithPartnerOrIbx: - $ref: "#/components/examples/LoaSearchStateWithPartnerOrIbx" + summary: Partial match on state with partner name or with ibx code + value: + filter: + and: + - property: /state + operator: '=' + values: + - PENDING_ACCEPTANCE + - or: + - property: /requestor/orgName + operator: ILIKE + values: + - abc + - property: /location/ibxCode + operator: ILIKE + values: + - MB + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/LoaSearchResponse" - examples: - example: - $ref: "#/components/examples/LoaSearchResponse" - "400": + $ref: '#/components/schemas/LoaSearchResponse' + examples: + example: + value: + pagination: + offset: 0 + limit: 25 + total: 1 + sort: + - property: /changeLog/createdDateTime + direction: DESC + data: + - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: PATCH_PANEL_PORT_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + state: INACTIVE + expirationDateTime: '2026-12-31T23:59:59Z' + operation: + consumersCount: 1 + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + demarcationPoint: + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0105 + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 23 + connectorType: SC + location: + ibxCode: SV1 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_400" - "401": + value: + - errorCode: EQ-3070103 + errorMessage: Loa does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/loas/{loaId}/actions/search: post: tags: @@ -16215,71 +44111,127 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 requestBody: content: application/json: schema: - $ref: "#/components/schemas/LoaActionSearchRequest" + $ref: '#/components/schemas/LoaActionSearchRequest' examples: ActionTypeSearch: - $ref: "#/components/examples/LoaActionSearchByActionType" + value: + filter: + and: + - property: /type + operator: '=' + values: + - LOA_REQUESTOR_ACCEPTANCE + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/createdDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/LoaActionSearchResponse" + $ref: '#/components/schemas/LoaActionSearchResponse' examples: LoaActionSearchExample: - $ref: "#/components/examples/LoaSearchActionResponse" - "400": + value: + pagination: + offset: 0 + limit: 25 + total: 1 + sort: + - property: /changeLog/createdDateTime + direction: DESC + data: + - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: LOA_ISSUER_AUTHORIZATION + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_Action_400" - "401": + value: + - errorCode: EQ-3070107 + errorMessage: Loa Action does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa Action does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_Action_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa Action not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa 3070101 does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/loas/{loaId}/consumers: get: tags: @@ -16293,62 +44245,105 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 responses: - "200": + '200': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/LoaConsumersResponse" + $ref: '#/components/schemas/LoaConsumersResponse' examples: LoaConsumersExample: - $ref: "#/components/examples/LoaConsumersResponse" - "400": + value: + pagination: + offset: 0 + limit: 25 + total: 2 + data: + - href: https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: XF_PORT + changeLog: + createdDateTime: '2025-07-24T06:50:46Z' + - href: https://api.equinix.com/fabric/v4/ports/b7e14c2d-93f8-4a61-8d5b-c29f71e4a306 + uuid: b7e14c2d-93f8-4a61-8d5b-c29f71e4a306 + type: XF_PORT + changeLog: + createdDateTime: '2025-07-26T06:50:46Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_400" - "401": + value: + - errorCode: EQ-3070103 + errorMessage: Loa does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/loas/{loaId}/notes: get: tags: @@ -16362,62 +44357,101 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 responses: - "200": + '200': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/LoaNotesResponse" + $ref: '#/components/schemas/LoaNotesResponse' examples: GetLoaNotesExample: - $ref: "#/components/examples/LoaNotesResponse" - "400": + value: + data: + - type: ISSUER + href: https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + comments: test note from issuer + createdDateTime: '2026-07-24T06:50:46Z' + - type: REQUESTOR + href: https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/a41f485e-3094-42de-8797-0ef19a51df81 + uuid: a41f485e-3094-42de-8797-0ef19a51df81 + comments: test note from requestor + createdDateTime: '2026-07-25T06:50:46Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_400" - "401": + value: + - errorCode: EQ-3070103 + errorMessage: Loa does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request post: tags: - Loas @@ -16430,71 +44464,105 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 requestBody: content: application/json: schema: - $ref: "#/components/schemas/CreateLoaNote" + $ref: '#/components/schemas/CreateLoaNote' examples: LoaNoteRequest: - $ref: "#/components/examples/LoaNoteRequest" + value: + comments: LOA under review by our team. Expected response within 2 business days. required: true responses: - "201": + '201': description: Created content: application/json: schema: - $ref: "#/components/schemas/LoaNoteDetails" + $ref: '#/components/schemas/LoaNoteDetails' examples: CreateLoaNoteExample: - $ref: "#/components/examples/CreateLoaNoteResponse" - "400": + value: + type: ISSUER + href: https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + comments: LOA under review by our team. Expected response within 2 business days. + createdDateTime: '2026-06-24T06:50:46Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_400" - "401": + value: + - errorCode: EQ-3070103 + errorMessage: Loa does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/crossConnects: post: tags: @@ -16502,91 +44570,732 @@ paths: summary: Create Cross Connect description: The API provides capability to create a new Cross Connect. operationId: createCrossConnect - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/CreateCrossConnect" + $ref: '#/components/schemas/CreateCrossConnect' examples: StandardCrossConnect: - $ref: "#/components/examples/StandardCrossConnectRequest" + summary: Standard Cross Connect + description: Minimal Cross Connect request with only the required fields. + value: + type: XC + name: My-CC-service + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 12 + patchPanelPortB: 24 + connectorType: SC + schedule: + code: STANDARD + requestedDateTime: '2026-02-27T07:21:39Z' StandardCrossConnectWithServices: - $ref: "#/components/examples/StandardCCWithServicesRequest" + summary: Standard Cross Connect With Services + description: Standard Cross Connect with additional services - link light verification and patch equipment. + value: + type: XC + name: My-CC-service + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 12 + patchPanelPortB: 24 + connectorType: SC + schedule: + code: STANDARD + requestedDateTime: '2026-02-27T07:21:39Z' + services: + - type: XC_LINK_LIGHT_VERIFICATION + - type: XC_PATCH_EQUIPMENT + device: + cabinetUniqueSpaceId: SV2:00:000000:0100 + port: 32 + connectorType: SC + description: device description + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + customerReferenceId: '12345' StandardCrossConnectByPatchPanel: - $ref: "#/components/examples/StandardCCByPatchPanelRequest" + summary: Standard Cross Connect By Patch Panel + description: Standard Cross Connect using patch panel demarcation points on both sides. + value: + type: XC + name: My-CC-service + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 12 + patchPanelPortB: 24 + connectorType: SC + schedule: + code: STANDARD + requestedDateTime: '2026-02-27T07:21:39Z' + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + purchaseOrder: + number: '1233' + amount: '10000' + startDate: '2026-02-26' + endDate: '2027-02-26' + attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 + type: NEW + customerReferenceId: '12345' + notes: + - comments: test note + attachments: + - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 StandardCrossConnectByLoa: - $ref: "#/components/examples/StandardCCByLoaRequest" + summary: Standard Cross Connect By LOA + description: Standard Cross Connect where the z-side is specified via a Letter of Authorization. + value: + type: XC + name: My-CC-service + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + zSide: + loa: + uuid: c61f485e-3094-42de-8797-0ef19a51df79 + schedule: + code: STANDARD + requestedDateTime: '2026-02-27T07:21:39Z' + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + customerReferenceId: '12345' + notes: + - comments: test note + attachments: + - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 ExtendedCrossConnectEquinixManaged: - $ref: "#/components/examples/ExtendedCCEquinixManagedRequest" + summary: Extended Cross Connect Equinix Managed + description: 'Extended Cross Connect with Equinix-managed meet-me room (bmmrType: EQUINIX).' + value: + type: XC + name: My-CC-service + bmmrType: EQUINIX + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + zSide: + location: + ibxCode: SV11 + loa: + uuid: c61f485e-3094-42de-8797-0ef19a51df79 + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + customerReferenceId: '12345' + notes: + - comments: test note + attachments: + - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 ExtendedCrossConnectSelfManaged: - $ref: "#/components/examples/ExtendedCCSelfManagedRequest" + summary: Extended Cross Connect Self Managed + description: 'Extended Cross Connect with self-managed meet-me room (bmmrType: SELF).' + value: + type: XC + name: My-CC-service + bmmrType: SELF + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + zSide: + location: + ibxCode: SV11 + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + customerReferenceId: '12345' + notes: + - comments: test note + attachments: + - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 DiverseWithExistingCrossConnect: - $ref: "#/components/examples/DiverseWithExistingCCRequest" + summary: Diverse with Existing Cross Connect + description: Add a SECONDARY Cross Connect to an existing PRIMARY by providing the PRIMARY's redundancy group identifier, or its serial number, as the redundancy group. + value: + type: XC + name: My-CC-service-SEC + redundancy: + priority: SECONDARY + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 14 + patchPanelPortB: 15 + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 22 + patchPanelPortB: 23 + connectorType: SC + schedule: + code: STANDARD + requestedDateTime: '2026-02-27T07:21:39Z' + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + customerReferenceId: '12345' required: true responses: - "202": + '202': description: Accepted. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectResponse" + $ref: '#/components/schemas/CrossConnectResponse' examples: StandardCrossConnectByPatchPanel: - $ref: "#/components/examples/StandardCCByPatchPanelResponse" + summary: Standard Cross Connect By Patch Panel + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 45 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV2:00:000000 + cabinetUniqueSpaceId: SV2:00:000000:0100 + location: + ibxCode: SV1 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser StandardCrossConnectByLoa: - $ref: "#/components/examples/StandardCCByLoaResponse" + summary: Standard Cross Connect By LOA + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + loa: + href: https://api.equinix.com/fabric/v4/loas/b51f485e-3094-42de-8797-0ef19a51df79 + uuid: c61f485e-3094-42de-8797-0ef19a51df79 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser ExtendedCrossConnectEquinixManaged: - $ref: "#/components/examples/ExtendedCCEquinixManagedResponse" + summary: Extended Cross Connect Equinix Managed + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + bmmrType: EQUINIX + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV11 + loa: + href: https://api.equinix.com/fabric/v4/loas/c61f485e-3094-42de-8797-0ef19a51df79 + uuid: c61f485e-3094-42de-8797-0ef19a51df79 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser ExtendedCrossConnectSelfManaged: - $ref: "#/components/examples/ExtendedCCSelfManagedResponse" + summary: Extended Cross Connect Self Managed + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + bmmrType: SELF + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV11 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser DiverseWithExistingCrossConnect: - $ref: "#/components/examples/DiverseWithExistingCCResponse" - "400": + summary: Diverse with Existing Cross Connect + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service-SEC + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: SECONDARY + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 14 + patchPanelPortB: 15 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 22 + patchPanelPortB: 23 + connectorType: SC + cageUniqueSpaceId: SV2:00:000000 + cabinetUniqueSpaceId: SV2:00:000000:0100 + location: + ibxCode: SV1 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/bulk: post: tags: @@ -16595,71 +45304,319 @@ paths: description: | The API provides capability to create several Cross Connects in a single order - a diverse pair where the PRIMARY and the SECONDARY Cross Connect are placed at the same time, or multiple Cross Connects by sending one entry per Cross Connect. operationId: createDiverseCrossConnect - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/DiverseCrossConnectRequest" + $ref: '#/components/schemas/DiverseCrossConnectRequest' examples: DiverseCrossConnectPair: - $ref: "#/components/examples/DiverseCCPairRequest" + summary: Diverse pair + description: Two Cross Connects placed at the same time on separate patch panels - one PRIMARY and one SECONDARY. + value: + data: + - type: XC + name: My-CC-service-PRI + redundancy: + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 12 + patchPanelPortB: 24 + connectorType: SC + schedule: + code: STANDARD + requestedDateTime: '2026-02-27T07:21:39Z' + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + customerReferenceId: '12345' + - type: XC + name: My-CC-service-SEC + redundancy: + priority: SECONDARY + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 14 + patchPanelPortB: 15 + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 22 + patchPanelPortB: 23 + connectorType: SC + schedule: + code: STANDARD + requestedDateTime: '2026-02-27T07:21:39Z' + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + customerReferenceId: '12345' required: true responses: - "202": + '202': description: Accepted. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectDiverse" + $ref: '#/components/schemas/CrossConnectDiverse' examples: DiverseCrossConnectPair: - $ref: "#/components/examples/DiverseCCPairResponse" - "400": + summary: Diverse Cross Connect Pair + value: + data: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + name: My-CC-service-PRI + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 12 + patchPanelPortB: 24 + connectorType: SC + cageUniqueSpaceId: SV2:00:000000 + cabinetUniqueSpaceId: SV2:00:000000:0100 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser + - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603 + type: XC + uuid: a6f77b33-96c6-4eeb-8d79-76374d950603 + name: My-CC-service-SEC + state: PROVISIONING + serialNumber: '234567891' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: SECONDARY + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 14 + patchPanelPortB: 15 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 22 + patchPanelPortB: 23 + connectorType: SC + cageUniqueSpaceId: SV2:00:000000 + cabinetUniqueSpaceId: SV2:00:000000:0100 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567891 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400_diverse" - "401": + summary: Invalid diverse pair + value: + - errorCode: EQ-3071106 + errorMessage: Invalid diverse Cross Connect request + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: A diverse pair order must contain exactly two Cross Connects, one PRIMARY and one SECONDARY. + additionalInfo: + - property: /data + reason: Expected two entries with complementary redundancy priorities. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/search: post: tags: @@ -16667,73 +45624,220 @@ paths: summary: Search Cross Connects description: The API provides capability to get list of user's Cross Connects using search criteria, including optional filtering, pagination and sorting. operationId: searchCrossConnects - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/CrossConnectSearchRequest" + $ref: '#/components/schemas/CrossConnectSearchRequest' examples: SearchByNameWithState: - $ref: "#/components/examples/CrossConnectSearchByNameWithState" + value: + filter: + and: + - property: /name + operator: LIKE + values: + - My-CC-service + - property: /state + operator: IN + values: + - PENDING + - PENDING_ACTION + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC SearchByIbxWithType: - $ref: "#/components/examples/CrossConnectSearchByIbxWithType" + value: + filter: + and: + - property: /type + operator: '=' + values: + - XC + - or: + - property: /aSide/location/ibxCode + operator: '=' + values: + - SV1 + - property: /zSide/location/ibxCode + operator: '=' + values: + - SV1 + pagination: + limit: 25 + offset: 0 + sort: + - property: /name + direction: ASC required: true responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectSearchResponse" - examples: - example: - $ref: "#/components/examples/CrossConnectSearchResponse" - "400": + $ref: '#/components/schemas/CrossConnectSearchResponse' + examples: + example: + value: + pagination: + offset: 0 + limit: 25 + total: 1 + sort: + - property: /changeLog/updatedDateTime + direction: DESC + data: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + name: My-CC-service + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + loa: + href: https://api.equinix.com/fabric/v4/loas/b51f485e-3094-42de-8797-0ef19a51df79 + uuid: c61f485e-3094-42de-8797-0ef19a51df79 + location: + ibxCode: SV1 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-26T07:21:39Z' + createdBy: testuser + updatedDateTime: '2026-02-28T07:21:39Z' + updatedBy: '1234' + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}: get: tags: @@ -16747,68 +45851,404 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectResponse" + $ref: '#/components/schemas/CrossConnectResponse' examples: StandardCrossConnectByPatchPanel: - $ref: "#/components/examples/StandardCCByPatchPanelResponse" + summary: Standard Cross Connect By Patch Panel + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 45 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV2:00:000000 + cabinetUniqueSpaceId: SV2:00:000000:0100 + location: + ibxCode: SV1 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser StandardCrossConnectByLoa: - $ref: "#/components/examples/StandardCCByLoaResponse" + summary: Standard Cross Connect By LOA + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + loa: + href: https://api.equinix.com/fabric/v4/loas/b51f485e-3094-42de-8797-0ef19a51df79 + uuid: c61f485e-3094-42de-8797-0ef19a51df79 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser ExtendedCrossConnectEquinixManaged: - $ref: "#/components/examples/ExtendedCCEquinixManagedResponse" + summary: Extended Cross Connect Equinix Managed + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + bmmrType: EQUINIX + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV11 + loa: + href: https://api.equinix.com/fabric/v4/loas/c61f485e-3094-42de-8797-0ef19a51df79 + uuid: c61f485e-3094-42de-8797-0ef19a51df79 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser ExtendedCrossConnectSelfManaged: - $ref: "#/components/examples/ExtendedCCSelfManagedResponse" - "400": + summary: Extended Cross Connect Self Managed + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + bmmrType: SELF + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV11 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/schedules: get: tags: @@ -16822,62 +46262,115 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/SchedulesResponse" + $ref: '#/components/schemas/SchedulesResponse' examples: SchedulesExample: - $ref: "#/components/examples/CrossConnectSchedulesResponse" - "400": + value: + data: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + type: XC_INSTALL_SCHEDULE + code: EXPEDITE + state: COMPLETED + autoConvertToStandard: true + readinessDateTime: '2026-08-23T07:21:39Z' + requestedDateTime: '2026-08-24T07:21:39Z' + equinixProposedDateTime: '2026-08-25T07:21:39Z' + installationDateTime: '2026-08-25T09:21:39Z' + changeLog: + createdBy: testuser + createdDateTime: '2026-08-22T07:21:39Z' + updatedBy: '124' + updatedDateTime: '2026-08-25T09:21:39Z' + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/a11f485e-3094-42de-8797-0ef19a51df79 + uuid: a11f485e-3094-42de-8797-0ef19a51df79 + type: XC_DEINSTALL_SCHEDULE + code: STANDARD + state: PENDING + requestedDateTime: '2026-09-14T17:21:25.586Z' + deinstallationDateTime: '2026-09-16T17:21:25.586Z' + changeLog: + createdBy: testuser + createdDateTime: '2026-09-12T07:21:39Z' + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/services: get: tags: @@ -16891,62 +46384,109 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectServicesResponse" + $ref: '#/components/schemas/CrossConnectServicesResponse' examples: GetCrossConnectServices: - $ref: "#/components/examples/CrossConnectServicesResponse" - "400": + value: + data: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + type: XC_LINK_LIGHT_VERIFICATION + state: PENDING + changeLog: + createdBy: testuser + createdDateTime: '2026-02-28T07:21:39Z' + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/a11f485e-3094-42de-8797-0ef19a51df79 + uuid: a11f485e-3094-42de-8797-0ef19a51df79 + type: XC_PATCH_EQUIPMENT + state: PENDING + device: + cabinetUniqueSpaceId: SV2:00:000000:0100 + port: 32 + connectorType: SC + description: additional notes for patch equipment + changeLog: + createdBy: testuser + createdDateTime: '2026-02-28T07:21:39Z' + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/attachments: get: tags: @@ -16960,62 +46500,109 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectAttachmentsResponse" + $ref: '#/components/schemas/CrossConnectAttachmentsResponse' examples: GetCrossConnectAttachments: - $ref: "#/components/examples/CrossConnectAttachmentsResponse" - "400": + summary: Cross Connect attachments + value: + data: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + type: ATTACHMENT + source: CUSTOMER + attachmentId: a11f485e-3094-42de-8797-0ef19a51df79 + downloadHref: https://api.equinix.com/ecp/attachments/a11f485e-3094-42de-8797-0ef19a51df79 + changeLog: + createdBy: '123' + createdDateTime: '2026-02-28T07:21:39Z' + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/a41f485e-3094-42de-8797-0ef19a51df81 + uuid: a41f485e-3094-42de-8797-0ef19a51df81 + type: ATTACHMENT + source: EQUINIX + attachmentId: b21f485e-3094-42de-8797-0ef19a51df80 + downloadHref: https://api.equinix.com/ecp/attachments/b21f485e-3094-42de-8797-0ef19a51df80 + changeLog: + createdBy: EQUINIX + createdDateTime: '2026-02-27T07:21:39Z' + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/notes: get: tags: @@ -17029,7 +46616,10 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - name: offset in: query description: offset @@ -17045,60 +46635,106 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectNotesResponse" + $ref: '#/components/schemas/CrossConnectNotesResponse' examples: GetCrossConnectNotes: - $ref: "#/components/examples/CrossConnectNotesResponse" - "400": + summary: Cross Connect notes + value: + pagination: + offset: 0 + limit: 10 + total: 2 + data: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + type: NOTE + source: CUSTOMER + comments: Additional note to EQUINIX technician. + changeLog: + createdBy: '124' + createdDateTime: '2026-02-28T07:21:39Z' + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79 + uuid: a11f485e-3094-42de-8797-0ef19a51df79 + type: NOTE + source: EQUINIX + comments: Please confirm the patch panel port before the scheduled installation. + changeLog: + createdBy: SYSTEM + createdDateTime: '2026-02-27T07:21:39Z' + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/actions: post: tags: @@ -17113,91 +46749,265 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 requestBody: content: application/json: schema: - $ref: "#/components/schemas/CrossConnectActionRequest" + $ref: '#/components/schemas/CrossConnectActionRequest' examples: SendSignatureQuote: - $ref: "#/components/examples/SendSignatureQuoteActionRequest" + value: + type: XC_SIGNATURE_SUBMISSION AcceptProposedDateTime: - $ref: "#/components/examples/AcceptProposedDateTimeActionRequest" + value: + type: XC_PROPOSED_DATE_TIME_ACCEPTANCE RejectProposedDateTime: - $ref: "#/components/examples/RejectProposedDateTimeActionRequest" + value: + type: XC_PROPOSED_DATE_TIME_REJECTION CancelCrossConnect: - $ref: "#/components/examples/CancelCrossConnectActionRequest" + value: + type: XC_CANCEL DeinstallCrossConnect: - $ref: "#/components/examples/DeinstallCrossConnectActionRequest" + summary: Deinstall a Cross Connect + description: Removal of a provisioned Cross Connect, along with the patch equipment. The notification contacts are appended to the ones already held on the Cross Connect, while the purchase order and the customer reference identifier replace the existing ones. + value: + type: XC_DEINSTALL + data: + schedule: + code: STANDARD + requestedDateTime: '2026-06-14T17:21:25.586Z' + deinstallationDateTime: '2026-06-16T17:21:25.586Z' + liveTrafficConsentProvided: true + services: + - type: XC_PATCH_EQUIPMENT + device: + cabinetUniqueSpaceId: SV2:00:000000:0100 + port: 32 + connectorType: SC + description: device description + notifications: + - type: TECHNICAL + emails: + - abc@test.com + attachments: + - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 + order: + purchaseOrder: + number: '1233' + amount: '23' + startDate: '2026-02-26' + endDate: '2027-02-26' + customerReferenceId: '12345' UpdateInformation: - $ref: "#/components/examples/UpdateInformationActionRequest" + value: + type: XC_INFORMATION_UPDATE + data: + notes: + - parentNote: + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + comments: Please proceed + attachments: + - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 required: true responses: - "202": + '202': description: Accepted. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectActionResponse" + $ref: '#/components/schemas/CrossConnectActionResponse' examples: SendSignatureQuote: - $ref: "#/components/examples/SendSignatureQuoteActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: XC_SIGNATURE_SUBMISSION + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser AcceptProposedDateTime: - $ref: "#/components/examples/AcceptProposedDateTimeActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/41dd8989-65f4-4f2b-9762-98b72465cbe5 + uuid: 41dd8989-65f4-4f2b-9762-98b72465cbe5 + type: XC_PROPOSED_DATE_TIME_ACCEPTANCE + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser RejectProposedDateTime: - $ref: "#/components/examples/RejectProposedDateTimeActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/52ee9090-76a5-4a3c-a873-a9c83576dcf6 + uuid: 52ee9090-76a5-4a3c-a873-a9c83576dcf6 + type: XC_PROPOSED_DATE_TIME_REJECTION + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser CancelCrossConnect: - $ref: "#/components/examples/CancelCrossConnectActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/63ffa1a1-87b6-4b4d-b984-bad94687edf7 + uuid: 63ffa1a1-87b6-4b4d-b984-bad94687edf7 + type: XC_CANCEL + state: PENDING + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser DeinstallCrossConnect: - $ref: "#/components/examples/DeinstallCrossConnectActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/74ffa1a1-87b6-4b4d-b984-bad94687edf8 + uuid: 74ffa1a1-87b6-4b4d-b984-bad94687edf8 + type: XC_DEINSTALL + state: PENDING + data: + attachments: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 + uuid: b41f485e-3094-42de-8797-0ef19a51df82 + attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 + schedule: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/c51f485e-3094-42de-8797-0ef19a51df83 + uuid: c51f485e-3094-42de-8797-0ef19a51df83 + type: XC_DEINSTALL_SCHEDULE + code: STANDARD + state: PENDING + requestedDateTime: '2026-06-14T17:21:25.586Z' + deinstallationDateTime: '2026-06-16T17:21:25.586Z' + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser + liveTrafficConsentProvided: true + services: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/d61f485e-3094-42de-8797-0ef19a51df84 + uuid: d61f485e-3094-42de-8797-0ef19a51df84 + type: XC_PATCH_EQUIPMENT + state: PENDING + device: + cabinetUniqueSpaceId: SV2:00:000000:0100 + port: 32 + connectorType: SC + description: device description + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser UpdateInformation: - $ref: "#/components/examples/UpdateInformationActionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/7400b2b2-98c7-4c5e-ca95-cbea5798fe08 + uuid: 7400b2b2-98c7-4c5e-ca95-cbea5798fe08 + type: XC_INFORMATION_UPDATE + state: COMPLETED + data: + notes: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + parentNote: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79 + uuid: a11f485e-3094-42de-8797-0ef19a51df79 + comments: Please proceed + attachments: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 + uuid: b41f485e-3094-42de-8797-0ef19a51df82 + attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_Action_400" - "401": + value: + - errorCode: EQ-3071104 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect Action type is not one of the allowedActions of the Cross Connect. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_Action_404" - "500": + value: + - errorCode: EQ-3071105 + errorMessage: Cross Connect Action does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect Action does not exist. Please check the Action UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/actions/{actionId}: get: tags: @@ -17211,78 +47021,214 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - name: actionId in: path description: Cross Connect Action UUID. required: true schema: - $ref: "#/components/schemas/ActionId_3" + description: Cross Connect Action UUID. + type: string + format: uuid + example: 30cc7878-54e3-4e1a-8651-87a61354bad4 responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectActionResponse" + $ref: '#/components/schemas/CrossConnectActionResponse' examples: SendSignatureQuote: - $ref: "#/components/examples/SendSignatureQuoteActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: XC_SIGNATURE_SUBMISSION + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser AcceptProposedDateTime: - $ref: "#/components/examples/AcceptProposedDateTimeActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/41dd8989-65f4-4f2b-9762-98b72465cbe5 + uuid: 41dd8989-65f4-4f2b-9762-98b72465cbe5 + type: XC_PROPOSED_DATE_TIME_ACCEPTANCE + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser RejectProposedDateTime: - $ref: "#/components/examples/RejectProposedDateTimeActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/52ee9090-76a5-4a3c-a873-a9c83576dcf6 + uuid: 52ee9090-76a5-4a3c-a873-a9c83576dcf6 + type: XC_PROPOSED_DATE_TIME_REJECTION + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser CancelCrossConnect: - $ref: "#/components/examples/CancelCrossConnectActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/63ffa1a1-87b6-4b4d-b984-bad94687edf7 + uuid: 63ffa1a1-87b6-4b4d-b984-bad94687edf7 + type: XC_CANCEL + state: PENDING + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser DeinstallCrossConnect: - $ref: "#/components/examples/DeinstallCrossConnectActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/74ffa1a1-87b6-4b4d-b984-bad94687edf8 + uuid: 74ffa1a1-87b6-4b4d-b984-bad94687edf8 + type: XC_DEINSTALL + state: PENDING + data: + attachments: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 + uuid: b41f485e-3094-42de-8797-0ef19a51df82 + attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 + schedule: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/c51f485e-3094-42de-8797-0ef19a51df83 + uuid: c51f485e-3094-42de-8797-0ef19a51df83 + type: XC_DEINSTALL_SCHEDULE + code: STANDARD + state: PENDING + requestedDateTime: '2026-06-14T17:21:25.586Z' + deinstallationDateTime: '2026-06-16T17:21:25.586Z' + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser + liveTrafficConsentProvided: true + services: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/d61f485e-3094-42de-8797-0ef19a51df84 + uuid: d61f485e-3094-42de-8797-0ef19a51df84 + type: XC_PATCH_EQUIPMENT + state: PENDING + device: + cabinetUniqueSpaceId: SV2:00:000000:0100 + port: 32 + connectorType: SC + description: device description + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser UpdateInformation: - $ref: "#/components/examples/UpdateInformationActionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/7400b2b2-98c7-4c5e-ca95-cbea5798fe08 + uuid: 7400b2b2-98c7-4c5e-ca95-cbea5798fe08 + type: XC_INFORMATION_UPDATE + state: COMPLETED + data: + notes: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + parentNote: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79 + uuid: a11f485e-3094-42de-8797-0ef19a51df79 + comments: Please proceed + attachments: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 + uuid: b41f485e-3094-42de-8797-0ef19a51df82 + attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_Action_400" - "401": + value: + - errorCode: EQ-3071104 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect Action type is not one of the allowedActions of the Cross Connect. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_Action_404" - "500": + value: + - errorCode: EQ-3071105 + errorMessage: Cross Connect Action does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect Action does not exist. Please check the Action UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/actions/search: post: tags: @@ -17296,71 +47242,137 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 requestBody: content: application/json: schema: - $ref: "#/components/schemas/CrossConnectActionSearchRequest" + $ref: '#/components/schemas/CrossConnectActionSearchRequest' examples: ActionTypeSearch: - $ref: "#/components/examples/CrossConnectActionSearchByActionType" + value: + filter: + and: + - property: /type + operator: '=' + values: + - XC_INFORMATION_UPDATE + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/createdDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectActionSearchResponse" + $ref: '#/components/schemas/CrossConnectActionSearchResponse' examples: CrossConnectActionSearchExample: - $ref: "#/components/examples/CrossConnectActionSearchResponse" - "400": + value: + pagination: + offset: 0 + limit: 25 + total: 1 + sort: + - property: /changeLog/createdDateTime + direction: DESC + data: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/7400b2b2-98c7-4c5e-ca95-cbea5798fe08 + uuid: 7400b2b2-98c7-4c5e-ca95-cbea5798fe08 + type: XC_INFORMATION_UPDATE + state: COMPLETED + data: + notes: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + parentNote: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79 + uuid: a11f485e-3094-42de-8797-0ef19a51df79 + comments: Please proceed + attachments: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 + uuid: b41f485e-3094-42de-8797-0ef19a51df82 + attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_Action_400" - "401": + value: + - errorCode: EQ-3071104 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect Action type is not one of the allowedActions of the Cross Connect. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_Action_404" - "500": + value: + - errorCode: EQ-3071105 + errorMessage: Cross Connect Action does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect Action does not exist. Please check the Action UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnectSchedules/search: post: tags: @@ -17369,72 +47381,215 @@ paths: description: | The API provides capability to search the Cross Connect schedule windows offered at an IBX, including optional filtering, pagination and sorting. operationId: searchCrossConnectSchedules - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/CrossConnectScheduleSearchRequest" + $ref: '#/components/schemas/CrossConnectScheduleSearchRequest' examples: SearchInstallSchedules: - $ref: "#/components/examples/SearchInstallSchedulesRequest" + summary: Installation schedule windows + value: + filter: + and: + - property: /type + operator: '=' + values: + - XC_INSTALL_SCHEDULE + - property: /code + operator: IN + values: + - EXPEDITE + - FLEXIBLE + - STANDARD + - property: /aSide/location/ibxCode + operator: '=' + values: + - SV11 + - property: /zSide/location/ibxCode + operator: '=' + values: + - SV11 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /startDateTime required: true responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/SearchSchedulesResponse" + $ref: '#/components/schemas/SearchSchedulesResponse' examples: SearchInstallSchedules: - $ref: "#/components/examples/SearchInstallSchedulesResponse" - "400": + summary: Installation schedule windows + value: + pagination: + offset: 0 + limit: 20 + total: 3 + data: + - href: https://api.equinix.com/fabric/v4/crossConnectSchedules/EXPEDITE + type: XC_INSTALL_SCHEDULE + code: EXPEDITE + aSide: + location: + ibxCode: SV11 + zSide: + location: + ibxCode: SV11 + startDateTime: '2026-03-05T17:00:00Z' + endDateTime: '2026-03-10T17:24:00Z' + unavailableDates: + - '2026-03-07' + - '2026-03-08' + - href: https://api.equinix.com/fabric/v4/crossConnectSchedules/STANDARD + type: XC_INSTALL_SCHEDULE + code: STANDARD + aSide: + location: + ibxCode: SV11 + zSide: + location: + ibxCode: SV11 + startDateTime: '2026-03-10T18:00:00Z' + endDateTime: '2026-04-10T17:24:00Z' + unavailableDates: + - '2026-03-27' + - '2026-03-28' + - '2026-03-29' + - href: https://api.equinix.com/fabric/v4/crossConnectSchedules/FLEXIBLE + type: XC_INSTALL_SCHEDULE + code: FLEXIBLE + aSide: + location: + ibxCode: SV11 + zSide: + location: + ibxCode: SV11 + startDateTime: '2026-04-10T18:00:00Z' + endDateTime: '2026-06-10T17:24:00Z' + unavailableDates: + - '2026-04-17' + - '2026-04-18' + - '2026-04-19' + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/tags: + post: + tags: + - Tags + summary: Create Tag + description: Create Tag for Equinix Fabric™ + operationId: createTag + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagRequest' + required: true + responses: + '202': + description: Successfully created tag and pending for approval + content: + application/json: + schema: + $ref: '#/components/schemas/TagResponse' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' get: tags: - Tags @@ -17463,85 +47618,41 @@ paths: description: Limit for pagination required: false schema: - maximum: 100 type: integer format: int32 default: 20 + maximum: 100 responses: - "200": + '200': description: Successful List operation content: application/json: schema: - $ref: "#/components/schemas/TagListResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - "401": - description: Unauthorized - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - "403": - description: Forbidden - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - "500": - description: Internal Server Error - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - post: - tags: - - Tags - summary: Create Tag - description: Create Tag for Equinix Fabric™ - operationId: createTag - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/TagRequest" - required: true - responses: - "202": - description: Successfully created tag and pending for approval - content: - application/json: - schema: - $ref: "#/components/schemas/TagResponse" - "400": + $ref: '#/components/schemas/TagListResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/tags/{uuid}: get: tags: @@ -17558,42 +47669,42 @@ paths: type: string format: uuid responses: - "200": + '200': description: Successful Get operation content: application/json: schema: - $ref: "#/components/schemas/TagResponse" - "400": + $ref: '#/components/schemas/TagResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/appDomains: post: tags: @@ -17601,71 +47712,112 @@ paths: summary: Create Domain description: This API provides capability to create user's App Domain operationId: createAppDomain - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppDomainPostRequest" + $ref: '#/components/schemas/AppDomainPostRequest' examples: CreateAppDomain: - $ref: "#/components/examples/AppDomainCreate" + value: + type: APP_DOMAIN + name: atlassian.net + description: Atlassian Domain + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "202": + '202': description: App Domain object content: application/json: schema: - $ref: "#/components/schemas/AppDomain" + $ref: '#/components/schemas/AppDomain' examples: AppDomainResponse: - $ref: "#/components/examples/AppDomainPostResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + description: Atlassian Domain + state: PENDING_VERIFICATION + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidName: - $ref: "#/components/examples/AppDomain_400_InvalidName" - "401": + value: + - errorCode: EQ-3810022 + errorMessage: Domain name is invalid + correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e + details: Domain name is invalid + additionalInfo: + - property: /name + reason: Domain name is invalid + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_401" - "403": + value: + - errorCode: EQ-3810001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_403" - "415": + value: + - errorCode: EQ-3810002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_415" - "500": + value: + - errorCode: EQ-3810016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_500" + value: + - errorCode: EQ-3810030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appDomains/{appDomainId}: get: tags: @@ -17679,53 +47831,86 @@ paths: description: App Domain UUID required: true schema: - $ref: "#/components/schemas/AppDomainId" + description: App Domain UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: - "200": + '200': description: App Domain object content: application/json: schema: - $ref: "#/components/schemas/AppDomain" + $ref: '#/components/schemas/AppDomain' examples: AppDomainResponse: - $ref: "#/components/examples/AppDomainGetResponseExample" - "401": + value: + href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + description: Atlassian Domain + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_401" - "403": + value: + - errorCode: EQ-3810001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_403" - "404": + value: + - errorCode: EQ-3810002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_404" - "500": + value: + - errorCode: EQ-3810020 + errorMessage: App Domain not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Domain not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_500" + value: + - errorCode: EQ-3810030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error delete: tags: - Application Domains @@ -17738,62 +47923,101 @@ paths: description: App Domain UUID required: true schema: - $ref: "#/components/schemas/AppDomainId" + description: App Domain UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: - "202": + '202': description: App Domain object content: application/json: schema: - $ref: "#/components/schemas/AppDomain" + $ref: '#/components/schemas/AppDomain' examples: AppDomainResponse: - $ref: "#/components/examples/AppDomainDeleteResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + description: Atlassian Domain + state: DEPROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + deletedBy: test + deletedDateTime: '2026-06-29T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_400_InvalidState" - "401": + value: + - errorCode: EQ-3810030 + errorMessage: Cannot delete App Domain in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot delete App Domain in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_401" - "403": + value: + - errorCode: EQ-3810001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_403" - "404": + value: + - errorCode: EQ-3810002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_404" - "500": + value: + - errorCode: EQ-3810020 + errorMessage: App Domain not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Domain not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_500" + value: + - errorCode: EQ-3810030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error patch: tags: - Application Domains @@ -17806,80 +48030,133 @@ paths: description: App Domain UUID required: true schema: - $ref: "#/components/schemas/AppDomainId" + description: App Domain UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/AppDomainUpdateRequest" + $ref: '#/components/schemas/AppDomainUpdateRequest' examples: UpdateDescription: - $ref: "#/components/examples/AppDomainUpdateDescription" + value: + - op: replace + path: /description + value: Updated Atlassian Domain required: true responses: - "202": + '202': description: App Domain object content: application/json: schema: - $ref: "#/components/schemas/AppDomain" + $ref: '#/components/schemas/AppDomain' examples: AppDomainResponse: - $ref: "#/components/examples/AppDomainPatchResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + description: Updated Atlassian Domain + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + change: + uuid: 531c4ab5-43b0-4352-8975-ee9045325841 + type: APP_DOMAIN_UPDATE + status: REQUESTED + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedDateTime: '2026-06-28T04:20:55.471Z' + data: + - op: replace + path: /description + value: Updated Atlassian Domain + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_400_InvalidOperation" - "401": + value: + - errorCode: EQ-3810022 + errorMessage: Invalid Argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_403" - "404": + value: + - errorCode: EQ-3810002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_404" - "415": + value: + - errorCode: EQ-3810020 + errorMessage: App Domain not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Domain not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_415" - "500": + value: + - errorCode: EQ-3810016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_500" + value: + - errorCode: EQ-3810030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appDomains/search: post: tags: @@ -17887,75 +48164,156 @@ paths: summary: Search Domains description: The API provides capability to get list of user's App Domains using search criteria, including optional filtering, pagination and sorting operationId: searchAppDomains - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppDomainSearchRequest" + $ref: '#/components/schemas/AppDomainSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/AppDomainSearchFilterByStatus" + value: + filter: + and: + - property: /state + operator: '=' + values: + - PROVISIONED + - property: /project/projectId + operator: IN + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterByName: - $ref: "#/components/examples/AppDomainSearchFilterByName" + value: + filter: + and: + - property: /name + operator: '=' + values: + - test- + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterOrAnd: - $ref: "#/components/examples/AppDomainSearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /name + operator: LIKE + values: + - abc% + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppDomainSearchResponse" + $ref: '#/components/schemas/AppDomainSearchResponse' examples: Example: - $ref: "#/components/examples/AppDomainSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + description: Atlassian Domain + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3810039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_401" - "403": + value: + - errorCode: EQ-3810001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_403" - "415": + value: + - errorCode: EQ-3810002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_415" - "500": + value: + - errorCode: EQ-3810016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_500" + value: + - errorCode: EQ-3810030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appDomains/{appDomainId}/appLinks: get: tags: @@ -17969,7 +48327,10 @@ paths: description: App Domain UUID required: true schema: - $ref: "#/components/schemas/AppDomainId" + description: App Domain UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - name: offset in: query description: offset @@ -17991,74 +48352,116 @@ paths: style: form explode: false schema: - $ref: "#/components/schemas/AttachedAppLinkState" + $ref: '#/components/schemas/AttachedAppLinkState' - name: order in: query description: Sort order for attached App Links. required: false schema: - $ref: "#/components/schemas/AttachedAppLinkOrder" + $ref: '#/components/schemas/AttachedAppLinkOrder' - name: style in: query description: Detail level of the response. required: false schema: - $ref: "#/components/schemas/Style" + $ref: '#/components/schemas/Style' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppDomainAttachedAppLinks" + $ref: '#/components/schemas/AppDomainAttachedAppLinks' examples: Example: - $ref: "#/components/examples/AppDomainAttachedAppLinksGetResponseExample" - "400": + value: + pagination: + limit: 20 + offset: 0 + total: 1 + data: + - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + type: APP_LINK + uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + name: Atlassian App Link + description: Atlassian App Link in SV + state: PROVISIONED + router: + href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + type: XF_ROUTER + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + bandwidth: 1000 + ipv4Subnet: 192.168.10.0/29 + ipv4Address: 192.168.10.3 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3810039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_401" - "403": + value: + - errorCode: EQ-3810001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_403" - "404": + value: + - errorCode: EQ-3810002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_404" - "500": + value: + - errorCode: EQ-3810020 + errorMessage: App Domain not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Domain not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_500" + value: + - errorCode: EQ-3810030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks: post: tags: @@ -18066,71 +48469,123 @@ paths: summary: Create Link description: This API provides capability to create user's Link operationId: createAppLink - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppLinkPostRequest" + $ref: '#/components/schemas/AppLinkPostRequest' examples: CreateAppLink: - $ref: "#/components/examples/AppLinkCreate" + value: + type: APP_LINK + name: Atlassian App Link + description: Atlassian App Link in SV + router: + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + ipv4Subnet: 192.168.10.0/29 + bandwidth: 1000 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "202": + '202': description: App Link object content: application/json: schema: - $ref: "#/components/schemas/AppLink" + $ref: '#/components/schemas/AppLink' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkPostResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + type: APP_LINK + name: Atlassian App Link + description: Atlassian App Link in SV + state: PROVISIONING + router: + href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + type: XF_ROUTER + ipv4Subnet: 192.168.10.0/29 + ipv4Address: 192.168.10.3 + bandwidth: 1000 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidName: - $ref: "#/components/examples/AppLink_400_InvalidName" - "401": + value: + - errorCode: EQ-3820022 + errorMessage: Name is minimum 0 and up to 50 characters in length + correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e + details: Name is minimum 0 and up to 50 characters in length + additionalInfo: + - property: /name + reason: Name is minimum 0 and up to 50 characters in length + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "415": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}: get: tags: @@ -18144,53 +48599,93 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 responses: - "200": + '200': description: App Link object content: application/json: schema: - $ref: "#/components/schemas/AppLink" + $ref: '#/components/schemas/AppLink' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkGetResponseExample" - "401": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + type: APP_LINK + name: Atlassian App Link + description: Atlassian App Link in SV + state: PROVISIONED + router: + href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + type: XF_ROUTER + ipv4Subnet: 192.168.10.0/29 + ipv4Address: 192.168.10.3 + bandwidth: 1000 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error delete: tags: - Application Links @@ -18203,62 +48698,108 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 responses: - "202": + '202': description: App Link object content: application/json: schema: - $ref: "#/components/schemas/AppLink" + $ref: '#/components/schemas/AppLink' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkDeleteResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + type: APP_LINK + name: Atlassian App Link + description: Atlassian App Link in SV + state: DEPROVISIONING + router: + href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + type: XF_ROUTER + ipv4Subnet: 192.168.10.0/29 + ipv4Address: 192.168.10.3 + bandwidth: 1000 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + deletedBy: test + deletedDateTime: '2026-06-29T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidState" - "401": + value: + - errorCode: EQ-3820030 + errorMessage: Cannot delete App Link in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot delete App Link in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error patch: tags: - Application Links @@ -18271,80 +48812,140 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/AppLinkUpdateRequest" + $ref: '#/components/schemas/AppLinkUpdateRequest' examples: UpdateName: - $ref: "#/components/examples/AppLinkUpdateName" + value: + - op: replace + path: /name + value: Updated Atlassian App Link required: true responses: - "202": + '202': description: App Link object content: application/json: schema: - $ref: "#/components/schemas/AppLink" + $ref: '#/components/schemas/AppLink' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkPatchResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + type: APP_LINK + name: Updated Atlassian App Link + description: Atlassian App Link in SV + state: REPROVISIONING + router: + href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + type: XF_ROUTER + ipv4Subnet: 192.168.10.0/29 + ipv4Address: 192.168.10.3 + bandwidth: 1000 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + change: + uuid: 531c4ab5-43b0-4352-8975-ee9045325841 + type: APP_LINK_UPDATE + status: REQUESTED + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedDateTime: '2026-06-28T04:20:55.471Z' + data: + - op: replace + path: /name + value: Updated Atlassian App Link + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidOperation" - "401": + value: + - errorCode: EQ-3040054 + errorMessage: Invalid Argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "415": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/search: post: tags: @@ -18352,289 +48953,484 @@ paths: summary: Search Links description: The API provides capability to get list of user's App Links using search criteria, including optional filtering, pagination and sorting operationId: searchAppLinks - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppLinkSearchRequest" + $ref: '#/components/schemas/AppLinkSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/AppLinkSearchFilterByStatus" + value: + filter: + and: + - property: /state + operator: '=' + values: + - PROVISIONED + - property: /project/projectId + operator: IN + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterByName: - $ref: "#/components/examples/AppLinkSearchFilterByName" + value: + filter: + and: + - property: /name + operator: '=' + values: + - test- + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterOrAnd: - $ref: "#/components/examples/AppLinkSearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /name + operator: LIKE + values: + - abc% + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppLinkSearchResponse" + $ref: '#/components/schemas/AppLinkSearchResponse' examples: Example: - $ref: "#/components/examples/AppLinkSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + type: APP_LINK + name: Atlassian App Link + description: Atlassian App Link in SV + state: PROVISIONED + router: + href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + type: XF_ROUTER + ipv4Subnet: 192.168.10.0/29 + ipv4Address: 192.168.10.3 + bandwidth: 1000 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3820039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "415": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appDomains/{appDomainId}: - get: + put: tags: - Application Links - summary: Get Attached Domain for Link - description: This API provides ability to retrieve an App Domain attached to an App Link - operationId: getAttachedAppDomainByUuid + summary: Attach Domain to Link + description: This API provides ability to attach the user's App Domain to App Link + operationId: attachAppDomainToAppLink parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appDomainId in: path description: App Domain UUID required: true schema: - $ref: "#/components/schemas/AppDomainId" + description: App Domain UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: - "200": - description: Attached App Domain object + '202': + description: Attach App Domain object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppDomainAttachment" + $ref: '#/components/schemas/AppLinkAppDomainAttachment' examples: - AppLinkDomainResponse: - $ref: "#/components/examples/AppLinkAttachDomainResponse" - "401": + AppLinkAttachDomainResponse: + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + attachmentStatus: ATTACHING + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-27T04:20:55.471Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3820030 + errorMessage: Cannot perform attach or detach operation in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot perform attach or detach operation in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" - put: + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error + delete: tags: - Application Links - summary: Attach Domain to Link - description: This API provides ability to attach the user's App Domain to App Link - operationId: attachAppDomainToAppLink + summary: Detach Domain from Link + description: This API provides ability to detach App Domain from App Link + operationId: detachAppDomainFromAppLink parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appDomainId in: path description: App Domain UUID required: true schema: - $ref: "#/components/schemas/AppDomainId" + description: App Domain UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: - "202": - description: Attach App Domain object + '202': + description: Detach App Domain object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppDomainAttachment" + $ref: '#/components/schemas/AppLinkAppDomainAttachment' examples: - AppLinkAttachDomainResponse: - $ref: "#/components/examples/AppLinkAttachDomainAttachResponse" - "400": + AppLinkDetachDomainResponse: + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + attachmentStatus: DETACHING + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidAttachState" - "401": + value: + - errorCode: EQ-3820030 + errorMessage: Cannot perform attach or detach operation in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot perform attach or detach operation in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" - delete: + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error + get: tags: - Application Links - summary: Detach Domain from Link - description: This API provides ability to detach App Domain from App Link - operationId: detachAppDomainFromAppLink + summary: Get Attached Domain for Link + description: This API provides ability to retrieve an App Domain attached to an App Link + operationId: getAttachedAppDomainByUuid parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appDomainId in: path description: App Domain UUID required: true schema: - $ref: "#/components/schemas/AppDomainId" + description: App Domain UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: - "202": - description: Detach App Domain object - content: - application/json: - schema: - $ref: "#/components/schemas/AppLinkAppDomainAttachment" - examples: - AppLinkDetachDomainResponse: - $ref: "#/components/examples/AppLinkAttachDomainDetachResponse" - "400": - description: Bad request + '200': + description: Attached App Domain object content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/AppLinkAppDomainAttachment' examples: - example: - $ref: "#/components/examples/AppLink_400_InvalidAttachState" - "401": + AppLinkDomainResponse: + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + attachmentStatus: ATTACHED + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appDomains/search: post: tags: @@ -18648,73 +49444,131 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachDomainSearchRequest" + $ref: '#/components/schemas/AppLinkAttachDomainSearchRequest' examples: SearchAttachedDomainFilterByStatus: - $ref: "#/components/examples/AppLinkAttachDomainSearchFilterByStatus" + value: + filter: + and: + - property: /attachmentStatus + operator: '=' + values: + - ATTACHED + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchAttachedDomainFilterOrAnd: - $ref: "#/components/examples/AppLinkAttachDomainSearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /uuid + operator: '=' + values: + - 20f3ef8e-d670-4236-86fa-bb0038adcfc3 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachDomainSearchResponse" + $ref: '#/components/schemas/AppLinkAttachDomainSearchResponse' examples: Example: - $ref: "#/components/examples/AppLinkAttachDomainSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + attachmentStatus: ATTACHED + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3820039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "415": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appDomains: get: tags: @@ -18728,7 +49582,10 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: offset in: query description: offset @@ -18750,380 +49607,585 @@ paths: style: form explode: false schema: - $ref: "#/components/schemas/AttachedAppDomainAttachmentStatus" + $ref: '#/components/schemas/AttachedAppDomainAttachmentStatus' - name: order in: query description: Sort order for attached App Domains. required: false schema: - $ref: "#/components/schemas/AttachedAppDomainOrder" + $ref: '#/components/schemas/AttachedAppDomainOrder' - name: style in: query description: Detail level of the response. required: false schema: - $ref: "#/components/schemas/Style" + $ref: '#/components/schemas/Style' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachedAppDomains" + $ref: '#/components/schemas/AppLinkAttachedAppDomains' examples: Example: - $ref: "#/components/examples/AppLinkAttachDomainGetExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + description: Atlassian Domain + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + attachmentStatus: ATTACHED + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3820039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appServices/{appServiceId}: - get: + put: tags: - Application Links - summary: Get Attached Service for Link - description: This API provides ability to retrieve an App Service attached to an App Link - operationId: getAttachedAppServiceByUuid + summary: Attach Service to Link + description: This API provides ability to attach the user's App Service to App Link + operationId: attachAppServiceToAppLink parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appServiceId in: path description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppLinkAttachServiceRequest' + examples: + AttachAppLinkToService: + value: + geoScope: GLOBAL + destinationIp: 10.10.1.110 + required: true responses: - "200": - description: Attached App Service object + '202': + description: Attach App Service object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppServiceAttachment" + $ref: '#/components/schemas/AppLinkAppServiceAttachment' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkAttachServiceResponse" - "401": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + geoScope: GLOBAL + destinationIp: 10.10.1.110 + attachmentStatus: ATTACHING + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-27T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" - put: + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error + delete: tags: - Application Links - summary: Attach Service to Link - description: This API provides ability to attach the user's App Service to App Link - operationId: attachAppServiceToAppLink + summary: Detach Service from Link + description: This API provides ability to detach App Service from App Link + operationId: detachAppServiceFromAppLink parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appServiceId in: path description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AppLinkAttachServiceRequest" - examples: - AttachAppLinkToService: - $ref: "#/components/examples/AppLinkAttachService" - required: true + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": - description: Attach App Service object + '202': + description: Detach App Service object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppServiceAttachment" + $ref: '#/components/schemas/AppLinkAppServiceAttachment' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkAttachServiceAttachResponse" - "401": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + geoScope: GLOBAL + destinationIp: 10.10.1.110 + attachmentStatus: DETACHING + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3820030 + errorMessage: Cannot delete App Link in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot delete App Link in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" - delete: + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error + patch: tags: - Application Links - summary: Detach Service from Link - description: This API provides ability to detach App Service from App Link - operationId: detachAppServiceFromAppLink + summary: Update Service Attachment for Link + description: This API provides ability to update the App Service attachment to App Link + operationId: updateAppServiceAttachmentToAppLink parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appServiceId in: path description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/AppLinkAttachServiceUpdateRequest' + examples: + UpdateDestinationIp: + value: + - op: replace + path: /destinationIp + value: 10.10.1.120 + required: true responses: - "202": - description: Detach App Service object + '202': + description: Update App Service attachment object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppServiceAttachment" + $ref: '#/components/schemas/AppLinkAppServiceAttachment' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkAttachServiceDetachResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + geoScope: GLOBAL + destinationIp: 10.10.1.120 + attachmentStatus: ATTACHING + change: + uuid: 531c4ab5-43b0-4352-8975-ee9045325841 + type: APP_SERVICE_UPDATE + status: REQUESTED + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedDateTime: '2026-06-27T04:20:55.471Z' + data: + - op: replace + path: /destinationIp + value: 10.10.1.120 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-27T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidState" - "401": + value: + - errorCode: EQ-3040054 + errorMessage: Invalid Argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" - patch: + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error + get: tags: - Application Links - summary: Update Service Attachment for Link - description: This API provides ability to update the App Service attachment to App Link - operationId: updateAppServiceAttachmentToAppLink + summary: Get Attached Service for Link + description: This API provides ability to retrieve an App Service attached to an App Link + operationId: getAttachedAppServiceByUuid parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appServiceId in: path description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" - requestBody: - content: - application/json-patch+json: - schema: - $ref: "#/components/schemas/AppLinkAttachServiceUpdateRequest" - examples: - UpdateDestinationIp: - $ref: "#/components/examples/AppLinkAttachServicePatchDestinationIp" - required: true + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": - description: Update App Service attachment object + '200': + description: Attached App Service object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppServiceAttachment" + $ref: '#/components/schemas/AppLinkAppServiceAttachment' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkAttachServicePatchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/AppLink_400_InvalidOperation" - "401": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + geoScope: GLOBAL + destinationIp: 10.10.1.110 + attachmentStatus: ATTACHED + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "415": - description: Unsupported Media Type - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appServices/search: post: tags: @@ -19137,73 +50199,132 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachServiceSearchRequest" + $ref: '#/components/schemas/AppLinkAttachServiceSearchRequest' examples: SearchAttachedServiceFilterByStatus: - $ref: "#/components/examples/AppLinkAttachServiceSearchFilterByStatus" + value: + filter: + and: + - property: /attachmentStatus + operator: '=' + values: + - ATTACHED + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchAttachedServiceFilterOrAnd: - $ref: "#/components/examples/AppLinkAttachServiceSearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /uuid + operator: '=' + values: + - 20f3ef8e-d670-4236-86fa-bb0038adcfc3 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachServiceSearchResponse" + $ref: '#/components/schemas/AppLinkAttachServiceSearchResponse' examples: Example: - $ref: "#/components/examples/AppLinkAttachServiceSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + geoScope: GLOBAL + destinationIp: 10.10.1.110 + attachmentStatus: ATTACHED + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3820039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "415": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appServices: get: tags: @@ -19217,7 +50338,10 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: offset in: query description: offset @@ -19239,306 +50363,471 @@ paths: style: form explode: false schema: - $ref: "#/components/schemas/AttachedAppServiceAttachmentStatus" + $ref: '#/components/schemas/AttachedAppServiceAttachmentStatus' - name: order in: query description: Sort order for attached App Services. required: false schema: - $ref: "#/components/schemas/AttachedAppServiceOrder" + $ref: '#/components/schemas/AttachedAppServiceOrder' - name: style in: query description: Detail level of the response. required: false schema: - $ref: "#/components/schemas/Style" + $ref: '#/components/schemas/Style' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachedAppServices" + $ref: '#/components/schemas/AppLinkAttachedAppServices' examples: Example: - $ref: "#/components/examples/AppLinkAttachServiceGetExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + name: Atlassian App Service + description: Atlassian App Service in SV + state: PROVISIONED + endpoint: equinixjira.atlassian.net + sourceDomains: + - equinix.com + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + geoScope: GLOBAL + destinationIp: 10.10.1.110 + attachmentStatus: ATTACHED + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3820039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appProcessors/{appProcessorId}: - get: + put: tags: - Application Links - summary: Get attached App Processor for App Link - description: This API provides ability to get an App Processor attached to an App Link. - operationId: getAttachedAppProcessor + summary: Attach Processor to Link + description: This API provides ability to attach an App Processor to an App Link. + operationId: attachAppProcessorToAppLink parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appProcessorId in: path description: App Processor UUID required: true schema: - $ref: "#/components/schemas/AppProcessorId" + description: App Processor UUID + type: string + format: uuid + example: 90ee425c-9988-454c-96d9-1128bc16350f + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppLinkAttachProcessorRequest' + examples: + AttachAppProcessorToAppLink: + value: + config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... + required: true responses: - "200": - description: App Processor attachment object + '202': + description: Attach App Processor object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppProcessorAttachment" + $ref: '#/components/schemas/AppLinkAppProcessorAttachment' examples: - AppLinkAttachProcessorGetResponse: - $ref: "#/components/examples/AppLinkAttachProcessorGetResponse" - "401": + AppLinkAttachProcessorResponse: + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + uuid: 90ee425c-9988-454c-96d9-1128bc16350f + type: APP_PROCESSOR + config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... + endpoint: 123456.privateai.link + attachmentStatus: ATTACHING + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-27T04:20:55.471Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3820030 + errorMessage: Cannot perform attach or detach operation in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot perform attach or detach operation in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" - put: + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error + delete: tags: - Application Links - summary: Attach Processor to Link - description: This API provides ability to attach an App Processor to an App Link. - operationId: attachAppProcessorToAppLink + summary: Detach App Processor from App Link + description: This API provides ability to detach an App Processor from an App Link. + operationId: detachAppProcessorFromAppLink parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appProcessorId in: path description: App Processor UUID required: true schema: - $ref: "#/components/schemas/AppProcessorId" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AppLinkAttachProcessorRequest" - examples: - AttachAppProcessorToAppLink: - $ref: "#/components/examples/AppLinkAttachProcessor" - required: true + description: App Processor UUID + type: string + format: uuid + example: 90ee425c-9988-454c-96d9-1128bc16350f responses: - "202": - description: Attach App Processor object + '202': + description: Detach App Processor object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppProcessorAttachment" + $ref: '#/components/schemas/AppLinkAppProcessorAttachment' examples: - AppLinkAttachProcessorResponse: - $ref: "#/components/examples/AppLinkAttachProcessorAttachResponse" - "400": + AppLinkDetachProcessorResponse: + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + uuid: 90ee425c-9988-454c-96d9-1128bc16350f + type: APP_PROCESSOR + config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... + endpoint: 123456.privateai.link + attachmentStatus: DETACHING + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidAttachState" - "401": + value: + - errorCode: EQ-3820030 + errorMessage: Cannot perform attach or detach operation in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot perform attach or detach operation in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "415": - description: Unsupported Media Type - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" - delete: + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error + get: tags: - Application Links - summary: Detach App Processor from App Link - description: This API provides ability to detach an App Processor from an App Link. - operationId: detachAppProcessorFromAppLink + summary: Get attached App Processor for App Link + description: This API provides ability to get an App Processor attached to an App Link. + operationId: getAttachedAppProcessor parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appProcessorId in: path description: App Processor UUID required: true schema: - $ref: "#/components/schemas/AppProcessorId" + description: App Processor UUID + type: string + format: uuid + example: 90ee425c-9988-454c-96d9-1128bc16350f responses: - "202": - description: Detach App Processor object - content: - application/json: - schema: - $ref: "#/components/schemas/AppLinkAppProcessorAttachment" - examples: - AppLinkDetachProcessorResponse: - $ref: "#/components/examples/AppLinkAttachProcessorDetachResponse" - "400": - description: Bad request + '200': + description: App Processor attachment object content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/AppLinkAppProcessorAttachment' examples: - example: - $ref: "#/components/examples/AppLink_400_InvalidAttachState" - "401": + AppLinkAttachProcessorGetResponse: + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + uuid: 90ee425c-9988-454c-96d9-1128bc16350f + type: APP_PROCESSOR + config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... + endpoint: 123456.privateai.link + attachmentStatus: ATTACHED + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appProcessors/search: post: tags: @@ -19552,71 +50841,123 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachProcessorSearchRequest" + $ref: '#/components/schemas/AppLinkAttachProcessorSearchRequest' examples: SearchAttachedProcessorFilterByStatus: - $ref: "#/components/examples/AppLinkAttachProcessorSearchFilterByStatus" + value: + filter: + and: + - property: /attachmentStatus + operator: '=' + values: + - ATTACHED + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachProcessorSearchResponse" + $ref: '#/components/schemas/AppLinkAttachProcessorSearchResponse' examples: Example: - $ref: "#/components/examples/AppLinkAttachProcessorSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + uuid: 90ee425c-9988-454c-96d9-1128bc16350f + type: APP_PROCESSOR + config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... + endpoint: 123456.privateai.link + attachmentStatus: ATTACHED + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3820039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "415": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appProcessors: get: tags: @@ -19630,7 +50971,10 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: offset in: query description: offset @@ -19652,74 +50996,114 @@ paths: style: form explode: false schema: - $ref: "#/components/schemas/AttachedAppProcessorAttachmentStatus" + $ref: '#/components/schemas/AttachedAppProcessorAttachmentStatus' - name: order in: query description: Sort order for attached App Processors. required: false schema: - $ref: "#/components/schemas/AttachedAppProcessorOrder" + $ref: '#/components/schemas/AttachedAppProcessorOrder' - name: style in: query description: Detail level of the response. required: false schema: - $ref: "#/components/schemas/Style" + $ref: '#/components/schemas/Style' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachedAppProcessors" + $ref: '#/components/schemas/AppLinkAttachedAppProcessors' examples: Example: - $ref: "#/components/examples/AppLinkAttachProcessorListExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /appProcessors?offset=1&limit=20 + previous: /appProcessors?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + uuid: 90ee425c-9988-454c-96d9-1128bc16350f + type: APP_PROCESSOR + attachmentStatus: ATTACHED + config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... + endpoint: 123456.privateai.link + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3820039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appProcessors/{appProcessorId}: get: tags: @@ -19733,53 +51117,89 @@ paths: description: App Processor UUID required: true schema: - $ref: "#/components/schemas/AppProcessorId" + description: App Processor UUID + type: string + format: uuid + example: 90ee425c-9988-454c-96d9-1128bc16350f responses: - "200": + '200': description: App Processor object content: application/json: schema: - $ref: "#/components/schemas/AppProcessor" + $ref: '#/components/schemas/AppProcessor' examples: AppProcessorResponse: - $ref: "#/components/examples/AppProcessorGetResponseExample" - "401": + value: + href: https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + uuid: 90ee425c-9988-454c-96d9-1128bc16350f + type: APP_PROCESSOR + name: agent-gateway + description: llm-routing, a2a-routing, mcp-routing + registryId: agentgateway/agentgateway:1.3.0 + marketplace: + visibility: PUBLIC + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-09-08T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-09-08T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_401" - "403": + value: + - errorCode: EQ-3850001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_403" - "404": + value: + - errorCode: EQ-3850002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_404" - "500": + value: + - errorCode: EQ-3850020 + errorMessage: AppProcessor not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppProcessor not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_500" + value: + - errorCode: EQ-3850030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appProcessors/search: post: tags: @@ -19787,75 +51207,159 @@ paths: summary: Search Processors description: The API provides capability to get list of user's App Processors using search criteria, including optional filtering, pagination and sorting operationId: searchAppProcessors - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppProcessorSearchRequest" + $ref: '#/components/schemas/AppProcessorSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/AppProcessorSearchFilterByStatus" + value: + filter: + and: + - property: /state + operator: '=' + values: + - PROVISIONED + - property: /project/projectId + operator: IN + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterByName: - $ref: "#/components/examples/AppProcessorSearchFilterByName" + value: + filter: + and: + - property: /name + operator: '=' + values: + - agent- + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterOrAnd: - $ref: "#/components/examples/AppProcessorSearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /name + operator: LIKE + values: + - agent% + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppProcessorSearchResponse" + $ref: '#/components/schemas/AppProcessorSearchResponse' examples: Example: - $ref: "#/components/examples/AppProcessorSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + uuid: 90ee425c-9988-454c-96d9-1128bc16350f + type: APP_PROCESSOR + name: agent-gateway + description: llm-routing, a2a-routing, mcp-routing + registryId: agentgateway/agentgateway:1.3.0 + marketplace: + visibility: PUBLIC + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3850039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_401" - "403": + value: + - errorCode: EQ-3850001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_403" - "415": + value: + - errorCode: EQ-3850002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_415" - "500": + value: + - errorCode: EQ-3850016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_500" + value: + - errorCode: EQ-3850030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appServices: post: tags: @@ -19863,71 +51367,118 @@ paths: summary: Create Service description: This API provides capability to create user's Service operationId: createAppService - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppServicePostRequest" + $ref: '#/components/schemas/AppServicePostRequest' examples: CreateAppService: - $ref: "#/components/examples/AppServiceCreate" + value: + type: APP_SERVICE + name: Atlassian App Service + description: Atlassian App Service in SV + endpoint: equinixjira.atlassian.net + sourceDomains: + - equinix.com + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "202": + '202': description: App Service object content: application/json: schema: - $ref: "#/components/schemas/AppService" + $ref: '#/components/schemas/AppService' examples: AppServiceResponse: - $ref: "#/components/examples/AppServicePostResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + name: Atlassian App Service + description: Atlassian App Service in SV + state: PROVISIONING + endpoint: equinixjira.atlassian.net + sourceDomains: + - equinix.com + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidName: - $ref: "#/components/examples/AppService_400_InvalidName" - "401": + value: + - errorCode: EQ-3830022 + errorMessage: Name is minimum 0 and up to 50 characters in length + correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e + details: Name is minimum 0 and up to 50 characters in length + additionalInfo: + - property: /name + reason: Name is minimum 0 and up to 50 characters in length + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_401" - "403": + value: + - errorCode: EQ-3830001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "415": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_415" - "500": + value: + - errorCode: EQ-3830016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appServices/{appServiceId}: get: tags: @@ -19941,53 +51492,91 @@ paths: description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: App Service object content: application/json: schema: - $ref: "#/components/schemas/AppService" + $ref: '#/components/schemas/AppService' examples: AppServiceResponse: - $ref: "#/components/examples/AppServiceGetResponseExample" - "401": + value: + href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + name: Atlassian App Service + description: Atlassian App Service in SV + state: PROVISIONED + endpoint: equinixjira.atlassian.net + sourceDomains: + - equinix.com + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + account: + organizationName: atlassian + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_401" - "403": + value: + - errorCode: EQ-3830001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "404": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_404" - "500": + value: + - errorCode: EQ-3830020 + errorMessage: App Service not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Service not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error delete: tags: - Application Services @@ -20000,62 +51589,104 @@ paths: description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '202': description: App Service object content: application/json: schema: - $ref: "#/components/schemas/AppService" + $ref: '#/components/schemas/AppService' examples: AppServiceResponse: - $ref: "#/components/examples/AppServiceDeleteResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + name: Atlassian App Service + description: Atlassian App Service in SV + state: DEPROVISIONING + endpoint: equinixjira.atlassian.net + sourceDomains: + - equinix.com + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + deletedBy: test + deletedDateTime: '2026-06-29T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_400_InvalidState" - "401": + value: + - errorCode: EQ-3830030 + errorMessage: Cannot delete App Service in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot delete App Service in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_401" - "403": + value: + - errorCode: EQ-3830001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "404": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_404" - "500": + value: + - errorCode: EQ-3830020 + errorMessage: App Service not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Service not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error patch: tags: - Application Services @@ -20068,80 +51699,136 @@ paths: description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/AppServiceUpdateRequest" + $ref: '#/components/schemas/AppServiceUpdateRequest' examples: UpdateName: - $ref: "#/components/examples/AppServiceUpdateName" + value: + - op: replace + path: /name + value: Updated Atlassian App Service required: true responses: - "202": + '202': description: App Service object content: application/json: schema: - $ref: "#/components/schemas/AppService" + $ref: '#/components/schemas/AppService' examples: AppServiceResponse: - $ref: "#/components/examples/AppServicePatchResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + name: Updated Atlassian App Service + description: Atlassian App Service in SV + state: REPROVISIONING + endpoint: equinixjira.atlassian.net + sourceDomains: + - equinix.com + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + change: + uuid: 531c4ab5-43b0-4352-8975-ee9045325841 + type: APP_SERVICE_UPDATE + status: REQUESTED + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedDateTime: '2026-06-28T04:20:55.471Z' + data: + - op: replace + path: /name + value: Updated Atlassian App Service + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_400_InvalidOperation" - "401": + value: + - errorCode: EQ-3040054 + errorMessage: Invalid Argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "404": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_404" - "415": + value: + - errorCode: EQ-3830020 + errorMessage: App Service not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Service not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_415" - "500": + value: + - errorCode: EQ-3830016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appServices/search: post: tags: @@ -20149,75 +51836,161 @@ paths: summary: Search Services description: The API provides capability to get list of user's App Services using search criteria, including optional filtering, pagination and sorting operationId: searchAppServices - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppServiceSearchRequest" + $ref: '#/components/schemas/AppServiceSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/AppServiceSearchFilterByStatus" + value: + filter: + and: + - property: /state + operator: '=' + values: + - PROVISIONED + - property: /project/projectId + operator: IN + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterByName: - $ref: "#/components/examples/AppServiceSearchFilterByName" + value: + filter: + and: + - property: /name + operator: '=' + values: + - test- + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterOrAnd: - $ref: "#/components/examples/AppServiceSearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /name + operator: LIKE + values: + - abc% + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppServiceSearchResponse" + $ref: '#/components/schemas/AppServiceSearchResponse' examples: Example: - $ref: "#/components/examples/AppServiceSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + name: Atlassian App Service + description: Atlassian App Service in SV + state: PROVISIONED + endpoint: equinixjira.atlassian.net + sourceDomains: + - equinix.com + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + account: + organizationName: atlassian + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3830039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_401" - "403": + value: + - errorCode: EQ-3830001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "415": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_415" - "500": + value: + - errorCode: EQ-3830016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appServices/{appServiceId}/appLinks: get: tags: @@ -20231,7 +52004,10 @@ paths: description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: offset in: query description: offset @@ -20253,74 +52029,116 @@ paths: style: form explode: false schema: - $ref: "#/components/schemas/AttachedAppLinkState_1" + $ref: '#/components/schemas/AttachedAppLinkState' - name: order in: query description: Sort order for attached App Links. required: false schema: - $ref: "#/components/schemas/AttachedAppLinkOrder" + $ref: '#/components/schemas/AttachedAppLinkOrder' - name: style in: query description: Detail level of the response. required: false schema: - $ref: "#/components/schemas/Style" + $ref: '#/components/schemas/Style' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppServiceAttachedAppLinks" + $ref: '#/components/schemas/AppServiceAttachedAppLinks' examples: Example: - $ref: "#/components/examples/AppServiceAttachedAppLinksGetResponseExample" - "400": + value: + pagination: + limit: 20 + offset: 0 + total: 1 + data: + - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + type: APP_LINK + uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + name: Atlassian App Link + description: Atlassian App Link in SV + state: PROVISIONED + router: + href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + type: XF_ROUTER + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + bandwidth: 1000 + ipv4Subnet: 192.168.10.0/29 + ipv4Address: 192.168.10.3 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3830039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_401" - "403": + value: + - errorCode: EQ-3830001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "404": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_404" - "500": + value: + - errorCode: EQ-3830020 + errorMessage: App Service not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Service not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appServices/{appServiceId}/appSubscriptions: get: tags: @@ -20334,7 +52152,10 @@ paths: description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: offset in: query description: offset @@ -20356,74 +52177,107 @@ paths: style: form explode: false schema: - $ref: "#/components/schemas/AttachedAppSubscriptionState" + $ref: '#/components/schemas/AttachedAppSubscriptionState' - name: order in: query description: Sort order for attached App Subscriptions. required: false schema: - $ref: "#/components/schemas/AttachedAppSubscriptionOrder" + $ref: '#/components/schemas/AttachedAppSubscriptionOrder' - name: style in: query description: Detail level of the response. required: false schema: - $ref: "#/components/schemas/Style" + $ref: '#/components/schemas/Style' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptions" + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptions' examples: Example: - $ref: "#/components/examples/AppServiceAttachedAppSubscriptionsGetResponseExample" - "400": + value: + pagination: + limit: 20 + offset: 0 + total: 1 + data: + - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_SUBSCRIPTION + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + state: PROVISIONED + account: + organizationName: equinix + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3830039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_401" - "403": + value: + - errorCode: EQ-3830001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "404": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_404" - "500": + value: + - errorCode: EQ-3830020 + errorMessage: App Service not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Service not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appServices/{appServiceId}/appSubscriptions/search: post: tags: @@ -20437,68 +52291,106 @@ paths: description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionSearchRequest" + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSearchRequest' required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionSearchResponse" + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSearchResponse' examples: Example: - $ref: "#/components/examples/AppServiceAttachedAppSubscriptionSearchExample" - "400": + value: + pagination: + limit: 20 + offset: 0 + total: 1 + data: + - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_SUBSCRIPTION + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + state: PROVISIONED + account: + organizationName: equinix + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3830039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_401" - "403": + value: + - errorCode: EQ-3830001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "415": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_415" - "500": + value: + - errorCode: EQ-3830016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appSubscriptions: post: tags: @@ -20506,62 +52398,112 @@ paths: summary: Create Subscription description: This API provides capability to create user's Subscription operationId: createAppSubscription - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppSubscriptionPostRequest" + $ref: '#/components/schemas/AppSubscriptionPostRequest' examples: CreateAppSubscription: - $ref: "#/components/examples/AppSubscriptionCreate" + value: + type: APP_SUBSCRIPTION + source: + appLink: + uuid: e32c9c7a-0149-4582-8345-192b82aef972 + ipSubnets: + - 192.168.100.0/24 + target: + appService: + uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d + geoScope: GLOBAL + prioritization: LATENCY + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "202": + '202': description: App Subscription object content: application/json: schema: - $ref: "#/components/schemas/AppSubscription" + $ref: '#/components/schemas/AppSubscription' examples: AppSubscriptionResponse: - $ref: "#/components/examples/AppSubscriptionPostResponseExample" - "401": + value: + href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_SUBSCRIPTION + source: + appLink: + uuid: e32c9c7a-0149-4582-8345-192b82aef972 + ipSubnets: + - 192.168.100.0/24 + target: + appService: + uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d + geoScope: GLOBAL + prioritization: LATENCY + state: PROVISIONING + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_401" - "403": + value: + - errorCode: EQ-3840001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_403" - "415": + value: + - errorCode: EQ-3840002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_415" - "500": + value: + - errorCode: EQ-3840016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_500" + value: + - errorCode: EQ-3840030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appSubscriptions/{appSubscriptionId}: get: tags: @@ -20575,53 +52517,94 @@ paths: description: App Subscription UUID required: true schema: - $ref: "#/components/schemas/AppSubscriptionId" + description: App Subscription UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: - "200": + '200': description: App Subscription object content: application/json: schema: - $ref: "#/components/schemas/AppSubscription" + $ref: '#/components/schemas/AppSubscription' examples: AppSubscriptionResponse: - $ref: "#/components/examples/AppSubscriptionGetResponseExample" - "401": + value: + href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_SUBSCRIPTION + source: + appLink: + uuid: e32c9c7a-0149-4582-8345-192b82aef972 + ipSubnets: + - 192.168.100.0/24 + target: + appService: + uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d + geoScope: GLOBAL + prioritization: LATENCY + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_401" - "403": + value: + - errorCode: EQ-3840001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_403" - "404": + value: + - errorCode: EQ-3840002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_404" - "500": + value: + - errorCode: EQ-3840020 + errorMessage: App Subscription not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_500" + value: + - errorCode: EQ-3840030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error delete: tags: - Application Subscriptions @@ -20634,62 +52617,109 @@ paths: description: App Subscription UUID required: true schema: - $ref: "#/components/schemas/AppSubscriptionId" + description: App Subscription UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: - "202": + '202': description: App Subscription object content: application/json: schema: - $ref: "#/components/schemas/AppSubscription" + $ref: '#/components/schemas/AppSubscription' examples: AppSubscriptionResponse: - $ref: "#/components/examples/AppSubscriptionDeleteResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_SUBSCRIPTION + source: + appLink: + uuid: e32c9c7a-0149-4582-8345-192b82aef972 + ipSubnets: + - 192.168.100.0/24 + target: + appService: + uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d + geoScope: GLOBAL + prioritization: LATENCY + state: DEPROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + deletedBy: test + deletedDateTime: '2026-06-29T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_400_InvalidState" - "401": + value: + - errorCode: EQ-3840030 + errorMessage: Cannot delete App Subscription in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot delete App Subscription in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_401" - "403": + value: + - errorCode: EQ-3840001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_403" - "404": + value: + - errorCode: EQ-3840002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_404" - "500": + value: + - errorCode: EQ-3840020 + errorMessage: App Subscription not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_500" + value: + - errorCode: EQ-3840030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error patch: tags: - Application Subscriptions @@ -20702,80 +52732,144 @@ paths: description: App Subscription UUID required: true schema: - $ref: "#/components/schemas/AppSubscriptionId" + description: App Subscription UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/AppSubscriptionUpdateRequest" + $ref: '#/components/schemas/AppSubscriptionUpdateRequest' examples: UpdateSourceIpSubnets: - $ref: "#/components/examples/AppSubscriptionUpdateSourceIpSubnets" + value: + - op: add + path: /source/ipSubnets + value: + - 192.168.200.0/24 required: true responses: - "202": + '202': description: App Subscription object content: application/json: schema: - $ref: "#/components/schemas/AppSubscription" + $ref: '#/components/schemas/AppSubscription' examples: AppSubscriptionResponse: - $ref: "#/components/examples/AppSubscriptionPatchResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_SUBSCRIPTION + source: + appLink: + uuid: e32c9c7a-0149-4582-8345-192b82aef972 + ipSubnets: + - 192.168.100.0/24 + - 192.168.200.0/24 + target: + appService: + uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d + geoScope: GLOBAL + prioritization: LATENCY + state: PROVISIONING + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + change: + uuid: 531c4ab5-43b0-4352-8975-ee9045325841 + type: APP_SUBSCRIPTION_UPDATE + status: REQUESTED + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedDateTime: '2026-06-28T04:20:55.471Z' + data: + - op: add + path: /source/ipSubnets + value: + - 192.168.200.0/24 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_400_InvalidOperation" - "401": + value: + - errorCode: EQ-3040054 + errorMessage: Invalid Argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_403" - "404": + value: + - errorCode: EQ-3840002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_404" - "415": + value: + - errorCode: EQ-3840020 + errorMessage: App Subscription not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Subscription not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_415" - "500": + value: + - errorCode: EQ-3840016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_500" + value: + - errorCode: EQ-3840030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appSubscriptions/search: post: tags: @@ -20783,82 +52877,613 @@ paths: summary: Search Subscriptions description: The API provides capability to get list of user's App Subscriptions using search criteria, including optional filtering, pagination and sorting operationId: searchAppSubscriptions - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppSubscriptionSearchRequest" + $ref: '#/components/schemas/AppSubscriptionSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/AppSubscriptionSearchFilterByStatus" + value: + filter: + and: + - property: /state + operator: IN + values: + - PROVISIONED + - property: /project/projectId + operator: IN + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterOrAnd: - $ref: "#/components/examples/AppSubscriptionSearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /uuid + operator: '=' + values: + - 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppSubscriptionSearchResponse" + $ref: '#/components/schemas/AppSubscriptionSearchResponse' examples: Example: - $ref: "#/components/examples/AppSubscriptionSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_SUBSCRIPTION + source: + appLink: + uuid: e32c9c7a-0149-4582-8345-192b82aef972 + ipSubnets: + - 192.168.100.0/24 + target: + appService: + uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d + geoScope: GLOBAL + prioritization: LATENCY + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3840039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_401" - "403": + value: + - errorCode: EQ-3840001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_403" - "415": + value: + - errorCode: EQ-3840002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_415" - "500": + value: + - errorCode: EQ-3840016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_500" + value: + - errorCode: EQ-3840030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error components: + securitySchemes: + BearerAuth: + type: http + scheme: bearer + bearerFormat: JWT schemas: + Project: + type: object + properties: + projectId: + description: Subscriber-assigned project ID + type: string + example: 44f4c4f8-2f39-494e-838c-d8e640591be5 + required: + - projectId + AsnRirRegion: + type: string + description: Regional Internet Registry region + enum: + - AFRINIC + - APNIC + - ARIN + - LACNIC + - RIPE_NCC + AsnOwnershipChallengeDetails: + type: object + description: Ownership challenge details for public ASN verification + required: + - type + properties: + type: + $ref: '#/components/schemas/AsnOwnershipChallengeType' + discriminator: + propertyName: type + mapping: + RPKI: '#/components/schemas/AsnOwnershipChallengeRpki' + LOA: '#/components/schemas/AsnOwnershipChallengeLoa' + AsnOwnershipChallengeRpki: + allOf: + - $ref: '#/components/schemas/AsnOwnershipChallengeDetails' + - type: object + properties: + message: + type: string + description: Challenge message to sign + example: eqx-rpki-challenge-2026-04-21T11:20:00Z-64497 + signature: + type: string + description: Signed challenge value + example: MEUCIQCrExampleBase64SignatureValue7h4Yg== + AsnOwnershipChallengeLoa: + allOf: + - $ref: '#/components/schemas/AsnOwnershipChallengeDetails' + - type: object + properties: + contentFormat: + type: string + description: Document content format + example: pdf + documentReference: + type: string + description: Document reference identifier + example: loa-2026-00019 + AsnOwnershipChallengeType: + type: string + description: Type of ownership challenge + enum: + - RPKI + - LOA + x-enum-varnames: + - RPKI + - LOA + 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: + deprecated: true + type: string + example: AM1 + AsnRange: + type: string + description: ASN range selection + enum: + - 16_BIT + - 32_BIT + CreateAsnRequest: + type: object + description: Create ASN request body + required: + - project + - type + properties: + project: + $ref: '#/components/schemas/Project' + number: + type: integer + format: int64 + description: ASN number used for public ASN creation. + example: 64497 + rirRegion: + $ref: '#/components/schemas/AsnRirRegion' + ownershipChallengeDetails: + $ref: '#/components/schemas/AsnOwnershipChallengeDetails' + location: + $ref: '#/components/schemas/SimplifiedLocation' + range: + $ref: '#/components/schemas/AsnRange' + AsnState: + type: string + description: ASN lifecycle state + enum: + - REQUESTED + - PROVISIONING + - PENDING + - PROVISIONED + - ATTACHED + - FAILED + - PROVISIONING_FAILED + - DEPROVISIONING + - DEPROVISIONING_FAILED + - DEPROVISIONED + x-enum-varnames: + - REQUESTED + - PROVISIONING + - PENDING + - PROVISIONED + - ATTACHED + - FAILED + - PROVISIONING_FAILED + - DEPROVISIONING + - DEPROVISIONING_FAILED + - DEPROVISIONED + AsnChange: + type: object + description: Change reference for ASN + properties: + href: + type: string + description: URL path to the change event + example: /cloudEvents + AsnAssetService: + type: object + description: Associated Internet Access Service reference + properties: + href: + type: string + type: + type: string + enum: + - IA + uuid: + type: string + example: 52fbdb3f-8def-410d-868b-ef920878bff8 + AsnAssetIpBlockRef: + type: object + properties: + href: + type: string + type: + type: string + enum: + - IPV4_IP_BLOCK + - IPV6_IP_BLOCK + uuid: + type: string + example: 129afa61-f706-41cb-a03a-69a276bdb0b4 + Changelog: + description: Change log + type: object + properties: + createdBy: + type: string + example: johnsmith + description: Created by User Key + createdByFullName: + type: string + example: John Smith + description: Created by User Full Name + createdByEmail: + type: string + example: john.smith@example.com + description: Created by User Email Address + createdDateTime: + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + description: Created by Date and Time + updatedBy: + type: string + example: johnsmith + description: Updated by User Key + updatedByFullName: + type: string + example: John Smith + description: Updated by User Full Name + updatedByEmail: + type: string + example: john.smith@example.com + description: Updated by User Email Address + updatedDateTime: + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + description: Updated by Date and Time + deletedBy: + type: string + example: johnsmith + description: Deleted by User Key + deletedByFullName: + type: string + example: John Smith + description: Deleted by User Full Name + deletedByEmail: + type: string + example: john.smith@example.com + description: Deleted by User Email Address + deletedDateTime: + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + description: Deleted by Date and Time + AsnAsset: + type: object + description: Asset associated with ASN + properties: + uuid: + type: string + example: 52fbdb3f-8def-410d-868b-ef920878bff8 + service: + $ref: '#/components/schemas/AsnAssetService' + announcingMetro: + type: string + example: LD + ipBlocks: + type: array + items: + $ref: '#/components/schemas/AsnAssetIpBlockRef' + changeLog: + $ref: '#/components/schemas/Changelog' + Error: + description: Error Response with details + required: + - errorCode + - errorMessage + type: object + properties: + errorCode: + type: string + pattern: ^EQ-\d{7}$ + errorMessage: + type: string + correlationId: + type: string + details: + type: string + help: + type: string + additionalInfo: + type: array + items: + type: object + properties: + property: + type: string + reason: + type: string + Asn: + type: object + description: ASN Record + properties: + href: + type: string + uuid: + type: string + format: uuid + description: Unique identifier for the ASN record + example: 6db706f8-2a37-4546-a3ed-1df113a84d43 + state: + $ref: '#/components/schemas/AsnState' + project: + $ref: '#/components/schemas/Project' + number: + type: integer + format: int64 + description: Autonomous System Number + example: 64497 + rirRegion: + $ref: '#/components/schemas/AsnRirRegion' + location: + $ref: '#/components/schemas/SimplifiedLocation' + range: + $ref: '#/components/schemas/AsnRange' + ownershipChallengeDetails: + $ref: '#/components/schemas/AsnOwnershipChallengeDetails' + change: + $ref: '#/components/schemas/AsnChange' + assets: + type: array + items: + $ref: '#/components/schemas/AsnAsset' + errors: + type: array + items: + $ref: '#/components/schemas/Error' + description: List of errors + changeLog: + $ref: '#/components/schemas/Changelog' ErrorList: - type: array description: List of Error Message + type: array + items: + $ref: '#/components/schemas/Error' + PaginationRequest: + description: Pagination request information + type: object + properties: + offset: + type: integer + description: Index of the first element. + minimum: 0 + default: 0 + limit: + type: integer + description: Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + minimum: 1 + default: 20 + 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' + AsnSearchSortCriteria: + type: object + properties: + direction: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + property: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + AsnSearchRequestBody: + type: object + properties: + pagination: + $ref: '#/components/schemas/PaginationRequest' + filter: + $ref: '#/components/schemas/SearchExpression' + sort: + type: array + items: + $ref: '#/components/schemas/AsnSearchSortCriteria' + Pagination: + description: Pagination response information + type: object + properties: + offset: + type: integer + description: Index of the first item returned in the response. The default is 0. + minimum: 0 + default: 0 + limit: + type: integer + description: Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20. + minimum: 0 + default: 20 + total: + type: integer + description: Total number of elements returned. + minimum: 0 + 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. + required: + - limit + - total + AsnSearchResponseBody: + type: object + required: + - pagination + - data + properties: + pagination: + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/AsnSearchSortCriteria' + data: + type: array + items: + $ref: '#/components/schemas/Asn' + AsnPatchOperation: + type: object + required: + - op + - path + - value + properties: + op: + type: string + description: JSON Patch operation + enum: + - add + - remove + - replace + path: + type: string + description: JSON Pointer to the field to update + example: /ownershipChallengeDetails/signature + value: + description: New value for add or replace operations + example: MEUCIQCrExampleBase64SignatureValue7h4Yg== + AsnPatchRequest: + type: array items: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/AsnPatchOperation' CloudEventAssetType: - type: string enum: - ports - connections @@ -20870,132 +53495,158 @@ components: - organizations - timeServices - companyProfiles - AssetId: type: string - description: Asset UUID - format: uuid - example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 StartDateTime: - type: string description: Start date and time + type: string format: date-time - example: 2024-07-11T18:06:21Z + example: '2024-07-11T18:06:21.000Z' EndDateTime: - type: string description: End date and time + type: string format: date-time - example: 2024-07-11T18:06:21Z + example: '2024-07-11T18:06:21.000Z' Offset: - type: integer description: Pagination offset - example: 0 + type: integer default: 0 + example: 0 Limit: - type: integer description: Pagination limit - example: 20 + type: integer default: 100 - GetCloudEventsByAssetResponse: + example: 20 + OperationalStatus: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/CloudEvent" - CloudEventId: - type: string - description: Cloud Event UUID - format: uuid - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + operationalStatus: + description: Operational status for the resource target of the event + type: string + ResourceData: + type: object + properties: + href: + description: Cloud Event asset href + type: string + uuid: + description: Cloud Event asset uuid + type: string + type: + description: Cloud Event asset type + type: string + name: + description: Cloud Event asset name + type: string + state: + description: Cloud Event asset state + type: string + operation: + $ref: '#/components/schemas/OperationalStatus' + AuthContext: + type: object + properties: + authtype: + description: Cloud Event auth type + type: string + enum: + - system + - user + authid: + description: Cloud Event auth identifier + type: string + enum: + - equinix + - userId + name: + description: Cloud Event username + type: string + email: + description: Cloud Event email + type: string + CloudEventData: + type: object + properties: + message: + description: Cloud Event message + type: string + resource: + $ref: '#/components/schemas/ResourceData' + auth: + $ref: '#/components/schemas/AuthContext' CloudEvent: + description: Cloud Event object type: object properties: specversion: - type: string description: Cloud Event Open Telemetry specification + type: string readOnly: true source: - type: string description: Cloud Event source - id: type: string + id: description: Cloud Event identifier + type: string format: uuid type: - type: string description: Equinix supported event type - subject: type: string + subject: description: Cloud Event subject - time: type: string + time: description: Cloud Event time the event occurred + type: string format: date-time dataschema: - type: string description: Cloud Event dataschema reference - datacontenttype: type: string + datacontenttype: description: Cloud Event data content type - severitynumber: type: string + severitynumber: description: Cloud Event severity number - severitytext: type: string + severitytext: description: Cloud Event severity text - equinixalert: type: string + equinixalert: description: Equinix alert - equinixorganization: type: string + equinixorganization: description: Equinix organization identifier - equinixproject: type: string + equinixproject: description: Equinix project identifier - authtype: type: string + authtype: description: Cloud Event auth type - authid: type: string + authid: description: Cloud Event user identifier - traceparent: type: string + traceparent: description: Cloud Event traceparent - tracestate: type: string + tracestate: description: Cloud Event tracestate + type: string data: - $ref: "#/components/schemas/CloudEventData" - description: Cloud Event object - CloudEventSearchRequest: - required: - - filter + $ref: '#/components/schemas/CloudEventData' + GetCloudEventsByAssetResponse: type: object properties: - filter: - $ref: "#/components/schemas/CloudEventFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" - description: Search requests containing criteria - CloudEventFilters: - type: object - properties: - and: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. type: array items: - $ref: "#/components/schemas/CloudEventFilter" - CloudEventFilter: - type: object - anyOf: - - $ref: "#/components/schemas/CloudEventSimpleExpression" + $ref: '#/components/schemas/CloudEvent' CloudEventSimpleExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: * `/id` - Cloud Event identifier @@ -21008,9 +53659,9 @@ components: * `/severitytext` - cloud event severity text * `/authid` - Equinix user key to identify the user that performed the action that triggered the Cloud Event * `/authtype` - Equinix user type either user or system + type: string example: /subject operator: - type: string description: | Possible operators to use on filters: * `=` - equal @@ -21025,126 +53676,180 @@ components: * `ILIKE` - like case-insensitive * `IS NULL` - is null * `IS NOT NULL` - is not null - example: = + type: string + example: '=' values: type: array items: type: string example: equinix.fabric.port.status.* - LiveEventSearchRequest: + CloudEventFilter: type: object - properties: - filter: - $ref: "#/components/schemas/LiveEventFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - description: Search requests containing criteria - LiveEventFilters: + anyOf: + - $ref: '#/components/schemas/CloudEventSimpleExpression' + CloudEventFilters: type: object properties: and: type: array items: - $ref: "#/components/schemas/LiveEventFilter" - LiveEventFilter: + $ref: '#/components/schemas/CloudEventFilter' + CloudEventSearchRequest: type: object - anyOf: - - $ref: "#/components/schemas/LiveEventSimpleExpression" + description: Search requests containing criteria + required: + - filter + properties: + filter: + $ref: '#/components/schemas/CloudEventFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' LiveEventSimpleExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: * `/subject` - Cloud Event subject description + type: string example: /subject operator: - type: string description: | Possible operators to use on filters: * `=` - equal * `IN` - in - example: = + type: string + example: '=' values: type: array items: type: string + LiveEventFilter: + type: object + anyOf: + - $ref: '#/components/schemas/LiveEventSimpleExpression' + LiveEventFilters: + type: object + properties: + and: + type: array + items: + $ref: '#/components/schemas/LiveEventFilter' + LiveEventSearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/LiveEventFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' SearchLiveEventResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: - type: array description: Data returned from the API call. + type: array items: - $ref: "#/components/schemas/CloudEvent" + $ref: '#/components/schemas/CloudEvent' MetricAssetType: - type: string enum: - ports - connections - metros - Limit_1: - type: integer + type: string + Limit-2: description: Pagination limit - example: 20 + type: integer default: 20 + example: 20 + Metric: + description: Metric object + type: object + properties: + type: + description: Equinix supported metric type + type: string + name: + description: Metric name + type: string + unit: + description: Metric unit + type: string + interval: + description: Metric interval (set automatically based on search range) + type: string + resource: + description: Metric resource + type: object + properties: + href: + description: Metric resource href + type: string + uuid: + description: Metric resource UUID + type: string + type: + description: Metric resource type + type: string + state: + description: Metric resource state + type: string + name: + description: Metric resource name + type: string + description: + description: Metric resource description + type: string + summary: + description: Metric summary + type: string + datapoints: + description: Metric data points + type: array + items: + type: object + properties: + endDateTime: + description: Datapoint end date and time + type: string + format: date-time + startDateTime: + description: Datapoint start date and time + type: string + format: date-time + value: + description: Datapoint value + type: number GetMetricsByAssetResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: - type: array description: Data returned from the API call. + type: array items: - $ref: "#/components/schemas/Metric" - PortUUID: - type: string - description: Port UUID - format: uuid + $ref: '#/components/schemas/Metric' Value: - type: string description: Which value to retrieve + type: string example: last GetMetricsByNameResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: - type: array description: Data returned from the API call. - items: - $ref: "#/components/schemas/Metric" - MetricsSearchRequest: - required: - - filter - type: object - properties: - filter: - $ref: "#/components/schemas/MetricFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - description: Search requests containing criteria - MetricFilters: - type: object - properties: - and: type: array items: - $ref: "#/components/schemas/MetricFilter" - MetricFilter: - type: object - anyOf: - - $ref: "#/components/schemas/MetricSimpleExpression" + $ref: '#/components/schemas/Metric' MetricSimpleExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: * `/subject` - Metric subject description (required and limited to 1 value) @@ -21153,9 +53858,9 @@ components: * `/time` - Time of Metrics * `/interval` - ISO-8601 duration format to specify the interval of metrics data points * `/value` - specific data points of the metric to return (e.g. 'last' - for metros only) + type: string example: /subject operator: - type: string description: | Possible operators to use on filters: * `=` - equal @@ -21165,14705 +53870,13894 @@ components: * `<=` - less than or equal to * `BETWEEN` - between * `IN` - in - example: = + type: string + example: '=' values: type: array items: type: string example: equinix.fabric.port.bandwidth_rx.usage - ConnectionPostRequest: - required: - - aSide - - bandwidth - - name - - notifications - - type - - zSide + MetricFilter: + type: object + anyOf: + - $ref: '#/components/schemas/MetricSimpleExpression' + MetricFilters: 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: 100000 - 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: + and: 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: + $ref: '#/components/schemas/MetricFilter' + MetricsSearchRequest: + type: object + description: Search requests containing criteria required: - - aSide - - bandwidth - - name - - type - - zSide + - filter + properties: + filter: + $ref: '#/components/schemas/MetricFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + ConnectionType: + description: Connection type + type: string + enum: + - EVPL_VC + - EPL_VC + - EC_VC + - IP_VC + - ACCESS_EPL_VC + - EIA_VC + - EVPLAN_VC + - EPLAN_VC + - EVPTREE_VC + - EPTREE_VC + - IPWAN_VC + - IA_VC + - MC_VC + - IX_VC + - GW_VC + - IPX_VC + Order: type: object properties: - href: + purchaseOrderNumber: + description: Purchase order number type: string - description: Connection URI - format: uri - readOnly: true - type: - $ref: "#/components/schemas/ConnectionType" - uuid: + customerReferenceNumber: + description: Customer reference number type: string - description: Equinix-assigned connection identifier - name: + billingTier: + description: Billing tier for connection bandwidth type: string - description: Customer-provided connection name - description: + orderId: + description: Order Identification 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 + orderNumber: + description: Order Reference Number + type: string + termLength: + description: Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case). + default: 1 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 + minimum: 1 + maximum: 60 + contractedBandwidth: + description: Contracted bandwidth + type: integer + ContactPreference: + description: Contact preference for the phone number type: object properties: - type: - $ref: "#/components/schemas/Actions" - description: + timezone: + description: Timezone of the contact preference type: string - description: Connection rejection reason detail - data: - $ref: "#/components/schemas/ConnectionAcceptanceData" - description: Connection action request - ConnectionAction: - required: - - data - - href - - type - - uuid + availability: + description: Availability of the contact preference + type: string + enum: + - WORK_HOURS + - ANYTIME + Phone: 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 - state: + description: Notification Type type: string - description: Connection action response state enum: - - SUCCEEDED - description: + - MOBILE + - OFFICE + example: MOBILE + number: + description: Phone number 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: + pattern: ^\+[1-9]\d{1,14}$ + contactPreference: + $ref: '#/components/schemas/ContactPreference' + SimplifiedNotification: type: object properties: - property: + type: + description: Notification Type 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: + enum: + - NOTIFICATION + - BANDWIDTH_ALERT + - CONNECTION_APPROVAL + - PROFILE_LIFECYCLE + - ALL + - SALES_REP_NOTIFICATIONS + - TECHNICAL + - ORDERING + - QUOTE_NOTIFICATIONS + example: BANDWIDTH_ALERT + sendInterval: 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: + emails: + description: Array of contact emails 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: + format: email + registeredUsers: + description: Array of registered users 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: string + phone: + description: Array of contact phone numbers type: array - description: List of Routing Protocols items: - $ref: "#/components/schemas/RoutingProtocolData" - RoutingProtocolBase: - required: - - type - type: object - properties: - type: - type: string - description: Routing protocol type - enum: - - BGP - - DIRECT - oneOf: - - $ref: "#/components/schemas/RoutingProtocolBGPType" - - $ref: "#/components/schemas/RoutingProtocolDirectType" - RoutingProtocolBGPType: + $ref: '#/components/schemas/Phone' required: - type + - emails + GeoScopeType: + description: Geographic boundary types + type: string + enum: + - CANADA + - CONUS + - JAPAN + - UK + - AUSTRALIA + - BRAZIL + - SWITZERLAND + - EU + ConnectionPriority: + description: Connection priority in redundancy group + type: string + enum: + - PRIMARY + - SECONDARY + ConnectionRedundancy: + description: Connection redundancy configuration type: object properties: - type: + group: + description: Redundancy group identifier (UUID of primary connection) type: string - description: Routing protocol type - enum: - - BGP + priority: + $ref: '#/components/schemas/ConnectionPriority' name: + description: Customer-provided name for the redundancy group 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 - bgpAuthKey: + description: + description: Customer-provided description for the redundancy group type: string - description: BGP authorization key - asOverrideEnabled: - type: boolean - description: Enable AS number override - bfd: - $ref: "#/components/schemas/RoutingProtocolBFD" - RoutingProtocolDirectType: - required: - - type + ServiceTokenType: + description: Type of Service Token + type: string + enum: + - VC_TOKEN + - EPL_TOKEN + SimplifiedMetadataEntity: + description: Configuration details for port used at the access point. type: object properties: - type: + href: type: string - description: Routing protocol type - enum: - - DIRECT - name: + format: uri + description: url to entity + uuid: + description: Equinix assigned Identifier type: string - example: My-direct-route-1 - directIpv4: - $ref: "#/components/schemas/DirectConnectionIpv4" - directIpv6: - $ref: "#/components/schemas/DirectConnectionIpv6" - RoutingProtocolData: - type: object - properties: + format: uuid type: + description: Type of Port 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: + cvpId: + description: Customer virtual port Id + type: integer + bandwidth: + description: Port Bandwidth + type: number + portName: + description: Port Name + type: string + encapsulationProtocolType: + description: Port Encapsulation + type: string + accountName: + description: Account Name + type: string + priority: + description: Port Priority + type: string + location: + $ref: '#/components/schemas/SimplifiedLocation' + LinkProtocolType: + description: Type of Link Protocol 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: + enum: + - UNTAGGED + - DOT1Q + - QINQ + - EVPN_VXLAN + - VXLAN + SimplifiedLinkProtocol: + description: Connection link protocol Configuration 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: + $ref: '#/components/schemas/LinkProtocolType' + vlanTag: + description: vlanTag value specified for DOT1Q connections + type: integer + minimum: 2 + maximum: 4092 + vlanSTag: + description: vlanSTag value specified for QINQ connections + type: integer + minimum: 2 + maximum: 4092 + vlanCTag: + description: vlanCTag value specified for QINQ connections + type: integer + minimum: 2 + maximum: 4092 + SimplifiedAccount: type: object properties: - type: - $ref: "#/components/schemas/BGPActions" - description: BGP action request - BGPActionData: + accountNumber: + description: Account number + type: integer + format: int64 + accountName: + description: Account name + type: string + orgId: + description: Customer organization identifier + type: integer + format: int64 + organizationName: + description: Customer organization name + type: string + globalOrgId: + description: Global organization identifier + type: string + globalOrganizationName: + description: Global organization name + type: string + ucmId: + description: Account ucmId + type: string + globalCustId: + description: Account name + type: string + deprecated: true + resellerAccountNumber: + description: Reseller account number + type: integer + format: int64 + resellerAccountName: + description: Reseller account name + type: string + resellerUcmId: + description: Reseller account ucmId + type: string + resellerOrgId: + description: Reseller customer organization identifier + type: integer + format: int64 + SimplifiedVirtualDevice: 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 + description: url to entity uuid: + description: Network Edge assigned Virtual Device Identifier type: string - description: Routing protocol identifier format: uuid - example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + name: + description: Customer-assigned Virtual Device name + type: string type: - $ref: "#/components/schemas/BGPActions" - description: + description: Type of Virtual Device 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: + enum: + - EDGE + account: + $ref: '#/components/schemas/SimplifiedAccount' + cluster: + description: Virtual Device Cluster Information + type: string + VirtualDeviceInterface: + description: Virtual Device Interface Information type: object properties: - status: + type: + description: Type of interface type: string - description: Current outcome of the change flow enum: - - COMPLETED - - FAILED - - REQUESTED - createdBy: + - NETWORK + id: + description: Network Edge assigned identifier + type: integer + uuid: + description: Interface identifier type: string - description: Created by User Key - createdDateTime: + format: uuid + SimplifiedTokenNetwork: + type: object + properties: + href: type: string - description: Set when change flow starts - format: date-time - updatedBy: + format: uri + description: url to entity + uuid: + description: Network Identifier type: string - description: Updated by User Key - updatedDateTime: + format: uuid + type: + description: Type of Network type: string - description: Set when change object is updated - format: date-time - information: + enum: + - EVPLAN + - EPLAN + - IPWAN + - EVPTREE + - EPTREE + name: + description: Network Name type: string - description: Additional information - data: - $ref: "#/components/schemas/RoutingProtocolChangeOperation" - description: Current state of latest Routing Protocol change - allOf: - - $ref: "#/components/schemas/RoutingProtocolChange" - RoutingProtocolChangeDataResponse: + scope: + description: scope of Network + type: string + enum: + - LOCAL + - REGIONAL + - GLOBAL + location: + $ref: '#/components/schemas/SimplifiedLocation' + AccessPointSelector: + description: List of criteria for selecting network access points with optimal efficiency, security, compatibility, and availability. type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + type: + description: Type of Access point + type: string + enum: + - COLO + - VD + - NETWORK + hideAssetInfo: + deprecated: true + type: boolean + 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' + ServiceTokenSide: + description: Connection link protocol,virtual device or network configuration + type: object + properties: + accessPointSelectors: + description: List of AccessPointSelectors type: array items: - $ref: "#/components/schemas/RoutingProtocolChangeData" - description: List of network changes - ExchangeServiceCreateRequest: - required: - - name - - publicPeeringConnection - - routingProtocol - - type + $ref: '#/components/schemas/AccessPointSelector' + ServiceTokenConnection: + description: Service Token Connection Type Information type: object properties: type: + description: Type of Connection type: string - description: Internet Exchange Service type - example: IX enum: - - IX - name: - maxLength: 50 - minLength: 1 + - EVPL_VC + - EPL_VC + - EVPLAN_VC + - EPLAN_VC + - IPWAN_VC + - IP_VC + - EVPTREE_VC + - EPTREE_VC + href: + description: An absolute URL that is the subject of the link's context. type: string - description: Customer-provided internet exchange service name - example: ix_exchange_service - description: - maxLength: 255 - minLength: 1 + format: uri + readOnly: true + uuid: + description: Equinix-assigned connection identifier type: string - description: Customer-provided internet exchange service description - example: ix_exchange_service - publicPeeringConnection: - $ref: "#/components/schemas/PublicPeeringConnectionRequest" - routingProtocol: - $ref: "#/components/schemas/RoutingProtocolRequest" - order: - $ref: "#/components/schemas/ExchangeServiceOrder" - project: - $ref: "#/components/schemas/Project" - account: - $ref: "#/components/schemas/SimplifiedAccount" - notifications: + format: uuid + allowRemoteConnection: + description: Authorization to connect remotely + type: boolean + default: false + allowCustomBandwidth: + description: Allow custom bandwidth value + type: boolean + default: false + bandwidthLimit: + description: Connection bandwidth limit in Mbps + type: integer + minimum: 0 + maximum: 100000 + supportedBandwidths: + description: List of permitted bandwidths. type: array - description: Preferences for notifications on Internet Exchange Service configuration or status changes items: - $ref: "#/components/schemas/ExchangeServiceNotification" - ExchangeServiceResponse: + type: integer + aSide: + $ref: '#/components/schemas/ServiceTokenSide' + zSide: + $ref: '#/components/schemas/ServiceTokenSide' + ServiceTokenState: + description: Service token state + type: string + enum: + - ACTIVE + - INACTIVE + - EXPIRED + - DELETED + ServiceToken: + 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. type: object properties: + type: + $ref: '#/components/schemas/ServiceTokenType' href: + description: An absolute URL that is the subject of the link's context. type: string - description: Internet Exchange Service URI - example: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 + format: uri + readOnly: true + expiry: + deprecated: true + type: integer uuid: + description: Equinix-assigned service token identifier type: string - description: Internet Exchange Service identifier format: uuid - example: a8ba52de-faae-43b5-b0b1-6904d37ee011 - type: + issuerSide: + deprecated: true + description: information about token side type: string - description: Internet Exchange Service Type - example: IX - default: IX - enum: - - IX name: + description: Customer-provided service token name type: string - description: Name - example: ix_exchange_service - bandwidth: - type: integer - description: bandwidth in Mbps - example: 400000 description: + description: Customer-provided service token description type: string - description: Description - example: ix_exchange_service - state: + expirationDateTime: + description: Expiration date and time of the service token. type: string - description: State - example: PROVISIONING - enum: - - PROVISIONING - - PROVISIONING_FAILED - - PENDING_ACTIVATION - - ACTIVATING - - ACTIVATING_FAILED - - PROVISIONED - - REPROVISIONING - - REPROVISIONING_FAILED - - DEPROVISIONING - - DEPROVISIONED - - DEPROVISIONING_FAILED - location: - $ref: "#/components/schemas/SimplifiedLocation" - publicPeeringConnection: - $ref: "#/components/schemas/PublicPeeringConnectionResponse" - routingProtocol: - $ref: "#/components/schemas/RoutingProtocolResponse" - order: - $ref: "#/components/schemas/ExchangeServiceOrder" - project: - $ref: "#/components/schemas/Project" - account: - $ref: "#/components/schemas/SimplifiedAccount" + format: date-time + example: '2020-11-06T07:00:00Z' + connection: + $ref: '#/components/schemas/ServiceTokenConnection' + state: + $ref: '#/components/schemas/ServiceTokenState' notifications: + description: Service token related notifications type: array - description: Preferences for notifications on Internet Exchange Service configuration or status changes items: - $ref: "#/components/schemas/ExchangeServiceNotification" + $ref: '#/components/schemas/SimplifiedNotification' + account: + description: AM-CRH customers can provide Account number + example: 272010 + $ref: '#/components/schemas/SimplifiedAccount' changelog: - $ref: "#/components/schemas/PlatformChangelog" - additionalInfo: - $ref: "#/components/schemas/ExchangeServiceAdditionalInfo" - ExchangeServiceId: + $ref: '#/components/schemas/Changelog' + project: + description: Project is optional for AM-CRH customers. If not provided, a default project will be assigned. + $ref: '#/components/schemas/Project' + AccessPointType: + description: Access point type type: string - description: Internet Exchange Service UUID - format: uuid - example: a8ba52de-faae-43b5-b0b1-6904d37ee011 - JsonPatch: - type: array - items: - $ref: "#/components/schemas/ExchangeServiceReplaceOperation" - ExchangeServiceReplaceOperation: - required: - - op - - path - - value - type: object - properties: - op: - $ref: "#/components/schemas/ExchangeServiceOpEnum" - path: - $ref: "#/components/schemas/ExchangeServicePath" - value: - description: value to replace with - description: Replace attribute value or sub-resource in the existing model - ExchangeServiceOpEnum: + enum: + - VD + - VG + - SP + - IGW + - COLO + - SUBNET + - CLOUD_ROUTER + - NETWORK + - METAL_NETWORK + - VPIC_INTERFACE + - APP_LINK + - IC + PortType: + description: Type of Port type: string - description: the operation to be performed enum: - - replace - - add - ExchangeServicePath: + - XF_PORT + PortState: + description: Port lifecycle state type: string - description: | - ### A JSON Pointer path. - * `/name` - Name of the Internet Exchange Service - * `/description` - Description of the Internet Exchange Service - * `routingProtocol/macAddress` - MAC Address - * `routingProtocol/bgpIpv4/domainName` - Domain Name for BGP IPv4 - * `routingProtocol/bgpIpv4/asSet` - AS Set for BGP IPv4 - * `routingProtocol/bgpIpv4/md5AuthKey` - MD5 Auth Key for BGP IPv4 - * `routingProtocol/bgpIpv4/rcMd5AuthKey` - RC MD5 Auth Key for BGP IPv4 - * `routingProtocol/bgpIpv4/ipPrefixes` - IP Prefixes for BGP IPv4 - * `routingProtocol/bgpIpv6/mlpeEnabled` - MLPE Enabled for BGP IPv4 - * `routingProtocol/bgpIpv6/domainName`- Domain Name for BGP IPv6 - * `routingProtocol/bgpIpv6/asSet`- AS Set for BGP IPv6 - * `routingProtocol/bgpIpv6/md5AuthKey` - MD5 Auth Key for BGP IPv6 - * `routingProtocol/bgpIpv6/rcMd5AuthKey` - RC MD5 Auth Key for BGP IPv6 - * `routingProtocol/bgpIpv6/ipPrefixes` - IP Prefixes for BGP IPv6 - * `routingProtocol/bgpIpv6/mlpeEnabled` - MLPE Enabled for BGP IPv6 - ExchangeServiceSearchRequest: + enum: + - PENDING + - PROVISIONING + - REPROVISIONING + - PENDING_CROSS_CONNECT + - PROVISIONED + - ACTIVE + - DEPROVISIONING + - DEPROVISIONED + - INACTIVE + - FAILED + - ADDED + - DELETED + - TO_BE_ADDED + - TO_BE_DELETED + maintenanceState: + description: Maintenance lifecycle state + type: string + enum: + - SCHEDULED + - IN_PROGRESS + - COMPLETED + - CANCELLED + - POSTPONED + example: SCHEDULED + PortOperation: + description: Operational specifications for ports. type: object properties: - filter: - $ref: "#/components/schemas/ExchangeServiceSearchExpression" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/ExchangeServiceSearchSortCriteria" - description: Search requests containing criteria - ExchangeServiceSearchExpression: - oneOf: - - $ref: "#/components/schemas/ExchangeServiceAndExpression" - - $ref: "#/components/schemas/ExchangeServiceOrExpression" - - $ref: "#/components/schemas/ExchangeServicePropertyExpression" - ExchangeServiceAndExpression: - required: - - and + operationalStatus: + description: Availability of a given physical port. + type: string + enum: + - UP + - DOWN + - PARTIAL + connectionCount: + description: Total number of connections. + type: integer + format: int64 + evplVCCount: + description: Total number of connections. + type: integer + format: int64 + fgVCCount: + description: Total number of connections. + type: integer + format: int64 + accessVCCount: + description: Total number of connections. + type: integer + format: int64 + opStatusChangedAt: + description: Date and time at which port availability changed. + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + maintenanceStatus: + allOf: + - $ref: '#/components/schemas/maintenanceState' + lockEnabled: + description: Indicates whether the port configuration is locked due to an ongoing or scheduled maintenance. + type: boolean + example: true + PortServiceCode: + description: Identifies the service type associated with this port + type: string + enum: + - CX + - IX + - IA + - MC + PortDeviceRedundancy: + description: Device redundancy type: object properties: - and: - type: array - items: - $ref: "#/components/schemas/ExchangeServiceSearchExpression" - ExchangeServiceOrExpression: - required: - - or + group: + description: Device redundancy group + type: string + priority: + description: Device redundancy priority + type: string + enum: + - PRIMARY + - SECONDARY + PortDevice: + description: Port device type: object properties: - or: - type: array - items: - $ref: "#/components/schemas/ExchangeServiceSearchExpression" - ExchangeServicePropertyExpression: - required: - - operator - - property - - values + name: + description: Device name + type: string + deprecated: true + redundancy: + deprecated: true + $ref: '#/components/schemas/PortDeviceRedundancy' + vcBandwidthMax: + description: Maximum bandwidth allowed for connection. + type: integer + format: int64 + PortInterface: + description: Port interface type: object properties: - property: - type: string - description: Possible field names to use on filters - enum: - - /project/projectId - - /uuid - - /state - - /name - - /bandwidth - - /changelog/createdDateTime - - /changelog/updatedDateTime - - /changelog/deletedDateTime - - /location/metroCode - operator: + type: + description: Port interface type type: string - enum: - - = - - "!=" - - BETWEEN - - < - - <= - - ">" - - ">=" - - LIKE - - ILIKE - - IN - values: - minItems: 1 - type: array - items: - type: string - ExchangeServiceSearchSortCriteria: + PortTether: + description: Port physical connection type: object properties: - direction: + crossConnectId: + description: Port cross connect identifier type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - property: + cabinetNumber: + description: Port cabinet number type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime - enum: - - /name - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - ExchangeServiceSearchResponse: + systemName: + description: Port system name + type: string + patchPanel: + description: Port patch panel + type: string + patchPanelPortA: + description: Port patch panel port A + type: string + patchPanelPortB: + description: Port patch panel port B + type: string + ibx: + description: z-side/Equinix IBX + type: string + PortDemarcationPoint: + description: Customer physical Port type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - sort: - type: array - items: - $ref: "#/components/schemas/ExchangeServiceSearchSortCriteria" - data: - type: array - items: - $ref: "#/components/schemas/ExchangeServiceResponse" - description: List of Internet Exchange Service - ExchangeServiceActionRequest: - required: - - type + cabinetUniqueSpaceId: + description: Port cabinet unique space id + type: string + cageUniqueSpaceId: + description: Port cage unique space id + type: string + patchPanel: + description: Port patch panel + type: string + patchPanelName: + deprecated: true + description: Port patch panel + type: string + patchPanelPortA: + description: Port patch panel port A + type: string + patchPanelPortB: + description: Port patch panel port B + type: string + connectorType: + description: Port connector type + type: string + ibx: + description: Port ibx identifier + type: string + PortPriority: + description: Port priority in redundancy group + type: string + enum: + - PRIMARY + - SECONDARY + PortRedundancy: + description: Port redundancy configuration type: object properties: - type: + enabled: + description: Access point redundancy + type: boolean + group: + deprecated: true + description: Port UUID of respective primary port type: string - enum: - - EXCHANGE_SERVICE_ACTIVATE - - EXCHANGE_SERVICE_VALIDATE - - EXCHANGE_SERVICE_RETRY_PROVISION - description: Internet Exchange Service Action Request - ExchangeServiceActionResponse: - allOf: - - $ref: "#/components/schemas/ExchangeServiceActionRequest" - - type: object - properties: - href: - type: string - description: Internet Exchange Service Action URI - example: https://api.equinix.com/fabric/v4/exchangeService/e8ba52fe-faae-43b5-b0b1-6904d37ee011/actions/a8ba52de-faae-43b5-b0b1-6904d37ee011 - uuid: - type: string - description: Action identifier - format: uuid - example: a8ba52de-faae-43b5-b0b1-6904d37ee011 - description: - maxLength: 255 - minLength: 0 - type: string - description: Action description - example: Action description text - state: - type: string - description: State - example: PENDING - enum: - - PENDING - - SUCCEEDED - - FAILED - changelog: - $ref: "#/components/schemas/PlatformChangelog" - InternetAccessPostRequest: - required: - - account - - billing - - name - - project - - routingProtocol - - type + priority: + $ref: '#/components/schemas/PortPriority' + PortEncapsulation: + description: Port encapsulation configuration type: object properties: type: - $ref: "#/components/schemas/InternetAccessServiceType" - name: + description: Port encapsulation protocol type type: string - description: The name of the EIA Service - bandwidth: - type: integer - description: Bandwidth of the service - bandwidthCommit: - type: integer - description: Minimum bandwidth commit for burst billing variant of the service - routingProtocol: - $ref: "#/components/schemas/InternetAccessRoutingProtocolRequest" - order: - $ref: "#/components/schemas/InternetAccessOrderRequest" - billing: - $ref: "#/components/schemas/InternetAccessPostRequest_billing" - project: - $ref: "#/components/schemas/Project" - account: - $ref: "#/components/schemas/InternetAccessAccount" - InternetAccessRoutingProtocolRequest: - required: - - customerRoutes - - type + enum: + - DOT1Q + - QINQ + - UNTAGGED + tagProtocolId: + description: Port encapsulation tag protocol identifier + type: string + Package: + description: Package settings for port type: object properties: - type: - $ref: "#/components/schemas/InternetAccessRoutingProtocolType" - customerRoutes: - maxItems: 100 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/InternetAccessCustomerRouteRequest" - discriminator: - propertyName: type - mapping: - BGP: "#/components/schemas/InternetAccessRoutingProtocolBgpRequest" - DIRECT: "#/components/schemas/InternetAccessRoutingProtocolDirectRequest" - STATIC: "#/components/schemas/InternetAccessRoutingProtocolStaticRequest" - InternetAccessCustomerRouteRequest: - required: - - ipBlock + code: + type: string + description: Type of Port Package + enum: + - STANDARD + - UNLIMITED + - UNLIMITED_PLUS + PortSettings: + description: Port configuration settings type: object properties: - ipBlock: - $ref: "#/components/schemas/InternetAccessIpBlockRequest" - InternetAccessIpBlockRequest: - required: - - uuid - type: object + buyout: + deprecated: true + type: boolean + viewPortPermission: + deprecated: true + type: boolean + placeVcOrderPermission: + deprecated: true + type: boolean + layer3Enabled: + deprecated: true + type: boolean + packageType: + description: Type of Port Package + deprecated: true + type: string + enum: + - STANDARD + - UNLIMITED + - UNLIMITED_PLUS + PortAdditionalInfo: + description: Additional information properties: - uuid: + key: + description: Key type: string - description: Unique identifier for the IP Block - format: uuid - InternetAccessRoutingProtocolBgpRequest: - allOf: - - $ref: "#/components/schemas/InternetAccessRoutingProtocolRequest" - - required: - - connections - - exportPolicy - type: object - properties: - connections: - maxItems: 2 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/InternetAccessConnectionBgpRequest" - exportPolicy: - $ref: "#/components/schemas/InternetAccessExportPolicy" - asn: - $ref: "#/components/schemas/InternetAccessRoutingProtocolBgpRequest_asn" - customerAsn: - type: integer - description: Customer ASN. Valid range is 1-64495 or 65536-4199999999. - format: int64 - example: 16220 - deprecated: true - bgpAuthKey: - type: string - description: BGP authentication key - example: SecretKey - customerAsnRange: - $ref: "#/components/schemas/InternetAccessCustomerAsnRange" - InternetAccessConnectionBgpRequest: - required: - - uuid + value: + description: Value + type: string + PhysicalPortType: + description: Type of Port + type: string + enum: + - XF_PHYSICAL_PORT + PortNotification: type: object properties: - uuid: + type: + description: Notification Type type: string - description: Unique identifier for the connection - format: uuid - InternetAccessRoutingProtocolDirectRequest: - allOf: - - $ref: "#/components/schemas/InternetAccessRoutingProtocolRequest" - - required: - - connections - type: object - properties: - connections: - maxItems: 2 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/InternetAccessConnectionDirectRequest" - InternetAccessConnectionDirectRequest: + enum: + - NOTIFICATION + - TECHNICAL + - PEERING + - ESCALATION + registeredUsers: + description: Array of registered users + type: array + items: + type: string required: - - uuid + - type + - registeredUsers + PortOrderPurchaseOrder: + description: Purchase Order information associate to the account type: object properties: - uuid: + number: + type: string + description: purchase order number + amount: + type: string + description: purchase order amount + startDate: + type: string + endDate: + type: string + attachmentId: type: string - description: Unique identifier for the connection format: uuid - peeringIpv4: - $ref: "#/components/schemas/InternetAccessPeeringIpv4Request" - peeringIpv6: - $ref: "#/components/schemas/InternetAccessPeeringIpv6Request" - InternetAccessPeeringIpv4Request: + selectionType: + type: string + deprecated: true + enum: + - EXEMPTION + - EXISTING + - NEW + - BLANKET + type: + type: string + enum: + - EXEMPTION + - EXISTING + - NEW + - BLANKET + PortOrderSignatureDelegate: + description: order delegate details type: object properties: - equinixPeerIp: - pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + firstName: + description: first name of delegate type: string - description: IPv4 address of the Equinix peering IP - equinixVrrpIp: - pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + lastName: + description: last Name of delegate type: string - description: IPv4 address for Equinix VRRP IP - InternetAccessPeeringIpv6Request: + email: + description: email of delegate + type: string + PortOrderSignature: + description: Port signature details type: object properties: - equinixPeerIp: - pattern: ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$ - type: string - description: IPv6 address of the Equinix peering IP - equinixVrrpIp: - pattern: ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$ + signatory: + description: Port signature Type type: string - description: IPv6 address for Equinix VRRP IP - InternetAccessRoutingProtocolStaticRequest: - allOf: - - $ref: "#/components/schemas/InternetAccessRoutingProtocolRequest" - - required: - - connections - type: object - properties: - connections: - maxItems: 2 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/InternetAccessConnectionStaticRequest" - InternetAccessConnectionStaticRequest: - required: - - uuid + enum: + - DELEGATE + - SELF + - ACCOUNT_SUPPORT + delegate: + $ref: '#/components/schemas/PortOrderSignatureDelegate' + PortOrder: type: object + properties: + purchaseOrder: + $ref: '#/components/schemas/PortOrderPurchaseOrder' + customerReferenceId: + description: Customer order reference Id + type: string + signature: + $ref: '#/components/schemas/PortOrderSignature' + PortLoa: + description: Port Loas properties: uuid: + description: uuid type: string - description: Unique identifier for the connection - format: uuid - InternetAccessOrderRequest: + type: + description: Loa type + type: string + example: DIGITAL_LOA + PhysicalPort: + description: Physical Port specification type: object properties: - purchaseOrderNumber: + href: + description: Equinix assigned response attribute for an absolute URL that is the subject of the link's context. type: string - description: Purchase order number - nullable: true - orderNumber: + format: uri + readOnly: true + type: + $ref: '#/components/schemas/PhysicalPortType' + id: + deprecated: true + description: Equinix assigned response attribute for Physical Port Id + type: integer + state: + $ref: '#/components/schemas/PortState' + account: + $ref: '#/components/schemas/SimplifiedAccount' + interfaceSpeed: + description: Physical Port Speed in Mbps + type: integer + minimum: 0 + interfaceType: + description: Physical Port Interface Type type: string - description: Order Number - nullable: true - orderLine: + uuid: + description: Equinix assigned response attribute for physical port identifier type: string - description: Order Line Number - nullable: true - InternetAccessService: - required: - - account - - billing - - change - - changeLog - - href - - name - - order - - project - - routingProtocol - - state - - type - - useCase - - uuid + format: uuid + tether: + $ref: '#/components/schemas/PortTether' + demarcationPoint: + $ref: '#/components/schemas/PortDemarcationPoint' + notifications: + description: Notification preferences + type: array + items: + $ref: '#/components/schemas/PortNotification' + additionalInfo: + description: Physical Port additional information + type: array + items: + $ref: '#/components/schemas/PortAdditionalInfo' + order: + $ref: '#/components/schemas/PortOrder' + operation: + $ref: '#/components/schemas/PortOperation' + loas: + description: Port Loas + type: array + items: + $ref: '#/components/schemas/PortLoa' + SimplifiedPort: + description: Port specification type: object properties: href: + description: Equinix assigned response attribute for an absolute URL that is the subject of the link's context. type: string - description: Service URL path format: uri - example: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 + readOnly: true type: - $ref: "#/components/schemas/InternetAccessServiceType" + $ref: '#/components/schemas/PortType' + id: + description: Equinix assigned response attribute for Port Id + type: integer uuid: + description: Equinix assigned response attribute for port identifier type: string - description: Unique identifier for the EIA Service format: uuid name: + description: Equinix assigned response attribute for Port name type: string - description: The name of the EIA Service - bandwidth: + description: + description: Equinix assigned response attribute for Port description + type: string + physicalPortsSpeed: + description: Physical Ports Speed in Mbps type: integer - description: Bandwidth of the service - bandwidthCommit: + minimum: 0 + connectionsCount: + description: Equinix assigned response attribute for Connection count type: integer - description: Minimum bandwidth commit for burst billing variant of the service + minimum: 0 + project: + $ref: '#/components/schemas/Project' state: - $ref: "#/components/schemas/InternetAccessServiceState" - change: - $ref: "#/components/schemas/InternetAccessChange" - locations: + $ref: '#/components/schemas/PortState' + operation: + $ref: '#/components/schemas/PortOperation' + account: + $ref: '#/components/schemas/SimplifiedAccount' + serviceType: + description: Port service Type + deprecated: true + type: string + enum: + - EPL + - MSP + serviceCode: + $ref: '#/components/schemas/PortServiceCode' + bandwidth: + description: Equinix assigned response attribute for Port bandwidth in Mbps + type: integer + format: int64 + minimum: 0 + availableBandwidth: + description: Equinix assigned response attribute for Port available bandwidth in Mbps + type: integer + format: int64 + minimum: 0 + usedBandwidth: + description: Equinix assigned response attribute for Port used bandwidth in Mbps + type: integer + format: int64 + minimum: 0 + 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: + description: If LAG enabled + type: boolean + package: + $ref: '#/components/schemas/Package' + settings: + $ref: '#/components/schemas/PortSettings' + physicalPortQuantity: + description: Number of physical ports + type: integer + additionalInfo: + description: Port additional information type: array - description: List of locations associated with the service items: - $ref: "#/components/schemas/InternetAccessLocation" - routingProtocol: - $ref: "#/components/schemas/InternetAccessRoutingProtocol" - billing: - $ref: "#/components/schemas/InternetAccessBilling" - account: - $ref: "#/components/schemas/InternetAccessAccount" - project: - $ref: "#/components/schemas/Project" - order: - $ref: "#/components/schemas/InternetAccessOrder" - changeLog: - $ref: "#/components/schemas/Changelog" - useCase: - $ref: "#/components/schemas/InternetAccessUseCase" - InternetAccessServiceType: + $ref: '#/components/schemas/PortAdditionalInfo' + physicalPorts: + type: array + description: Physical ports that implement this port + items: + $ref: '#/components/schemas/PhysicalPort' + ServiceProfileTypeEnum: + description: Service profile type type: string - description: Type of the service, either single or dual internet access + x-eqx-api-linter-skip-rules: + - 40 enum: - - SINGLE_IA - - DUAL_IA - x-enum-varnames: - - SINGLE_IA - - DUAL_IA - InternetAccessServiceState: + - L2_PROFILE + - L3_PROFILE + - IA_PROFILE + - IX_PROFILE + - IC_PROFILE + - LMAAS_PROFILE + example: L2_PROFILE + Tags: + type: array + items: + type: string + ServiceProfileVisibilityEnum: type: string - description: Current state of the service enum: - - PROVISIONING - - PROVISIONED - - FAILED - - DEPROVISIONING - - DEPROVISIONED - x-enum-varnames: - - PROVISIONING - - PROVISIONED - - FAILED - - DEPROVISIONING - - DEPROVISIONED - InternetAccessSearchRequest: - type: object - properties: - pagination: - $ref: "#/components/schemas/PaginationRequest" - filter: - $ref: "#/components/schemas/SearchExpression" - sort: - $ref: "#/components/schemas/SearchSort" - InternetAccessServices: - required: - - data - - pagination - - sort + - PRIVATE + - PUBLIC + ServiceProfileAccessPointTypeEnum: + description: Access point type + type: string + enum: + - VD + - COLO + Bandwidth: + type: integer + example: 50 + description: speed in Mbps + Bandwidths: + type: array + items: + $ref: '#/components/schemas/Bandwidth' + ServiceProfileLinkProtocolConfig: type: object + description: Configuration for dot1q to qinq translation support properties: - pagination: - $ref: "#/components/schemas/Pagination" - sort: - $ref: "#/components/schemas/SearchSort" - data: + encapsulationStrategy: + description: was tagType - missing on wiki + type: string + enum: + - CTAGED + - BOTH + - NAMED + namedTags: type: array + maxItems: 64 items: - $ref: "#/components/schemas/InternetAccessService" - InternetAccessPatchRequest: - maxItems: 100 - minItems: 1 - type: array - description: Only one replace operation allowed for '/bandwidth' path. - items: - $ref: "#/components/schemas/InternetAccessPatchOperationUpdate" - InternetAccessPatchOperationUpdate: - required: - - op - - path + type: string + vlanCTagLabel: + description: was ctagLabel + type: string + reuseVlanSTag: + type: boolean + example: true + default: false + encapsulation: + description: Port encapsulation - Derived response attribute. Ignored on request payloads. + type: string + enum: + - QINQ + - DOT1Q + - UNTAGGED + ApiConfig: type: object + description: Configuration for API based Integration for Service Profile properties: - op: - $ref: "#/components/schemas/InternetAccessPatchOperationUpdateAllowedOp" - path: - $ref: "#/components/schemas/InternetAccessPatchOperationUpdateAllowedPath" - value: - description: New value for updated parameter. Required for add and replace. - InternetAccessPatchOperationUpdateAllowedOp: - type: string - description: Allowed patch operations. - enum: - - replace - - add - - remove - InternetAccessPatchOperationUpdateAllowedPath: - pattern: ^(\/name|\/bandwidth|\/bandwidthCommit|\/routingProtocol\/customerRoutes(?:\[@\.ipBlock\.uuid=[A-Fa-f0-9-]+\])?|\/order\/purchaseOrderNumber)$ - type: string - description: Allowed patch paths for Internet Access update. - example: /bandwidth - SubmitIpBlockRequestBody: + apiAvailable: + description: Setting indicating whether the API is available (true) or not (false). + type: boolean + example: true + default: false + integrationId: + type: string + equinixManagedPort: + description: Setting indicating that the port is managed by Equinix (true) or not (false). + type: boolean + example: true + default: false + equinixManagedVlan: + description: Setting indicating that the VLAN is managed by Equinix (true) or not (false). + type: boolean + example: true + default: false + allowOverSubscription: + 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. + type: boolean + example: false + default: false + overSubscriptionLimit: + description: A cap on oversubscription. + type: integer + example: 1 + minimum: 1 + maximum: 20 + default: 1 + bandwidthFromApi: + type: boolean + default: false + AuthenticationKey: + description: Authentication Key Support and Customization + 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 + ServiceProfileMetadata: + type: object + description: Metadata. Response attribute. Ignored on request payload. + 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 + ServiceProfileAccessPointTypeCOLO: + description: Colo Access Point Type required: - - project - type type: object properties: - location: - $ref: "#/components/schemas/IpBlockLocation" + uuid: + type: string type: - $ref: "#/components/schemas/TypeOfIpBlockProduct" - project: - $ref: "#/components/schemas/IpBlockProjectRequest" - account: - $ref: "#/components/schemas/IpBlockAccount" - order: - $ref: "#/components/schemas/IpBlockOrderRequest" - regulations: - $ref: "#/components/schemas/IpBlockRegulations" - prefixLength: - $ref: "#/components/schemas/IpBlockPrefixLength" - prefix: - $ref: "#/components/schemas/IpBlockPrefix" - IpBlock: + $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: + description: for verizon only. + type: boolean + connectionRedundancyRequired: + type: boolean + example: true + description: Mandate redundant connections + default: false + selectiveRedundancy: + type: boolean + example: true + description: Optional redundant connections + 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' + ServiceProfileAccessPointTypeVD: + description: VirtualDevice Access Point Type required: - - changeLog - - href - - ownership - - prefixLength - - project - - state - type - - uuid type: object + additionalProperties: false properties: uuid: type: string - description: Unique identifier for the IP Block - format: uuid - href: - type: string - description: Resource URL path for the IP Block - example: /fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb type: - $ref: "#/components/schemas/TypeOfIpBlockProduct" - state: - $ref: "#/components/schemas/IpBlockState" - ownership: - $ref: "#/components/schemas/IpBlockOwnership" - location: - $ref: "#/components/schemas/IpBlockLocation" - prefixLength: - $ref: "#/components/schemas/IpBlockPrefixLength" - prefix: - $ref: "#/components/schemas/IpBlockPrefix" - order: - $ref: "#/components/schemas/IpBlockOrderResponse" - account: - $ref: "#/components/schemas/IpBlockAccount" - project: - $ref: "#/components/schemas/IpBlockProject" - regulations: - $ref: "#/components/schemas/IpBlockRegulations" - assets: - type: array - description: Products using this IP Block - items: - $ref: "#/components/schemas/IpBlockAsset" - change: - $ref: "#/components/schemas/IpBlockChange" - changeLog: - $ref: "#/components/schemas/IpBlockChangeLog" - error: - $ref: "#/components/schemas/Error" - PatchIpBlockRequestBody: - maxItems: 1 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/PatchIpBlockRequestBodyItem" - IpBlocksSearchRequestBody: - properties: - pagination: - $ref: "#/components/schemas/PaginationRequest" - filter: - $ref: "#/components/schemas/IpBlockFilter" - sort: - $ref: "#/components/schemas/SearchSort" - IpBlockFilter: + $ref: '#/components/schemas/ServiceProfileAccessPointTypeEnum' + supportedBandwidths: + $ref: '#/components/schemas/Bandwidths' + allowRemoteConnections: + type: boolean + example: true + description: Allow remote connections to Service Profile + allowCustomBandwidth: + type: boolean + example: true + ServiceProfileAccessPointType: + description: Access Point Type type: object - properties: - and: - type: array - items: - $ref: "#/components/schemas/IpBlockAndQuery" - IpBlockAndQuery: + oneOf: + - $ref: '#/components/schemas/ServiceProfileAccessPointTypeCOLO' + - $ref: '#/components/schemas/ServiceProfileAccessPointTypeVD' + CustomField: + description: Define Custom Attributes required: - - operator - - property - - values - type: object + - label + - required + - dataType properties: - property: + label: type: string - operator: + example: Account Number + description: + type: string + example: Provide a valid account number + required: + type: boolean + example: true + dataType: type: string enum: - - = - values: + - STRING + - LIST + - NUMBER + options: type: array items: type: string - IpBlockSearchResponseBody: - required: - - data - - pagination + captureInEmail: + type: boolean + description: capture this field as a part of email notification + ProcessStep: + type: object + description: Definition of customized step while making connection properties: - pagination: - $ref: "#/components/schemas/Pagination" - sort: - $ref: "#/components/schemas/SearchSort" - data: - type: array - items: - $ref: "#/components/schemas/IpBlock" - SearchRequest: + 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 + MarketingInfo: type: object properties: - filter: - $ref: "#/components/schemas/Expression" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + logo: + type: string + description: Logo file name + promotion: + type: boolean + description: Profile promotion on marketplace + processSteps: type: array + maxItems: 3 items: - $ref: "#/components/schemas/SortCriteria" - description: Search requests containing criteria - Expression: + $ref: '#/components/schemas/ProcessStep' + ServiceProfileAccessPointCOLO: + description: Colo Access Point + type: object + required: + - type + - uuid + properties: + type: + type: string + enum: + - XF_PORT + - IX_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 + ServiceProfileAccessPointVD: + description: Virtual Device Point + required: + - type + - uuid type: object properties: - and: - $ref: "#/components/schemas/Expressions" - or: - $ref: "#/components/schemas/Expressions" - property: - $ref: "#/components/schemas/SearchFieldName" - operator: + type: type: string enum: - - = - - "!=" - - ">" - - ">=" - - < - - <= - - LIKE - - ILKE - - IS NOT NULL - - IS NULL - - IN - - BETWEEN - values: + - 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 + 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 - Expressions: - type: array - items: - $ref: "#/components/schemas/Expression" - SearchFieldName: + description: ibx codes + inTrail: + type: boolean + displayName: + type: string + description: service metro display name + sellerRegions: + type: object + additionalProperties: + type: string + ProviderEnvironmentTypeEnum: + description: Provider environment type 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/interconnect/uuid - - /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 - - /bandwidth - - /change/status - - /changeLog/createdBy - - /changeLog/createdDateTime - - /changeLog/deletedBy - - /changeLog/deletedDateTime - - /changeLog/lastUpdatedBy - - /operation/equinixStatus - - /operation/providerStatus - - /operation/maintenanceStatus - - /operation/lockEnabled - - /project/projectId - - /redundancy/group - - /redundancy/priority - - /redundancy/name - - /redundancy/description - - /zSide/accessPoint/account/accountName - - /zSide/accessPoint/authenticationKey - - /zSide/accessPoint/linkProtocol/vlanTagMin - - /zSide/accessPoint/linkProtocol/vlanTagMax - - /zSide/accessPoint/location/metroCode - - /zSide/accessPoint/location/metroName - - /zSide/accessPoint/sellerRegion - - /zSide/accessPoint/name - - /zSide/accessPoint/port/uuid - - /zSide/accessPoint/network/uuid - - /zSide/accessPoint/port/name - - /zSide/accessPoint/profile/uuid - - /zSide/accessPoint/type - - /zSide/accessPoint/role - - /zSide/accessPoint/virtualDevice/name - - /zSide/accessPoint/virtualDevice/uuid - - /zSide/serviceToken/uuid - - /zSide/internetAccess/uuid - - /state - 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: + - IC_ENV + ProviderEnvironment: + description: Provider Environment associated with an IC_PROFILE service profile Beta type: object properties: - and: - $ref: "#/components/schemas/SearchExpressions" - or: - $ref: "#/components/schemas/SearchExpressions" - property: + href: + description: Provider Environment URI type: string - operator: + format: uri + readOnly: true + uuid: + description: Equinix-assigned provider environment identifier type: string - enum: - - = - - "!=" - - ">" - - ">=" - - < - - <= - - BETWEEN - - NOT BETWEEN - - LIKE - - NOT LIKE - - IN - - NOT IN - - IS NOT NULL - - IS NULL - values: + format: uuid + type: + $ref: '#/components/schemas/ProviderEnvironmentTypeEnum' + name: + description: Provider environment name + type: string + example: US West 1 – Production + description: + description: Provider environment description + type: string + example: Primary production environment + sellerRegion: + description: Cloud provider region identifier + type: string + example: us-west-1 + supportedBandwidths: type: array + description: Supported bandwidths in Mbps items: - type: string - SearchExpressions: - type: array - items: - $ref: "#/components/schemas/SearchExpression" - PriceSearchResponse: - type: object - properties: - data: + type: integer + example: + - 1000 + - 10000 + - 100000 + metros: type: array + description: Derived response attribute. 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: + $ref: '#/components/schemas/ServiceMetro' + supportedFeatures: type: array + description: Supported Feature Types items: - $ref: "#/components/schemas/PriceError_additionalInfo" - description: Error with details - discriminator: - propertyName: errorCode - Statistics: + type: string + example: + - FEATURE_TYPE_L3_BASE + changeLog: + $ref: '#/components/schemas/Changelog' + ServiceProfileLastMileApiIntegration: type: object + description: Last-mile API integration details. 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: + siteValidationEnabled: + type: boolean + description: Whether site validation is enabled for the last-mile provider. + dataCenterLocationEnabled: + type: boolean + description: Whether data center location is enabled for the last-mile provider. + productOfferingEnabled: + type: boolean + description: Whether product offering is enabled for the last-mile provider. + poqEnabled: + type: boolean + description: Whether product qualification is enabled for the last-mile provider. + quoteEnabled: + type: boolean + description: Whether quote generation is enabled for the last-mile provider. + placeOrderEnabled: + type: boolean + description: Whether place order is enabled for the last-mile provider. + quoteViaAggregatorEnabled: + type: boolean + description: Whether quote via aggregator is enabled for the last-mile provider. + ServiceProfileLastMileDeliveryDateRange: type: object + description: Range details for delivery window. 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: + description: Unit for this range is DAYS. + example: USD + min: + type: integer + description: Minimum value for the range. + example: 1 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: integer + description: Maximum value for the range. + example: 10 + ServiceProfileLastMilePriceRange: type: object + description: Range details for price or delivery window. properties: - intervalEndTimestamp: + unit: type: string - description: Interval end timestamp - format: date-time - example: 2020-11-06T07:00:00Z - max: + description: Unit for this range, such as USD or DAYS. + example: USD + min: type: number - description: Max bandwidth within statistics object time interval, represented in units specified by response "units" field - format: float - mean: + format: double + description: Minimum value for the range. + example: 10 + max: 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: + format: double + description: Maximum value for the range. + example: 100 + ServiceProfileLastMileOffering: type: object + description: Last-mile offering details. properties: - data: + bandwidth: + type: integer + description: Offered bandwidth in Mbps. + example: 10 + price: + $ref: '#/components/schemas/ServiceProfileLastMilePriceRange' + ServiceProfileLastMileProductCatalog: + type: object + description: Last-mile provider catalog details. + properties: + name: + type: string + description: Last-mile provider or catalog name. + example: att fiber + id: + type: string + description: Last-mile provider or catalog identifier. + example: fc1eb018-df0a-4ee8-8dd1-e6b8ad61178d + webUrl: + type: string + description: Last-mile catalog or provider website URL. + example: att.com/lastmile + deliveryDate: + $ref: '#/components/schemas/ServiceProfileLastMileDeliveryDateRange' + billingTerms: type: array + nullable: true + description: Available billing terms in months. items: - $ref: "#/components/schemas/ServiceProfile" - pagination: - $ref: "#/components/schemas/Pagination" - description: Service Profiles - ServiceProfileRequest: - required: - - description - - name - - type + type: integer + enum: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + example: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + offerings: + type: array + description: Available last-mile offerings. + items: + $ref: '#/components/schemas/ServiceProfileLastMileOffering' + ServiceProfileLastMileConfig: type: object + description: Last-mile configuration for the service profile. properties: - project: - $ref: "#/components/schemas/Project" + apiIntegration: + type: object + description: Last-mile API integration details. + $ref: '#/components/schemas/ServiceProfileLastMileApiIntegration' + productCatalogs: + type: array + description: Last-mile provider catalogs. + items: + $ref: '#/components/schemas/ServiceProfileLastMileProductCatalog' + SimplifiedServiceProfile: 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 + type: string format: uri readOnly: true type: - $ref: "#/components/schemas/ServiceProfileTypeEnum" + $ref: '#/components/schemas/ServiceProfileTypeEnum' name: - maxLength: 50 - type: string description: Customer-assigned service profile name + type: string + maxLength: 50 example: Sample Service Profile uuid: - type: string description: Equinix-assigned service profile identifier + type: string format: uuid description: - type: string description: User-provided service description should be of maximum length 375 + type: string example: offering connectivity to my-network notifications: type: array description: Recipients of notifications on service profile change items: - $ref: "#/components/schemas/SimplifiedNotification" + $ref: '#/components/schemas/SimplifiedNotification' tags: - $ref: "#/components/schemas/Tags" + $ref: '#/components/schemas/Tags' visibility: - $ref: "#/components/schemas/ServiceProfileVisibilityEnum" + $ref: '#/components/schemas/ServiceProfileVisibilityEnum' allowedEmails: type: array items: type: string format: email accessPointTypeConfigs: - minItems: 1 type: array + minItems: 1 items: - $ref: "#/components/schemas/ServiceProfileAccessPointType" + $ref: '#/components/schemas/ServiceProfileAccessPointType' customFields: type: array items: - $ref: "#/components/schemas/CustomField" + $ref: '#/components/schemas/CustomField' marketingInfo: - $ref: "#/components/schemas/MarketingInfo" + $ref: '#/components/schemas/MarketingInfo' ports: type: array items: - $ref: "#/components/schemas/ServiceProfileAccessPointCOLO" + $ref: '#/components/schemas/ServiceProfileAccessPointCOLO' virtualDevices: type: array items: - $ref: "#/components/schemas/ServiceProfileAccessPointVD" + $ref: '#/components/schemas/ServiceProfileAccessPointVD' metros: type: array description: Derived response attribute. items: - $ref: "#/components/schemas/ServiceMetro" + $ref: '#/components/schemas/ServiceMetro' environments: type: array description: Provider environments associated with this IC_PROFILE service profile. Beta items: - $ref: "#/components/schemas/ProviderEnvironment" + $ref: '#/components/schemas/ProviderEnvironment' selfProfile: type: boolean - description: response attribute indicates whether the profile belongs to the same organization as the api-invoker. readOnly: true + description: response attribute indicates whether the profile belongs to the same organization as the api-invoker. projectId: type: string lastMileConfig: - $ref: "#/components/schemas/ServiceProfileLastMileConfig" - 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 + description: Last-mile provider catalogs and offerings available for this service profile. + $ref: '#/components/schemas/ServiceProfileLastMileConfig' + example: + - apiIntegration: + siteValidationEnabled: true + dataCenterLocationEnabled: false + productOfferingEnabled: false + poqEnabled: true + quoteEnabled: true + placeOrderEnabled: false + quoteViaAggregatorEnabled: false + contactInfo: + - type: SUPPORT_URL + url: http://www.example.com/lastmile/home + - type: DOCUMENTATION_URL + url: http://www.example.com/lastmile/home + - type: SUPPORT_EMAIL + emails: + - support@example.com + productCatalogs: + - name: att fiber + webUrl: att.com/lastmile + deliveryDate: + unit: DAYS + min: 1 + max: 10 + billingTerms: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + offerings: + - bandwidth: 10 + price: + unit: USD + min: 10 + max: 100 + - bandwidth: 50 + price: + unit: USD + min: 50 + max: 500 + - name: att fiber gold + webUrl: att.com/wireless + deliveryDate: + unit: DAYS + min: 1 + max: 5 + billingTerms: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + offerings: + - bandwidth: 10 + price: + unit: USD + min: 10 + max: 100 + - bandwidth: 50 + price: + unit: USD + min: 50 + max: 500 + SimplifiedLocationWithoutIBX: type: object properties: - uuid: + metroHref: + description: The Canonical URL at which the resource resides. 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 - selectiveRedundancy: - type: boolean - description: Optional redundant connections - example: true - default: false - apiConfig: - $ref: "#/components/schemas/ApiConfig" - connectionLabel: + example: https://api.equinix.com/fabric/v4/metros/AM + region: 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: + example: AMER, APAC, EMEA + metroName: + type: string + example: Amsterdam + metroCode: + type: string + example: AM + required: + - metroCode + CloudRouterPostRequestPackage: + description: Fabric Cloud Router Package Type type: object properties: - encapsulationStrategy: + href: + description: Fabric Cloud Router URI type: string - description: was tagType - missing on wiki - enum: - - CTAGED - - BOTH - - NAMED - namedTags: - maxItems: 64 - type: array - items: - type: string - vlanCTagLabel: + format: uri + example: https://api.equinix.com/fabric/v4/routerPackages/LAB + type: + description: Cloud Router package type type: string - description: was ctagLabel - reuseVlanSTag: - type: boolean - example: true - default: false - encapsulation: + enum: + - ROUTER_PACKAGE + example: ROUTER_PACKAGE + code: + description: Cloud Router package code 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: + - LAB + - BASIC + - STANDARD + - ADVANCED + - PREMIUM + example: LAB + required: + - code + marketplaceSubscription: + description: Equinix Fabric Entity for Marketplace Subscription 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: + href: + description: Marketplace Subscription URI type: string - limitAuthKeyConn: - type: boolean - allowSecondaryLocation: - type: boolean - redundantProfileId: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/marketplaceSubscriptions/20d32a80-0d61-4333-bc03-707b591ae2f5 + type: + description: Marketplace Subscription type type: string - allowVcMigration: - type: boolean - connectionEditable: - type: boolean - releaseVlan: - type: boolean - maxConnectionsOnPort: - type: integer - portAssignmentStrategy: + enum: + - AWS_MARKETPLACE_SUBSCRIPTION + - GCP_MARKETPLACE_SUBSCRIPTION + - AZURE_MARKETPLACE_SUBSCRIPTION + example: AWS_MARKETPLACE_SUBSCRIPTION + uuid: + description: Equinix-assigned Marketplace Subscription identifier type: string - eqxManagedPort: - type: boolean - connectionNameEditable: - type: boolean - description: Metadata. Response attribute. Ignored on request payload. - ServiceProfileAccessPointTypeVD: - required: - - type + example: 20d32a80-0d61-4333-bc03-707b591ae2f5 + CloudRouterPostRequestBase: type: object + description: Create Cloud Router 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 - - label - - required - 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: + - XF_ROUTER + name: + description: Customer-provided Cloud Router name type: string - description: Logo file name - promotion: - type: boolean - description: Profile promotion on marketplace - processSteps: - maxItems: 3 + 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: + description: Preferences for notifications on connection configuration or status changes type: array items: - $ref: "#/components/schemas/ProcessStep" - ProcessStep: + $ref: '#/components/schemas/SimplifiedNotification' + marketplaceSubscription: + $ref: '#/components/schemas/marketplaceSubscription' + CloudRouterAccessPointState: + description: Access point lifecycle state + type: string + enum: + - PROVISIONED + - PROVISIONING + - DEPROVISIONING + - DEPROVISIONED + - REPROVISIONING + - NOT_PROVISIONED + - NOT_DEPROVISIONED + CloudRouterChangeOperation: + description: Fabric Cloud Router change operation data type: object properties: - title: - type: string - description: Service profile custom step title - subTitle: + op: + description: Handy shortcut for operation name type: string - description: Service profile custom step sub title - description: + enum: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter type: string - description: Service profile custom step description - description: Definition of customized step while making connection - ServiceProfileAccessPointCOLO: + value: + description: new value for updated parameter required: - - type - - uuid + - op + - path + - value + CloudRouterChange: + description: Current state of latest CloudRouter change type: object properties: + uuid: + description: Uniquely identifies a change + type: string type: + description: Type of change type: string enum: - - XF_PORT - - IX_PORT - uuid: + - ROUTER_UPDATE + status: + description: Current outcome of the change flow type: string - format: uuid - example: 94662143-e21b-4098-bfcf-e9416f47eae1 - location: - $ref: "#/components/schemas/SimplifiedLocation" - sellerRegion: + enum: + - COMPLETED + - FAILED + - REQUESTED + createdDateTime: + description: Set when change flow starts type: string - sellerRegionDescription: + format: date-time + example: '2020-11-06T07:00:00Z' + updatedDateTime: + description: Set when change object is updated type: string - crossConnectId: + format: date-time + example: '2020-11-06T07:00:00Z' + information: + description: Additional information type: string - description: Colo Access Point - ServiceProfileAccessPointVD: + data: + type: array + items: + $ref: '#/components/schemas/CloudRouterChangeOperation' required: - type - - uuid + - updatedDateTime + CloudRouter: + description: Fabric Cloud Router object type: object + allOf: + - $ref: '#/components/schemas/CloudRouterPostRequestBase' properties: - type: + href: + description: Cloud Routers URI type: string - enum: - - VD + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/routers/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 uuid: + description: Equinix-assigned access point identifier type: string format: uuid - example: 94662143-e21b-4098-bfcf-e9416f47eae1 - location: - $ref: "#/components/schemas/SimplifiedLocation" - interfaceUuid: + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + name: + description: Customer-provided Cloud Router name type: string - format: uuid - example: 94662143-e21b-4098-bfcf-e9416f47eae1 - description: Virtual Device Point - ServiceMetro: + format: string + example: test-fg-1 + state: + $ref: '#/components/schemas/CloudRouterAccessPointState' + example: PROVISIONED + equinixAsn: + description: Equinix ASN + type: integer + format: int64 + example: 30000 + connectionsCount: + description: Number of connections associated with this Access point + type: integer + minimum: 0 + marketplaceSubscription: + $ref: '#/components/schemas/marketplaceSubscription' + changeLog: + $ref: '#/components/schemas/Changelog' + change: + $ref: '#/components/schemas/CloudRouterChange' + VirtualDevice: + description: Virtual Device AccessPoint Information type: object properties: - code: + href: + description: Virtual Device URI type: string - description: metro code + format: uri + readOnly: true + uuid: + description: Equinix-assigned Virtual Device identifier + type: string + format: uuid name: + description: Customer-assigned Virtual Device 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: + description: Virtual Device type type: string - description: service metro display name - sellerRegions: - type: object - additionalProperties: - type: string - ProviderEnvironment: + enum: + - EDGE + account: + $ref: '#/components/schemas/SimplifiedAccount' + cluster: + description: Virtual Device Cluster Information + type: string + Interface: + description: Interface Information type: object properties: href: + description: Interface URI type: string - description: Provider Environment URI format: uri readOnly: true uuid: + description: Equinix-assigned Interface identifier type: string - description: Equinix-assigned provider environment identifier format: uuid + id: + description: Interface id + type: integer type: - $ref: "#/components/schemas/ProviderEnvironmentTypeEnum" - name: - type: string - description: Provider environment name - example: US West 1 – Production - description: + description: Interface type type: string - description: Provider environment description - example: Primary production environment - sellerRegion: + enum: + - CLOUD + - NETWORK + projectId: + description: Interface Project ID type: string - description: Cloud provider region identifier - example: us-west-1 - supportedBandwidths: - type: array - description: Supported bandwidths in Mbps - example: - - 1000 - - 10000 - - 100000 - items: - type: integer - metros: - type: array - description: Derived response attribute. - items: - $ref: "#/components/schemas/ServiceMetro" - supportedFeatures: - type: array - description: Supported Feature Types - example: - - FEATURE_TYPE_L3_BASE - items: - type: string - changeLog: - $ref: "#/components/schemas/Changelog" - description: Provider Environment associated with an IC_PROFILE service profile Beta - ProviderEnvironmentTypeEnum: + NetworkState: + description: Network status type: string - description: Provider environment type + example: ACTIVE enum: - - IC_ENV - ServiceProfileLastMileConfig: + - ACTIVE + - INACTIVE + - DELETED + NetworkChangeType: + description: Type of change + type: string + enum: + - NETWORK_CREATION + - NETWORK_UPDATE + - NETWORK_DELETION + SimplifiedNetworkChange: + description: Current state of latest network change type: object properties: - apiIntegration: - $ref: "#/components/schemas/ServiceProfileLastMileApiIntegration" - productCatalogs: - type: array - description: Last-mile provider catalogs. - items: - $ref: "#/components/schemas/ServiceProfileLastMileProductCatalog" - description: Last-mile configuration for the service profile. - ServiceProfileLastMileApiIntegration: + href: + description: Network URI + type: string + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9 + uuid: + description: Uniquely identifies a change + type: string + format: uuid + example: 4b17da68-3d6b-436d-9c8f-2105f3b950d9 + type: + $ref: '#/components/schemas/NetworkChangeType' + example: NETWORK_CREATION + NetworkEquinixStatus: + description: Network status + type: string + enum: + - PROVISIONING + - PROVISIONED + - NOT_PROVISIONED + - DEPROVISIONING + - DEPROVISIONED + - NOT_DEPROVISIONED + NetworkOperation: + description: Network operational data type: object properties: - siteValidationEnabled: - type: boolean - description: Whether site validation is enabled for the last-mile provider. - dataCenterLocationEnabled: - type: boolean - description: Whether data center location is enabled for the last-mile provider. - productOfferingEnabled: - type: boolean - description: Whether product offering is enabled for the last-mile provider. - poqEnabled: - type: boolean - description: Whether product qualification is enabled for the last-mile provider. - quoteEnabled: - type: boolean - description: Whether quote generation is enabled for the last-mile provider. - placeOrderEnabled: - type: boolean - description: Whether place order is enabled for the last-mile provider. - quoteViaAggregatorEnabled: - type: boolean - description: Whether quote via aggregator is enabled for the last-mile provider. - description: Last-mile API integration details. - ServiceProfileLastMileContactInfoItem: + equinixStatus: + $ref: '#/components/schemas/NetworkEquinixStatus' + Link: type: object properties: - type: + href: + description: Resource URI type: string - description: Contact type. - enum: - - SUPPORT_URL - - DOCUMENTATION_URL - - SUPPORT_EMAIL - url: + format: uri + readOnly: true + rel: + description: OperationId from Swagger hub spec type: string - description: Contact URL. - example: https://support.example.com - emails: - type: array - description: List of contact emails. - items: - type: string - format: email - example: support@example.com - description: Last-mile provider contact information item. - ServiceProfileLastMileProductCatalog: + method: + description: Http method type + type: string + contentType: + description: Content type for the response + type: string + authenticate: + description: Authentication required or not + type: boolean + NetworkType: + description: Network type + type: string + enum: + - EVPLAN + - EPLAN + - IPWAN + - EVPTREE + - EPTREE + NetworkScope: + description: Network scope + type: string + enum: + - REGIONAL + - GLOBAL + - LOCAL + SimplifiedNetwork: + description: Network specification type: object properties: - name: + href: + description: Network URI type: string - description: Last-mile provider or catalog name. - example: att fiber - id: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784 + uuid: + description: Equinix-assigned network identifier type: string - description: Last-mile provider or catalog identifier. - example: fc1eb018-df0a-4ee8-8dd1-e6b8ad61178d - webUrl: + format: uuid + example: 92dc376a-a932-43aa-a6a2-c806dedbd784 + name: + description: Customer-assigned network name type: string - description: Last-mile catalog or provider website URL. - example: att.com/lastmile - deliveryDate: - $ref: "#/components/schemas/ServiceProfileLastMileDeliveryDateRange" - billingTerms: + 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: + description: Network sub-resources links type: array - description: Available billing terms in months. - nullable: true - example: - - 1 - - 12 - - 24 - - 36 - - 48 - - 60 - items: - type: integer - enum: - - 1 - - 12 - - 24 - - 36 - - 48 - - 60 - offerings: - type: array - description: Available last-mile offerings. + readOnly: true items: - $ref: "#/components/schemas/ServiceProfileLastMileOffering" - description: Last-mile provider catalog details. - ServiceProfileLastMileDeliveryDateRange: + $ref: '#/components/schemas/Link' + type: + $ref: '#/components/schemas/NetworkType' + name: + description: Customer-provided network name + type: string + scope: + $ref: '#/components/schemas/NetworkScope' + location: + $ref: '#/components/schemas/SimplifiedLocation' + required: + - uuid + PeeringType: + description: Access point peering type + type: string + enum: + - PRIVATE + - MICROSOFT + - PUBLIC + - MANUAL + VirtualNetwork: + description: Virtual Network Information type: object properties: - unit: + href: + description: The Canonical URL at which the resource resides. type: string - description: Unit for this range is DAYS. - example: USD - min: - type: integer - description: Minimum value for the range. - example: 1 - max: - type: integer - description: Maximum value for the range. - example: 10 - description: Range details for delivery window. - ServiceProfileLastMileOffering: + format: uri + readOnly: true + uuid: + description: Equinix-assigned Virtual Network identifier + type: string + format: uuid + MetalInterconnection: + description: Metal Interconnection type: object properties: - bandwidth: - type: integer - description: Offered bandwidth in Mbps. - example: 10 - price: - $ref: "#/components/schemas/ServiceProfileLastMilePriceRange" - description: Last-mile offering details. - ServiceProfileLastMilePriceRange: + uuid: + description: Equinix Metal Interconnection + type: string + format: uuid + ProductOffering: + description: Product offering for connection. Applicable to zSide only. type: object properties: - unit: + id: + description: Product offering identifier type: string - description: Unit for this range, such as USD or DAYS. - example: USD - min: - type: number - description: Minimum value for the range. - format: double - example: 10 - max: - type: number - description: Maximum value for the range. - format: double - example: 100 - description: Range details for price or delivery window. - ServiceProfile: + name: + description: Product offering name + type: string + billingTerm: + description: Billing term in months. + type: integer + minimum: 1 + enum: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + example: 12 + Address: + description: Address. type: object properties: - state: - $ref: "#/components/schemas/ServiceProfileStateEnum" - account: - $ref: "#/components/schemas/SimplifiedAccount" - project: - $ref: "#/components/schemas/Project" - change: - $ref: "#/components/schemas/ServiceProfileChange" - changeLog: - $ref: "#/components/schemas/Changelog" - 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" - ServiceProfileChange: - required: - - createdDateTime - - type + id: + description: Address identifier + type: string + streetNr: + description: Street number of address + type: string + streetName: + description: Street name of address + type: string + city: + description: City of address + type: string + stateOrProvince: + description: State of address + type: string + postCode: + description: Postal code of address + type: string + country: + description: Country of address + type: string + AccessPoint: + description: Access point object type: object properties: - uuid: - type: string - description: Uniquely identifies a change 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' + environment: + $ref: '#/components/schemas/ProviderEnvironment' + sellerRegion: + description: Access point seller region type: string - description: Type of change - example: SERVICE_PROFILE_VISIBILITY_UPDATE - status: + peeringType: + $ref: '#/components/schemas/PeeringType' + authenticationKey: + description: Access point authentication key + type: string + activationKey: + description: Access point activation key + type: string + providerConnectionId: + description: Provider assigned Connection Id + type: string + virtualNetwork: + $ref: '#/components/schemas/VirtualNetwork' + interconnection: + $ref: '#/components/schemas/MetalInterconnection' + role: + description: E-Tree network connection role type: string - description: Current outcome of the change flow enum: - - APPROVED - - COMPLETED - - FAILED - - REJECTED - - REQUESTED - - SUBMITTED_FOR_APPROVAL - createdDateTime: + - LEAF + - ROOT + productOffering: + $ref: '#/components/schemas/ProductOffering' + bandwidthCommit: + description: Bandwidth commit in Mbps + type: integer + minimum: 0 + maximum: 100000 + providerIdentifier: + description: Provider identifier type: string - description: Set when change flow starts - format: date-time - example: 2020-11-06T07:00:00Z - updatedDateTime: + address: + $ref: '#/components/schemas/Address' + ConnectionSideAdditionalInfo: + description: Additional information + properties: + key: + description: Key type: string - description: Set when change object is updated - format: date-time - example: 2020-11-06T07:00:00Z - information: + value: + description: Value type: string - description: Additional information - data: - $ref: "#/components/schemas/ServiceProfileUpdateRequest" - description: Current state of latest service profile change - ServiceProfileSearchRequest: + ConnectionSide: + description: Connection configuration object for each side of multi-segment connection type: object properties: - filter: - $ref: "#/components/schemas/ServiceProfileFilter" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + serviceToken: + $ref: '#/components/schemas/ServiceToken' + accessPoint: + $ref: '#/components/schemas/AccessPoint' + additionalInfo: + description: Any additional information, which is not part of connection metadata or configuration 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: + $ref: '#/components/schemas/ConnectionSideAdditionalInfo' + ConnectionPostRequest: + required: + - type + - name + - notifications + - bandwidth + - aSide + - zSide type: object + description: Create connection post request 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: + $ref: '#/components/schemas/ConnectionType' + name: + description: Customer-provided connection name type: string - description: | - Possible operators to use on filters: - * `=` - equal - example: = - values: + order: + $ref: '#/components/schemas/Order' + notifications: + description: Preferences for notifications on connection configuration or status changes type: array items: - type: string - example: ServiceProfile-1 - ServiceProfileAndFilter: - type: object - properties: - and: + $ref: '#/components/schemas/SimplifiedNotification' + bandwidth: + description: Connection bandwidth in Mbps + type: integer + minimum: 0 + maximum: 100000 + geoScope: + description: Geographic boundary for the connection + $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: + description: Connection additional information 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 - ServiceProfileUpdateRequest: - type: array - items: - $ref: "#/components/schemas/ServiceProfileUpdateOperation" - ServiceProfileUpdateOperation: - 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 + $ref: '#/components/schemas/ConnectionSideAdditionalInfo' + marketplaceSubscription: + $ref: '#/components/schemas/marketplaceSubscription' + ConnectionChangeOperation: + description: Connection change operation data type: object properties: op: + description: Handy shortcut for operation name type: string - enum: - - add + example: add path: - $ref: "#/components/schemas/Path" + description: path inside document leading to updated parameter + type: string + example: /ipv6 value: - type: object - description: value to add - description: Add Sub-Resource to the existing model - Path: - type: string - description: A JSON Pointer path. - RemoveOperation: + description: new value for updated parameter required: - op - path + - value + Change: + description: Current state of latest connection change type: object properties: - op: + uuid: + description: Uniquely identifies a change + type: string + type: + description: Type of change type: string enum: - - remove - path: - $ref: "#/components/schemas/Path" - description: Remove sub-resource from an existing model - ReplaceOperation: - required: - - op - - path - - value - type: object - properties: - op: + - CONNECTION_CREATION + - CONNECTION_UPDATE + - CONNECTION_DELETION + - CONNECTION_PROVIDER_STATUS_REQUEST + status: + description: Current outcome of the change flow type: string enum: - - replace - path: - $ref: "#/components/schemas/Path" - value: - type: object - description: value to replace with - description: Replace attribute value or sub-resource in the existing model - ServiceProfileActionRequest: + - APPROVED + - COMPLETED + - FAILED + - REJECTED + - REQUESTED + - SUBMITTED_FOR_APPROVAL + createdDateTime: + description: Set when change flow starts + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + updatedDateTime: + description: Set when change object is updated + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + information: + description: Additional information + type: string + data: + $ref: '#/components/schemas/ConnectionChangeOperation' required: - type + - createdDateTime + ProviderStatus: + description: Connection provider readiness status + type: string + enum: + - AVAILABLE + - DEPROVISIONED + - DEPROVISIONING + - FAILED + - NOT_AVAILABLE + - PENDING_APPROVAL + - PENDING_CONFIGURATION + - PROVISIONED + - PROVISIONING + - REJECTED + - PENDING_BGP + - ERROR + - ORDERING + - DELETING + - PENDING DELETE + - N/A + - QUOTING + EquinixStatus: + description: Connection status + type: string + enum: + - REJECTED_ACK + - REJECTED + - PENDING_DELETE + - PROVISIONED + - PENDING_APPROVAL + - NOT_PROVISIONED + - DEPROVISIONING + - NOT_DEPROVISIONED + - PENDING_AUTO_APPROVAL + - PROVISIONING + - PENDING_BGP_PEERING + - PENDING_PROVIDER_VLAN + - DEPROVISIONED + - DELETED + - AUTO_APPROVAL_FAILED + - PENDING_PROVIDER_VLAN_ERROR + - DRAFT + - CANCELLED + - PENDING_INTERFACE_CONFIGURATION + ConnectionOperation: + description: Connection type-specific operational data type: object properties: - type: + providerStatus: + $ref: '#/components/schemas/ProviderStatus' + equinixStatus: + $ref: '#/components/schemas/EquinixStatus' + operationalStatus: + description: Connection operational status type: string - description: "Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION" - example: PROFILE_UPDATE_ACCEPTANCE - description: + enum: + - UP + - DOWN + errors: + type: array + items: + $ref: '#/components/schemas/Error' + opStatusChangedAt: + description: When connection transitioned into current operational status type: string - description: Action description - example: Approved to migrate to public - description: Service Profile Action Request - ServiceProfileActionResponse: + format: date-time + example: '2020-11-06T07:00:00Z' + maintenanceStatus: + allOf: + - $ref: '#/components/schemas/maintenanceState' + lockEnabled: + description: Indicates whether the connection configuration is locked due to an ongoing or scheduled maintenance. + type: boolean + example: true + ConnectionDirection: + description: Connection directionality from the requester point of view + type: string + enum: + - INTERNAL + - INCOMING + - OUTGOING + Connection: + description: Connection specification type: object properties: href: + description: Connection URI type: string - description: Service Profile Action URI format: uri readOnly: true type: - type: string - description: "Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION" - example: PROFILE_UPDATE_ACCEPTANCE + $ref: '#/components/schemas/ConnectionType' uuid: + description: Equinix-assigned connection identifier type: string - description: Equinix-assigned action identifier - format: uuid - comments: + name: + description: Customer-provided connection name type: string - description: Action comments - example: Approved to migrate to public + description: + description: Customer-provided connection description + type: string + change: + $ref: '#/components/schemas/Change' + operation: + $ref: '#/components/schemas/ConnectionOperation' + order: + $ref: '#/components/schemas/Order' + notifications: + description: Preferences for notifications on connection configuration or status changes + type: array + items: + $ref: '#/components/schemas/SimplifiedNotification' + account: + $ref: '#/components/schemas/SimplifiedAccount' changeLog: - $ref: "#/components/schemas/Changelog" - description: Service Profile Action Response - ProviderEnvironments: - type: object - properties: - data: + $ref: '#/components/schemas/Changelog' + bandwidth: + description: Connection bandwidth in Mbps + type: integer + minimum: 0 + maximum: 10000 + geoScope: + description: Geographic boundary for this connection + $ref: '#/components/schemas/GeoScopeType' + redundancy: + $ref: '#/components/schemas/ConnectionRedundancy' + isRemote: + description: Connection property derived from access point locations + type: boolean + direction: + $ref: '#/components/schemas/ConnectionDirection' + aSide: + $ref: '#/components/schemas/ConnectionSide' + zSide: + $ref: '#/components/schemas/ConnectionSide' + marketplaceSubscription: + $ref: '#/components/schemas/marketplaceSubscription' + additionalInfo: + description: Connection additional information type: array items: - $ref: "#/components/schemas/ProviderEnvironment" - pagination: - $ref: "#/components/schemas/Pagination" - description: Service Profile Provider Environments - EnvironmentId: - type: string - description: Provider Environment Reference - EnvironmentActionRequest: + $ref: '#/components/schemas/ConnectionSideAdditionalInfo' + project: + description: Project is optional for AM-CRH customers. If not provided, a default project will be assigned. + example: 30ad25e2-53dc-11ed-bdc3-0242ac120002 + $ref: '#/components/schemas/Project' required: - - keyDetails - type - type: object - properties: - type: - $ref: "#/components/schemas/EnvironmentActionTypeEnum" - keyDetails: - $ref: "#/components/schemas/ActivationKeyDetails" - description: Request payload for environment action - EnvironmentActionTypeEnum: + - name + - bandwidth + - aSide + - zSide + ConnectionUpdateRequest: + description: Connection Update Request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/ConnectionChangeOperation' + Actions: + description: Connection action type type: string - description: Environment action type - example: VALIDATE_ACTIVATION_KEY enum: - - VALIDATE_ACTIVATION_KEY - ActivationKeyDetails: + - 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 + - CONNECTION_CREATION_RETRY + - CONNECTION_DELETION_RETRY + - CONNECTION_PROVIDER_STATUS_UPDATE_REQUEST + ConnectionAcceptanceData: + description: Connection acceptance data type: object properties: - value: - type: string - description: Provider Encoded activation key - example: key_here - providerId: - type: string - description: AWS Connection identifier - accountId: - type: string - description: Account identifier - bandwidth: + zSide: + $ref: '#/components/schemas/ConnectionSide' + providerBandwidth: + description: Authorization key bandwidth in Mbps type: integer - description: Bandwidth in Mbps - region: - type: string - description: Cloud provider region identifier - description: Activation Key Details Beta - EnvironmentActionResponse: - type: object - properties: - href: - type: string - description: Environment action URI - format: uri readOnly: true - type: - $ref: "#/components/schemas/EnvironmentActionTypeEnum" - uuid: - type: string - description: Equinix-assigned action identifier - format: uuid - example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 - state: - $ref: "#/components/schemas/EnvironmentActionStateEnum" - keyDetails: - $ref: "#/components/schemas/ActivationKeyDetails" - changeLog: - $ref: "#/components/schemas/Changelog" - description: Response from environment action Beta - EnvironmentActionStateEnum: - type: string - description: Environment action state. ACTIVE - already used , INACTIVE - not used - example: ACTIVE - enum: - - ACTIVE - - INACTIVE - 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: + operation: + $ref: '#/components/schemas/ConnectionOperation' + ConnectionActionRequest: + description: Connection action request 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 + $ref: '#/components/schemas/Actions' description: + description: Connection rejection reason detail 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" - or: - $ref: "#/components/schemas/ServiceTokenSearchExpressions" - property: - $ref: "#/components/schemas/ServiceTokenSearchFieldName" - operator: - type: string - enum: - - = - - "!=" - - LIKE - - ILIKE - - < - - ">" - - <= - - ">=" - - IN - - NOT IN - - BETWEEN - - NOT BETWEEN - 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 - - /type - - /expirationDateTime - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - - /connection/aSide/accessPointSelectors/port/uuid - - /connection/zSide/accessPointSelectors/port/uuid - OpticalConnectPostRequest: + $ref: '#/components/schemas/ConnectionAcceptanceData' required: - - aSide - - bandwidth - - connectionDestinationType - - pathType - type - - zSide + ConnectionAction: + description: Connection action type: object properties: type: - type: string - description: OC - Optical Connect Type - example: OC - enum: - - OC - bandwidth: - type: integer - description: | - Connection bandwidth Mbps.
Available bandwidths depend on the IBX pair.
1000 - 1 Gbps.
10000 - 10 Gbps.
100000 - 100 Gbps.
- example: 100000 - connectionDestinationType: - type: string - description: | - Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
BMMR and REMOTE require a Letter of Authorization on the Z-side. - example: COLO - enum: - - COLO - - BMMR - - REMOTE - pathType: - type: string - description: | - Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs. - example: PROTECTED - enum: - - DUAL_DIVERSE - - PROTECTED - - UNPROTECTED - redundancy: - $ref: "#/components/schemas/OpticalConnectRedundancy" - aSide: - $ref: "#/components/schemas/OpticalConnectASideRequest" - zSide: - $ref: "#/components/schemas/OpticalConnectZSideRequest" - order: - $ref: "#/components/schemas/OpticalConnectOrder" - account: - $ref: "#/components/schemas/SimplifiedAccount" - notifications: - type: array - description: Contacts to notify about connection configuration and status changes - items: - $ref: "#/components/schemas/OpticalConnectNotification" - bmmrType: - type: string - description: | - BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR. - example: EQUINIX - enum: - - EQUINIX - - SELF - description: |- - Request to order a single connection. The A-side is always a patch panel - port in your own cage; the Z-side shape depends on - connectionDestinationType. - OpticalConnectResponse: - type: object - properties: + $ref: '#/components/schemas/Actions' href: + description: Connection action URI type: string - description: URI of this Optical Connect resource. format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 uuid: + description: Equinix-assigned connection identifier type: string - description: Unique identifier of this Optical Connect. - format: uuid - readOnly: true - example: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: - type: string - description: | - Connection Type.
OC - Optical Connect. - example: OC - enum: - - OC - name: - type: string - description: | - Equinix-assigned name, derived from the account number and the two IBX locations. - readOnly: true - example: 123456-SV1-SV2-01 state: - $ref: "#/components/schemas/OpticalConnectState" - bandwidth: - type: integer - description: Provisioned connection bandwidth in Mbps. - example: 10000 - connectionDestinationType: - type: string - description: | - Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
- enum: - - COLO - - BMMR - - REMOTE - pathType: + description: Connection action response state type: string - description: | - Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs. enum: - - DUAL_DIVERSE - - PROTECTED - - UNPROTECTED - bmmrType: + - SUCCEEDED + description: + description: Connection rejection reason detail type: string - description: | - BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR. - enum: - - EQUINIX - - SELF - redundancy: - $ref: "#/components/schemas/OpticalConnectRedundancy" - aSide: - $ref: "#/components/schemas/OpticalConnectASideResponse" - zSide: - $ref: "#/components/schemas/OpticalConnectZSideResponse" - order: - $ref: "#/components/schemas/OpticalConnectOrder" - account: - $ref: "#/components/schemas/SimplifiedAccount" - notifications: - type: array - description: Preferences for notifications on connection configuration or status changes - items: - $ref: "#/components/schemas/OpticalConnectNotification" - changeLog: - $ref: "#/components/schemas/Changelog" - description: |- - Optical Metro Connect connection with its current state and the resolved - physical termination points at both ends. - BulkOpticalConnectRequest: - type: object - properties: data: - type: array - description: | - The two connections forming the diverse pair — one PRIMARY and one - SECONDARY. - items: - $ref: "#/components/schemas/OpticalConnectPostRequest" - description: Request to create a dual diverse pair of Optical Connect connections. - OpticalConnectBulk: - type: object - properties: - data: - type: array - items: - $ref: "#/components/schemas/OpticalConnectResponse" - description: Dual diverse pair Connection - OpticalConnectId: - type: string - description: Unique identifier of an Optical Connect. - format: uuid - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - OpticalConnectSearchRequest: - type: object - properties: - filter: - $ref: "#/components/schemas/OpticalConnectFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/OpticalConnectSortCriteria" - description: |- - Search criteria for retrieving Optical Connects, with optional - filtering, pagination and sorting. - OpticalConnectFilters: - type: object - properties: - and: - maxItems: 8 - type: array - items: - $ref: "#/components/schemas/OpticalConnectFilter" - OpticalConnectFilter: - type: object - description: A single condition, or a group of conditions combined with logical OR. - anyOf: - - $ref: "#/components/schemas/OpticalConnectSimpleExpression" - - $ref: "#/components/schemas/OpticalConnectOrFilter" - OpticalConnectSimpleExpression: + $ref: '#/components/schemas/ConnectionAcceptanceData' + changeLog: + $ref: '#/components/schemas/Changelog' + required: + - type + - href + - uuid + - data + ConnectionRouteEntrySimpleExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: - * `/name` - Connection name - * `/uuid` - Connection uuid - * `/type` - type - * `/state` - state - * `/bandwidth` - Bandwidth - example: /name - operator: + * `/type` - Route table entry type + * `/state` - Route table entry state + * `/prefix` - Route table entry prefix + * `/nextHop` - Route table entry nextHop + * `/*` - all-category search type: string + example: /type + operator: 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: = + * `~*` - case-insensitive like + type: string + example: '=' values: type: array items: type: string - example: 123456-SV1-SV2-01 - OpticalConnectOrFilter: + example: IPv4_BGP_ROUTE + ConnectionRouteEntryOrFilter: type: object properties: or: - maxItems: 3 type: array + maxItems: 3 items: - $ref: "#/components/schemas/OpticalConnectSimpleExpression" - OpticalConnectSortCriteria: + $ref: '#/components/schemas/ConnectionRouteEntrySimpleExpression' + ConnectionRouteEntryFilter: + type: object + anyOf: + - $ref: '#/components/schemas/ConnectionRouteEntrySimpleExpression' + - $ref: '#/components/schemas/ConnectionRouteEntryOrFilter' + ConnectionRouteEntryFilters: type: object properties: - direction: - $ref: "#/components/schemas/OpticalConnectSortDirection" - property: - $ref: "#/components/schemas/OpticalConnectSortBy" - description: Sorting to apply to search results. - OpticalConnectSortDirection: - type: string - description: | - Sorting direction.
ASC - ascending
DESC - descending + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/ConnectionRouteEntryFilter' + ConnectionRouteEntrySortDirection: + description: Sorting direction default: DESC + type: string enum: - DESC - ASC - OpticalConnectSortBy: - type: string + ConnectionRouteEntrySortBy: description: Possible field names to use on sorting default: /changeLog/updatedDateTime + type: string enum: - - /name - - /uuid - - /state - - /type - - /bandwidth - - /aSide/location/ibxCode - - /zSide/location/ibxCode - /changeLog/createdDateTime - /changeLog/updatedDateTime - OpticalConnectServiceSearchResponse: + - /med + - /connection/name + - /type + - /prefix + - /nextHop + ConnectionRouteSortCriteria: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/OpticalConnectResponse" - Presence: - type: string - description: Presence - enum: - - MY_PORTS - MetroResponse: + direction: + $ref: '#/components/schemas/ConnectionRouteEntrySortDirection' + property: + $ref: '#/components/schemas/ConnectionRouteEntrySortBy' + ConnectionRouteSearchRequest: type: object + description: Search requests containing criteria properties: + filter: + $ref: '#/components/schemas/ConnectionRouteEntryFilters' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: 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: + $ref: '#/components/schemas/ConnectionRouteSortCriteria' + RouteTableEntryType: + description: Route table entry type + type: string + enum: + - IPv4_BGP_ROUTE + - IPv4_STATIC_ROUTE + - IPv4_DIRECT_ROUTE + - IPv6_BGP_ROUTE + - IPv6_STATIC_ROUTE + - IPv6_DIRECT_ROUTE + RouteTableEntryProtocolType: + description: Route table entry protocol type + type: string + enum: + - BGP + - STATIC + - DIRECT + ConnectionRouteTableEntry: + description: Advertised and received route table entry object type: object properties: - href: - type: string - description: The Canonical URL at which the resource resides. type: + $ref: '#/components/schemas/RouteTableEntryType' + example: IPv4_BGP_SESSION + protocolType: + $ref: '#/components/schemas/RouteTableEntryProtocolType' + example: BGP + state: 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: + enum: + - ACTIVE + - INACTIVE + example: ACTIVE + prefix: type: string - description: Name of the region in which the data center is located. - country: + example: 192.168.10.0/24 + nextHop: type: string - description: Country code in which the data center is located. - equinixAsn: + example: 10.10.10.5 + MED: 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: + example: 5 + localPreference: 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" - services: + example: 200 + asPath: type: array items: - $ref: "#/components/schemas/services" - geoScopes: - type: array - description: List of supported geographic boundaries of a Fabric Metro. - items: - $ref: "#/components/schemas/GeoScopeType" - geoZones: + type: string + connection: + type: object + properties: + uuid: + type: string + example: 81331c52-04c0-4656-a4a7-18c52669348f + name: + type: string + example: connection_1 + href: + type: string + example: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + changeLog: + $ref: '#/components/schemas/Changelog' + required: + - type + - changeLog + ConnectionRouteTableEntrySearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. type: array - description: List of supported geographic zones of a Fabric Metro. items: - $ref: "#/components/schemas/GeoZone" - 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: + $ref: '#/components/schemas/ConnectionRouteTableEntry' + BGPConnectionOperation: + description: BGP IPv4 or IPv6 Connection State operational data 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: + operationalStatus: + description: BGP IPv4 or IPv6 Connection State operational status + type: string + enum: + - UP + - DOWN + - UNKNOWN + opStatusChangedAt: + description: Last BGP State Update by Date and Time + type: string + format: date-time + example: '2021-10-30T07:21:39Z' + BGPConnectionIpv4: type: object properties: - href: + customerPeerIp: + description: Customer side peering ip type: string - description: The Canonical URL at which the resource resides. - code: + example: 10.1.1.2 + equinixPeerIp: + description: Equinix side peering ip 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: + example: 10.1.1.3 + enabled: + description: Admin status for the BGP session + type: boolean + outboundASPrependCount: + description: AS path prepend count 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 - services: + example: 3 + inboundMED: + description: Inbound Multi Exit Discriminator attribute + type: integer + format: int64 + example: 1000 + outboundMED: + description: Outbound Multi Exit Discriminator attribute + type: integer + format: int64 + example: 2000 + routesMax: + description: Maximum learnt prefixes limit + type: integer + format: int64 + example: 1000 + operation: + $ref: '#/components/schemas/BGPConnectionOperation' + required: + - customerPeerIp + - enabled + BGPConnectionIpv6: type: object properties: - type: + customerPeerIp: + description: Customer side peering ip type: string - description: Type of Service - description: Arrays of objects containing type of services supported in the specified metros - GeoScopeType: - type: string - description: Geographic boundary types - enum: - - CANADA - - CONUS - - JAPAN - - UK - - AUSTRALIA - - BRAZIL - - SWITZERLAND - - EU - GeoZone: + example: 2001:db8:c59b::1 + equinixPeerIp: + description: Equinix side peering ip + type: string + example: 2001:db8:c59b::1 + enabled: + description: Admin status for the BGP session + type: boolean + outboundASPrependCount: + description: AS path prepend count + type: integer + format: int64 + example: 3 + inboundMED: + description: Inbound Multi Exit Discriminator attribute + type: integer + format: int64 + example: 1000 + outboundMED: + description: Outbound Multi Exit Discriminator attribute + type: integer + format: int64 + example: 2000 + routesMax: + description: Maximum learnt prefixes limit + type: integer + format: int64 + example: 1000 + operation: + $ref: '#/components/schemas/BGPConnectionOperation' + required: + - customerPeerIp + - enabled + RoutingProtocolBFD: type: object properties: - code: - type: string - description: Code assigned to a geographic zone. - name: - type: string - description: Name of a geographic zone. - description: + enabled: + type: boolean + interval: type: string - description: Description of a geographic zone. - description: Geographic zone of a Fabric Metro - MetroErrorList: - type: array - items: - $ref: "#/components/schemas/MetroError" - MetroError: + example: '100' required: - - errorCode - - errorMessage + - enabled + RoutingProtocolOperation: type: object properties: - errorCode: + errors: + type: array + items: + $ref: '#/components/schemas/Error' + RoutingProtocolChange: + description: Current state of latest Routing Protocol change + type: object + properties: + uuid: + description: Uniquely identifies a change type: string - enum: - - EQ-3036001 - - EQ-3036013 - - EQ-3036030 - - EQ-3036100 - errorMessage: + type: + description: Type of change 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: + - ROUTING_PROTOCOL_UPDATE + - ROUTING_PROTOCOL_CREATION + - ROUTING_PROTOCOL_DELETION + href: + description: Routing Protocol Change URI 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: + format: uri + required: + - uuid + - type + RoutingProtocolProject: + description: The Routing Protocol's project 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: + projectId: + description: Uniquely identifies a project + type: string + required: + - projectId + RoutingProtocolConnection: + description: Connection specification type: object properties: - href: + uuid: + description: Equinix-assigned connection identifier type: string - description: Equinix assigned response attribute for an absolute URL that is the subject of the link's context. - format: uri - readOnly: true + platformUuid: + description: Equinix-assigned platform connection identifier + type: string + RoutingProtocolBGPData: + type: object + properties: type: - $ref: "#/components/schemas/PortType" - uuid: + description: Routing protocol type type: string - description: Equinix assigned response attribute for port identifier - format: uuid + enum: + - BGP 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 + example: My-BGP-route-1 + bgpIpv4: + $ref: '#/components/schemas/BGPConnectionIpv4' + bgpIpv6: + $ref: '#/components/schemas/BGPConnectionIpv6' + customerAsn: + description: Customer asn type: integer - description: Physical Ports Speed in Mbps - connectionsCount: - minimum: 0 + format: int64 + example: 65002 + equinixAsn: + description: Equinix asn type: integer - description: Equinix assigned response attribute for Connection count - physicalPortsType: + format: int64 + example: 65002 + bgpAuthKey: + description: BGP authorization key type: string - description: Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports - enum: - - 1000BASE_LX - - 10GBASE_LR - - 100GBASE_LR4 - - 10GBASE_ER - - 1000BASE_SX - - 10GBASE_SMF - - 400GBASE_LR4 - physicalPortsCount: - type: integer - connectivitySourceType: + example: testAuthKey + asOverrideEnabled: + description: Enable AS number override + type: boolean + bfd: + $ref: '#/components/schemas/RoutingProtocolBFD' + href: type: string - description: Port connectivity type - enum: - - COLO - - BMMR - - REMOTE - bmmrType: + format: uri + description: Routing Protocol URI + example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/69762051-85ed-4d13-b6b4-e32e93c672b5 + uuid: + description: Routing protocol identifier type: string - enum: - - SELF - - EQUINIX - project: - $ref: "#/components/schemas/Project" + format: uuid + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 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 - serviceCode: - $ref: "#/components/schemas/PortServiceCode" - 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: + - PROVISIONED + - DEPROVISIONED + - PROVISIONING + - DEPROVISIONING + - REPROVISIONING + - FAILED + operation: + $ref: '#/components/schemas/RoutingProtocolOperation' + change: + $ref: '#/components/schemas/RoutingProtocolChange' + changelog: + $ref: '#/components/schemas/Changelog' + project: + $ref: '#/components/schemas/RoutingProtocolProject' + connection: + $ref: '#/components/schemas/RoutingProtocolConnection' + DirectConnectionIpv4: + type: object + properties: + equinixIfaceIp: + description: Equinix side Interface IP address type: string - description: A-side/Equinix ibx - tetherIbx: + example: 192.168.100.0/30 + DirectConnectionIpv6: + type: object + properties: + equinixIfaceIp: + description: Equinix side Interface IP address 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: - deprecated: true - 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" - marketplaceSubscription: - $ref: "#/components/schemas/marketplaceSubscription" - description: Port specification - PhysicalPort: + example: 2001:db8:c59b::/1 + required: + - equinixIfaceIp + RoutingProtocolDirectData: type: object properties: + type: + description: Routing protocol type + type: string + enum: + - DIRECT + name: + type: string + example: My-direct-route-1 + directIpv4: + $ref: '#/components/schemas/DirectConnectionIpv4' + directIpv6: + $ref: '#/components/schemas/DirectConnectionIpv6' 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 + description: Routing Protocol URI + example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/69762051-85ed-4d13-b6b4-e32e93c672b5 uuid: + description: Routing protocol identifier 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" + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + state: + type: string + enum: + - PROVISIONED + - DEPROVISIONED + - PROVISIONING + - DEPROVISIONING + - REPROVISIONING + - FAILED operation: - $ref: "#/components/schemas/PortOperation" - loas: + $ref: '#/components/schemas/RoutingProtocolOperation' + change: + $ref: '#/components/schemas/RoutingProtocolChange' + changelog: + $ref: '#/components/schemas/Changelog' + project: + $ref: '#/components/schemas/RoutingProtocolProject' + connection: + $ref: '#/components/schemas/RoutingProtocolConnection' + RoutingProtocolData: + type: object + properties: + type: + description: Routing protocol type + type: string + enum: + - BGP + - DIRECT + oneOf: + - $ref: '#/components/schemas/RoutingProtocolBGPData' + - $ref: '#/components/schemas/RoutingProtocolDirectData' + GetResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: List of Routing Protocols type: array - description: Port Loas items: - $ref: "#/components/schemas/PortLoa" - description: Physical Port specification - PortRequest: - required: - - account - - connectivitySourceType - - encapsulation - - location - - physicalPortsSpeed - - physicalPortsType - - project - - type + $ref: '#/components/schemas/RoutingProtocolData' + RoutingProtocolBGPType: type: object properties: type: - $ref: "#/components/schemas/PortType" - physicalPortsSpeed: - minimum: 0 - type: integer - description: Physical Ports Speed in Mbps - physicalPortsType: + description: Routing protocol type type: string - description: Physical Ports Type. 10GBASE_SMF is only applicable for IX ports enum: - - 1000BASE_LX - - 10GBASE_LR - - 100GBASE_LR4 - - 10GBASE_ER - - 1000BASE_SX - - 10GBASE_SMF - - 400GBASE_LR4 - physicalPortsCount: + - BGP + name: + type: string + example: My-BGP-route-1 + bgpIpv4: + $ref: '#/components/schemas/BGPConnectionIpv4' + bgpIpv6: + $ref: '#/components/schemas/BGPConnectionIpv6' + customerAsn: + description: Customer asn type: integer - connectivitySourceType: + format: int64 + bgpAuthKey: + description: BGP authorization key type: string - description: Port connectivity type - enum: - - COLO - - BMMR - - REMOTE - bmmrType: - type: string - description: BMMR Type is mandatory when connectivitySourceType is BMMR - enum: - - SELF - - EQUINIX - project: - $ref: "#/components/schemas/Project" - order: - $ref: "#/components/schemas/PortOrder" - account: - $ref: "#/components/schemas/SimplifiedAccountRequest" - serviceType: - type: string - description: Port service Type - deprecated: true - enum: - - EPL - - MSP - serviceCode: - $ref: "#/components/schemas/PortServiceCode" - bandwidth: - minimum: 0 - type: integer - description: Equinix assigned response attribute for Port bandwidth in Mbps - deprecated: true - location: - $ref: "#/components/schemas/SimplifiedLocationRequest" - 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: + asOverrideEnabled: + description: Enable AS number override type: boolean - description: Indicates whether Link Aggregation Group (LAG) is enabled on this port - package: - $ref: "#/components/schemas/Package" - settings: - $ref: "#/components/schemas/PortSettings" - notifications: - type: array - description: Notification preferences - items: - $ref: "#/components/schemas/PortNotification" - 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: PortRequest is the Request Object for creating single and bulk fabric ports - 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" - Error: + bfd: + $ref: '#/components/schemas/RoutingProtocolBFD' required: - - errorCode - - errorMessage + - type + RoutingProtocolDirectType: type: object properties: - errorCode: - pattern: ^EQ-\d{7}$ - type: string - errorMessage: - type: string - correlationId: - type: string - details: + type: + description: Routing protocol type type: string - help: + enum: + - DIRECT + name: type: string - additionalInfo: - type: array - items: - $ref: "#/components/schemas/PriceError_additionalInfo" - description: Error Response with details - LinkProtocolGetResponse: - type: object - properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - items: - $ref: "#/components/schemas/LinkProtocolResponse" - description: List of Vlans - PortV4SearchRequest: + example: My-direct-route-1 + directIpv4: + $ref: '#/components/schemas/DirectConnectionIpv4' + directIpv6: + $ref: '#/components/schemas/DirectConnectionIpv6' required: - - filter - 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 + RoutingProtocolBase: type: object properties: - and: - $ref: "#/components/schemas/PortExpressions" - or: - $ref: "#/components/schemas/PortExpressions" - property: - $ref: "#/components/schemas/PortSearchFieldName" - operator: + type: + description: Routing protocol type type: string enum: - - = - - "!=" - - ">" - - ">=" - - < - - <= - - LIKE - - ILIKE - - IN - - NOT IN - - BETWEEN - values: - type: array - items: - type: string - description: | - Either use 'and' for AND operations, 'or' for OR operations, or specify 'property', 'operator', and 'values' for field filtering. Only one of these patterns should be used at a time. - PortExpressions: - type: array - items: - $ref: "#/components/schemas/PortExpression" - PortSearchFieldName: - type: string - description: Possible field names to use on filters - enum: - - /device/name - - /physicalPorts/tether/crossConnectId - - /physicalPorts/interface/name - - /state - - /project/projectId - - /uuid - - /name - - /account/orgId - - /account/accountNumber - - /location/metroCode - - /operation/maintenanceStatus - - /operation/lockEnabled - x-enum-deprecations: - /device/name: true - /physicalPorts/interface/name: true - PortSortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/PortSortDirection" - property: - $ref: "#/components/schemas/PortSortBy" - AllPortPackagesResponse: + - BGP + - DIRECT required: - - data - type: object - properties: - data: - type: array - description: List of Port Packages - items: - $ref: "#/components/schemas/PortPackage" - description: Port Packages response - GetAllConnectionRouteAggregationsResponse: + - type + oneOf: + - $ref: '#/components/schemas/RoutingProtocolBGPType' + - $ref: '#/components/schemas/RoutingProtocolDirectType' + ConnectionRoutingProtocolPostRequest: type: object + description: Create connection routing protocolpost request properties: - pagination: - $ref: "#/components/schemas/Pagination" data: + description: Connection routing protocol configuration type: array - description: List of Route Aggregations attached to a Connection items: - $ref: "#/components/schemas/ConnectionRouteAggregationData" - RouteAggregationId: + $ref: '#/components/schemas/RoutingProtocolBase' + ConnectionRoutingProtocolPatchRequest: + description: Patch connection routing protocol request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/ConnectionChangeOperation' + BGPActions: + description: BGP action type type: string - description: Route Aggregations UUID - example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - ConnectionRouteAggregationData: + enum: + - CLEAR_BGPIPV4 + - CLEAR_BGPIPV6 + - CLEAR_BGPIPV4_INBOUND + - CLEAR_BGPIPV6_INBOUND + - RESET_BGPIPV4 + - RESET_BGPIPV6 + BGPActionStates: + description: BGP action state + type: string + enum: + - PENDING + - FAILED + - SUCCEEDED + BGPActionData: 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 + description: Routing Protocol URI + example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/69762051-85ed-4d13-b6b4-e32e93c672b5/actions uuid: + description: Routing protocol identifier type: string - description: Route Aggregation identifier format: uuid - example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - attachmentStatus: + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + type: + $ref: '#/components/schemas/BGPActions' + description: type: string - enum: - - ATTACHING - - ATTACHED - - DETACHED - - DETACHING - - FAILED - - PENDING_BGP_CONFIGURATION - changeLog: - $ref: "#/components/schemas/Changelog" - GetAllConnectionRouteFiltersResponse: + description: BGP action description + state: + $ref: '#/components/schemas/BGPActionStates' + changelog: + $ref: '#/components/schemas/Changelog' + BGPActionsBulkData: + description: List of BGP Actions type: object properties: pagination: - $ref: "#/components/schemas/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: + $ref: '#/components/schemas/BGPActionData' + BGPActionRequest: + description: BGP action request 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 - changeLog: - $ref: "#/components/schemas/Changelog" - ConnectionRouteFiltersBase: - required: - - direction - type: object - properties: - direction: - type: string - description: Route Filter direction to attach to a connection - enum: - - INBOUND - - OUTBOUND - RouteFiltersBase: + $ref: '#/components/schemas/BGPActions' required: - - name - - project - type + RoutingProtocolChangeOperation: + description: Routing Protocol change operation data 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: + op: + description: Handy shortcut for operation name 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: + - add + - replace + - remove + path: + description: path inside document leading to updated parameter 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: + example: / + value: + $ref: '#/components/schemas/RoutingProtocolBase' + required: + - op + - path + - value + RoutingProtocolChangeData: + description: Current state of latest Routing Protocol change type: object properties: status: - type: string description: Current outcome of the change flow + type: string enum: - COMPLETED - FAILED - REQUESTED createdBy: type: string - description: Created by user key + description: Created by User Key createdDateTime: - type: string description: Set when change flow starts + type: string format: date-time updatedBy: type: string - description: Updated by user key + description: Updated by User Key updatedDateTime: - type: string description: Set when change object is updated + type: string format: date-time information: - type: string description: Additional information + type: string data: - $ref: "#/components/schemas/RouteFiltersChangeOperation" - description: Current state of latest route filter change + $ref: '#/components/schemas/RoutingProtocolChangeOperation' allOf: - - $ref: "#/components/schemas/RouteFiltersChange" - GetRouteFilterGetConnectionsResponse: + - $ref: '#/components/schemas/RoutingProtocolChange' + RoutingProtocolChangeDataResponse: + description: List of network changes type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: type: array - description: List of Connections using a Route Filter items: - $ref: "#/components/schemas/RouteFilterConnectionsData" - RouteFiltersSearchRequest: + $ref: '#/components/schemas/RoutingProtocolChangeData' + PublicPeeringConnectionRequest: type: object + description: Public Peering Connection properties: - filter: - $ref: "#/components/schemas/SearchFilter" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/RouteFilterSortCriteria" - description: Search route filters - RouteFiltersSearchResponse: + uuid: + type: string + format: uuid + description: connection id + example: b44c6e6c-2c36-4488-b3f1-47064357b5b4 + ExchangeServiceRequestBgp: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + domainName: + type: string + description: Domain name for BGP + example: gw01.sin.example.net + minLength: 1 + maxLength: 253 + asSet: + type: string + description: AS-SET used to filter the prefixes announced by the customer + example: AS-EC-SV + minLength: 2 + maxLength: 48 + mlpeEnabled: + type: boolean + description: Whether Multi-Lateral Peering Exchange (MLPE) is enabled + example: true + default: false + md5AuthKey: + type: string + description: MD5 key for BGP + example: TestAuthKey12345 + minLength: 1 + maxLength: 255 + rcMd5AuthKey: + type: string + description: RC MD5 key for BGP + example: TestAuthKey123456 + minLength: 1 + maxLength: 255 + prefixes: type: array - description: List of route filters + description: List of IP prefix items: - $ref: "#/components/schemas/RouteFiltersData" - GetRouteFilterRulesResponse: + type: string + description: IP prefix + maxPrefixLimit: + type: integer + description: Max Prefix Limit number + format: int64 + example: 300 + prependSelfEnabled: + type: boolean + description: Prepend Self Enabled + example: true + default: true + RoutingProtocolRequest: 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 + customerAsn: + type: integer + description: Customer Autonomous System Number (ASN) + example: 1100 + macAddress: + type: string + description: MAC address of the customer interface + example: '00:11:22:33:44:55' + bgpIpv4: + $ref: '#/components/schemas/ExchangeServiceRequestBgp' + bgpIpv6: + $ref: '#/components/schemas/ExchangeServiceRequestBgp' + ExchangeServiceOrder: type: object + description: Ordering and billing reference details for this Exchange Service. properties: - name: + purchaseOrderNumber: type: string - example: Private-subnet-filter - description: + description: Purchase order number reference. + example: '156576' + orderId: + description: Equinix-assigned order identifier. type: string - description: Customer-provided Route Filter Rule description - prefix: + readOnly: true + customerReferenceId: + description: Your own reference for this Exchange Service. type: string - example: 192.168.0.0/24 - prefixMatch: + orderNumber: + description: Equinix order reference number. type: string - example: orlonger, exact - default: orlonger - RouteFilterRulesData: - type: object - properties: - href: + example: 1-129105284100 + orderLineItemNumber: + description: Order Reference Number for Sales Assisted Order 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: + readOnly: true + domainOrderNumber: + description: product domain Order Number for Sales Assisted Order type: string - description: Route filter type - enum: - - BGP_IPv4_PREFIX_FILTER_RULE - - BGP_IPv6_PREFIX_FILTER_RULE + readOnly: true uuid: + description: Equinix-assigned order identifier, this is a derived response attribute type: string - description: Route Filter Rule identifier format: uuid - example: 65b025ef-022b-4180-85cf-82cfc1ab655b + readOnly: true + ExchangeServiceNotification: + type: object + properties: + type: + description: Internet Exchange Service Notification Type + type: string + enum: + - NOTIFICATION + - TECHNICAL + - PEERING + - ESCALATION + - ORDERING + registeredUsers: + description: Array of registered users + type: array + items: + type: string + required: + - type + - registeredUsers + ExchangeServiceCreateRequest: + type: object + properties: + type: + type: string + example: IX + enum: + - IX + description: Internet Exchange Service type name: type: string - example: Private-subnet-filter-2 + example: ix_exchange_service + description: Customer-provided internet exchange service name + minLength: 1 + maxLength: 50 description: type: string - description: Customer-provided Route Filter Rule description - state: - $ref: "#/components/schemas/RouteFilterRuleState" - prefixMatch: + example: ix_exchange_service + description: Customer-provided internet exchange service description + minLength: 1 + maxLength: 255 + publicPeeringConnection: + $ref: '#/components/schemas/PublicPeeringConnectionRequest' + routingProtocol: + $ref: '#/components/schemas/RoutingProtocolRequest' + order: + $ref: '#/components/schemas/ExchangeServiceOrder' + project: + $ref: '#/components/schemas/Project' + account: + $ref: '#/components/schemas/SimplifiedAccount' + notifications: + description: Preferences for notifications on Internet Exchange Service configuration or status changes + type: array + items: + $ref: '#/components/schemas/ExchangeServiceNotification' + required: + - type + - name + - publicPeeringConnection + - routingProtocol + PublicPeeringConnectionResponse: + type: object + properties: + type: type: string - description: prefix matching operator - example: exact - default: orlonger - change: - $ref: "#/components/schemas/RouteFilterRulesChange" - action: + format: enum + description: Connection type IX_VC + example: IX_VC + href: type: string - enum: - - PERMIT - - DENY - prefix: + format: string + description: URI + example: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 + uuid: 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: + format: uuid + description: uuid + example: b44c6e6c-2c36-4488-b3f1-47064357b5b4 + ExchangeServiceResponseBgp: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + customerPeerIp: + type: string + description: Customer peer IP address + example: 12.1.1.1 + domainName: + type: string + description: Domain name for BGP + example: ix-v4.gw01.sin.example.net + primaryRouteServerIp: + type: string + description: Primary route server IP address with prefix length + example: 206.126.239.251/22 + secondaryRouteServerIp: + type: string + description: Secondary route server IP address with prefix length + example: 206.126.239.252/22 + asSet: + type: string + description: AS-SET used to filter the prefixes announced by the customer + example: AS-EC-SV + mlpeEnabled: + type: boolean + description: Whether Multi-Lateral Peering Exchange (MLPE) is enabled + example: true + md5AuthKey: + type: string + description: MD5 key for BGP + example: TestAuthKey12345 + rcMd5AuthKey: + type: string + description: RC MD5 key for BGP + example: TestAuthKey123456 + prefixes: type: array + description: List of IP prefix 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: string + description: IP prefix + maxPrefixLimit: + type: integer + description: Max Prefix Limit number + format: int64 + example: 300 + prependSelfEnabled: + type: boolean + description: Prepend Self Enabled + example: true + RouteCollector: type: object + description: Route Collector properties: - status: + asn: + type: integer + format: int64 + description: Route Collector ASN + example: 1238 + ipV4: type: string - description: Current outcome of the change flow - enum: - - COMPLETED - - FAILED - - REQUESTED + description: Route Collector ipV4 address + example: 206.126.239.250/22 + ipV6: + type: string + description: Route Collector ipV6 address + example: 2001:504:0:2:0:6:5517:1/64 + RoutingProtocolResponse: + type: object + properties: + customerAsn: + type: integer + description: Customer Autonomous System Number (ASN) + example: 1100 + macAddress: + type: string + description: MAC address of the customer interface + example: '00:11:22:33:44:55' + vlan: + type: integer + format: int64 + description: VLAN ID + example: 3292 + routeServerAsn: + type: integer + format: int64 + description: Equinix Route Server ASN + example: 1100 + bgpIpv4: + $ref: '#/components/schemas/ExchangeServiceResponseBgp' + bgpIpv6: + $ref: '#/components/schemas/ExchangeServiceResponseBgp' + routeCollector: + $ref: '#/components/schemas/RouteCollector' + PlatformChangelog: + description: Change log + type: object + properties: createdBy: type: string + example: johnsmith description: Created by User Key createdDateTime: type: string - description: Set when change flow starts format: date-time + example: '2020-11-06T07:00:00Z' + description: Created by Date and Time updatedBy: type: string + example: johnsmith 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: + example: '2020-11-06T07:00:00Z' + description: Updated by Date and Time + deletedBy: + type: string + example: johnsmith + description: Deleted by User Key + deletedDateTime: + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + description: Deleted by Date and Time + ExchangeServiceAdditionalInfo: type: object + description: Additional information regarding the specified Exchange Service properties: - data: - type: array - description: Route Filter Rule configuration - items: - $ref: "#/components/schemas/RouteFilterRulesBase" - description: Create Route Filter Rule POST request - RouteFilterRulesSearchRequest: + errorCode: + type: string + description: Error code shown if an operation on the Exchange Service fails + errorMessage: + type: string + description: Generic message shown if an operation on the Exchange Service fails + ExchangeServiceResponse: type: object properties: - filter: - $ref: "#/components/schemas/RouteFilterRulesFilter" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + href: + type: string + description: Internet Exchange Service URI + example: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 + uuid: + type: string + format: uuid + description: Internet Exchange Service identifier + example: a8ba52de-faae-43b5-b0b1-6904d37ee011 + type: + type: string + description: Internet Exchange Service Type + example: IX + default: IX + enum: + - IX + name: + type: string + description: Name + example: ix_exchange_service + bandwidth: + type: integer + description: bandwidth in Mbps + example: 400000 + description: + type: string + description: Description + example: ix_exchange_service + state: + type: string + description: State + example: PROVISIONING + enum: + - PROVISIONING + - PROVISIONING_FAILED + - PENDING_ACTIVATION + - ACTIVATING + - ACTIVATING_FAILED + - PROVISIONED + - REPROVISIONING + - REPROVISIONING_FAILED + - DEPROVISIONING + - DEPROVISIONED + - DEPROVISIONING_FAILED + location: + $ref: '#/components/schemas/SimplifiedLocation' + publicPeeringConnection: + $ref: '#/components/schemas/PublicPeeringConnectionResponse' + routingProtocol: + $ref: '#/components/schemas/RoutingProtocolResponse' + order: + $ref: '#/components/schemas/ExchangeServiceOrder' + project: + $ref: '#/components/schemas/Project' + account: + $ref: '#/components/schemas/SimplifiedAccount' + notifications: + description: Preferences for notifications on Internet Exchange Service configuration or status changes type: array items: - $ref: "#/components/schemas/RouteFilterRuleSortCriteria" - description: Search route filter rules - RouteFilterRulesFilter: - description: Top-level filter that can be either an AND expression or OR expression - anyOf: - - $ref: "#/components/schemas/RouteFilterRuleAndExpression" - - $ref: "#/components/schemas/RouteFilterRuleOrExpression" - RouteFilterRuleAndExpression: + $ref: '#/components/schemas/ExchangeServiceNotification' + changelog: + $ref: '#/components/schemas/PlatformChangelog' + additionalInfo: + $ref: '#/components/schemas/ExchangeServiceAdditionalInfo' + ExchangeServiceOpEnum: + description: the operation to be performed + type: string + enum: + - replace + - add + ExchangeServicePath: + description: | + ### A JSON Pointer path. + * `/name` - Name of the Internet Exchange Service + * `/description` - Description of the Internet Exchange Service + * `routingProtocol/macAddress` - MAC Address + * `routingProtocol/bgpIpv4/domainName` - Domain Name for BGP IPv4 + * `routingProtocol/bgpIpv4/asSet` - AS Set for BGP IPv4 + * `routingProtocol/bgpIpv4/md5AuthKey` - MD5 Auth Key for BGP IPv4 + * `routingProtocol/bgpIpv4/rcMd5AuthKey` - RC MD5 Auth Key for BGP IPv4 + * `routingProtocol/bgpIpv4/ipPrefixes` - IP Prefixes for BGP IPv4 + * `routingProtocol/bgpIpv6/mlpeEnabled` - MLPE Enabled for BGP IPv4 + * `routingProtocol/bgpIpv6/domainName`- Domain Name for BGP IPv6 + * `routingProtocol/bgpIpv6/asSet`- AS Set for BGP IPv6 + * `routingProtocol/bgpIpv6/md5AuthKey` - MD5 Auth Key for BGP IPv6 + * `routingProtocol/bgpIpv6/rcMd5AuthKey` - RC MD5 Auth Key for BGP IPv6 + * `routingProtocol/bgpIpv6/ipPrefixes` - IP Prefixes for BGP IPv6 + * `routingProtocol/bgpIpv6/mlpeEnabled` - MLPE Enabled for BGP IPv6 + type: string + ExchangeServiceReplaceOperation: + description: Replace attribute value or sub-resource in the existing model + type: object + required: + - op + - path + - value + properties: + op: + $ref: '#/components/schemas/ExchangeServiceOpEnum' + path: + $ref: '#/components/schemas/ExchangeServicePath' + value: + description: value to replace with + JsonPatch: + type: array + items: + $ref: '#/components/schemas/ExchangeServiceReplaceOperation' + ExchangeServiceSearchExpression: + oneOf: + - $ref: '#/components/schemas/ExchangeServiceAndExpression' + - $ref: '#/components/schemas/ExchangeServiceOrExpression' + - $ref: '#/components/schemas/ExchangeServicePropertyExpression' + ExchangeServiceAndExpression: type: object + required: + - and properties: and: - maxItems: 8 - minItems: 1 type: array items: - $ref: "#/components/schemas/RouteFilterRuleExpression" - description: AND expression containing multiple filter expressions - RouteFilterRuleExpression: - description: Filter expression that can be AND, OR, or a simple expression - anyOf: - - $ref: "#/components/schemas/RouteFilterRuleAndExpression" - - $ref: "#/components/schemas/RouteFilterRuleOrExpression" - - $ref: "#/components/schemas/RouteFilterRuleSimpleExpression" - RouteFilterRuleOrExpression: + $ref: '#/components/schemas/ExchangeServiceSearchExpression' + ExchangeServiceOrExpression: type: object + required: + - or properties: or: - maxItems: 8 - minItems: 1 type: array items: - $ref: "#/components/schemas/RouteFilterRuleExpression" - description: OR expression containing multiple filter expressions - RouteFilterRuleSimpleExpression: + $ref: '#/components/schemas/ExchangeServiceSearchExpression' + ExchangeServicePropertyExpression: type: object + required: + - property + - operator + - values properties: property: + description: Possible field names to use on filters type: string - description: | - Possible field names to use on filters: - * `/type` - Route Filter Rules Type - * `/name` - Route Filter Rules Name - * `/uuid` - Route Filter Rules uuid - * `/state` - Route Filter Rules status - * `/prefix` - Route Filter Rule Prefix - * `/prefixMatch` - Route Filter Rule Prefix Match - example: /name + enum: + - /project/projectId + - /uuid + - /state + - /name + - /bandwidth + - /changelog/createdDateTime + - /changelog/updatedDateTime + - /changelog/deletedDateTime + - /location/metroCode operator: type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `[NOT] LIKE` - (not) like - * `[NOT] IN` - (not) in - * `ILIKE` - case-insensitive like - example: = + enum: + - '=' + - '!=' + - BETWEEN + - < + - <= + - '>' + - '>=' + - LIKE + - ILIKE + - IN values: - maxItems: 8 - minItems: 1 type: array + minItems: 1 items: type: string - example: Route_Filter_Rule_Demo - description: Simple filter expression with property, operator, and values - RouteFilterRuleSortCriteria: + ExchangeServiceSearchSortCriteria: type: object properties: direction: - $ref: "#/components/schemas/RouteFilterRuleSortDirection" + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC property: - $ref: "#/components/schemas/RouteFilterRuleSortBy" - RouteFilterRuleSortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - RouteFilterRuleSortBy: - type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime - enum: - - /type - - /uuid - - /name - - /state - - /prefix - - /prefixMatch - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - RouteFilterRulesSearchResponse: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + enum: + - /name + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + ExchangeServiceSearchRequest: type: object + description: Search requests containing criteria properties: + filter: + $ref: '#/components/schemas/ExchangeServiceSearchExpression' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array - description: List of route filter rules items: - $ref: "#/components/schemas/RouteFilterRulesData" - 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: + $ref: '#/components/schemas/ExchangeServiceSearchSortCriteria' + ExchangeServiceSearchResponse: + description: List of Internet Exchange Service type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/ExchangeServiceSearchSortCriteria' 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: + $ref: '#/components/schemas/ExchangeServiceResponse' + ExchangeServiceActionRequest: type: object + required: + - type + description: Internet Exchange Service Action Request properties: - status: + type: 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 + - EXCHANGE_SERVICE_ACTIVATE + - EXCHANGE_SERVICE_VALIDATE + - EXCHANGE_SERVICE_RETRY_PROVISION + ExchangeServiceActionResponse: 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" - RouteAggregationsSearchRequest: - type: object - properties: - filter: - $ref: "#/components/schemas/SearchFilter" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/RouteAggregationSortCriteria" - description: Search route aggregations - RouteAggregationsSearchResponse: + - $ref: '#/components/schemas/ExchangeServiceActionRequest' + - type: object + properties: + href: + type: string + description: Internet Exchange Service Action URI + example: https://api.equinix.com/fabric/v4/exchangeService/e8ba52fe-faae-43b5-b0b1-6904d37ee011/actions/a8ba52de-faae-43b5-b0b1-6904d37ee011 + uuid: + type: string + format: uuid + description: Action identifier + example: a8ba52de-faae-43b5-b0b1-6904d37ee011 + description: + type: string + description: Action description + example: Action description text + minLength: 0 + maxLength: 255 + state: + type: string + description: State + example: PENDING + enum: + - PENDING + - SUCCEEDED + - FAILED + changelog: + $ref: '#/components/schemas/PlatformChangelog' + InternetAccessServiceType: + type: string + enum: + - SINGLE_IA + - DUAL_IA + x-enum-varnames: + - SINGLE_IA + - DUAL_IA + description: Type of the service, either single or dual internet access + InternetAccessRoutingProtocolRequest: type: object + required: + - type + - customerRoutes properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + type: + $ref: '#/components/schemas/InternetAccessRoutingProtocolType' + customerRoutes: type: array - description: List of Route Aggregations + minItems: 1 + maxItems: 100 items: - $ref: "#/components/schemas/RouteAggregationsData" - GetRouteAggregationRulesResponse: + $ref: '#/components/schemas/InternetAccessCustomerRouteRequest' + discriminator: + propertyName: type + mapping: + BGP: '#/components/schemas/InternetAccessRoutingProtocolBgpRequest' + DIRECT: '#/components/schemas/InternetAccessRoutingProtocolDirectRequest' + STATIC: '#/components/schemas/InternetAccessRoutingProtocolStaticRequest' + InternetAccessConnectionBgpRequest: 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 + - uuid 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: + description: Unique identifier for the connection + InternetAccessExportPolicy: 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: + description: Denotes which routes should be advertised to the internet + example: FULL + enum: + - FULL + - DEFAULT + - FULL_DEFAULT + - PARTIAL + x-enum-varnames: + - FULL + - DEFAULT + - FULL_DEFAULT + - PARTIAL + InternetAccessCustomerAsnRange: type: string - description: Route Aggregation Rule Change UUID - format: uuid - example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 - RouteAggregationRulesChangeData: + description: Customer Autonomous System Number range. Based on the value a proper private ASN will be generated. + enum: + - BITS_16 + - BITS_32 + x-enum-varnames: + - BITS_16 + - BITS_32 + InternetAccessRoutingProtocolBgpRequest: + allOf: + - $ref: '#/components/schemas/InternetAccessRoutingProtocolRequest' + - type: object + required: + - exportPolicy + - connections + properties: + connections: + type: array + minItems: 1 + maxItems: 2 + items: + $ref: '#/components/schemas/InternetAccessConnectionBgpRequest' + exportPolicy: + $ref: '#/components/schemas/InternetAccessExportPolicy' + asn: + type: object + required: + - uuid + properties: + uuid: + type: string + format: uuid + description: Unique identifier of the ASN + example: ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91 + customerAsn: + type: integer + description: Customer ASN. Valid range is 1-64495 or 65536-4199999999. + format: int64 + example: 16220 + deprecated: true + bgpAuthKey: + type: string + description: BGP authentication key + example: SecretKey + customerAsnRange: + deprecated: true + $ref: '#/components/schemas/InternetAccessCustomerAsnRange' + InternetAccessPeeringIpv4Request: type: object properties: - status: - type: string - description: Current outcome of the change flow - enum: - - COMPLETED - - FAILED - - REQUESTED - createdBy: + equinixPeerIp: type: string - description: Created by User Key - createdDateTime: + pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + description: IPv4 address of the Equinix peering IP + equinixVrrpIp: type: string - description: Set when change flow starts - format: date-time - updatedBy: + pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + description: IPv4 address for Equinix VRRP IP + InternetAccessPeeringIpv6Request: + type: object + properties: + equinixPeerIp: type: string - description: Updated by User Key - updatedDateTime: + pattern: ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$ + description: IPv6 address of the Equinix peering IP + equinixVrrpIp: 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: + pattern: ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$ + description: IPv6 address for Equinix VRRP IP + InternetAccessConnectionDirectRequest: type: object + required: + - uuid properties: - data: - type: array - description: Route Aggregation Rule configuration - items: - $ref: "#/components/schemas/RouteAggregationRulesBase" - description: Create Route Aggregation Rule POST request - RouteAggregationRulesSearchRequest: + uuid: + type: string + format: uuid + description: Unique identifier for the connection + peeringIpv4: + $ref: '#/components/schemas/InternetAccessPeeringIpv4Request' + peeringIpv6: + $ref: '#/components/schemas/InternetAccessPeeringIpv6Request' + InternetAccessRoutingProtocolDirectRequest: + allOf: + - $ref: '#/components/schemas/InternetAccessRoutingProtocolRequest' + - type: object + required: + - connections + properties: + connections: + type: array + minItems: 1 + maxItems: 2 + items: + $ref: '#/components/schemas/InternetAccessConnectionDirectRequest' + InternetAccessConnectionStaticRequest: type: object + required: + - uuid properties: - filter: - $ref: "#/components/schemas/RouteAggregationRulesFilter" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/RouteAggregationRuleSortCriteria" - description: Search route aggregation rules - RouteAggregationRulesFilter: - description: Top-level filter that can be either an AND expression or OR expression - anyOf: - - $ref: "#/components/schemas/RouteAggregationRuleAndExpression" - - $ref: "#/components/schemas/RouteAggregationRuleOrExpression" - RouteAggregationRuleAndExpression: + uuid: + type: string + format: uuid + description: Unique identifier for the connection + InternetAccessRoutingProtocolStaticRequest: + allOf: + - $ref: '#/components/schemas/InternetAccessRoutingProtocolRequest' + - type: object + required: + - connections + properties: + connections: + type: array + minItems: 1 + maxItems: 2 + items: + $ref: '#/components/schemas/InternetAccessConnectionStaticRequest' + InternetAccessRoutingProtocolType: + type: string + enum: + - BGP + - DIRECT + - STATIC + x-enum-varnames: + - BGP + - DIRECT + - STATIC + InternetAccessIpBlockRequest: type: object + required: + - uuid properties: - and: - maxItems: 8 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/RouteAggregationRuleExpression" - description: AND expression containing multiple filter expressions - RouteAggregationRuleExpression: - description: Filter expression that can be AND, OR, or a simple expression - anyOf: - - $ref: "#/components/schemas/RouteAggregationRuleAndExpression" - - $ref: "#/components/schemas/RouteAggregationRuleOrExpression" - - $ref: "#/components/schemas/RouteAggregationRuleSimpleExpression" - RouteAggregationRuleOrExpression: + uuid: + type: string + format: uuid + description: Unique identifier for the IP Block + InternetAccessCustomerRouteRequest: type: object + required: + - ipBlock properties: - or: - maxItems: 8 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/RouteAggregationRuleExpression" - description: OR expression containing multiple filter expressions - RouteAggregationRuleSimpleExpression: + ipBlock: + $ref: '#/components/schemas/InternetAccessIpBlockRequest' + InternetAccessOrderRequest: type: object properties: - property: + purchaseOrderNumber: type: string - description: | - Possible field names to use on filters: - * `/type` - Route Aggregation Rules Type - * `/name` - Route Aggregation Rules Name - * `/uuid` - Route Aggregation Rules uuid - * `/state` - Route Aggregation Rules status - * `/prefix` - Route Aggregation Rule Prefix - example: /name - operator: + nullable: true + description: Purchase order number + orderNumber: type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `[NOT] LIKE` - (not) like - * `[NOT] IN` - (not) in - * `ILIKE` - case-insensitive like - example: = - values: - maxItems: 8 - minItems: 1 - type: array - items: - type: string - example: Route_Aggregation_Rule_Demo - description: Simple filter expression with property, operator, and values - RouteAggregationRuleSortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/RouteAggregationRuleSortDirection" - property: - $ref: "#/components/schemas/RouteAggregationRuleSortBy" - RouteAggregationRuleSortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - RouteAggregationRuleSortBy: + nullable: true + description: Order Number + orderLine: + type: string + nullable: true + description: Order Line Number + InternetAccessBillingType: type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime enum: - - /type - - /uuid - - /name - - /state - - /prefix - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - RouteAggregationRulesSearchResponse: + - FIXED + - USAGE_BASED + - BURST_BASED + x-enum-varnames: + - FIXED + - USAGE_BASED + - BURST_BASED + InternetAccessAccount: type: object + required: + - accountNumber properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: List of route aggregation rules - items: - $ref: "#/components/schemas/RouteAggregationRulesData" - CloudRouterPostRequest: + accountNumber: + type: string + description: Account number + href: + type: string + format: uri + description: Account URL path + example: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 + InternetAccessPostRequest: + type: object required: - - location - - name - - notifications - - package - type - allOf: - - $ref: "#/components/schemas/CloudRouterPostRequestBase" - CloudRouterPostRequestBase: - type: object + - name + - routingProtocol + - billing + - project + - account properties: type: - type: string - enum: - - XF_ROUTER + $ref: '#/components/schemas/InternetAccessServiceType' name: type: string - description: Customer-provided Cloud Router name - location: - $ref: "#/components/schemas/SimplifiedLocationWithoutIBX" - package: - $ref: "#/components/schemas/CloudRouterPostRequestPackage" + description: The name of the EIA Service + bandwidth: + type: integer + description: Bandwidth of the service + bandwidthCommit: + type: integer + description: Minimum bandwidth commit for burst billing variant of the service + routingProtocol: + $ref: '#/components/schemas/InternetAccessRoutingProtocolRequest' order: - $ref: "#/components/schemas/Order" + $ref: '#/components/schemas/InternetAccessOrderRequest' + billing: + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/InternetAccessBillingType' project: - $ref: "#/components/schemas/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: + $ref: '#/components/schemas/InternetAccessAccount' + InternetAccessServiceState: + type: string + enum: + - PROVISIONING + - PROVISIONED + - FAILED + - DEPROVISIONING + - DEPROVISIONED + x-enum-varnames: + - PROVISIONING + - PROVISIONED + - FAILED + - DEPROVISIONING + - DEPROVISIONED + description: Current state of the service + InternetAccessChange: type: object + required: + - href 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/CloudRouterPostRequestBase" - RouterId: - type: string - description: Cloud Router UUID - format: uuid - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - CloudRouterReadResponse: + description: URI of the change object + InternetAccessLocation: type: object + required: + - metroHref + - metroCode + - ibx + - region properties: - type: + metroHref: type: string - enum: - - IC_ROUTER - - XF_ROUTER - name: + format: uri + description: Metro URL path for the linked resource + example: https://api.equinix.com/fabric/v4/metros/WA + metroCode: 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: + pattern: ^[A-Z]{2}$ + example: WA + description: Code representing the metro + region: + type: string + example: EMEA + enum: + - APAC + - EMEA + - AMER + description: Geographic region + ibx: + type: string + description: IBX data center code + example: WA1 + InternetAccessRoutingProtocol: + type: object + required: + - type + - customerRoutes + - connections + properties: + type: + $ref: '#/components/schemas/InternetAccessRoutingProtocolType' + customerRoutes: + type: array + items: + $ref: '#/components/schemas/InternetAccessCustomerRoute' + connections: type: array - description: Preferences for notifications on connection configuration or status changes items: - $ref: "#/components/schemas/SimplifiedNotification" + $ref: '#/components/schemas/InternetAccessConnection' + discriminator: + propertyName: type + mapping: + BGP: '#/components/schemas/InternetAccessRoutingProtocolBgp' + DIRECT: '#/components/schemas/InternetAccessRoutingProtocolDirect' + STATIC: '#/components/schemas/InternetAccessRoutingProtocolStatic' + InternetAccessBgpAuthType: + type: string + description: Indicates whether a BGP authentication key is configured. AUTH_KEY when bgpAuthKey is set, NONE otherwise. + enum: + - AUTH_KEY + - NONE + x-enum-varnames: + - AUTH_KEY + - NONE + default: NONE + example: AUTH_KEY + InternetAccessRoutingProtocolBgp: + allOf: + - $ref: '#/components/schemas/InternetAccessRoutingProtocol' + - type: object + required: + - exportPolicy + properties: + exportPolicy: + $ref: '#/components/schemas/InternetAccessExportPolicy' + asn: + type: object + required: + - uuid + properties: + href: + type: string + description: URI of the ASN resource + example: https://api.equinix.com/fabric/v4/asns/ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91 + uuid: + type: string + format: uuid + description: Unique identifier of the ASN + example: ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91 + customerAsn: + type: integer + format: int64 + description: Customer ASN. Valid range is 1-64495 or 131072-4199999999. Currently this option is only available for EIA over dedicated port. + example: 11111 + deprecated: true + bgpAuthKey: + type: string + description: BGP authentication key. This field is deprecated and will be removed in future releases. Please use bgpAuthType instead to determine if a BGP authentication key is configured. + example: SecretKey + deprecated: true + bgpAuthType: + $ref: '#/components/schemas/InternetAccessBgpAuthType' + customerAsnRange: + deprecated: true + $ref: '#/components/schemas/InternetAccessCustomerAsnRange' + InternetAccessRoutingProtocolDirect: + allOf: + - $ref: '#/components/schemas/InternetAccessRoutingProtocol' + InternetAccessRoutingProtocolStatic: + allOf: + - $ref: '#/components/schemas/InternetAccessRoutingProtocol' + InternetAccessIpBlock: + type: object + required: + - href + - uuid + 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 + description: URI of the IP block uuid: type: string - description: Equinix-assigned access point identifier format: uuid - example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 - state: - $ref: "#/components/schemas/CloudRouterAccessPointState" - equinixAsn: + description: Unique identifier for the IP block + InternetAccessCustomerRoute: + type: object + properties: + ipBlock: + $ref: '#/components/schemas/InternetAccessIpBlock' + InternetAccessPeeringIpv4: + type: object + properties: + prefix: + type: string + pattern: ^([01]?\d\d?|2[0-4]\d|25[0-5])(?:\.(?:[01]?\d\d?|2[0-4]\d|25[0-5])){3}/(?:[1-9]|[12]\d|3[0-2])$ + description: IPv4 prefix for the peering connection + prefixLength: type: integer - description: Equinix ASN - format: int64 - example: 30000 - connectionsCount: - minimum: 0 + minimum: 1 + maximum: 32 + description: Determines the size of subnet + example: 30 + equinixPeerIp: + type: string + pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + description: IPv4 peering IP address for Equinix side + customerPeerIp: + type: string + pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + description: IPv4 peering IP address for customer side + equinixVrrpIp: + type: string + pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + description: IPv4 address for Equinix VRRP IP + customerVrrpIp: + type: string + pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + description: IPv4 address for customer VRRP IP + InternetAccessPeeringIpv6: + type: object + properties: + prefix: + type: string + description: IPv6 prefix for the peering connection + prefixLength: 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 read response object - CloudRouterUpdateRequest: - minItems: 1 - type: array - description: Fabric Cloud Router Update Request - items: - $ref: "#/components/schemas/CloudRouterChangeOperation" - ActionState: - $ref: "#/components/schemas/CloudRouterActionState" - CloudRouterActionState: - type: string - description: Cloud router action state - enum: - - SUCCEEDED - - FAILED - - PENDING - CloudRouterActionsSearchResponse: + minimum: 8 + maximum: 128 + description: Determines the size of subnet + example: 64 + equinixPeerIp: + type: string + description: IPv6 peering IP address for Equinix side + customerPeerIp: + type: string + description: IPv6 peering IP address for customer side + equinixVrrpIp: + type: string + description: IPv6 address for Equinix VRRP IP + customerVrrpIp: + type: string + description: IPv6 address for customer VRRP IP + InternetAccessConnection: type: object + required: + - href + - uuid properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/CloudRouterActionResponse" - CloudRouterActionRequest: + href: + type: string + format: uri + description: URI of the connection + uuid: + type: string + format: uuid + description: Unique identifier for the connection + peeringIpv4: + $ref: '#/components/schemas/InternetAccessPeeringIpv4' + peeringIpv6: + $ref: '#/components/schemas/InternetAccessPeeringIpv6' + InternetAccessBilling: + type: object required: - type - type: object properties: type: - $ref: "#/components/schemas/CloudRouterActionType" - connection: - $ref: "#/components/schemas/RouterActionsConnection" - description: Cloud router action request - CloudRouterActionResponse: + $ref: '#/components/schemas/InternetAccessBillingType' + enabled: + type: boolean + description: Indicates whether the billing is enabled + startDate: + type: string + format: date-time + description: The start date for the billing period + InternetAccessOrder: + allOf: + - $ref: '#/components/schemas/Order' + - type: object + properties: + href: + type: string + format: uri + description: Order URI + example: https://api.equinix.com/colocations/v2/orders/100200300 + InternetAccessUseCase: + type: string + enum: + - MAIN + - MANAGEMENT_ACCESS + x-enum-varnames: + - MAIN + - MANAGEMENT_ACCESS + InternetAccessService: + type: object required: - - changeLog - - state + - href - type - uuid - type: object + - name + - state + - change + - routingProtocol + - billing + - account + - project + - order + - changeLog + - useCase properties: + href: + type: string + format: uri + description: Service URL path + example: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 type: - $ref: "#/components/schemas/CloudRouterActionType" + $ref: '#/components/schemas/InternetAccessServiceType' uuid: type: string format: uuid - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - description: + description: Unique identifier for the EIA Service + name: type: string - example: description + description: The name of the EIA Service + bandwidth: + type: integer + description: Bandwidth of the service + bandwidthCommit: + type: integer + description: Minimum bandwidth commit for burst billing variant of the service state: - $ref: "#/components/schemas/CloudRouterActionState" + $ref: '#/components/schemas/InternetAccessServiceState' + change: + $ref: '#/components/schemas/InternetAccessChange' + locations: + type: array + items: + $ref: '#/components/schemas/InternetAccessLocation' + description: List of locations associated with the service + routingProtocol: + $ref: '#/components/schemas/InternetAccessRoutingProtocol' + billing: + $ref: '#/components/schemas/InternetAccessBilling' + account: + $ref: '#/components/schemas/InternetAccessAccount' + project: + $ref: '#/components/schemas/Project' + order: + $ref: '#/components/schemas/InternetAccessOrder' changeLog: - $ref: "#/components/schemas/Changelog" - href: + $ref: '#/components/schemas/Changelog' + useCase: + $ref: '#/components/schemas/InternetAccessUseCase' + SearchSortItem: + type: object + required: + - direction + - property + properties: + direction: 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" - router: - $ref: "#/components/schemas/RouterActionsRouter" - description: Cloud router actions response object - CloudRouterActionsSearchRequest: + enum: + - ASC + - DESC + example: ASC + property: + type: string + SearchSort: + type: array + items: + $ref: '#/components/schemas/SearchSortItem' + InternetAccessSearchRequest: type: object properties: - filter: - $ref: "#/components/schemas/CloudRouterActionsSearchFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" + $ref: '#/components/schemas/PaginationRequest' + filter: + $ref: '#/components/schemas/SearchExpression' sort: - type: array - items: - $ref: "#/components/schemas/CloudRouterActionsSearchSortCriteria" - description: Search requests containing criteria - CloudRouterActionsSearchFilters: + $ref: '#/components/schemas/SearchSort' + InternetAccessServices: type: object + required: + - pagination + - sort + - data properties: - and: - maxItems: 8 + pagination: + $ref: '#/components/schemas/Pagination' + sort: + $ref: '#/components/schemas/SearchSort' + data: type: array items: - $ref: "#/components/schemas/CloudRouterActionsSearchFilter" - CloudRouterActionsSearchFilter: + $ref: '#/components/schemas/InternetAccessService' + InternetAccessPatchOperationUpdateAllowedOp: + type: string + enum: + - replace + - add + - remove + description: Allowed patch operations. + InternetAccessPatchOperationUpdateAllowedPath: + type: string + description: Allowed patch paths for Internet Access update. + pattern: ^(\/name|\/bandwidth|\/bandwidthCommit|\/routingProtocol\/customerRoutes(?:\[@\.ipBlock\.uuid=[A-Fa-f0-9-]+\])?|\/order\/purchaseOrderNumber)$ + example: /bandwidth + InternetAccessPatchOperationUpdate: + required: + - op + - path type: object - anyOf: - - $ref: "#/components/schemas/CloudRouterActionsSearchExpression" - - $ref: "#/components/schemas/CloudRouterActionsSearchOrFilter" - CloudRouterActionsSearchExpression: + properties: + op: + $ref: '#/components/schemas/InternetAccessPatchOperationUpdateAllowedOp' + path: + $ref: '#/components/schemas/InternetAccessPatchOperationUpdateAllowedPath' + value: + description: New value for updated parameter. Required for add and replace. + InternetAccessPatchRequest: + maxItems: 100 + minItems: 1 + type: array + items: + $ref: '#/components/schemas/InternetAccessPatchOperationUpdate' + description: Only one replace operation allowed for '/bandwidth' path. + IpBlockLocation: type: object + required: + - metroCode properties: - property: + metroHref: 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: + description: Metro URL path for the linked resource + example: https://api.equinix.com/fabric/v4/metros/WA + metroCode: + pattern: ^[A-Z]{2}$ 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: + example: WA + TypeOfIpBlockProduct: type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime enum: - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - - /connection/name - - /type - ActionId_1: - type: string - description: Action UUID - format: uuid - example: 457400f8-d360-11e9-bb65-2a2ae2dbcced - GetAllCloudRouterCommands: + - IPV4_IP_BLOCK + - IPV6_IP_BLOCK + x-enum-varnames: + - IPV4_IP_BLOCK + - IPV6_IP_BLOCK + IpBlockProjectRequest: 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 + - projectId properties: - type: - $ref: "#/components/schemas/CloudRouterCommandType" - name: - type: string - description: Customer-provided Cloud Router Command name - description: + projectId: type: string - description: Customer-provided Cloud Router Command description - project: - $ref: "#/components/schemas/Project" - request: - $ref: "#/components/schemas/CloudRouterCommandRequestPayload" - description: Execute Cloud Router Command Request - CloudRouterCommand: + description: project id + IpBlockAccount: type: object + required: + - accountNumber properties: - href: + accountNumber: 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: + description: account number + IpBlockOrderRequest: + type: object + properties: + purchaseOrderNumber: type: string - format: uuid - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: + nullable: true + description: Purchase order number + orderNumber: type: string - description: Customer-provided Cloud Router name - format: string - example: test-fg-1 - description: + nullable: true + description: Order Number + orderLine: type: string - example: description - state: - $ref: "#/components/schemas/CloudRouterCommandState" - project: - $ref: "#/components/schemas/Project" - request: - $ref: "#/components/schemas/CloudRouterCommandRequestResponse" - response: - $ref: "#/components/schemas/CloudRouterCommandResponse" - changeLog: - $ref: "#/components/schemas/Changelog" - description: Get Fabric Cloud Router Command response object - CloudRouterCommandSearchRequest: + nullable: true + description: Order Line Number + IpBlockAddressingPlan: type: object + required: + - purpose + - size 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: + purpose: + type: string + description: purpose + size: + type: integer + format: int32 + description: size + IpBlockRegulations: type: object + required: + - addressingPlans + - questions properties: - and: - maxItems: 8 + addressingPlans: type: array + description: List of addressing plans items: - $ref: "#/components/schemas/CloudRouterCommandSearchFilter" - CloudRouterCommandSearchFilter: - type: object - anyOf: - - $ref: "#/components/schemas/CloudRouterCommandSearchExpression" - - $ref: "#/components/schemas/CloudRouterCommandSearchOrFilter" - CloudRouterCommandSearchExpression: + $ref: '#/components/schemas/IpBlockAddressingPlan' + questions: + type: object + required: + - privateSpaceConsidered + - refusedPreviously + - returningAddressSpace + properties: + privateSpaceConsidered: + type: boolean + refusedPreviously: + type: boolean + returningAddressSpace: + type: boolean + IpBlockPrefixLength: + type: integer + minimum: 1 + maximum: 128 + description: IpBlockPrefix length + IpBlockPrefix: + type: string + description: CIDR prefix + SubmitIpBlockRequestBody: type: object + required: + - project + - type 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: + location: + $ref: '#/components/schemas/IpBlockLocation' + type: + $ref: '#/components/schemas/TypeOfIpBlockProduct' + project: + $ref: '#/components/schemas/IpBlockProjectRequest' + account: + $ref: '#/components/schemas/IpBlockAccount' + order: + $ref: '#/components/schemas/IpBlockOrderRequest' + regulations: + $ref: '#/components/schemas/IpBlockRegulations' + prefixLength: + $ref: '#/components/schemas/IpBlockPrefixLength' + prefix: + $ref: '#/components/schemas/IpBlockPrefix' + IpBlockState: type: string - description: Sorting direction - default: DESC enum: - - DESC - - ASC - CloudRouterCommandSearchSortBy: + - PENDING + - ACTIVE + - DELETING + - DELETED + - FAILED + description: Current state of the IP Block + IpBlockOwnership: 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: + - EQUINIX + - CUSTOMER + description: IpBlockOwnership of the IP Block + IpBlockOrderResponse: type: object + required: + - href + - orderNumber properties: - property: + href: 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 - * `/MED` - Route table entry med - * `/*` - all-category search - example: /type - operator: + format: uri + description: Order URI + example: https://api.equinix.com/colocations/v2/orders/1-34834234 + orderNumber: 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: + description: Order number + IpBlockProject: type: object + required: + - projectId properties: - direction: - $ref: "#/components/schemas/RouteTableEntrySortDirection" - property: - $ref: "#/components/schemas/RouteTableEntrySortBy" - RouteTableEntrySortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - RouteTableEntrySortBy: + href: + type: string + format: uri + description: URI of the project + projectId: + type: string + description: project id + IpBlockProductType: type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime enum: - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - - /prefix - - /nextHop - - /connection/name - - /type - - /MED - 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 - CloudRouterRouteFiltersSearchBase: + - EIA + - FABRIC + - NE + IpBlockAsset: type: object + required: + - type + - uuid + - href properties: - filter: - $ref: "#/components/schemas/CloudRouterRouteFiltersFilter" - pagination: - $ref: "#/components/schemas/Pagination" - sort: - maxItems: 3 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/RfAttachmentSortItem" - CloudRouterRouteFiltersFilter: - description: Top-level filter that can be either an AND expression or OR expression - anyOf: - - $ref: "#/components/schemas/CloudRouterRouteFilterAndExpression" - - $ref: "#/components/schemas/CloudRouterRouteFilterOrExpression" - CloudRouterRouteFilterAndExpression: + type: + $ref: '#/components/schemas/IpBlockProductType' + uuid: + type: string + format: uuid + description: Unique identifier for the asset + href: + type: string + description: Resource URL path for the linked resource + example: https://api.equinix.com/fabric/v4/internetAccesses/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + IpBlockChange: type: object + required: + - href properties: - and: - maxItems: 8 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/CloudRouterRouteFilterExpression" - description: AND expression containing multiple filter expressions - CloudRouterRouteFilterExpression: - description: Filter expression that can be AND, OR, or a simple expression - anyOf: - - $ref: "#/components/schemas/CloudRouterRouteFilterAndExpression" - - $ref: "#/components/schemas/CloudRouterRouteFilterOrExpression" - - $ref: "#/components/schemas/CloudRouterRouteFilterSimpleExpression" - CloudRouterRouteFilterOrExpression: + href: + type: string + format: uri + description: URI of the IpBlockChange object + IpBlockChangeLog: type: object + required: + - createdDateTime properties: - or: - maxItems: 8 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/CloudRouterRouteFilterExpression" - description: OR expression containing multiple filter expressions - CloudRouterRouteFilterSimpleExpression: + createdDateTime: + type: string + format: date-time + updatedDateTime: + type: string + format: date-time + deletedDateTime: + type: string + format: date-time + IpBlock: type: object + required: + - uuid + - href + - state + - type + - ownership + - prefixLength + - project + - changeLog properties: - property: + uuid: type: string - enum: - - /type - - /direction - - /attachmentStatus - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - operator: + format: uuid + description: Unique identifier for the IP Block + href: type: string - values: - maxItems: 8 - minItems: 1 + description: Resource URL path for the IP Block + example: /fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + type: + $ref: '#/components/schemas/TypeOfIpBlockProduct' + state: + $ref: '#/components/schemas/IpBlockState' + ownership: + $ref: '#/components/schemas/IpBlockOwnership' + location: + $ref: '#/components/schemas/IpBlockLocation' + prefixLength: + $ref: '#/components/schemas/IpBlockPrefixLength' + prefix: + $ref: '#/components/schemas/IpBlockPrefix' + order: + $ref: '#/components/schemas/IpBlockOrderResponse' + account: + $ref: '#/components/schemas/IpBlockAccount' + project: + $ref: '#/components/schemas/IpBlockProject' + regulations: + $ref: '#/components/schemas/IpBlockRegulations' + assets: type: array items: - type: string - RfAttachmentSortItem: + $ref: '#/components/schemas/IpBlockAsset' + description: Products using this IP Block + change: + $ref: '#/components/schemas/IpBlockChange' + changeLog: + $ref: '#/components/schemas/IpBlockChangeLog' + error: + $ref: '#/components/schemas/Error' + PatchIpBlockRequestBodyItem: type: object + required: + - op + - path properties: - property: + op: type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime + description: operation enum: - - /type - - /uuid - - /direction - - /attachmentStatus - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - direction: + - add + - remove + path: type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - CloudRouterRouteFiltersSearchResponse: - type: object - properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: List of route filter attachments for a given cloud router - items: - $ref: "#/components/schemas/ConnectionRouteFilterData" - CloudRouterRouteAggregationsSearchBase: - type: object - properties: - filter: - $ref: "#/components/schemas/CloudRouterRouteAggregationsFilter" - pagination: - $ref: "#/components/schemas/Pagination" - sort: - maxItems: 3 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/RaAttachmentSortItem" - CloudRouterRouteAggregationsFilter: - description: Top-level filter that can be either an AND expression or OR expression - anyOf: - - $ref: "#/components/schemas/CloudRouterRouteAggregationAndExpression" - - $ref: "#/components/schemas/CloudRouterRouteAggregationOrExpression" - CloudRouterRouteAggregationAndExpression: - type: object - properties: - and: - maxItems: 8 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/CloudRouterRouteAggregationExpression" - description: AND expression containing multiple filter expressions - CloudRouterRouteAggregationExpression: - description: Filter expression that can be AND, OR, or a simple expression - anyOf: - - $ref: "#/components/schemas/CloudRouterRouteAggregationAndExpression" - - $ref: "#/components/schemas/CloudRouterRouteAggregationOrExpression" - - $ref: "#/components/schemas/CloudRouterRouteAggregationSimpleExpression" - CloudRouterRouteAggregationOrExpression: - type: object - properties: - or: - maxItems: 8 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/CloudRouterRouteAggregationExpression" - description: OR expression containing multiple filter expressions - CloudRouterRouteAggregationSimpleExpression: + description: path + value: + type: object + required: + - uuid + properties: + uuid: + type: string + format: uuid + description: new value + PatchIpBlockRequestBody: + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/PatchIpBlockRequestBodyItem' + IpBlockAndQuery: type: object + required: + - property + - operator + - values properties: property: type: string - enum: - - /type - - /attachmentStatus - - /changeLog/createdDateTime - - /changeLog/updatedDateTime operator: type: string + enum: + - '=' values: type: array items: type: string - RaAttachmentSortItem: - type: object - properties: - property: - type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime - enum: - - /type - - /uuid - - /attachmentStatus - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - direction: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - CloudRouterRouteAggregationsSearchResponse: + IpBlockFilter: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + and: type: array - description: List of route aggregation attachments for a given cloud router items: - $ref: "#/components/schemas/ConnectionRouteAggregationData" - CloudRouterSearchRequest: - type: object + $ref: '#/components/schemas/IpBlockAndQuery' + IpBlocksSearchRequestBody: properties: + pagination: + $ref: '#/components/schemas/PaginationRequest' filter: - $ref: "#/components/schemas/CloudRouterExpression" + $ref: '#/components/schemas/IpBlockFilter' + sort: + $ref: '#/components/schemas/SearchSort' + IpBlockSearchResponseBody: + required: + - pagination + - data + properties: pagination: - $ref: "#/components/schemas/PaginationRequest" + $ref: '#/components/schemas/Pagination' sort: + $ref: '#/components/schemas/SearchSort' + data: type: array items: - $ref: "#/components/schemas/CloudRouterSortCriteria" - description: Search requests containing criteria - CloudRouterExpression: + $ref: '#/components/schemas/IpBlock' + Expression: type: object properties: and: - $ref: "#/components/schemas/CloudRouterExpressions" + $ref: '#/components/schemas/Expressions' or: - $ref: "#/components/schemas/CloudRouterExpressions" + $ref: '#/components/schemas/Expressions' property: - $ref: "#/components/schemas/SearchFieldName_1" + $ref: '#/components/schemas/SearchFieldName' 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 + enum: + - '=' + - '!=' + - '>' + - '>=' + - < + - <= + - LIKE + - ILKE + - IS NOT NULL + - IS NULL + - IN + - BETWEEN values: type: array items: type: string - CloudRouterExpressions: + Expressions: type: array items: - $ref: "#/components/schemas/CloudRouterExpression" - SearchFieldName_1: - 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 - * `/type` - Fabric Cloud Router type - * `/connectionsCount` - Fabric Cloud Router attached connections count - * `/changeLog/createdDateTime` - Fabric Cloud Router creation timestamp - * `/changeLog/updatedDateTime` - Fabric Cloud Router last updated timestamp - * `/changeLog/deletedDateTime` - Fabric Cloud Router deletion timestamp - * `/*` - all-category search - example: /name - 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: + $ref: '#/components/schemas/Expression' + SearchFieldName: + description: Possible field names to use on filters type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime enum: + - /isRemote - /name - /uuid - - /state - - /location/metroCode - - /location/metroName - - /package/code - /type - - /connectionsCount - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - - /changeLog/deletedDateTime - - /order/termLength - SearchResponse: - type: object - properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/CloudRouterReadResponse" - PackageResponse: + - /geoScope + - /account/orgId + - /aSide/accessPoint/account/accountName + - /aSide/accessPoint/account/accountNumber + - /aSide/accessPoint/router/uuid + - /aSide/accessPoint/interconnect/uuid + - /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 + - /bandwidth + - /change/status + - /changeLog/createdBy + - /changeLog/createdDateTime + - /changeLog/deletedBy + - /changeLog/deletedDateTime + - /changeLog/lastUpdatedBy + - /operation/equinixStatus + - /operation/providerStatus + - /operation/maintenanceStatus + - /operation/lockEnabled + - /project/projectId + - /redundancy/group + - /redundancy/priority + - /redundancy/name + - /redundancy/description + - /zSide/accessPoint/account/accountName + - /zSide/accessPoint/authenticationKey + - /zSide/accessPoint/linkProtocol/vlanTagMin + - /zSide/accessPoint/linkProtocol/vlanTagMax + - /zSide/accessPoint/location/metroCode + - /zSide/accessPoint/location/metroName + - /zSide/accessPoint/sellerRegion + - /zSide/accessPoint/name + - /zSide/accessPoint/port/uuid + - /zSide/accessPoint/network/uuid + - /zSide/accessPoint/port/name + - /zSide/accessPoint/profile/uuid + - /zSide/accessPoint/type + - /zSide/accessPoint/role + - /zSide/accessPoint/virtualDevice/name + - /zSide/accessPoint/virtualDevice/uuid + - /zSide/serviceToken/uuid + - /zSide/internetAccess/uuid + - /state + SortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + SortBy: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + 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/role + - /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 + - /operation/maintenanceStatus + - /redundancy/priority + SortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/SortDirection' + property: + $ref: '#/components/schemas/SortBy' + SearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/Expression' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/SortCriteria' + SortCriteriaResponse: + type: object + properties: + direction: + $ref: '#/components/schemas/SortDirection' + property: + $ref: '#/components/schemas/SortBy' + ConnectionSearchResponse: + description: List of connections type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/SortCriteriaResponse' data: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/CloudRouterPackage" - RouterPackageCode: + $ref: '#/components/schemas/Connection' + FilterBody: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/SearchExpression' + ProductType: + description: Product type type: string - description: Router package code enum: - - LAB - - BASIC - - STANDARD - - ADVANCED - - PREMIUM - CloudRouterPackage: + - VIRTUAL_CONNECTION_PRODUCT + - IP_BLOCK_PRODUCT + - VIRTUAL_PORT_PRODUCT + - CLOUD_ROUTER_PRODUCT + - PRECISION_TIME_PRODUCT + - OPTICAL_CONNECT_PRODUCT + PriceCharge: + description: Price Charge 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: + description: Price charge 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: + - MONTHLY_RECURRING + - NON_RECURRING + price: + description: Offering price + type: number + format: double minimum: 0 - type: integer - description: CloudRouter package Max Bandwidth limit - example: 50 - changeLog: - $ref: "#/components/schemas/PackageChangeLog" - description: Fabric Cloud Router Package - HealthResponse: + PriceCategory: + description: Price category + type: string + enum: + - COUNTRY + - CUSTOMER + VirtualConnectionPriceConnectionType: + description: Virtual Connection type + type: string + enum: + - EVPL_VC + - EPL_VC + - EC_VC + - IP_VC + - VD_CHAIN_VC + - ACCESS_EPL_VC + - EVPLAN_VC + - EPLAN_VC + - IPWAN_VC + - EVPTREE_VC + - EPTREE_VC + - IA_VC + VirtualConnectionPriceAccessPointType: + description: Virtual Connection access point type + type: string + enum: + - VD + - SP + - COLO + - CLOUD_ROUTER + - CHAINGROUP + - NETWORK + - METAL_NETWORK + PriceLocation: type: object properties: - href: - type: string - description: The Canonical URL at which the resource resides. - version: - type: string - description: Indicator of a version - release: + metroCode: type: string - description: release details. - state: + ibx: 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 - NetworkPostRequest: - required: - - name - - notifications - - scope - - type + VirtualConnectionPriceASide: 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 + accessPoint: 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: + $ref: '#/components/schemas/VirtualConnectionPriceAccessPointType' + location: + $ref: '#/components/schemas/PriceLocation' + port: + type: object + properties: + settings: + type: object + properties: + buyout: + type: boolean + default: false + VirtualConnectionBridgePackageCode: + description: Virtual Connection bridge package code 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: + enum: + - REGIONAL + - GLOBAL + VirtualConnectionPriceZSide: 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: + accessPoint: + type: object + properties: + uuid: + type: string + format: uuid + type: + $ref: '#/components/schemas/VirtualConnectionPriceAccessPointType' + location: + $ref: '#/components/schemas/PriceLocation' + port: + type: object + properties: + settings: + type: object + properties: + buyout: + type: boolean + default: false + profile: + type: object + properties: + uuid: + type: string + format: uuid + bridge: + type: object + properties: + package: + type: object + properties: + code: + $ref: '#/components/schemas/VirtualConnectionBridgePackageCode' + VirtualConnectionPrice: + description: Virtual Connection Product configuration type: object properties: - and: - $ref: "#/components/schemas/NetworkSimpleExpression" - or: - $ref: "#/components/schemas/NetworkSimpleExpression" - property: - $ref: "#/components/schemas/NetworkSearchFieldName" - operator: + uuid: + description: Either uuid or rest of attributes are required 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: + format: uuid + type: + $ref: '#/components/schemas/VirtualConnectionPriceConnectionType' + bandwidth: + type: integer + minimum: 0 + aSide: + $ref: '#/components/schemas/VirtualConnectionPriceASide' + zSide: + $ref: '#/components/schemas/VirtualConnectionPriceZSide' + geoScope: + $ref: '#/components/schemas/GeoScopeType' + IpBlockType: + description: IP Block type type: string - description: Possible field names to use on filters - example: /name enum: - - /name - - /uuid - - /scope - - /type - - /state - - /operation/equinixStatus - - /location/region - - /location/metroCode - - /connectionsCount - - /project/projectId - - /account/globalCustId - - /account/orgId - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - - /changeLog/deletedDateTime - - /* - NetworkSortCriteria: + - IPv4 + - IPv6 + IpBlockPrice: + description: IP Block Product configuration type: object properties: - direction: - $ref: "#/components/schemas/NetworkSortDirection" - property: - $ref: "#/components/schemas/NetworkSortBy" - NetworkSortDirection: + uuid: + description: Either uuid or rest of attributes are required + type: string + format: uuid + type: + $ref: '#/components/schemas/IpBlockType' + prefixLength: + type: integer + location: + $ref: '#/components/schemas/PriceLocation' + FabricCloudRouterCode: + description: Cloud Router code type: string - description: Sorting direction - default: DESC enum: - - DESC - - ASC - NetworkSortBy: + - LAB + - BASIC + - STANDARD + - ADVANCED + - PREMIUM + FabricCloudRouterPackages: + description: Cloud Router package + type: object + properties: + code: + $ref: '#/components/schemas/FabricCloudRouterCode' + FabricCloudRouterPrice: + description: Cloud Router Product configuration + type: object + properties: + uuid: + description: Unique identifier assigned to the Cloud Router + type: string + format: uuid + location: + $ref: '#/components/schemas/PriceLocation' + package: + $ref: '#/components/schemas/FabricCloudRouterPackages' + VirtualPortType: + description: Port type. 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: + - XF_PORT + VirtualPortLocation: + description: Geographic data for the port. 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: + ibx: + 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. + type: string + LinkAggregationGroup: + description: Link aggregation group (LAG) preferences and settings. type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - items: - $ref: "#/components/schemas/Connection" - description: List of network changes - NetworkChangeResponse: + enabled: + description: Parameter showing whether LAG configuration is mandatory. The default is false. + type: boolean + default: false + VirtualPortRedundancy: + 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. type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - items: - $ref: "#/components/schemas/NetworkChange" - description: List of network changes - ChangeId_5: + enabled: + description: Parameter showing whether redundancy is mandatory. The default is false. + type: boolean + default: false + ConnectivitySourceType: + 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. type: string - description: Network Change UUID - format: uuid - example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 - NetworkChange: + enum: + - COLO + - BMMR + - REMOTE + default: COLO + ConnectivitySource: + description: Physical or virtual port that houses the connection. 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: + $ref: '#/components/schemas/ConnectivitySourceType' + VirtualPortServiceType: + description: Port service type. The default is managed-service provider (MSP). + type: string + enum: + - MSP + - EPL + default: MSP + VirtualPortConfiguration: + description: Port configuration. + type: object + properties: + buyout: + 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. + type: boolean + default: false + VirtualPortPackageCode: + description: Virtual port package code + type: string + example: STANDARD, UNLIMITED or UNLIMITED_PLUS + VirtualPortPackage: + description: Virtual Port Package + type: object + properties: + code: + $ref: '#/components/schemas/VirtualPortPackageCode' + VirtualPortServiceCode: + description: Port service code. + type: string + VirtualPortPrice: + description: Preferences and settings for a virtual port connected to an internet service provider (ISP) or other Equinix platform entity. + type: object + properties: + uuid: + description: Unique identifier assigned to the virtual port. Either the uuid or the remaining attributes must be supplied. type: string - description: Set when change flow starts - format: date-time - example: 2020-11-06T07:00:00Z - updatedDateTime: + format: uuid + type: + $ref: '#/components/schemas/VirtualPortType' + location: + $ref: '#/components/schemas/VirtualPortLocation' + lag: + $ref: '#/components/schemas/LinkAggregationGroup' + physicalPortsQuantity: + description: Number of physical ports requested. The defaults is 1. + type: integer + default: 1 + bandwidth: + 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. + type: integer + redundancy: + $ref: '#/components/schemas/VirtualPortRedundancy' + connectivitySource: + $ref: '#/components/schemas/ConnectivitySource' + serviceType: + $ref: '#/components/schemas/VirtualPortServiceType' + settings: + $ref: '#/components/schemas/VirtualPortConfiguration' + package: + $ref: '#/components/schemas/VirtualPortPackage' + serviceCode: + $ref: '#/components/schemas/VirtualPortServiceCode' + precisionTimePackageRequest: + title: precisionTimePackageRequest + type: object + example: + code: NTP_STANDARD + description: Precision Time Service Level Request + properties: + code: 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 + enum: + - NTP_STANDARD + - NTP_ENTERPRISE + - PTP_STANDARD + - PTP_ENTERPRISE + description: Precision Time Service Level required: - - connections - - ipv4 - - name - - package - - type + - code + TimeServicePriceConnectionAccessPoint: + description: Time Service Price Connection Access Point configuration + type: object + properties: + location: + $ref: '#/components/schemas/PriceLocation' + TimeServicePriceConnectionASide: + description: Time Service Price Connection ASide configuration + type: object + properties: + accessPoint: + $ref: '#/components/schemas/TimeServicePriceConnectionAccessPoint' + TimeServicePriceConnection: + description: Time Service Price Connection configuration + type: object + properties: + aSide: + $ref: '#/components/schemas/TimeServicePriceConnectionASide' + TimeServicePrice: + description: Time Service Product configuration 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. + description: Precision Time Service Type refers to the corresponding Protocol. 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 + $ref: '#/components/schemas/precisionTimePackageRequest' + connection: + $ref: '#/components/schemas/TimeServicePriceConnection' + OpticalConnectPricePortType: + description: Optical Connect type. + type: string + example: OC + OpticalConnectPricePathType: + description: Optical Connect Port Path type. + type: string + enum: + - PROTECTED + - UNPROTECTED + - DUAL_DIVERSE + OpticalConnectConnectionDestinationType: + description: Destination Port connectivity type + type: string + enum: + - COLO + - BMMR + - REMOTE + OpticalConnectPriceLocation: + description: Optical Connect Location + type: object + properties: + ibxCode: + description: IBX identifier + type: string + example: SV1 + OpticalConnectPriceASide: + description: Optical Connection ASide configuration + type: object + properties: + location: + $ref: '#/components/schemas/OpticalConnectPriceLocation' + OpticalConnectPriceZSide: + description: Optical Connection ZSide configuration + type: object + properties: + location: + $ref: '#/components/schemas/OpticalConnectPriceLocation' + OpticalConnectPrice: + description: Optical Metro Connect Port Product configuration type: object + properties: + type: + $ref: '#/components/schemas/OpticalConnectPricePortType' + bandwidth: + description: Bandwidth in Mbps + type: integer + minimum: 0 + example: 1000 + pathType: + $ref: '#/components/schemas/OpticalConnectPricePathType' + connectionDestinationType: + $ref: '#/components/schemas/OpticalConnectConnectionDestinationType' + aSide: + $ref: '#/components/schemas/OpticalConnectPriceASide' + zSide: + $ref: '#/components/schemas/OpticalConnectPriceZSide' + Price: properties: href: + description: An absolute URL that returns specified pricing data type: string - description: Precision Time Service URI. - format: uri + format: url type: + $ref: '#/components/schemas/ProductType' + code: + description: Equinix-assigned product code type: string - description: Precision Time Service type refers to the corresponding protocol. - enum: - - NTP - - PTP name: + description: Full product name type: string - description: Precision Time Service Name. - uuid: + description: + description: Product description type: string - description: Precision Time Service UUID. - format: uuid - state: + account: + $ref: '#/components/schemas/SimplifiedAccount' + charges: + type: array + items: + $ref: '#/components/schemas/PriceCharge' + currency: + description: Product offering price currency type: string - description: Precision Time Service Status. + termLength: + description: In months. No value or value of 1 means on-demand + type: integer enum: - - CANCELLED - - CANCELLING - - CONFIGURING - - CONFIGURING_FAILED - - DRAFT - - DEPROVISIONING - - DEPROVISIONING_FAILED - - DEPROVISIONED - - PROVISIONED - - PROVISIONING - - PROVISIONING_FAILED - - REPROVISIONING - - REPROVISIONING_FAILED - operation: - $ref: "#/components/schemas/timeServiceOperation" - package: - $ref: "#/components/schemas/precisionTimePackagePostResponse" - connections: - maxItems: 2 - minItems: 1 - uniqueItems: true + - 1 + - 12 + - 24 + - 36 + - 60 + 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' + opticalConnect: + allOf: + - $ref: '#/components/schemas/OpticalConnectPrice' + PriceSearchResponse: + type: object + properties: + data: 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: + $ref: '#/components/schemas/Price' + pagination: + $ref: '#/components/schemas/Pagination' + PriceError: + description: Error with details required: - - op - - path - - value + - errorCode + - errorMessage type: object + discriminator: + propertyName: errorCode properties: - op: + errorCode: type: string - description: Handy shortcut for operation name enum: - - replace - - add - - remove - path: + - EQ-3038010 + - EQ-3038022 + - EQ-3038030 + errorMessage: 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: + - Validation failure + - Invalid value + - Internal Server Error + correlationId: + type: string + details: + type: string + help: + type: string + additionalInfo: type: array items: - $ref: "#/components/schemas/TimeServiceSortCriteria" - description: Search requests containing criteria - TimeServiceFilters: + type: object + properties: + property: + type: string + reason: + type: string + PriceErrorList: + type: array + items: + $ref: '#/components/schemas/PriceError' + startDateTime: + description: startDateTime + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + endDateTime: + description: endDateTime + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + Metrics: + description: Bandwidth utilization statistics for a specified interval. 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: + intervalEndTimestamp: + description: Interval end timestamp + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + max: + description: Max bandwidth within statistics object time interval, represented in units specified by response "units" field + type: number + format: float + mean: + description: Mean bandwidth within statistics object time interval, represented in units specified by response "units" field + type: number + format: float + Direction: + description: Directional statistics 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: + max: + description: Max bandwidth within request time range, represented in units specified by response "units" field + type: number + format: float + mean: + description: Mean bandwidth within request time range, represented in units specified by response "units" field + type: number + format: float + metrics: + description: Bandwidth utilization statistics for a specified interval. type: array items: - type: string - example: FabricPrecisionTimeService-1 - TimeServiceOrFilter: + $ref: '#/components/schemas/Metrics' + BandwidthUtilization: + description: Bandwidth utilization statistics (octet counters-based) type: object properties: - or: - maxItems: 3 - type: array - items: - $ref: "#/components/schemas/TimeServiceSimpleExpression" - TimeServiceSortCriteria: + unit: + description: Aggregated data transfer capacity. Possible values- Mbps, megabits (1 million bits) per second; Gbps, gigabits (1 billion bits) per second. + type: string + enum: + - Mbps + metricInterval: + description: An interval formatted value, indicating the time-interval the metric objects within the response represent + type: string + inbound: + $ref: '#/components/schemas/Direction' + outbound: + $ref: '#/components/schemas/Direction' + Statistics: + 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. type: object properties: - direction: - $ref: "#/components/schemas/TimeServiceSortDirection" - property: - $ref: "#/components/schemas/TimeServiceSortBy" - TimeServiceSortDirection: + startDateTime: + description: Start and duration of the statistical analysis interval. + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + endDateTime: + description: End and duration of the statistical analysis interval. + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + viewPoint: + description: Point of view for connection metrics - aSide or zSide + type: string + enum: + - aSide + - zSide + bandwidthUtilization: + $ref: '#/components/schemas/BandwidthUtilization' + viewPoint: + description: viewPoint type: string - description: Sorting direction - default: DESC enum: - - DESC - - ASC - TimeServiceSortBy: + - aSide + - zSide + ServiceProfileStateEnum: + description: Equinix assigned state. 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: + - ACTIVE + - PENDING_APPROVAL + - DELETED + - REJECTED + example: ACTIVE + Path: + description: A JSON Pointer path. + type: string + AddOperation: + description: Add Sub-Resource to the existing model type: object + required: + - op + - path + - value properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/precisionTimeServiceResponse" - precisionTimeServiceConnectionsResponse: - title: precisionTimeServiceConnectionResponse + op: + type: string + enum: + - add + path: + $ref: '#/components/schemas/Path' + value: + type: object + description: value to add + RemoveOperation: + description: Remove sub-resource from an existing model type: object + required: + - op + - path 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 + op: + type: string + enum: + - remove + path: + $ref: '#/components/schemas/Path' + ReplaceOperation: + description: Replace attribute value or sub-resource in the existing model 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 + - op + - path + - value + properties: + op: + type: string + enum: + - replace + path: + $ref: '#/components/schemas/Path' + value: + type: object + description: value to replace with + ServiceProfileUpdateOperation: + description: Service Profile Access Points + type: object + oneOf: + - $ref: '#/components/schemas/AddOperation' + - $ref: '#/components/schemas/RemoveOperation' + - $ref: '#/components/schemas/ReplaceOperation' + ServiceProfileUpdateRequest: + type: array + items: + $ref: '#/components/schemas/ServiceProfileUpdateOperation' + ServiceProfileChange: type: object + description: Current state of latest service profile change properties: - href: + uuid: + description: Uniquely identifies a change type: string - format: uri type: + description: Type of change 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: + example: SERVICE_PROFILE_VISIBILITY_UPDATE + status: + description: Current outcome of the change flow 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: + - APPROVED + - COMPLETED + - FAILED + - REJECTED + - REQUESTED + - SUBMITTED_FOR_APPROVAL + createdDateTime: + description: Set when change flow starts 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: + example: '2020-11-06T07:00:00Z' + updatedDateTime: + description: Set when change object is updated 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: + format: date-time + example: '2020-11-06T07:00:00Z' + information: + description: Additional information type: string - description: Cloud Router package code - 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: + $ref: '#/components/schemas/ServiceProfileUpdateRequest' required: - - name - - project - type + - createdDateTime + ServiceProfile: + 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. 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" + state: + $ref: '#/components/schemas/ServiceProfileStateEnum' account: - $ref: "#/components/schemas/SimplifiedAccount" - notifications: - maxItems: 1 - type: array - description: Preferences for stream notifications. Optional; at most one entry, of type ALL, with up to 12 emails. Set at creation only. - items: - $ref: "#/components/schemas/SimplifiedNotification" - 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 - type: - type: string - description: type - enum: - - TELEMETRY_STREAM - name: - type: string - description: Customer-provided stream name - description: - type: string - description: Customer-provided stream description + description: Seller Account for Service Profile. + $ref: '#/components/schemas/SimplifiedAccount' project: - $ref: "#/components/schemas/Project" - account: - $ref: "#/components/schemas/SimplifiedAccount" - notifications: - type: array - description: Preferences for stream notifications, set at creation - items: - $ref: "#/components/schemas/SimplifiedNotification" - 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 - alertRulesCount: - type: integer - description: Stream alert rules count - example: 3 + $ref: '#/components/schemas/Project' + change: + $ref: '#/components/schemas/ServiceProfileChange' changeLog: - $ref: "#/components/schemas/Changelog" - description: Stream object - StreamSearchRequest: + description: Seller Account for Service Profile. + $ref: '#/components/schemas/Changelog' + allOf: + - $ref: '#/components/schemas/SimplifiedServiceProfile' + ServiceProfiles: type: object + description: Service Profiles properties: - filter: - $ref: "#/components/schemas/StreamSearchFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + data: type: array items: - $ref: "#/components/schemas/StreamSearchSortCriteria" - description: Search requests containing criteria - StreamSearchFilters: - required: - - and + $ref: '#/components/schemas/ServiceProfile' + pagination: + $ref: '#/components/schemas/Pagination' + ServiceProfileRequest: + 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. type: object + allOf: + - $ref: '#/components/schemas/SimplifiedServiceProfile' properties: - and: - maxItems: 10 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/StreamSearchFilter" - StreamSearchFilter: - type: object - anyOf: - - $ref: "#/components/schemas/StreamSearchSimpleExpression" - - $ref: "#/components/schemas/StreamSearchOrFilter" - StreamSearchSimpleExpression: + project: + $ref: '#/components/schemas/Project' + required: + - name + - description + - type + ServiceProfileSimpleExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: - * `/uuid` - Stream uuid - * `/name` - Stream name - * `/state` - Stream state (`DEPROVISIONED` returned only when explicitly requested) - * `/type` - Stream type - * `/description` - Stream description - * `/project/projectId` - Stream project id - * `/changeLog/createdDateTime` - Stream created date time - * `/changeLog/updatedDateTime` - Stream updated date time + * `/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 + type: string 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 - * `BETWEEN` - between - * `NOT BETWEEN` - not between - * `LIKE` - like - * `ILIKE` - like case-insensitive - * `IN` - in - * `NOT IN` - not in - example: = + type: string + example: '=' values: - maxItems: 100 - minItems: 1 type: array items: type: string - example: stream-dev-01 - StreamSearchOrFilter: + example: ServiceProfile-1 + ServiceProfileAndFilter: type: object properties: - or: - maxItems: 10 + and: type: array items: - $ref: "#/components/schemas/StreamSearchSimpleExpression" - StreamSearchSortCriteria: - required: - - direction - - property + $ref: '#/components/schemas/ServiceProfileSimpleExpression' + ServiceProfileFilter: type: object - properties: - direction: - $ref: "#/components/schemas/StreamSearchSortDirection" - property: - $ref: "#/components/schemas/StreamSearchSortBy" - StreamSearchSortDirection: - type: string + anyOf: + - $ref: '#/components/schemas/ServiceProfileSimpleExpression' + - $ref: '#/components/schemas/ServiceProfileAndFilter' + ServiceProfileSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - StreamSearchSortBy: - type: string + ServiceProfileSortBy: description: Possible field names to use on sorting - default: /changeLog/createdDateTime + default: /changeLog/updatedDateTime + type: string enum: + - /name + - /state - /changeLog/createdDateTime - /changeLog/updatedDateTime - SearchStreamResponse: - type: object - properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/Stream" - StreamId: - type: string - description: Stream UUID - format: uuid - example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - StreamPutRequest: - required: - - name + ServiceProfileSortCriteria: type: object properties: - name: - type: string - description: Customer-provided stream name - description: - type: string - description: Customer-provided stream description - description: Update Stream - StreamAssetSearchRequest: + direction: + $ref: '#/components/schemas/ServiceProfileSortDirection' + property: + $ref: '#/components/schemas/ServiceProfileSortBy' + ServiceProfileSearchRequest: type: object + description: Search requests containing criteria properties: filter: - $ref: "#/components/schemas/StreamAssetFilters" + $ref: '#/components/schemas/ServiceProfileFilter' pagination: - $ref: "#/components/schemas/PaginationRequest" + $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: + $ref: '#/components/schemas/ServiceProfileSortCriteria' + ServiceProfileActionRequest: + description: Service Profile Action Request type: object properties: - property: + type: + description: 'Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION' type: string - description: | - Possible field names to use on filters: - * `/uuid` - Asset uuid (`=` and `IN` only) - * `/streamUuid` - Stream uuid (`=` and `IN` only) - * `/attachmentStatus` - Asset attachment status (`=`, `IN`, and `NOT IN`) - example: /streamUuid - operator: + example: PROFILE_UPDATE_ACCEPTANCE + description: + description: Action description type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `IN` - in - * `NOT IN` - not in - example: = - values: - minItems: 1 - type: array - items: - type: string - example: 4719e319-65ae-4001-aabf-ca5f107b9b29 - StreamAssetOrFilter: - type: object - properties: - or: - maxItems: 3 - type: array - items: - $ref: "#/components/schemas/StreamAssetSimpleExpression" - StreamAssetSortCriteria: + example: Approved to migrate to public required: - - direction - - property + - type + ServiceProfileActionResponse: + description: Service Profile Action Response 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 - - /streamUuid - SearchStreamAssetResponse: + href: + description: Service Profile Action URI + type: string + format: uri + readOnly: true + type: + description: 'Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION' + type: string + example: PROFILE_UPDATE_ACCEPTANCE + uuid: + description: Equinix-assigned action identifier + type: string + format: uuid + comments: + description: Action comments + type: string + example: Approved to migrate to public + changeLog: + $ref: '#/components/schemas/Changelog' + ProviderEnvironments: type: object + description: Service Profile Provider Environments properties: - pagination: - $ref: "#/components/schemas/Pagination" data: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/StreamSearchAsset" - AssetId_1: - type: string - description: Stream Asset UUID - format: uuid - example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - Asset: + $ref: '#/components/schemas/ProviderEnvironment' + pagination: + $ref: '#/components/schemas/Pagination' + EnvironmentActionTypeEnum: + description: Environment action type type: string enum: - - ports - - connections - - routers - - metros - - organizations - - projects - - companyProfiles - StreamAsset: + - VALIDATE_ACTIVATION_KEY + example: VALIDATE_ACTIVATION_KEY + ActivationKeyDetails: + description: Activation Key Details Beta type: object properties: - href: + value: + description: Provider Encoded activation key type: string - description: Stream Asset URI - format: uri - readOnly: true - uuid: + example: key_here + providerId: + description: AWS Connection identifier type: string - description: Equinix-assigned access point identifier - format: uuid - example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 - type: + accountId: + description: Account identifier type: string - description: Asset types - enum: - - XF_PORT - - IP_VC - - EVPLAN_VC - - EVPL_VC - - XF_METRO - - XF_ROUTER - - ORGANIZATION - - PROJECT - - VIRTUAL_DEVICE - - DATA - - MGMT - - SSH - - FAB - - CTRL - metricsEnabled: - type: boolean - description: enable metric - example: false - attachmentStatus: + bandwidth: + description: Bandwidth in Mbps + type: integer + region: + description: Cloud provider region identifier type: string - description: asset status - enum: - - ATTACHING - - ATTACHED - - DETACHED - - DETACHING - - FAILED - description: Stream object - StreamAssetPutRequest: + EnvironmentActionRequest: + description: Request payload for environment action type: object + required: + - type + - keyDetails properties: - metricsEnabled: - type: boolean - description: enable metric - example: false - default: false - description: Update Stream Asset - DeviceId: + type: + $ref: '#/components/schemas/EnvironmentActionTypeEnum' + keyDetails: + $ref: '#/components/schemas/ActivationKeyDetails' + EnvironmentActionStateEnum: + description: Environment action state. ACTIVE - already used , INACTIVE - not used type: string - description: Network Edge Device UUID - format: uuid - example: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d - StreamDevicePutRequest: - type: object - properties: - metricsEnabled: - type: boolean - description: enable metric. Must be true when interfaces are provided - example: true - default: false - interfaces: - type: array - description: | - Complete desired set of Network Edge Device interfaces attached to the stream. Interfaces not in the list are detached; an empty or absent list detaches all interfaces. - items: - $ref: "#/components/schemas/StreamDeviceInterfaceRequest" - description: Attach Network Edge Device interfaces to a Stream - StreamDeviceInterfaceRequest: - required: - - id + enum: + - ACTIVE + - INACTIVE + example: ACTIVE + EnvironmentActionResponse: + description: Response from environment action Beta type: object properties: - id: - type: integer - description: Network Edge Device interface identifier - format: int32 - example: 5 - description: Network Edge Device interface - GetAllStreamSubscriptionResponse: + href: + description: Environment action URI + type: string + format: uri + readOnly: true + type: + $ref: '#/components/schemas/EnvironmentActionTypeEnum' + uuid: + description: Equinix-assigned action identifier + type: string + format: uuid + example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 + state: + $ref: '#/components/schemas/EnvironmentActionStateEnum' + keyDetails: + $ref: '#/components/schemas/ActivationKeyDetails' + changeLog: + $ref: '#/components/schemas/Changelog' + ServiceMetros: type: object + description: Service Profile Metros properties: - pagination: - $ref: "#/components/schemas/Pagination" data: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/StreamSubscription" - StreamSubscriptionPostRequest: - required: - - name - - sink - - type + $ref: '#/components/schemas/ServiceMetro' + pagination: + $ref: '#/components/schemas/Pagination' + ServiceTokenChangeOperation: + description: Service Token change operation data type: object properties: - type: + op: + description: Handy shortcut for operation name type: string enum: - - STREAM_SUBSCRIPTION - name: - type: string - description: Customer-provided stream subscription name - description: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter type: string - description: Customer-provided stream subscription description - enabled: - type: boolean - description: Stream subscription enabled status - example: true - default: true - metricSelector: - $ref: "#/components/schemas/StreamSubscriptionSelector" - eventSelector: - $ref: "#/components/schemas/StreamSubscriptionSelector" - sink: - $ref: "#/components/schemas/StreamSubscriptionSink" - description: Create Stream Subscription - StreamSubscriptionSelector: + example: /expirationDateTime + value: + description: new value for updated parameter + required: + - op + - path + - value + ServiceTokenUpdateRequest: + description: Service Token Update Request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/ServiceTokenChangeOperation' + ServiceTokens: type: object + 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. properties: - include: - maxItems: 8 - type: array - items: - $ref: "#/components/schemas/StreamSubscriptionSelectorExpression" - except: - maxItems: 8 + data: + description: List of Service Tokens type: array items: - $ref: "#/components/schemas/StreamSubscriptionSelectorExpression" - StreamSubscriptionSelectorExpression: + $ref: '#/components/schemas/ServiceToken' + pagination: + $ref: '#/components/schemas/Pagination' + ServiceTokenActions: + description: Service Token action type type: string - description: | - Supported event or metric types to use on event and metric selectors: - * `*` - all events or metrics - * `equinix.fabric.company_profile.*` - company profile events - * `equinix.fabric.connection.*` - connection events, metrics, or alerts - * `equinix.fabric.connection_bgpipv4_session.*` - connection BGP IPv4 session events - * `equinix.fabric.connection_bgpipv6_session.*` - connection BGP IPv6 session events - * `equinix.fabric.connection_maintenance.*` - connection maintenance events - * `equinix.fabric.connection_route_aggregation.*` - connection route aggregation events - * `equinix.fabric.connection_route_filter.*` - connection route filter events - * `equinix.fabric.connection_routing_protocol.*` - connection routing protocol events - * `equinix.fabric.internet_access.*` - internet access service events - * `equinix.fabric.ip_block.*` - IP block events - * `equinix.fabric.metric` - metric collection events - * `equinix.fabric.metro.*` - metro metrics or alerts - * `equinix.fabric.network.*` - network events - * `equinix.fabric.physical_port.*` - physical port events - * `equinix.fabric.port.*` - virtual port events, metrics, or alerts - * `equinix.fabric.port_maintenance.*` - port maintenance events - * `equinix.fabric.route_aggregation.*` - route aggregation events - * `equinix.fabric.route_aggregation_rule.*` - route aggregation rule events - * `equinix.fabric.route_filter.*` - route filter events - * `equinix.fabric.route_filter_rule.*` - route filter rule events - * `equinix.fabric.router.*` - cloud router events or alerts - * `equinix.fabric.router_action.*` - cloud router action events - * `equinix.fabric.router_command.*` - cloud router command events - * `equinix.fabric.routing_protocol_action.*` - routing protocol action events - * `equinix.fabric.service_profile_connection.*` - service profile connection events - * `equinix.fabric.service_token.*` - service token events - * `equinix.fabric.time_service.*` - precision time service events - * `equinix.network.maintenance.*` - network maintenance events - * `equinix.network.repair.*` - network repair events - * `equinix.network_edge.*` - network edge events, metrics, or alerts - * `equinix.network_edge.acl.*` - network edge acl events - * `equinix.network_edge.device.*` - network edge device events - * `equinix.network_edge.device_interface.*` - network edge device interface metrics or alerts - * `equinix.network_edge.devicelinkgroup.*` - network edge device link group events - * `equinix.access_manager.*` - identity access manager events - * `equinix.access_manager.user.role.*` - identity access manager user role events - * `equinix.iam.principal.*` - IAM principal authorization and token events - * `equinix.identity.user.*` - identity user events - * `equinix.identity.organization.*` - identity organization membership events - * `equinix.resource_manager.organization.*` - resource manager organization events - * `equinix.resource_manager.project.*` - resource manager project events - example: equinix.fabric.connection.* - StreamSubscriptionSink: + enum: + - RESEND_EMAIL_NOTIFICATION + ServiceTokenActionRequest: + description: Service Token action request + type: object + properties: + type: + $ref: '#/components/schemas/ServiceTokenActions' required: - type + ServiceTokenSearchExpression: type: object properties: - uri: - type: string - description: any publicly reachable http endpoint - type: + and: + $ref: '#/components/schemas/ServiceTokenSearchExpressions' + or: + $ref: '#/components/schemas/ServiceTokenSearchExpressions' + property: + $ref: '#/components/schemas/ServiceTokenSearchFieldName' + operator: type: string - description: destination type enum: - - DATADOG - - DYNATRACE - - GOOGLE_PUBSUB - - PAGERDUTY - - SERVICENOW - - SLACK - - SPLUNK_HEC - - TEAMS - - WEBHOOK - 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: + - '=' + - '!=' + - LIKE + - ILIKE + - < + - '>' + - <= + - '>=' + - IN + - NOT IN + - BETWEEN + - NOT BETWEEN + values: + type: array + items: + type: string + ServiceTokenSearchExpressions: + type: array + items: + $ref: '#/components/schemas/ServiceTokenSearchExpression' + ServiceTokenSearchFieldName: + description: Possible field names to use on filters + type: string + enum: + - /uuid + - /state + - /name + - /project/projectId + - /type + - /expirationDateTime + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + - /connection/aSide/accessPointSelectors/port/uuid + - /connection/zSide/accessPointSelectors/port/uuid + ServiceTokenSearchRequest: type: object + description: Search requests containing criteria properties: - type: + filter: + $ref: '#/components/schemas/ServiceTokenSearchExpression' + pagination: + $ref: '#/components/schemas/PaginationRequest' + OpticalConnectRedundancy: + description: | + Optical Connect redundancy configuration.
Required only for DUAL_DIVERSE connection. + type: object + properties: + priority: + description: | + Role within the diverse pair.
PRIMARY - first connection of the pair.
SECONDARY - the diverse connection on a separate path. type: string - description: credential type + example: PRIMARY enum: - - ACCESS_TOKEN - - INTEGRATION_KEY - - API_KEY - - USERNAME_PASSWORD - - API_TOKEN - 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 - apiToken: + - PRIMARY + - SECONDARY + group: + description: Redundancy group identifier type: string - description: passed as Authorization header value - description: Stream subscription sink credentials - StreamSubscriptionSinkSetting: + format: uuid + OpticalConnectDemarcationPoint: + description: | + Specifies the demarcation point: the patch panel and ports at this side. type: object properties: - eventIndex: - type: string - description: event index - metricIndex: - type: string - description: metric index - source: - type: string - description: source - applicationKey: + patchPanelId: + description: Unique identifier of the patch panel. type: string - description: Application key - eventUri: + example: CP:Demarc:1259684 + patchPanelPortA: + description: | + Specify the desired port number for Port A.
When ports are not provided, next available ports will be used. type: string - description: event uri - metricUri: + example: '10' + patchPanelPortB: + description: | + Specify the desired port number for Port B.
When ports are not provided, next available ports will be used.
Required for Connector type FC, SC and ST only. type: string - description: metric uri - format: + example: '11' + connectorType: + description: Type of Connector type: string - description: webhook message format - default: CLOUDEVENT enum: - - CLOUDEVENT - - OPENTELEMETRY - description: Stream subscription sink settings - StreamSubscription: + - FC + - SC + - LC + - ST + example: SC + OpticalConnectASideRequest: + description: | + A-Side configuration. Always a patch panel port from your cage. type: object properties: - href: + demarcationPoint: + $ref: '#/components/schemas/OpticalConnectDemarcationPoint' + OpticalConnectLocation: + description: Destination location for BMMR and REMOTE connections. + type: object + properties: + ibxCode: + description: Equinix IBX data centre code. 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 + example: SV1 + OpticalConnectLOA: + description: | + Letter of Authorization granting the right to terminate at the Z-side location.
Required for BMMR and REMOTE. + type: object + properties: uuid: + description: Identifier of the Letter of Authorization 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: + example: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + OpticalConnectZSideRequest: + description: | + Z-Side configuration.
For COLO, specify the destination patch panel and ports.
For BMMR and REMOTE, specify the location and Letter of Authorization. + type: object + properties: + demarcationPoint: + $ref: '#/components/schemas/OpticalConnectDemarcationPoint' + location: + $ref: '#/components/schemas/OpticalConnectLocation' + loa: + $ref: '#/components/schemas/OpticalConnectLOA' + OpticalConnectOrder: + type: object + description: Ordering and billing reference details for this connection. + properties: + purchaseOrderNumber: type: string - description: Customer-provided subscription name - description: + description: Purchase order number reference. + example: PO-156576 + customerReferenceId: + description: Your own reference for this connection. type: string - description: Customer-provided subscription description - state: + orderNumber: + description: Equinix order reference number. 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/StreamSubscriptionSinkResponse" - operation: - $ref: "#/components/schemas/StreamSubscriptionOperation" - changeLog: - $ref: "#/components/schemas/Changelog" - description: Stream Subscription object - StreamSubscriptionId: - type: string - description: Stream Subscription UUID - format: uuid - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - StreamSubscriptionPutRequest: - required: - - name - - sink - - type + example: 1-129105284100 + OpticalConnectNotification: + description: Notification preferences for this connection. type: object properties: type: + description: | + Notification category.
NOTIFICATION - states and configuration updates.
ORDERING - order and fulfilment correspondence.
TECHNICAL - maintenance and technical advisories. 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 - filters: - $ref: "#/components/schemas/StreamSubscriptionFilter" - metricSelector: - $ref: "#/components/schemas/StreamSubscriptionSelector" - eventSelector: - $ref: "#/components/schemas/StreamSubscriptionSelector" - sink: - $ref: "#/components/schemas/StreamSubscriptionSink" - description: Update Stream Subscription - StreamSubscriptionSearchRequest: - required: - - filter - type: object - properties: - filter: - $ref: "#/components/schemas/StreamSubscriptionSearchFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + - NOTIFICATION + - ORDERING + - TECHNICAL + example: NOTIFICATION + emails: + description: Email addresses to notify. type: array items: - $ref: "#/components/schemas/StreamSubscriptionSearchSortCriteria" - description: Search requests containing criteria - StreamSubscriptionSearchFilters: - required: - - and - type: object - properties: - and: - minItems: 1 + type: string + format: email + registeredUsers: + description: Usernames of registered Equinix Portal users to notify. type: array items: - $ref: "#/components/schemas/StreamSubscriptionSearchFilter" - StreamSubscriptionSearchFilter: - type: object - anyOf: - - $ref: "#/components/schemas/StreamSubscriptionSearchSimpleExpression" - - $ref: "#/components/schemas/StreamSubscriptionSearchOrFilter" - StreamSubscriptionSearchSimpleExpression: + type: string + required: + - type + - emails + OpticalConnectPostRequest: type: object + description: |- + Request to order a single connection. The A-side is always a patch panel + port in your own cage; the Z-side shape depends on + connectionDestinationType. properties: - property: + type: type: string + description: OC - Optical Connect Type + enum: + - OC + example: OC + bandwidth: description: | - Possible field names to use on filters: - * `/uuid` - Subscription uuid - * `/streamUuid` - Stream uuid the subscription belongs to - * `/state` - Subscription state (`DEPROVISIONED` returned only when explicitly requested) - * `/name` - Subscription name - * `/project/projectId` - Subscription project id - * `/description` - Subscription description - * `/changeLog/createdDateTime` - Subscription created date time - * `/changeLog/updatedDateTime` - Subscription updated date time - example: /streamUuid - operator: - type: string + Connection bandwidth Mbps.
Available bandwidths depend on the IBX pair.
1000 - 1 Gbps.
10000 - 10 Gbps.
100000 - 100 Gbps.
+ type: integer + example: 100000 + connectionDestinationType: + description: | + Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
BMMR and REMOTE require a Letter of Authorization on the Z-side. + type: string + enum: + - COLO + - BMMR + - REMOTE + example: COLO + pathType: + type: string + description: | + Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs. + enum: + - DUAL_DIVERSE + - PROTECTED + - UNPROTECTED + example: PROTECTED + redundancy: + $ref: '#/components/schemas/OpticalConnectRedundancy' + aSide: + $ref: '#/components/schemas/OpticalConnectASideRequest' + zSide: + $ref: '#/components/schemas/OpticalConnectZSideRequest' + order: + $ref: '#/components/schemas/OpticalConnectOrder' + account: + $ref: '#/components/schemas/SimplifiedAccount' + notifications: + type: array + description: Contacts to notify about connection configuration and status changes + items: + $ref: '#/components/schemas/OpticalConnectNotification' + bmmrType: + type: string + description: | + BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR. + enum: + - EQUINIX + - SELF + example: EQUINIX + required: + - type + - bandwidth + - connectionDestinationType + - pathType + - aSide + - zSide + OpticalConnectState: + description: Optical Connect lifecycle states. + type: string + example: PROVISIONED + readOnly: true + enum: + - PROVISIONING + - PROVISIONED + - PROVISIONING_FAILED + - REPROVISIONING + - REPROVISIONING_FAILED + - DEPROVISIONING + - DEPROVISIONED + OpticalConnectResponseDemarcationPoint: + description: | + Demarcation point as provisioned, with the cage and cabinet it belongs to. + allOf: + - $ref: '#/components/schemas/OpticalConnectDemarcationPoint' + - type: object + properties: + cageUniqueSpaceId: + description: Unique identifier of the cage. + type: string + example: SV1:01:002174 + cabinetUniqueSpaceId: + description: Unique identifier of the cabinet. + type: string + example: Demarc + OpticalConnectASideResponse: + description: Originating end as provisioned, with the demarcation point and IBX location. + type: object + properties: + demarcationPoint: + $ref: '#/components/schemas/OpticalConnectResponseDemarcationPoint' + location: + $ref: '#/components/schemas/OpticalConnectLocation' + OpticalConnectZSideResponse: + description: Terminating end as provisioned, with the demarcation point and IBX location. + type: object + properties: + demarcationPoint: + $ref: '#/components/schemas/OpticalConnectResponseDemarcationPoint' + location: + $ref: '#/components/schemas/OpticalConnectLocation' + loa: + $ref: '#/components/schemas/OpticalConnectLOA' + OpticalConnectResponse: + description: |- + Optical Metro Connect connection with its current state and the resolved + physical termination points at both ends. + type: object + properties: + href: + type: string + description: URI of this Optical Connect resource. + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: + type: string + description: Unique identifier of this Optical Connect. + format: uuid + readOnly: true + example: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: + type: string + description: | + Connection Type.
OC - Optical Connect. + enum: + - OC + example: OC + name: + type: string + description: | + Equinix-assigned name, derived from the account number and the two IBX locations. + readOnly: true + example: 123456-SV1-SV2-01 + state: + $ref: '#/components/schemas/OpticalConnectState' + bandwidth: + type: integer + description: Provisioned connection bandwidth in Mbps. + example: 10000 + connectionDestinationType: + description: | + Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
+ type: string + enum: + - COLO + - BMMR + - REMOTE + pathType: + type: string + description: | + Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs. + enum: + - DUAL_DIVERSE + - PROTECTED + - UNPROTECTED + bmmrType: + type: string + description: | + BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR. + enum: + - EQUINIX + - SELF + redundancy: + $ref: '#/components/schemas/OpticalConnectRedundancy' + aSide: + $ref: '#/components/schemas/OpticalConnectASideResponse' + zSide: + $ref: '#/components/schemas/OpticalConnectZSideResponse' + order: + $ref: '#/components/schemas/OpticalConnectOrder' + account: + $ref: '#/components/schemas/SimplifiedAccount' + notifications: + description: Preferences for notifications on connection configuration or status changes + type: array + items: + $ref: '#/components/schemas/OpticalConnectNotification' + changeLog: + $ref: '#/components/schemas/Changelog' + BulkOpticalConnectRequest: + type: object + description: Request to create a dual diverse pair of Optical Connect connections. + properties: + data: + type: array + description: | + The two connections forming the diverse pair — one PRIMARY and one + SECONDARY. + items: + $ref: '#/components/schemas/OpticalConnectPostRequest' + OpticalConnectBulk: + description: Dual diverse pair Connection + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/OpticalConnectResponse' + OpticalConnectSimpleExpression: + type: object + properties: + property: + description: | + Possible field names to use on filters: + * `/name` - Connection name + * `/uuid` - Connection uuid + * `/type` - type + * `/state` - state + * `/bandwidth` - Bandwidth + type: string + example: /name + operator: description: | Possible operators to use on filters: * `=` - equal * `!=` - not equal - * `>` - greater than - * `>=` - greater than or equal to - * `<` - less than - * `<=` - less than or equal to - * `BETWEEN` - between - * `NOT BETWEEN` - not between - * `LIKE` - like - * `ILIKE` - like case-insensitive - * `IN` - in - * `NOT IN` - not in - example: = + * `[NOT] BETWEEN` - (not) between + * `[NOT] LIKE` - (not) like + * `[NOT] IN` - (not) in + * `ILIKE` - case-insensitive like + type: string + example: '=' values: - minItems: 1 type: array items: type: string - example: 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 - StreamSubscriptionSearchOrFilter: + example: 123456-SV1-SV2-01 + OpticalConnectOrFilter: type: object properties: or: type: array + maxItems: 3 items: - $ref: "#/components/schemas/StreamSubscriptionSearchSimpleExpression" - StreamSubscriptionSearchSortCriteria: - required: - - direction - - property + $ref: '#/components/schemas/OpticalConnectSimpleExpression' + OpticalConnectFilter: + type: object + description: A single condition, or a group of conditions combined with logical OR. + anyOf: + - $ref: '#/components/schemas/OpticalConnectSimpleExpression' + - $ref: '#/components/schemas/OpticalConnectOrFilter' + OpticalConnectFilters: type: object properties: - direction: - $ref: "#/components/schemas/StreamSubscriptionSearchSortDirection" - property: - $ref: "#/components/schemas/StreamSubscriptionSearchSortBy" - StreamSubscriptionSearchSortDirection: - type: string - description: Sorting direction + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/OpticalConnectFilter' + OpticalConnectSortDirection: + description: | + Sorting direction.
ASC - ascending
DESC - descending default: DESC + type: string enum: - DESC - ASC - StreamSubscriptionSearchSortBy: - type: string + OpticalConnectSortBy: description: Possible field names to use on sorting - default: /changeLog/createdDateTime + default: /changeLog/updatedDateTime + type: string enum: + - /name + - /uuid + - /state + - /type + - /bandwidth + - /aSide/location/ibxCode + - /zSide/location/ibxCode - /changeLog/createdDateTime - /changeLog/updatedDateTime - SearchStreamSubscriptionResponse: + OpticalConnectSortCriteria: + type: object + description: Sorting to apply to search results. + properties: + direction: + $ref: '#/components/schemas/OpticalConnectSortDirection' + property: + $ref: '#/components/schemas/OpticalConnectSortBy' + OpticalConnectSearchRequest: type: object + description: |- + Search criteria for retrieving Optical Connects, with optional + filtering, pagination and sorting. properties: + filter: + $ref: '#/components/schemas/OpticalConnectFilters' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/StreamSubscription" - GetAllStreamAlertRuleResponse: + $ref: '#/components/schemas/OpticalConnectSortCriteria' + OpticalConnectServiceSearchResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: - type: array description: Data returned from the API call. + type: array items: - $ref: "#/components/schemas/StreamAlertRule" - AlertRulePostRequest: - required: - - detectionMethod - - metricSelector - - name - - resourceSelector - - type + $ref: '#/components/schemas/OpticalConnectResponse' + Presence: + description: Presence + type: string + enum: + - MY_PORTS + GeoCoordinates: + description: Geographic location data of Fabric Metro + type: object + properties: + latitude: + description: Latitude of a Fabric Metro + type: number + format: double + longitude: + description: Longitude of a Fabric Metro + type: number + format: double + ConnectedMetro: + description: Arrays of objects containing latency data for the specified metros + type: object + properties: + href: + description: The Canonical URL at which the resource resides. + type: string + code: + description: Code assigned to an Equinix International Business Exchange (IBX) data center in a specified metropolitan area. + type: string + avgLatency: + description: Average latency (in milliseconds[ms]) between two specified metros. + type: number + remoteVCBandwidthMax: + description: This field holds the Max Connection speed with connected metros + type: integer + format: int64 + services: + description: Arrays of objects containing type of services supported in the specified metros type: object properties: type: + description: Type of Service + type: string + GeoZone: + description: Geographic zone of a Fabric Metro + type: object + properties: + code: + description: Code assigned to a geographic zone. type: string - enum: - - METRIC_ALERT name: + description: Name of a geographic zone. type: string - description: Customer-provided stream name description: + description: Description of a geographic zone. type: string - description: Customer-provided stream description - enabled: - type: boolean - description: Stream alert rule enabled status - example: true - default: true - metricSelector: - $ref: "#/components/schemas/MetricSelector" - resourceSelector: - $ref: "#/components/schemas/ResourceSelector" - detectionMethod: - $ref: "#/components/schemas/DetectionMethod" - description: Create Stream Alert Rules - MetricSelector: - required: - - include + 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. type: object properties: - include: + href: + description: The Canonical URL at which the resource resides. + type: string + type: + description: Indicator of a Fabric Metro + type: string + code: + description: Code Assigned to an Equinix IBX data center in a specified metropolitan area. + type: string + region: + description: Board geographic area in which the data center is located + type: string + name: + description: Name of the region in which the data center is located. + type: string + country: + description: Country code in which the data center is located. + type: string + equinixAsn: + 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. + type: integer + format: int64 + localVCBandwidthMax: + description: This field holds Max Connection speed with in the metro + type: integer + format: int64 + geoCoordinates: + $ref: '#/components/schemas/GeoCoordinates' + connectedMetros: type: array - description: Stream alert rule filtered by metric name items: - type: string - example: equinix.fabric.metro.sv_da.latency - ResourceSelector: - required: - - include + $ref: '#/components/schemas/ConnectedMetro' + services: + type: array + items: + $ref: '#/components/schemas/services' + geoScopes: + description: List of supported geographic boundaries of a Fabric Metro. + type: array + items: + $ref: '#/components/schemas/GeoScopeType' + geoZones: + description: List of supported geographic zones of a Fabric Metro. + type: array + items: + $ref: '#/components/schemas/GeoZone' + MetroResponse: + 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. type: object properties: - include: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: List of Fabric Metros. type: array - description: | - ### Supported metric names to use on filters with property /subject: - * `/fabric/v4/ports/` - port metrics - * `/fabric/v4/connections/` - connection metrics - * `/fabric/v4/metros/` - metro latency metrics items: - type: string - DetectionMethod: + $ref: '#/components/schemas/Metro' + MetroError: + description: Error with details required: - - type + - errorCode + - errorMessage type: object + discriminator: + propertyName: errorCode properties: - type: + errorCode: type: string - description: | - * THRESHOLD - Alert when a metric crosses a defined threshold by user. - * OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric. enum: - - THRESHOLD - - OUTLIER - windowSize: - type: string - description: Stream alert rule metric window size - example: PT15M - operand: + - EQ-3036001 + - EQ-3036013 + - EQ-3036030 + - EQ-3036100 + errorMessage: type: string - description: Stream alert rule metric operand enum: - - ABOVE - - BELOW - warningThreshold: + - Unauthorized + - Invalid Query Parameter + - Invalid Path Parameter + - Invalid Query or Path Parameter + - Internal Server Error + - Metro Not Found + correlationId: type: string - description: Stream alert rule metric warning threshold - criticalThreshold: + details: type: string - description: Stream alert rule metric critical threshold - StreamAlertRule: + help: + type: string + additionalInfo: + type: array + items: + type: object + properties: + property: + type: string + reason: + type: string + MetroErrorList: + type: array + items: + $ref: '#/components/schemas/MetroError' + PortChangeOperation: + description: Port change operation data type: object properties: - href: + op: + description: Handy shortcut for operation name type: string - description: Stream Alert Rule URI - format: uri - readOnly: true + example: replace + path: + description: path inside document leading to updated parameter + type: string + example: /name + value: + description: new value for updated parameter + required: + - op + - path + - value + PortChange: + description: Current state of latest port change + type: object + properties: uuid: + description: Uniquely identifies a change type: string - description: Equinix-assigned access point identifier - format: uuid - example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: + description: Type of change type: string - description: Stream subscription type enum: - - METRIC_ALERT - name: + - PORT_CREATION + - PORT_UPDATE + - PORT_DELETION + status: + description: Current outcome of the change flow type: string - description: Customer-provided stream alert rule name - description: + enum: + - COMPLETED + - FAILED + - REQUESTED + information: + description: Additional information type: string - description: Customer-provided stream alert rule description - state: + data: + $ref: '#/components/schemas/PortChangeOperation' + createdDateTime: + description: Set when change flow starts + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + updatedDateTime: + description: Set when change object is updated + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + PortLag: + description: Port Lag + type: object + properties: + id: + description: id type: string - description: Steam subscription provision state - enum: - - ACTIVE - - INACTIVE enabled: + deprecated: true + description: enabled type: boolean - description: Stream alert rule enabled status - default: true - metricSelector: - $ref: "#/components/schemas/MetricSelectorResponse" - resourceSelector: - $ref: "#/components/schemas/ResourceSelectorResponse" - detectionMethod: - $ref: "#/components/schemas/DetectionMethodResponse" - changeLog: - $ref: "#/components/schemas/Changelog" - description: Stream object - AlertRuleId: - type: string - description: Stream Alert Rule UUID - format: uuid - example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 - AlertRulePutRequest: - required: - - detectionMethod - - metricSelector - - name - - resourceSelector - - type - type: object - properties: name: + description: name type: string - description: Customer-provided stream name - type: - type: string - enum: - - METRIC_ALERT - description: + memberStatus: + description: member status type: string - description: Customer-provided stream description - enabled: - type: boolean - description: Stream alert rule enabled status - default: true - metricSelector: - $ref: "#/components/schemas/MetricSelector" - resourceSelector: - $ref: "#/components/schemas/ResourceSelector" - detectionMethod: - $ref: "#/components/schemas/DetectionMethod" - description: Create Stream Alert Rules - CompanyProfileRequest: - required: - - description - - name - - summary - - type - - webUrl + Port: + description: Port specification type: object properties: + href: + description: Equinix assigned response attribute for an absolute URL that is the subject of the link's context. + type: string + format: uri + readOnly: true type: + $ref: '#/components/schemas/PortType' + uuid: + description: Equinix assigned response attribute for port identifier type: string - example: COMPANY_PROFILE + format: uuid name: - maxLength: 50 - minLength: 1 - type: string - example: Equinix - summary: - maxLength: 125 - minLength: 1 + description: Equinix assigned response attribute for Port name type: string - example: Global interconnection and data center company description: - maxLength: 450 - minLength: 1 - type: string - example: Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers. - pointOfContacts: - type: array - example: - - type: SUPPORT - contacts: - - name: Peter Griffin - role: Vice President of Sales - email: example1@example.com - - name: Taylor Swift - role: Director of Marketing - email: example2@example.com - - name: Darth Vader - role: Head of Engineering - email: example3@example.com - items: - $ref: "#/components/schemas/CompanyProfileContact" - notifications: - type: array - example: - - type: NOTIFICATION - emails: - - example1@example.com - - example2@example.com - items: - $ref: "#/components/schemas/SimplifiedNotification" - overview: - type: string - example: About Initech Corp

lorem ipsum

- webUrl: - type: string - example: https://www.equinix.com - contactUrl: + description: Equinix assigned response attribute for Port description type: string - example: https://www.equinix.com/contact-us - CompanyProfileResponse: - type: object - properties: - href: + physicalPortsSpeed: + description: Physical Ports Speed in Mbps + type: integer + minimum: 0 + connectionsCount: + description: Equinix assigned response attribute for Connection count + type: integer + minimum: 0 + physicalPortsType: + description: Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports type: string - example: https://api.equinix.com/fabric/v4/companyProfiles/123e4567-e89b-12d3-a456-426614174000 - uuid: + enum: + - 1000BASE_LX + - 10GBASE_LR + - 100GBASE_LR4 + - 10GBASE_ER + - 1000BASE_SX + - 10GBASE_SMF + - 400GBASE_LR4 + physicalPortsCount: + type: integer + connectivitySourceType: + description: Port connectivity type type: string - example: 123e4567-e89b-12d3-a456-426614174000 - type: + enum: + - COLO + - BMMR + - REMOTE + bmmrType: type: string - example: COMPANY_PROFILE - name: - maxLength: 50 - minLength: 1 + 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: + deprecated: true + description: Port service Type type: string - example: Equinix - summary: - maxLength: 125 - minLength: 1 + enum: + - EPL + - MSP + serviceCode: + $ref: '#/components/schemas/PortServiceCode' + bandwidth: + deprecated: true + description: Equinix assigned response attribute for Port bandwidth in Mbps + type: integer + minimum: 0 + availableBandwidth: + description: Equinix assigned response attribute for Port available bandwidth in Mbps + type: integer + minimum: 0 + usedBandwidth: + description: Equinix assigned response attribute for Port used bandwidth in Mbps + type: integer + minimum: 0 + location: + $ref: '#/components/schemas/SimplifiedLocation' + device: + $ref: '#/components/schemas/PortDevice' + interface: + $ref: '#/components/schemas/PortInterface' + demarcationPointIbx: + description: A-side/Equinix ibx type: string - example: Global interconnection and data center company - description: - maxLength: 450 - minLength: 1 + tetherIbx: + description: z-side/Equinix ibx type: string - example: Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers. - state: - $ref: "#/components/schemas/CompanyProfileState" - account: - $ref: "#/components/schemas/CompanyProfileResponse_account" - metros: - type: array - example: - - href: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - items: - $ref: "#/components/schemas/CompanyMetro" - logo: - $ref: "#/components/schemas/CompanyLogo" - tags: - type: array - example: - - href: https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387 - uuid: 260af68b-42f0-4f2e-9c5c-2fbd44b4b387 - type: RESOURCE_TAG - name: environment - displayName: Environment - weight: 30000 - items: - $ref: "#/components/schemas/TagResponse" - serviceProfiles: + demarcationPoint: + $ref: '#/components/schemas/PortDemarcationPoint' + redundancy: + $ref: '#/components/schemas/PortRedundancy' + encapsulation: + $ref: '#/components/schemas/PortEncapsulation' + lagEnabled: + description: If LAG enabled + type: boolean + lag: + allOf: + - $ref: '#/components/schemas/PortLag' + deprecated: true + asn: + description: Port ASN + type: integer + package: + $ref: '#/components/schemas/Package' + settings: + $ref: '#/components/schemas/PortSettings' + physicalPortQuantity: + description: Number of physical ports + type: integer + notifications: + description: Notification preferences type: array - example: - - href: https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387 - uuid: 423af68b-42f0-4f2e-9c5c-2fbd44b4b387 - type: L2_PROFILE items: - $ref: "#/components/schemas/CompanyServiceProfile" - privateServices: + $ref: '#/components/schemas/PortNotification' + additionalInfo: + description: Port additional information type: array - example: - - href: https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387 - uuid: 460af68b-42f0-4f2e-9c5c-2fbd44b4b387 - - href: https://api.equinix.com/fabric/v4/privateServices/8a5685a6-063d-41ac-9279-d32431e8d8f6 - uuid: 8a5685a6-063d-41ac-9279-d32431e8d8f6 items: - $ref: "#/components/schemas/PrivateService" - pointOfContacts: + $ref: '#/components/schemas/PortAdditionalInfo' + physicalPorts: type: array - example: - - type: SUPPORT - contacts: - - name: Peter Griffin - role: Vice President of Sales - email: example1@example.com - - name: Taylor Swift - role: Director of Marketing - email: example2@example.com - - name: Darth Vader - role: Head of Engineering - email: example3@example.com + description: Physical ports that implement this port items: - $ref: "#/components/schemas/CompanyProfileContact" - notifications: + $ref: '#/components/schemas/PhysicalPort' + loas: + description: Port Loas type: array - example: - - type: NOTIFICATION - emails: - - example1@example.com - - example2@example.com items: - $ref: "#/components/schemas/SimplifiedNotification" - overview: - type: string - example: About Initech Corp

lorem ipsum

- webUrl: - type: string - example: https://www.equinix.com - contactUrl: - type: string - example: https://www.equinix.com/contact-us - change: - $ref: "#/components/schemas/CompanyProfileChange" - changeLog: - $ref: "#/components/schemas/Changelog" - CompanyProfileSearchRequest: + $ref: '#/components/schemas/PortLoa' + marketplaceSubscription: + $ref: '#/components/schemas/marketplaceSubscription' + AllPortsResponse: + description: GET All User Port Across Fabric Metros type: object properties: - filter: - $ref: "#/components/schemas/CompanyProfileSearchFilters" - pagination: - $ref: "#/components/schemas/Pagination" - sort: - $ref: "#/components/schemas/Sort" - example: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONED - - or: - - property: /name - operator: ILIKE - values: - - equinix - - property: /tags/name - operator: = - values: - - environment pagination: - offset: 0 - limit: 20 - total: 0 - sort: - property: /changeLog/updatedDateTime - direction: DESC - CompanyProfileSearchFilters: - type: object - properties: - and: + $ref: '#/components/schemas/Pagination' + data: + description: GET All User Port Across Fabric Metros type: array items: - $ref: "#/components/schemas/CompanyProfileSearchFilter" - description: | - Filter criteria for company profile search. The `and` array combines conditions where all must match. Each item in `and` is either a simple expression (property/operator/values) or an `or` group. At most one `or` group is allowed per request. - CompanyProfileSearchFilter: - type: object - oneOf: - - $ref: "#/components/schemas/CompanyProfileSearchSimpleExpression" - - $ref: "#/components/schemas/CompanyProfileSearchOrFilter" - CompanyProfileSearchSimpleExpression: - required: - - operator - - property - - values + $ref: '#/components/schemas/Port' + SimplifiedAccountRequest: type: object properties: - property: - description: | - Searchable field name. Properties are grouped by their supported operators: - String properties (support all operators): - * `/name` - Company profile name - * `/uuid` - Company profile UUID - * `/tags/name` - Tag name - * `/tags/uuid` - Tag UUID - * `/tags/displayName` - Tag display name - - Discrete value properties (only support `=`, `!=`, `IN`, `NOT IN`): - * `/state` - Company profile state (`PENDING`, `PROVISIONED`, `DEPROVISIONED`, `REJECTED`) - * `/metros/metroCode` - Metro code (e.g. `SV`, `NY`, `DC`) - * `/change/status` - Change status (`PENDING`, `COMPLETED`, `REJECTED`) — seller and admin users only - example: /state - allOf: - - $ref: "#/components/schemas/CompanyProfileSearchFieldName" - operator: - description: | - Comparison operator. `LIKE`, `NOT LIKE`, `ILIKE`, and `NOT ILIKE` require exactly one value. All other operators accept one or more values. - * `=` - equal; equivalent to `IN` when multiple values are provided - * `!=` - not equal; equivalent to `NOT IN` when multiple values are provided - * `LIKE` - case-sensitive partial match (single value) - * `NOT LIKE` - case-sensitive partial non-match (single value) - * `ILIKE` - case-insensitive partial match (single value) - * `NOT ILIKE` - case-insensitive partial non-match (single value) - * `IN` - matches any of the provided values - * `NOT IN` - does not match any of the provided values - example: IN - allOf: - - $ref: "#/components/schemas/OperatorEnum" - values: - minItems: 1 - type: array - example: - - PROVISIONED - - PENDING - items: - type: string - CompanyProfileSearchFieldName: - type: string - description: Searchable field names in company profile - example: /tags/name - enum: - - /name - - /uuid - - /tags/name - - /tags/uuid - - /tags/displayName - - /state - - /metros/metroCode - - /change/status - OperatorEnum: - type: string - description: Comparison operators for filtering - example: = - enum: - - = - - "!=" - - LIKE - - NOT LIKE - - ILIKE - - NOT ILIKE - - IN - - NOT IN - CompanyProfileSearchOrFilter: + accountNumber: + description: Account number + type: integer + format: int64 required: - - or - type: object - properties: - or: - minItems: 1 - type: array - items: - $ref: "#/components/schemas/CompanyProfileSearchSimpleExpression" - description: | - Groups multiple simple expressions with OR logic. At most one `or` group is allowed within the top-level `and` array. - Sort: + - accountNumber + SimplifiedLocationRequest: type: object properties: - property: + metroCode: type: string - description: | - Property to sort by. Supported values: - * `/name` - Company profile name - * `/state` - Company profile state - * `/changeLog/updatedDateTime` - Date and time the profile was last updated - * `/changeLog/createdDateTime` - Date and time the profile was created - example: /changeLog/updatedDateTime - direction: - $ref: "#/components/schemas/CompanyProfileSortDirection" - CompanyProfileSearchResponse: + example: AM required: - - data - - pagination + - metroCode + PortRequest: + description: PortRequest is the Request Object for creating single and bulk fabric ports type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + type: + $ref: '#/components/schemas/PortType' + physicalPortsSpeed: + description: Physical Ports Speed in Mbps + type: integer + minimum: 0 + physicalPortsType: + description: Physical Ports Type. 10GBASE_SMF is only applicable for IX ports + type: string + enum: + - 1000BASE_LX + - 10GBASE_LR + - 100GBASE_LR4 + - 10GBASE_ER + - 1000BASE_SX + - 10GBASE_SMF + - 400GBASE_LR4 + physicalPortsCount: + type: integer + connectivitySourceType: + description: Port connectivity type + type: string + enum: + - COLO + - BMMR + - REMOTE + bmmrType: + description: BMMR Type is mandatory when connectivitySourceType is BMMR + type: string + enum: + - SELF + - EQUINIX + project: + $ref: '#/components/schemas/Project' + order: + $ref: '#/components/schemas/PortOrder' + account: + $ref: '#/components/schemas/SimplifiedAccountRequest' + serviceType: + deprecated: true + description: Port service Type + type: string + enum: + - EPL + - MSP + serviceCode: + $ref: '#/components/schemas/PortServiceCode' + bandwidth: + deprecated: true + description: Equinix assigned response attribute for Port bandwidth in Mbps + type: integer + minimum: 0 + location: + $ref: '#/components/schemas/SimplifiedLocationRequest' + demarcationPointIbx: + description: A-side/Equinix ibx + type: string + tetherIbx: + description: z-side/Equinix ibx + type: string + demarcationPoint: + $ref: '#/components/schemas/PortDemarcationPoint' + redundancy: + $ref: '#/components/schemas/PortRedundancy' + encapsulation: + $ref: '#/components/schemas/PortEncapsulation' + lagEnabled: + description: Indicates whether Link Aggregation Group (LAG) is enabled on this port + type: boolean + package: + $ref: '#/components/schemas/Package' + notifications: + description: Notification preferences type: array items: - $ref: "#/components/schemas/CompanyProfileResponse" - ServiceProfileListResponse: - type: object - properties: - data: + $ref: '#/components/schemas/PortNotification' + physicalPorts: type: array - description: List of service profiles - example: - - href: https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387 - uuid: 423af68b-42f0-4f2e-9c5c-2fbd44b4b387 + description: Physical ports that implement this port items: - $ref: "#/components/schemas/CompanyServiceProfile" - AttachServiceProfileResponse: + $ref: '#/components/schemas/PhysicalPort' + loas: + description: Port Loas + type: array + items: + $ref: '#/components/schemas/PortLoa' required: - type - - uuid - type: object - properties: - href: - type: string - description: URL to the attached service profile - example: https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387 - type: - type: string - description: Type of the service or attachment - example: SERVICE_PROFILE - uuid: - type: string - description: Unique identifier for the service profile - example: 423af68b-42f0-4f2e-9c5c-2fbd44b4b387 - attachmentStatus: - type: string - description: Status of the attachment operation - example: ATTACHED - TagListResponse: + - physicalPortsSpeed + - physicalPortsType + - connectivitySourceType + - location + - encapsulation + - account + - project + BulkPhysicalPort: type: object + description: Add to Lag request properties: data: + description: add physical ports to virtual port type: array items: - $ref: "#/components/schemas/TagResponse" + $ref: '#/components/schemas/PhysicalPort' + AllPhysicalPortsResponse: + description: GET All Physical Ports + type: object + properties: pagination: - $ref: "#/components/schemas/Pagination" - description: Equinix Fabric Tag List Response Object - TagResponse: - type: object - properties: - href: - type: string - format: uri - example: https://api.equinix.com/fabric/v4/tags/18a127ad-9d0c-46e2-a66d-8ed85d1858b0 - uuid: - type: string - format: uuid - example: 18a127ad-9d0c-46e2-a66d-8ed85d1858b0 - type: - type: string - example: PREDEFINED_TAG - name: - type: string - example: equinix.fabric.spotlight.ai.llm - displayName: - type: string - example: LLM - state: - type: string - description: Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT - example: PENDING_APPROVAL - enum: - - APPROVED - - PENDING_APPROVAL - - REJECTED - notifications: - type: array - example: - - type: NOTIFICATION - emails: - - example1@example.com - - example2@example.com - items: - $ref: "#/components/schemas/SimplifiedNotification" - changeLog: - $ref: "#/components/schemas/Changelog" - weight: - type: integer - example: 30000 - description: Equinix Fabric Tag Response Object - AttachTagResponse: - required: - - type - - uuid - type: object - properties: - href: - type: string - description: URL to the attached tag - example: https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387 - type: - type: string - description: Type of the tag or attachment - example: TAG - uuid: - type: string - description: Unique identifier for the tag - example: 260af68b-42f0-4f2e-9c5c-2fbd44b4b387 - attachmentStatus: - type: string - description: Status of the attachment operation - example: ATTACHED - PrivateServiceListResponse: - type: object - properties: + $ref: '#/components/schemas/Pagination' data: + description: GET All Physical Ports type: array - description: List of private services - example: - - href: https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387 - uuid: 460af68b-42f0-4f2e-9c5c-2fbd44b4b387 items: - $ref: "#/components/schemas/PrivateService" - AttachPrivateServiceResponse: - required: - - type - - uuid - type: object - properties: - href: - type: string - description: URL to the attached private service - example: https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387 - type: - type: string - description: Type of the private service or attachment - example: PRIVATE_SERVICE - uuid: - type: string - description: Unique identifier for the private service - example: 460af68b-42f0-4f2e-9c5c-2fbd44b4b387 - attachmentStatus: - type: string - description: Status of the attachment operation - example: ATTACHED - LogoRequest: - required: - - description - - logo - - name - - type + $ref: '#/components/schemas/PhysicalPort' + PortUpdateRequest: + description: Port Update Request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/PortChangeOperation' + LinkProtocolState: + description: Network status + type: string + enum: + - RESERVED + - RELEASED + LinkProtocolRequestType: + description: Type of Link Protocol + type: string + enum: + - UNTAGGED + - DOT1Q + - QINQ + - VXLAN + SubInterface: + description: Sub Interface information type: object properties: - logo: - type: string - description: Logo image file - format: binary name: - maxLength: 24 - minLength: 1 - type: string - description: Name of the Logo - example: Equinix Logo - description: - maxLength: 125 - minLength: 1 - type: string - description: Description of the logo - example: Company branding logo - type: + deprecated: true + description: name of subInterface of a port type: string - description: Type of logo - example: COMPANY_LOGO - description: Equinix Fabric Logo Request Object - LogoResponse: + unit: + type: integer + example: 200 + LinkProtocolConnection: + description: Connection details of Link Protocol type: object properties: href: + description: Connection URI type: string format: uri - example: https://api.equinix.com/fabric/v4/logos/18a127ad-9d0c-46e2-a66d-8ed85d1858b0 + readOnly: true uuid: type: string - format: uuid - example: 18a127ad-9d0c-46e2-a66d-8ed85d1858b0 + format: string + example: cd67f685-41b0-1b07-6de0-320a5c00abe type: type: string - description: Type of logo - example: COMPANY_LOGO - name: - type: string - example: Equinix Logo - description: - type: string - example: Company branding logo - status: - type: string - example: CREATED - extensionType: - type: string - example: .png - changelog: - $ref: "#/components/schemas/Changelog" - description: Equinix Fabric Logo Response Object - CreateLoa: - description: Create Loa - oneOf: - - $ref: "#/components/schemas/IssueLoa" - - $ref: "#/components/schemas/RequestLoa" - LoaResponse: + example: EVPL_VC + bandwidth: + type: integer + format: int64 + example: 100 + LinkProtocolServiceToken: + description: Service Token details of Link Protocol type: object properties: href: + description: Service Token URI type: string - description: URI of this LOA resource. format: uri - example: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + readOnly: true uuid: type: string - description: Unique identifier of this LOA. format: uuid - example: 29cc7878-54e3-4e1a-8651-87a61354bac2 + example: cd67f685-41b0-1b07-6de0-320a5c00eabe type: - $ref: "#/components/schemas/LoaType" - name: - type: string - description: A short, descriptive name for this LOA - example: LOA-Equinix-SV1-2026 - description: type: string - description: Additional context about this LOA - example: Authorization for patch panel port access to Equinix at SV1 - authorizedProductType: - $ref: "#/components/schemas/LoaProductType" - state: - $ref: "#/components/schemas/LoaState" - operation: - $ref: "#/components/schemas/LoaResponse_operation" - requestor: - $ref: "#/components/schemas/LoaRequestor" - issuer: - $ref: "#/components/schemas/LoaIssuer" - demarcationPoint: - $ref: "#/components/schemas/LoaDemarcationPoint" - location: - $ref: "#/components/schemas/LoaLocation" - expirationDateTime: - $ref: "#/components/schemas/LoaExpiration" - changeLog: - $ref: "#/components/schemas/LoaChangelog" - description: Loa Response - LoaId: - type: string - description: Loa UUID - format: uuid - example: 29cc7878-54e3-4e1a-8651-87a61354bac2 - LoaUpdate: - type: array - items: - $ref: "#/components/schemas/LoaReplaceOperation" - LoaReplaceOperation: - required: - - op - - path - - value - type: object - properties: - op: - $ref: "#/components/schemas/LoaOpEnum" - path: - $ref: "#/components/schemas/LoaPath" - value: - description: New value for updated parameter - description: Replace attribute value or sub-resource in the existing model - LoaOpEnum: - type: string - description: Operation to be performed - enum: - - replace - - add - - remove - LoaPath: - type: string - description: | - ### A JSON Pointer path. - * `/name` - Name of the Loa - * `/description` - Description of the Loa - * `/requestor/email` - Email of the requestor contact - * `/requestor/orgName` - Organization name of the requestor - * `/issuer/email` - Email of the issuer contact - * `/issuer/orgName` - Organization name of the issuer - * `/demarcationPoint/patchPanelId` - Patch Panel Identifier - * `/demarcationPoint/patchPanelPortA` - Patch Panel Port A - * `/demarcationPoint/patchPanelPortB` - Patch Panel Port B - * `/demarcationPoint/connectorType` - Connector Type - * `/demarcationPoint/cageUniqueSpaceId` - Cage Unique Space Identifier - * `/expirationDateTime` - Expiration date and time of the Loa - * `/location/ibxCode` - IBX code of the Eligible location - LoaActionRequest: - title: AuthorizeLoa - required: - - type - type: object - properties: - type: - $ref: "#/components/schemas/LoaActionType" - data: - $ref: "#/components/schemas/LoaActionData" - description: Action Request - LoaActionResponse: + example: TOKEN + bandwidth: + type: integer + format: int64 + example: 1000 + LinkProtocolResponse: + description: Link Protocol response type: object properties: href: + description: LinkProtocol URI type: string - description: Action URI format: uri - example: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + readOnly: true uuid: + description: Equinix-assigned network identifier type: string - description: Action Identifier format: uuid - example: 30cc7878-54e3-4e1a-8651-87a61354bad4 + example: 92dc376a-a932-43aa-a6a2-c806dedbd784 state: - $ref: "#/components/schemas/LoaActionState" + $ref: '#/components/schemas/LinkProtocolState' + example: ACTIVE type: - $ref: "#/components/schemas/LoaActionType" - data: - $ref: "#/components/schemas/LoaActionData" + $ref: '#/components/schemas/LinkProtocolRequestType' + example: DOT1Q + 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/LoaChangelog" - description: Action Response - ActionId_2: - type: string - description: Action UUID - format: uuid - example: 30cc7878-54e3-4e1a-8651-87a61354bad4 - LoaSearchRequest: + $ref: '#/components/schemas/Changelog' + LinkProtocolGetResponse: + description: List of Vlans type: object properties: - filter: - $ref: "#/components/schemas/LoaSearchFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + $ref: '#/components/schemas/Pagination' + data: type: array items: - $ref: "#/components/schemas/LoaSortCriteria" - description: Search loas based on filter criteria - LoaSearchFilters: + $ref: '#/components/schemas/LinkProtocolResponse' + PortExpression: type: object properties: and: - maxItems: 8 - type: array - items: - $ref: "#/components/schemas/LoaFilter" - LoaFilter: - type: object - anyOf: - - $ref: "#/components/schemas/LoaSimpleExpression" - - $ref: "#/components/schemas/LoaOrFilter" - LoaSimpleExpression: - type: object - properties: + $ref: '#/components/schemas/PortExpressions' + or: + $ref: '#/components/schemas/PortExpressions' property: - $ref: "#/components/schemas/LoaFieldName" + description: | + Possible field names to use on filters: + * `/project/projectId` - project id + * `/settings/productCode` - Product Type CX + * `/state` - Port Status ACTIVE + $ref: '#/components/schemas/PortSearchFieldName' operator: type: string - example: = enum: - - = - - "!=" + - '=' + - '!=' + - '>' + - '>=' + - < + - <= - LIKE - ILIKE - - BETWEEN - - NOT BETWEEN - IN - NOT IN - - ">" - - < - - ">=" - - <= + - BETWEEN values: type: array - example: - - Loa-2026 items: type: string - LoaFieldName: - type: string + description: | + Either use 'and' for AND operations, 'or' for OR operations, or specify 'property', 'operator', and 'values' for field filtering. Only one of these patterns should be used at a time. + PortExpressions: + type: array + items: + $ref: '#/components/schemas/PortExpression' + PortSearchFieldName: description: Possible field names to use on filters - example: /name + type: string enum: - - /uuid + - /device/name + - /physicalPorts/tether/crossConnectId + - /physicalPorts/interface/name - /state - - /type + - /project/projectId + - /uuid - /name - - /authorizedProductType - - /expirationDateTime - - /requestor/email - - /requestor/orgId - - /requestor/orgName - - /issuer/email - - /issuer/orgId - - /issuer/orgName - - /demarcationPoint/patchPanelId - - /demarcationPoint/patchPanelPortA - - /demarcationPoint/patchPanelPortB - - /demarcationPoint/connectorType - - /demarcationPoint/cageUniqueSpaceId - - /location/ibxCode - - /changeLog/createdDateTime + - /account/orgId + - /account/accountNumber + - /location/metroCode + - /operation/maintenanceStatus + - /operation/lockEnabled + x-enum-deprecations: + /device/name: true + /physicalPorts/interface/name: true + PortSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + PortSortBy: + description: Possible field names to use on sorting + default: /device/name + type: string + enum: + - /device/name + - /name + - /state + - /location/metroName + - /demarcationPointIbx + - /device/redundancy/priority + - /lagEnabled + - /physicalPortsSpeed + - /encapsulation/type + - /physicalPorts/tether/crossConnectId + - /package/code - /changeLog/updatedDateTime - LoaOrFilter: + - /changeLog/createdDateTime + - /bandwidth + - /serviceCode + - /operation/maintenanceStatus + PortSortCriteria: type: object properties: - or: + direction: + $ref: '#/components/schemas/PortSortDirection' + property: + $ref: '#/components/schemas/PortSortBy' + PortV4SearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/PortExpression' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array items: - $ref: "#/components/schemas/LoaSimpleExpression" - LoaSortCriteria: + $ref: '#/components/schemas/PortSortCriteria' + required: + - filter + PortPackageSourceType: + type: string + description: Port Package Source Type + enum: + - COLO + - REMOTE + - BMMR + PortPackage: type: object + description: Port Package details properties: - direction: + href: type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - property: + description: Port Package URI + readOnly: true + type: type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime + description: Port Package Type enum: - - /name - - /expirationDateTime - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - LoaSearchResponse: - type: object - properties: - pagination: - $ref: "#/components/schemas/Pagination" - sort: + - PORT_PACKAGE + code: + type: string + description: Port Package code + vcBandwidthMax: + type: integer + description: Maximum virtual connection bandwidth in Mbps + vcRemoteSupported: + type: boolean + description: Indicates if remote virtual connections are supported + supportedServiceTypes: type: array + description: List of supported service types items: - $ref: "#/components/schemas/LoaSortCriteria" - data: + type: string + description: Port Package Service Type + enum: + - MSP + supportedSourceTypes: type: array + description: List of supported source types items: - $ref: "#/components/schemas/LoaResponse" - description: List of LOAs - LoaActionSearchRequest: - type: object - properties: - filter: - $ref: "#/components/schemas/LoaActionSearchFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + $ref: '#/components/schemas/PortPackageSourceType' + supportedMetros: type: array + description: List of supported metros items: - $ref: "#/components/schemas/LoaActionSortCriteria" - description: Search loa actions based on filter criteria - LoaActionSearchFilters: + type: string + required: + - type + - code + AllPortPackagesResponse: type: object + description: Port Packages response properties: - and: - maxItems: 8 + data: type: array + description: List of Port Packages items: - $ref: "#/components/schemas/LoaActionFilter" - LoaActionFilter: - type: object - anyOf: - - $ref: "#/components/schemas/LoaActionSearchSimpleExpressions" - - $ref: "#/components/schemas/LoaActionOrFilter" - LoaActionSearchSimpleExpressions: + $ref: '#/components/schemas/PortPackage' + required: + - data + ConnectionRouteAggregationData: type: object properties: - property: - $ref: "#/components/schemas/LoaActionFieldName" - operator: + href: + type: string + format: uri + description: Route Aggregation URI + example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d + type: + description: Route Aggregation type type: string enum: - - = - - "!=" - - LIKE - - ILIKE - - BETWEEN - - NOT BETWEEN - - IN - - NOT IN - - ">" - - < - - ">=" - - <= - values: - type: array - items: - type: string - example: LOA_ACCEPTANCE - LoaActionFieldName: - type: string - description: Possible field names to use on filters - enum: - - /type - - /state - - /uuid - LoaActionOrFilter: - type: object - properties: - or: - type: array - items: - $ref: "#/components/schemas/LoaActionSearchSimpleExpressions" - LoaActionSortCriteria: - type: object - properties: - direction: + - BGP_IPv4_PREFIX_AGGREGATION + uuid: + description: Route Aggregation identifier type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - property: + format: uuid + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d + attachmentStatus: type: string - description: Possible field names to use on sorting - default: /changeLog/createdDateTime enum: - - /changeLog/createdDateTime - LoaActionSearchResponse: + - ATTACHING + - ATTACHED + - DETACHED + - DETACHING + - FAILED + - PENDING_BGP_CONFIGURATION + changeLog: + $ref: '#/components/schemas/Changelog' + GetAllConnectionRouteAggregationsResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" - sort: - type: array - items: - $ref: "#/components/schemas/LoaActionSortCriteria" + $ref: '#/components/schemas/Pagination' data: + description: List of Route Aggregations attached to a Connection type: array items: - $ref: "#/components/schemas/LoaActionResponse" - description: List of LOA Actions - LoaConsumersResponse: + $ref: '#/components/schemas/ConnectionRouteAggregationData' + ConnectionRouteFilterData: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - items: - $ref: "#/components/schemas/LoaConsumer" - description: List of Consumers associated with a LOA - LoaNotesResponse: + href: + type: string + format: uri + description: Route filter URI + example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d + type: + description: Route filter type + type: string + enum: + - BGP_IPv4_PREFIX_FILTER + - BGP_IPv6_PREFIX_FILTER + uuid: + description: Route Filter identifier + type: string + 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 + changeLog: + $ref: '#/components/schemas/Changelog' + GetAllConnectionRouteFiltersResponse: type: object properties: + pagination: + $ref: '#/components/schemas/Pagination' data: + description: List of Route Filters attached to a Connection type: array items: - $ref: "#/components/schemas/LoaNoteDetails" - description: List of Loa note details - CreateLoaNote: - required: - - comments + $ref: '#/components/schemas/ConnectionRouteFilterData' + ConnectionRouteFiltersBase: type: object properties: - comments: - maxLength: 4000 - minLength: 0 + direction: + description: Route Filter direction to attach to a connection type: string - description: | - The note content to add to this LOA. Notes are visible to both the issuer and requestor organizations. Use notes to communicate updates, clarifications, or additional context about the LOA. - example: LOA under review by our team. Expected response within 2 business days - description: Create Loa Note - LoaNoteDetails: + enum: + - INBOUND + - OUTBOUND + required: + - direction + RouteFiltersBase: type: object properties: type: + description: Route Filter type type: string - description: | - Indicates which party added the note.
ISSUER — note was added by a user from the issuer organization.
REQUESTOR — note was added by a user from the requestor organization. - example: ISSUER enum: - - ISSUER - - REQUESTOR - href: - type: string - description: URI to note resource. - format: uri - example: https://api.equinix.com/fabric/v4/loas/b7e14c2d-93f8-4a61-8d5b-c29f71e4a306/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: - type: string - description: Unique identifier of this note. - format: uuid - example: e41f485e-3094-42de-8797-0ef19a51df79 - comments: + - BGP_IPv4_PREFIX_FILTER + - BGP_IPv6_PREFIX_FILTER + name: type: string - description: Content of the note as submitted by the user. - example: LOA under review by our team. Expected response within 2 business days - createdDateTime: + example: My-direct-route-1 + description: + description: Customer-provided connection description type: string - description: Date and time when the note was created. - format: date-time - example: 2023-08-01T12:34:56Z - description: | - Represents a note added to a LOA by an authorized user from either the issuer or requestor organization - CreateCrossConnect: - title: CreateCrossConnect + project: + $ref: '#/components/schemas/Project' required: - - aSide - - name - type - - zSide + - name + - project + RouteFiltersChange: + description: Current state of latest route filter change type: object properties: + uuid: + description: Uniquely identifies a change + type: string type: - $ref: "#/components/schemas/CrossConnectType" - name: - maxLength: 50 - minLength: 3 + description: Type of change type: string - description: A short, descriptive name for this Cross Connect. - example: My-CC-service - bmmrType: - description: | - Required when connecting to a BMMR.
Use EQUINIX when BMMR Extension is required and Equinix installs it, or SELF when you install it yourself. - allOf: - - $ref: "#/components/schemas/BmmrType" - circuitId: + 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: + description: Route filter change URI type: string - description: Circuit identifier of the Cross Connect. - redundancy: - description: | - Provide it to place a diverse Cross Connect against an existing one - set group to the redundancy group id or the serial number of the existing Cross Connect, and priority to SECONDARY. - allOf: - - $ref: "#/components/schemas/CrossConnectRedundancy" - aSide: - description: A-Side connection details. - allOf: - - $ref: "#/components/schemas/CrossConnectASideRequest" - zSide: - description: | - Z-Side connection details.
Provide the DemarcationPoint, the LOA reference or the BMMR location depending on the Cross Connect being requested. - allOf: - - $ref: "#/components/schemas/CrossConnectZSideRequest" - schedule: - description: | - Preferred installation schedule. When omitted, the Cross Connect is scheduled with the STANDARD schedule code. - allOf: - - $ref: "#/components/schemas/ScheduleRequest" - services: - type: array - description: Cross Connect Services. - items: - $ref: "#/components/schemas/CrossConnectServiceRequest" - notifications: - type: array - description: | - Preferences for notifications on Cross Connect configuration or status changes. - items: - $ref: "#/components/schemas/CrossConnectNotification" - order: - $ref: "#/components/schemas/OrderRequest" - notes: - maxItems: 1 - type: array - description: Additional Note. - items: - $ref: "#/components/schemas/CrossConnectNoteRequest" - attachments: - maxItems: 5 - type: array - description: Additional Attachments. - items: - $ref: "#/components/schemas/CrossConnectAttachment" - description: | - Create Cross Connect request. A single request body supports all Cross Connect connection types - patch panel to patch panel, connection with LOA and connection to a BMMR (by Equinix or by Self). Refer to the request examples for each use case. - CrossConnectResponse: + format: uri + required: + - uuid + - type + RouteFiltersData: type: object properties: href: type: string - description: Cross Connect URI. format: uri - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + description: Route filter URI + example: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: - $ref: "#/components/schemas/CrossConnectType" + description: Route Filter type + type: string + enum: + - BGP_IPv4_PREFIX_FILTER + - BGP_IPv6_PREFIX_FILTER uuid: + description: Route filter identifier type: string - description: Cross Connect Identifier. format: uuid - example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: type: string - description: A short, descriptive name for this Cross Connect. - example: My-CC-service - state: - $ref: "#/components/schemas/CrossConnectState" - allowedActions: - type: array - description: | - List of actions that can be performed on the Cross Connect based on its current state. Use these values to determine which action types are valid to submit to the actions endpoint. - readOnly: true - items: - $ref: "#/components/schemas/CrossConnectResponse_allowedActions" - bmmrType: - $ref: "#/components/schemas/BmmrType" - mediaType: + example: My-direct-route-1 + description: + description: Customer-provided connection description type: string - description: Media type of the Cross Connect. - example: SINGLE_MODE_FIBER - mediaSubType: + change: + $ref: '#/components/schemas/RouteFiltersChange' + notMatchedRuleAction: type: string - description: Media sub-type of the Cross Connect. - example: SINGLE_MODE_FIBER - circuitId: + enum: + - ALLOW + - DENY + connectionsCount: + type: integer + example: 0 + rulesCount: + type: integer + example: 0 + project: + type: object + properties: + projectId: + description: Subscriber-assigned project ID + type: string + example: 44f4c4f8-2f39-494e-838c-d8e640591be5 + href: + type: string + format: uri + description: Project URI + example: https://api.equinix.com/resourceManager/v1/projects/567 + required: + - projectId + changelog: + $ref: '#/components/schemas/Changelog' + RouteFiltersPatchRequestItem: + description: Route filter change operation data + type: object + properties: + op: + description: Handy shortcut for operation name type: string - description: Circuit identifier of the Cross Connect. - serialNumber: + example: replace + path: + description: path to change type: string - description: Serial number of the Cross Connect. - readOnly: true - example: "234567890" - redundancy: - $ref: "#/components/schemas/CrossConnectRedundancy" - aSide: - $ref: "#/components/schemas/CrossConnectASideResponse" - zSide: - $ref: "#/components/schemas/CrossConnectZSideResponse" - account: - $ref: "#/components/schemas/CrossConnectAccount" - notifications: - type: array - description: | - Preferences for notifications on Cross Connect configuration or status changes. - items: - $ref: "#/components/schemas/CrossConnectNotification" - order: - $ref: "#/components/schemas/OrderResponse" - links: - type: array - description: | - Links to the Cross Connect sub-resources - schedules, services, notes and attachments. - readOnly: true - items: - $ref: "#/components/schemas/CrossConnectLink" - changeLog: - $ref: "#/components/schemas/CrossConnectChangelog" - description: Cross Connect Response. - DiverseCrossConnectRequest: - title: DiverseCrossConnectRequest + example: /name + value: + description: new value for updated parameter required: - - data + - op + - path + - value + RouteFiltersPatchRequest: + description: Patch Route Filters request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/RouteFiltersPatchRequestItem' + RouteFiltersChangeOperation: + description: Route filter change operation data + type: object + properties: + op: + description: Handy shortcut for operation name + type: string + enum: + - add + - replace + - remove + path: + description: path inside document leading to updated parameter + type: string + example: / + value: + $ref: '#/components/schemas/RouteFiltersBase' + required: + - op + - path + - value + RouteFilterChangeData: + description: Current state of latest route filter change type: object properties: + status: + description: Current outcome of the change flow + type: string + enum: + - COMPLETED + - FAILED + - REQUESTED + createdBy: + type: string + description: Created by user key + createdDateTime: + description: Set when change flow starts + type: string + format: date-time + updatedBy: + type: string + description: Updated by user key + updatedDateTime: + description: Set when change object is updated + type: string + format: date-time + information: + description: Additional information + type: string data: - minItems: 1 - type: array - description: | - For a diverse pair, send two entries - one with redundancy.priority PRIMARY and one with SECONDARY - and omit redundancy.group, which Equinix assigns. - items: - $ref: "#/components/schemas/CreateCrossConnect" - description: | - Request to create several Cross Connects in a single order. Use it to order a diverse pair - one PRIMARY and one SECONDARY entry provisioned at the same time on separate paths - or to order multiple Cross Connects at once by sending one entry per Cross Connect. - CrossConnectDiverse: - title: CrossConnectDiverse + $ref: '#/components/schemas/RouteFiltersChangeOperation' + allOf: + - $ref: '#/components/schemas/RouteFiltersChange' + RouteFilterChangeDataResponse: + description: List of route filter changes type: object properties: + pagination: + $ref: '#/components/schemas/Pagination' data: type: array - description: The Cross Connects the diverse order applies to. items: - $ref: "#/components/schemas/CrossConnectResponse" - description: | - Cross Connects returned by a diverse order. One item is returned per Cross Connect requested; a diverse pair returns the PRIMARY and the SECONDARY Cross Connect sharing one redundancy group. - CrossConnectSearchRequest: + $ref: '#/components/schemas/RouteFilterChangeData' + RouteFilterConnectionsData: + type: object + properties: + href: + type: string + format: uri + description: Connection URI + example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f + type: + $ref: '#/components/schemas/ConnectionType' + uuid: + description: Route filter identifier + type: string + format: uuid + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d + name: + type: string + example: connection-1 + GetRouteFilterGetConnectionsResponse: type: object properties: - filter: - $ref: "#/components/schemas/CrossConnectSearchFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + $ref: '#/components/schemas/Pagination' + data: + description: List of Connections using a Route Filter type: array items: - $ref: "#/components/schemas/CrossConnectSortCriteria" - description: Search Cross Connects based on filter criteria. - CrossConnectSearchFilters: + $ref: '#/components/schemas/RouteFilterConnectionsData' + SearchAndExpression: type: object + required: + - and properties: and: - maxItems: 8 type: array + minItems: 1 + maxItems: 8 items: - $ref: "#/components/schemas/CrossConnectFilter" - CrossConnectFilter: + $ref: '#/components/schemas/SearchFilterExpression' + SearchFilterExpression: + description: Filter expression that can be AND, OR, or a simple expression + oneOf: + - $ref: '#/components/schemas/SearchAndExpression' + - $ref: '#/components/schemas/SearchOrExpression' + - $ref: '#/components/schemas/SearchSimpleExpression' + SearchOrExpression: type: object - anyOf: - - $ref: "#/components/schemas/CrossConnectSearchSimpleExpressions" - - $ref: "#/components/schemas/CrossConnectOrFilter" - CrossConnectSearchSimpleExpressions: + required: + - or + properties: + or: + type: array + minItems: 1 + maxItems: 8 + items: + $ref: '#/components/schemas/SearchFilterExpression' + SearchSimpleExpression: type: object + description: Simple filter expression with property, operator, and values + required: + - property + - operator + - values properties: property: - $ref: "#/components/schemas/CrossConnectFieldName" + type: string operator: type: string - example: = + description: | + "~*" is a case-insensitive glob match, equivalent to ILIKE - the same single "*" wildcard, not POSIX regex - kept as its own operator only because existing callers already send it. + example: '=' enum: - - = - - "!=" + - '=' + - '!=' + - IN + - NOT IN - LIKE - ILIKE - BETWEEN - - NOT BETWEEN - - IN - - NOT IN - - ">" + - '>' + - '>=' - < - - ">=" - <= + - ~* + x-enum-varnames: + - EQUAL + - NOT_EQUAL + - IN + - NOT_IN + - LIKE + - ILIKE + - BETWEEN + - GREATER_THAN + - GREATER_THAN_OR_EQUAL_TO + - LESS_THAN + - LESS_THAN_OR_EQUAL_TO + - CASE_INSENSITIVE_REGEX values: type: array - example: - - My-CC-service + minItems: 1 + maxItems: 8 items: type: string - CrossConnectFieldName: + SearchFilter: + description: Top-level filter that can be either an AND expression or OR expression + oneOf: + - $ref: '#/components/schemas/SearchAndExpression' + - $ref: '#/components/schemas/SearchOrExpression' + RouteFilterSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + RouteFilterSortBy: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime type: string - description: Possible field names to use on filters. - example: /name enum: + - /type - /uuid - /name - - /type + - /project/projectId - /state - - /bmmrType - - /circuitId - - /serialNumber - - /redundancy/group - - /redundancy/priority - - /aSide/demarcationPoint/patchPanelId - - /aSide/demarcationPoint/patchPanelPortA - - /aSide/demarcationPoint/patchPanelPortB - - /aSide/location/ibxCode - - /zSide/demarcationPoint/patchPanelId - - /zSide/demarcationPoint/patchPanelPortA - - /zSide/demarcationPoint/patchPanelPortB - - /zSide/location/ibxCode - - /zSide/loa/uuid - - /account/accountNumber - - /order/orderNumber - - /order/customerReferenceId - /changeLog/createdDateTime - /changeLog/updatedDateTime - CrossConnectOrFilter: + - /changeLog/deletedDateTime + RouteFilterSortCriteria: type: object properties: - or: + direction: + $ref: '#/components/schemas/RouteFilterSortDirection' + property: + $ref: '#/components/schemas/RouteFilterSortBy' + RouteFiltersSearchRequest: + type: object + description: Search route filters + properties: + filter: + $ref: '#/components/schemas/SearchFilter' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array items: - $ref: "#/components/schemas/CrossConnectSearchSimpleExpressions" - CrossConnectSortCriteria: - type: object - properties: - direction: - type: string - description: Sorting direction. - default: DESC - enum: - - DESC - - ASC - property: - type: string - description: Possible field names to use on sorting. - default: /changeLog/updatedDateTime - enum: - - /name - - /state - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - CrossConnectSearchResponse: + $ref: '#/components/schemas/RouteFilterSortCriteria' + RouteFiltersSearchResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" - sort: - type: array - items: - $ref: "#/components/schemas/CrossConnectSortCriteria" + $ref: '#/components/schemas/Pagination' data: + description: List of route filters type: array items: - $ref: "#/components/schemas/CrossConnectResponse" - description: List of Cross Connects. - CrossConnectId: + $ref: '#/components/schemas/RouteFiltersData' + RouteFilterRuleState: + description: Route filter rule status type: string - description: Cross Connect UUID. - format: uuid - example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - DeleteCrossConnect: - title: DeleteCrossConnect - required: - - schedule - type: object - properties: - schedule: - description: | - Removal schedule. The requestedDateTime is mandatory. Only the STANDARD schedule type is supported for a removal. - allOf: - - $ref: "#/components/schemas/DeinstallScheduleRequest" - notifications: - type: array - description: | - Optional. The contacts are appended to the ones already held on the Cross Connect. - items: - $ref: "#/components/schemas/CrossConnectNotification" - order: - description: | - Optional. The purchase order and the customer reference identifier replace the ones already held on the Cross Connect. - allOf: - - $ref: "#/components/schemas/OrderRequest" - description: | - Delete Cross Connect request. Carries the removal schedule together with the notification and order details to apply to the removal order. - SchedulesResponse: - type: object - properties: - data: - type: array - readOnly: true - items: - $ref: "#/components/schemas/CrossConnectScheduleResponse" - description: Schedules of the Cross Connect. - CrossConnectServicesResponse: - type: object - properties: - data: - type: array - readOnly: true - items: - $ref: "#/components/schemas/CrossConnectServiceResponse" - description: List of services ordered alongside the Cross Connect. - CrossConnectAttachmentsResponse: - type: object - properties: - data: - type: array - readOnly: true - items: - $ref: "#/components/schemas/CrossConnectAttachmentResponse" - description: List of documents attached to the Cross Connect. - CrossConnectAttachment: - required: - - attachmentId + enum: + - PROVISIONING + - REPROVISIONING + - DEPROVISIONING + - PROVISIONED + - DEPROVISIONED + - NOT_PROVISIONED + - NOT_DEPROVISIONED + RouteFilterRulesChange: + description: Current state of latest route filter rule change type: object properties: - attachmentId: + uuid: + description: Uniquely identifies a change type: string - description: Attachment Identifier. - format: uuid - example: a11f485e-3094-42de-8797-0ef19a51df79 - description: Cross Connect Attachment. - CrossConnectAttachmentResponse: + type: + description: Type of change + type: string + 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: + description: Route Filter Change URI + type: string + format: uri + required: + - uuid + - type + RouteFilterRulesData: type: object properties: href: type: string - description: URI to the attachment resource. format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79 + description: Route Filter Rules URI + example: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/65b025ef-022b-4180-85cf-82cfc1ab655b + type: + description: Route filter type + type: string + enum: + - BGP_IPv4_PREFIX_FILTER_RULE + - BGP_IPv6_PREFIX_FILTER_RULE uuid: + description: Route Filter Rule identifier type: string - description: Attachment resource Identifier. format: uuid - readOnly: true - example: e41f485e-3094-42de-8797-0ef19a51df79 - type: + example: 65b025ef-022b-4180-85cf-82cfc1ab655b + name: type: string - description: Sub-resource type. - readOnly: true - example: ATTACHMENT - enum: - - ATTACHMENT - source: + example: Private-subnet-filter-2 + description: + description: Customer-provided Route Filter Rule description type: string - description: Attachment Source. - readOnly: true - example: CUSTOMER - enum: - - CUSTOMER - - EQUINIX - attachmentId: + state: + $ref: '#/components/schemas/RouteFilterRuleState' + prefixMatch: + description: prefix matching operator + default: orlonger type: string - description: Attachment Identifier. - format: uuid - readOnly: true - example: a11f485e-3094-42de-8797-0ef19a51df79 - downloadHref: + example: exact + change: + $ref: '#/components/schemas/RouteFilterRulesChange' + action: type: string - description: | - URI to download the attachment file content from the Equinix attachment service. - format: uri - readOnly: true - example: https://api.equinix.com/ecp/attachments/a11f485e-3094-42de-8797-0ef19a51df79 - changeLog: - $ref: "#/components/schemas/CrossConnectChangelog" - description: Document attached to a Cross Connect. - CrossConnectNotesResponse: + enum: + - PERMIT + - DENY + prefix: + type: string + example: 192.168.0.0/24 + changelog: + $ref: '#/components/schemas/Changelog' + GetRouteFilterRulesResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: + description: List of Route Filter Rules type: array - readOnly: true items: - $ref: "#/components/schemas/CrossConnectNoteResponse" - description: List of notes added to the Cross Connect. - CrossConnectNoteRequest: - required: - - comments - type: object - properties: - comments: - maxLength: 4000 - type: string - description: Note comments. - example: test note - description: Cross Connect Note. - CrossConnectNoteResponse: + $ref: '#/components/schemas/RouteFilterRulesData' + RouteFilterRulesBase: type: object properties: - href: - type: string - description: Note URI. - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: + name: type: string - description: Note Identifier. - format: uuid - readOnly: true - example: e41f485e-3094-42de-8797-0ef19a51df79 - type: + example: Private-subnet-filter + description: + description: Customer-provided Route Filter Rule description type: string - description: Sub-resource type. - readOnly: true - example: NOTE - enum: - - NOTE - source: + prefix: type: string - description: Party that added the note. - readOnly: true - example: CUSTOMER - enum: - - CUSTOMER - - EQUINIX - comments: - maxLength: 4000 + example: 192.168.0.0/24 + prefixMatch: type: string - description: Note comments. - readOnly: true - example: this is reply to the technician note. - parentNote: - description: | - The note this note is responding to. Returned when the note was added in response to an Equinix note. - readOnly: true - allOf: - - $ref: "#/components/schemas/CrossConnectParentNote" - changeLog: - $ref: "#/components/schemas/CrossConnectChangelog" - description: Cross Connect Note. - CrossConnectActionRequest: + default: orlonger + example: orlonger, exact required: - - type - type: object - properties: - type: - $ref: "#/components/schemas/CrossConnectActionType" - data: - $ref: "#/components/schemas/CrossConnectActionData" - description: Cross Connect Action Request. - CrossConnectActionResponse: + - prefix + RouteFilterRulesPatchRequestItem: + description: Route filter rule change operation data type: object properties: - href: + op: + description: Handy shortcut for operation name type: string - description: Action URI. - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: + example: replace + path: + description: path to change type: string - description: Action Identifier. - format: uuid - readOnly: true - example: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: - readOnly: true - allOf: - - $ref: "#/components/schemas/CrossConnectActionType" - state: - readOnly: true - allOf: - - $ref: "#/components/schemas/CrossConnectActionState" - data: - readOnly: true - allOf: - - $ref: "#/components/schemas/CrossConnectActionResponseData" - changeLog: - readOnly: true - allOf: - - $ref: "#/components/schemas/CrossConnectChangelog" - description: Cross Connect Action Response. - ActionId_3: - type: string - description: Cross Connect Action UUID. - format: uuid - example: 30cc7878-54e3-4e1a-8651-87a61354bad4 - CrossConnectActionSearchRequest: - type: object - properties: - filter: - $ref: "#/components/schemas/CrossConnectActionSearchFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/CrossConnectActionSortCriteria" - description: Search Cross Connect actions based on filter criteria. - CrossConnectActionSearchFilters: - type: object - properties: - and: - maxItems: 8 - type: array - items: - $ref: "#/components/schemas/CrossConnectActionFilter" - CrossConnectActionFilter: - type: object - anyOf: - - $ref: "#/components/schemas/CrossConnectActionSearchSimpleExpressions" - - $ref: "#/components/schemas/CrossConnectActionOrFilter" - CrossConnectActionSearchSimpleExpressions: + example: /prefixMatch + value: + description: new value for updated parameter + required: + - op + - path + - value + RouteFilterRulesPatchRequest: + description: Patch Route Filters Rule request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/RouteFilterRulesPatchRequestItem' + RouteFilterRulesChangeOperation: + description: Route filter rule change operation data type: object properties: - property: - $ref: "#/components/schemas/CrossConnectActionFieldName" - operator: + op: + description: Handy shortcut for operation name type: string enum: - - = - - "!=" - - LIKE - - ILIKE - - BETWEEN - - NOT BETWEEN - - IN - - NOT IN - - ">" - - < - - ">=" - - <= - values: - type: array - items: - type: string - example: XC_SIGNATURE_SUBMISSION - CrossConnectActionFieldName: - type: string - description: Possible field names to use on filters. - enum: - - /type - - /state - - /uuid - CrossConnectActionOrFilter: - type: object - properties: - or: - type: array - items: - $ref: "#/components/schemas/CrossConnectActionSearchSimpleExpressions" - CrossConnectActionSortCriteria: + - add + - replace + - remove + path: + description: path inside document leading to updated parameter + type: string + example: / + value: + $ref: '#/components/schemas/RouteFilterRulesBase' + required: + - op + - path + - value + RouteFilterRulesChangeData: + description: Current state of latest route filter rules change type: object properties: - direction: + status: + description: Current outcome of the change flow type: string - description: Sorting direction. - default: DESC enum: - - DESC - - ASC - property: + - COMPLETED + - FAILED + - REQUESTED + createdBy: type: string - description: Possible field names to use on sorting. - default: /changeLog/createdDateTime - enum: - - /changeLog/createdDateTime - CrossConnectActionSearchResponse: + description: Created by User Key + createdDateTime: + description: Set when change flow starts + type: string + format: date-time + updatedBy: + type: string + description: Updated by User Key + updatedDateTime: + description: Set when change object is updated + type: string + format: date-time + data: + $ref: '#/components/schemas/RouteFilterRulesChangeOperation' + allOf: + - $ref: '#/components/schemas/RouteFilterRulesChange' + RouteFilterRulesChangeDataResponse: + description: List of route filter rule changes type: object properties: pagination: - $ref: "#/components/schemas/Pagination" - sort: - type: array - items: - $ref: "#/components/schemas/CrossConnectActionSortCriteria" + $ref: '#/components/schemas/Pagination' data: type: array items: - $ref: "#/components/schemas/CrossConnectActionResponse" - description: List of Cross Connect Actions. - CrossConnectScheduleSearchRequest: + $ref: '#/components/schemas/RouteFilterRulesChangeData' + RouteFilterRulesPostRequest: type: object + description: Create Route Filter Rule POST request properties: - filter: - $ref: "#/components/schemas/CrossConnectScheduleSearchFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + data: + description: Route Filter Rule configuration type: array items: - $ref: "#/components/schemas/CrossConnectScheduleSortCriteria" - description: Search Cross Connect schedules based on filter criteria. - CrossConnectScheduleSearchFilters: + $ref: '#/components/schemas/RouteFilterRulesBase' + RouteFilterRuleAndExpression: type: object + description: AND expression containing multiple filter expressions properties: and: + type: array + minItems: 1 maxItems: 8 + items: + $ref: '#/components/schemas/RouteFilterRuleExpression' + RouteFilterRuleExpression: + description: Filter expression that can be AND, OR, or a simple expression + anyOf: + - $ref: '#/components/schemas/RouteFilterRuleAndExpression' + - $ref: '#/components/schemas/RouteFilterRuleOrExpression' + - $ref: '#/components/schemas/RouteFilterRuleSimpleExpression' + RouteFilterRuleOrExpression: + type: object + description: OR expression containing multiple filter expressions + properties: + or: type: array + minItems: 1 + maxItems: 8 items: - $ref: "#/components/schemas/CrossConnectScheduleSearchSimpleExpressions" - CrossConnectScheduleSearchSimpleExpressions: + $ref: '#/components/schemas/RouteFilterRuleExpression' + RouteFilterRuleSimpleExpression: type: object + description: Simple filter expression with property, operator, and values properties: property: - $ref: "#/components/schemas/CrossConnectScheduleFieldName" + description: | + Possible field names to use on filters: + * `/type` - Route Filter Rules Type + * `/name` - Route Filter Rules Name + * `/uuid` - Route Filter Rules uuid + * `/state` - Route Filter Rules status + * `/prefix` - Route Filter Rule Prefix + * `/prefixMatch` - Route Filter Rule Prefix Match + type: string + example: /name operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `[NOT] LIKE` - (not) like + * `[NOT] IN` - (not) in + * `ILIKE` - case-insensitive like type: string - example: = - enum: - - = - - "!=" - - IN - - NOT IN + example: '=' values: type: array - example: - - SV11 + minItems: 1 + maxItems: 8 items: type: string - CrossConnectScheduleFieldName: + example: Route_Filter_Rule_Demo + RouteFilterRulesFilter: + description: Top-level filter that can be either an AND expression or OR expression + anyOf: + - $ref: '#/components/schemas/RouteFilterRuleAndExpression' + - $ref: '#/components/schemas/RouteFilterRuleOrExpression' + RouteFilterRuleSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + RouteFilterRuleSortBy: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime type: string - description: Possible field names to use on filters. - example: /aSide/location/ibxCode enum: - /type - - /code - - /aSide/location/ibxCode - - /zSide/location/ibxCode - CrossConnectScheduleSortCriteria: + - /uuid + - /name + - /state + - /prefix + - /prefixMatch + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + RouteFilterRuleSortCriteria: type: object properties: direction: - type: string - description: Sorting direction. - default: DESC - enum: - - DESC - - ASC + $ref: '#/components/schemas/RouteFilterRuleSortDirection' property: - type: string - description: Possible field names to use on sorting. - default: /startDateTime - enum: - - /code - - /startDateTime - - /endDateTime - SearchSchedulesResponse: + $ref: '#/components/schemas/RouteFilterRuleSortBy' + RouteFilterRulesSearchRequest: type: object + description: Search route filter rules properties: + filter: + $ref: '#/components/schemas/RouteFilterRulesFilter' pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/PaginationRequest' sort: type: array items: - $ref: "#/components/schemas/CrossConnectScheduleSortCriteria" + $ref: '#/components/schemas/RouteFilterRuleSortCriteria' + RouteFilterRulesSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' data: + description: List of route filter rules type: array - readOnly: true items: - $ref: "#/components/schemas/CrossConnectScheduleAvailability" - description: List of Cross Connect schedule windows offered at an IBX. - TagRequest: + $ref: '#/components/schemas/RouteFilterRulesData' + RouteAggregationsBase: + type: object + properties: + type: + description: Route Aggregation type + type: string + enum: + - BGP_IPv4_PREFIX_AGGREGATION + - BGP_IPv6_PREFIX_AGGREGATION + name: + type: string + example: My-direct-route-1 + description: + description: Customer-provided connection description + type: string + project: + $ref: '#/components/schemas/Project' required: - - displayName - type + - name + - project + RouteAggregationsChange: + description: Current state of latest Route Aggregation change type: object properties: + uuid: + description: Uniquely identifies a change + type: string type: + description: Type of change type: string - description: Type of tag - example: PREDEFINED_TAG - displayName: - maxLength: 24 - minLength: 1 - type: string - description: Display name of the Tag - example: LLM - notifications: - type: array - example: - - type: NOTIFICATION - emails: - - example1@example.com - - example2@example.com - items: - $ref: "#/components/schemas/SimplifiedNotification" - description: Equinix Fabric Tag Request Object - AppDomainPostRequest: - required: - - name - - project - - type - type: object - properties: - type: - $ref: "#/components/schemas/AppDomainType" - name: - maxLength: 50 - minLength: 1 - type: string - description: Customer-provided App Domain name - format: string - example: atlassian.net - description: + 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: + description: Route AGGREGATION Change URI type: string - description: Customer-provided App Domain description - format: string - example: Atlassian Domain - project: - $ref: "#/components/schemas/Project" - description: Create App Domain - AppDomain: + format: uri required: - - name - - project + - uuid - type + RouteAggregationsData: type: object properties: href: type: string - description: Resource URI format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - x-order: 1 + description: Route Aggregation URI + example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: - $ref: "#/components/schemas/AppDomainType" + description: Route Aggregation type + type: string + enum: + - BGP_IPv4_PREFIX_AGGREGATION + - BGP_IPv6_PREFIX_AGGREGATION uuid: + description: Route Aggregation identifier type: string - description: Equinix-assigned access point identifier format: uuid - example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - x-order: 3 + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: type: string - description: Customer-provided App Domain name - format: string - example: atlassian.net - x-order: 4 + example: My-direct-route-1 description: + description: Customer-provided connection description type: string - description: Customer-provided App Domain description - format: string - example: Atlassian Domain - x-order: 5 - state: - $ref: "#/components/schemas/AppDomainState" + change: + $ref: '#/components/schemas/RouteAggregationsChange' + connectionsCount: + type: integer + example: 0 + rulesCount: + type: integer + example: 0 project: - $ref: "#/components/schemas/Project" + type: object + properties: + projectId: + description: Subscriber-assigned project ID + type: string + example: 44f4c4f8-2f39-494e-838c-d8e640591be5 + href: + type: string + format: uri + description: Project URI + required: + - projectId changeLog: - $ref: "#/components/schemas/Changelog" - change: - $ref: "#/components/schemas/AppDomainChange" - description: App Domain object - AppDomainId: - type: string - description: App Domain UUID - format: uuid - example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - AppDomainUpdateRequest: - maxItems: 1 - minItems: 1 + $ref: '#/components/schemas/Changelog' + RouteAggregationsPatchRequestItem: + description: Route Aggregation change operation data + type: object + properties: + op: + description: Handy shortcut for operation name + type: string + example: replace + path: + description: path to change + type: string + example: /name + value: + description: new value for updated parameter + required: + - op + - path + - value + RouteAggregationsPatchRequest: + description: Patch Route Aggregations request type: array - description: App Domain Update Request + minItems: 1 items: - $ref: "#/components/schemas/AppDomainChangeOperation" - AppDomainSearchRequest: + $ref: '#/components/schemas/RouteAggregationsPatchRequestItem' + RouteAggregationsChangeOperation: + description: Route Aggregation change operation data type: object properties: - filter: - $ref: "#/components/schemas/AppDomainFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/AppDomainSortCriteria" - description: Search requests containing criteria - AppDomainFilters: + op: + description: Handy shortcut for operation name + type: string + enum: + - add + - replace + - remove + path: + description: path inside document leading to updated parameter + type: string + example: / + value: + $ref: '#/components/schemas/RouteAggregationsBase' + required: + - op + - path + - value + RouteAggregationChangeData: + description: Current state of latest Route Aggregation change type: object properties: - and: - maxItems: 8 + status: + description: Current outcome of the change flow + type: string + enum: + - COMPLETED + - FAILED + - REQUESTED + createdBy: + type: string + description: Created by User Key + createdDateTime: + description: Set when change flow starts + type: string + format: date-time + updatedBy: + type: string + description: Updated by User Key + updatedDateTime: + description: Set when change object is updated + type: string + format: date-time + information: + description: Additional information + type: string + data: + $ref: '#/components/schemas/RouteAggregationsChangeOperation' + allOf: + - $ref: '#/components/schemas/RouteAggregationsChange' + RouteAggregationChangeDataResponse: + description: List of Route Aggregation changes + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: type: array items: - $ref: "#/components/schemas/AppDomainFilter" - AppDomainFilter: - type: object - anyOf: - - $ref: "#/components/schemas/AppDomainSimpleExpression" - - $ref: "#/components/schemas/AppDomainOrFilter" - AppDomainSimpleExpression: + $ref: '#/components/schemas/RouteAggregationChangeData' + RouteAggregationConnectionsData: type: object properties: - property: + href: type: string - description: | - Possible field names to use on filters: - * `/project/projectId` - project id - * `/uuid` - App Domain uuid - * `/name` - App Domain name - * `/description` - App Domain description - * `/state` - App Domain status - * `/changeLog/createdDateTime` - App Domain creation timestamp - * `/changeLog/updatedDateTime` - App Domain last updated timestamp - * `/changeLog/deletedDateTime` - App Domain deletion timestamp - example: /name - operator: + format: uri + description: Connection URI + example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f + type: + $ref: '#/components/schemas/ConnectionType' + uuid: + description: Route Aggregation identifier type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `>` - greater than - * `<` - less than - * `IN` - in - * `NOT IN` - not in - * `LIKE` - like - * `ILIKE` - case-insensitive like - * `BETWEEN` - between - * `NOT BETWEEN` - not between - example: = - values: - type: array - items: - type: string - example: Gateway - AppDomainOrFilter: + format: uuid + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d + name: + type: string + example: connection-1 + GetRouteAggregationGetConnectionsResponse: type: object properties: - or: - maxItems: 3 + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: List of Connections using a Route Aggregation type: array items: - $ref: "#/components/schemas/AppDomainSimpleExpression" - AppDomainSortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/AppDomainSortDirection" - property: - $ref: "#/components/schemas/AppDomainSortBy" - AppDomainSortDirection: - type: string + $ref: '#/components/schemas/RouteAggregationConnectionsData' + RouteAggregationSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - AppDomainSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/name` - App Domain name - * `/uuid` - App Domain uuid - * `/state` - App Domain status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime + RouteAggregationSortBy: + description: Possible field names to use on sorting default: /changeLog/updatedDateTime - AppDomainSearchResponse: + type: string + enum: + - /type + - /uuid + - /name + - /project/projectId + - /state + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + - /changeLog/deletedDateTime + RouteAggregationSortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/RouteAggregationSortDirection' + property: + $ref: '#/components/schemas/RouteAggregationSortBy' + RouteAggregationsSearchRequest: type: object + description: Search route aggregations properties: + filter: + $ref: '#/components/schemas/SearchFilter' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppDomain" - AttachedAppLinkState: - type: array - description: Filter attached App Links by lifecycle state. - example: - - PROVISIONED - - PROVISIONING - items: - $ref: "#/components/schemas/AppLinkState" - AttachedAppLinkOrder: - type: string - description: Sort order for attached App Links. - example: DESC - default: DESC - enum: - - DESC - - ASC - Style: - type: string - description: Detail level of the response. - example: MEDIUM - default: MEDIUM - enum: - - MIN - - MEDIUM - - FULL - AppDomainAttachedAppLinks: + $ref: '#/components/schemas/RouteAggregationSortCriteria' + RouteAggregationsSearchResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: + description: List of Route Aggregations type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppDomainAttachedAppLink" - AppLinkPostRequest: - required: - - bandwidth - - ipv4Subnet - - name - - project - - router - - type + $ref: '#/components/schemas/RouteAggregationsData' + RouteAggregationRuleState: + description: Route Aggregation Rule status + type: string + enum: + - PROVISIONING + - REPROVISIONING + - DEPROVISIONING + - PROVISIONED + - DEPROVISIONED + - NOT_PROVISIONED + - NOT_DEPROVISIONED + RouteAggregationRulesChange: + description: Current state of latest Route Aggregation Rule change type: object properties: - type: - $ref: "#/components/schemas/AppLinkType" - name: - maxLength: 50 - minLength: 1 + uuid: + description: Uniquely identifies a change type: string - description: Customer-provided App Link name - format: string - example: Atlassian App Link - description: + type: + description: Type of change type: string - description: Customer-provided App Link description - format: string - example: Atlassian App Link in SV - router: - $ref: "#/components/schemas/AppLinkPostRequestRouter" - ipv4Subnet: + enum: + - BGP_IPv4_PREFIX_AGGREGATION_RULE_UPDATE + - BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION + - BGP_IPv4_PREFIX_AGGREGATION_RULE_DELETION + href: + description: Route Aggregation Change URI type: string - description: Customer-provided IP subnet for AppLink setup (/29 or larger subnet) - example: 192.168.10.0/29 - bandwidth: - type: integer - description: App Link aggregated data transfer capacity in Mbps - example: 1000 - project: - $ref: "#/components/schemas/Project" - description: Create App Link - AppLink: + format: uri required: - - bandwidth - - ipv4Subnet - - name - - project - - router + - uuid - type + RouteAggregationRulesData: type: object properties: href: type: string - description: Resource URI format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - x-order: 1 + description: Route Aggregation Rules URI + example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b type: - $ref: "#/components/schemas/AppLinkType" + description: Route Aggregation type + type: string + enum: + - BGP_IPv4_PREFIX_AGGREGATION_RULE uuid: + description: Route Aggregation Rule identifier type: string - description: Equinix-assigned access point identifier format: uuid - example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - x-order: 3 + example: 65b025ef-022b-4180-85cf-82cfc1ab655b name: type: string - description: Customer-provided App Link name - format: string - example: Atlassian App Link - x-order: 4 + example: Private-subnet-aggregation-2 description: + description: Customer-provided Route Aggregation Rule description type: string - description: Customer-provided App Link description - format: string - example: Atlassian App Link in SV - x-order: 5 state: - $ref: "#/components/schemas/AppLinkState" - router: - $ref: "#/components/schemas/AppLinkCloudRouter" - ipv4Subnet: - type: string - description: Customer-provided IP subnet for AppLink setup (/29 or larger subnet) - example: 192.168.10.0/29 - x-order: 8 - ipv4Address: + $ref: '#/components/schemas/RouteAggregationRuleState' + change: + $ref: '#/components/schemas/RouteAggregationRulesChange' + prefix: type: string - description: App Link IP address - format: ipv4 - example: 192.168.10.1 - x-order: 9 - bandwidth: - type: integer - description: App Link aggregated data transfer capacity in Mbps - example: 1000 - x-order: 10 - project: - $ref: "#/components/schemas/Project" + example: 192.168.0.0/24 changeLog: - $ref: "#/components/schemas/Changelog" - change: - $ref: "#/components/schemas/AppLinkChange" - description: App Link object - AppLinkId: - type: string - description: App Link UUID - format: uuid - example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - AppLinkUpdateRequest: - maxItems: 1 - minItems: 1 - type: array - description: App Link Update Request - items: - $ref: "#/components/schemas/AppLinkChangeOperation" - AppLinkSearchRequest: + $ref: '#/components/schemas/Changelog' + GetRouteAggregationRulesResponse: type: object properties: - filter: - $ref: "#/components/schemas/AppLinkFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/AppLinkSortCriteria" - description: Search requests containing criteria - AppLinkFilters: - type: object - properties: - and: - maxItems: 8 + $ref: '#/components/schemas/Pagination' + data: + description: List of Route Aggregation Rules type: array items: - $ref: "#/components/schemas/AppLinkFilter" - AppLinkFilter: - type: object - anyOf: - - $ref: "#/components/schemas/AppLinkSimpleExpression" - - $ref: "#/components/schemas/AppLinkOrFilter" - AppLinkSimpleExpression: + $ref: '#/components/schemas/RouteAggregationRulesData' + RouteAggregationRulesBase: type: object properties: - property: + name: type: string - description: | - Possible field names to use on filters: - * `/project/projectId` - project id - * `/uuid` - App Link uuid - * `/name` - App Link name - * `/description` - App Link description - * `/state` - App Link status - * `/ipv4Subnet` - App Link ipv4 subnet - * `/bandwidth` - App Link bandwidth - * `/changeLog/createdDateTime` - App Link creation timestamp - * `/changeLog/updatedDateTime` - App Link last updated timestamp - * `/changeLog/deletedDateTime` - App Link deletion timestamp - example: /name - operator: + example: Private-subnet-Aggregation + description: + description: Customer-provided Route Aggregation Rule description type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `>` - greater than - * `<` - less than - * `IN` - in - * `NOT IN` - not in - * `LIKE` - like - * `ILIKE` - case-insensitive like - * `BETWEEN` - between - * `NOT BETWEEN` - not between - example: = - values: - type: array - items: - type: string - example: Gateway - AppLinkOrFilter: + prefix: + type: string + example: 192.168.0.0/24 + required: + - prefix + RouteAggregationRulesPatchRequestItem: + description: Route Aggregation Rule change operation data type: object properties: - or: - maxItems: 3 - type: array - items: - $ref: "#/components/schemas/AppLinkSimpleExpression" - AppLinkSortCriteria: + op: + description: Handy shortcut for operation name + type: string + example: replace + path: + description: path to change + type: string + example: /prefix + value: + description: new value for updated parameter + required: + - op + - path + - value + RouteAggregationRulesPatchRequest: + description: Patch Route Aggregations Rule request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/RouteAggregationRulesPatchRequestItem' + RouteAggregationRulesChangeOperation: + description: Route Aggregation Rule change operation data type: object properties: - direction: - $ref: "#/components/schemas/AppLinkSortDirection" - property: - $ref: "#/components/schemas/AppLinkSortBy" - AppLinkSortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - AppLinkSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/name` - App Link name - * `/uuid` - App Link uuid - * `/state` - App Link status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime - default: /changeLog/updatedDateTime - AppLinkSearchResponse: - type: object - properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/AppLink" - AppLinkAppDomainAttachment: + op: + description: Handy shortcut for operation name + type: string + enum: + - add + - replace + - remove + path: + description: path inside document leading to updated parameter + type: string + example: / + value: + $ref: '#/components/schemas/RouteAggregationRulesBase' required: - - uuid + - op + - path + - value + RouteAggregationRulesChangeData: + description: Current state of latest Route Aggregation Rules change type: object properties: - href: + status: + description: Current outcome of the change flow type: string - description: Resource URI - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - x-order: 1 - type: - $ref: "#/components/schemas/AppDomainType" - uuid: + enum: + - COMPLETED + - FAILED + - REQUESTED + createdBy: type: string - description: Equinix-assigned access point identifier - format: uuid - example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - x-order: 3 - name: + description: Created by User Key + createdDateTime: + description: Set when change flow starts type: string - description: Customer-provided App Domain name - example: atlassian.net - x-order: 4 - attachmentStatus: - $ref: "#/components/schemas/AppLinkAttachState" - changeLog: - $ref: "#/components/schemas/Changelog" - description: App Link Attached App Domain object - AppLinkAttachDomainSearchRequest: + format: date-time + updatedBy: + type: string + description: Updated by User Key + updatedDateTime: + description: Set when change object is updated + type: string + format: date-time + data: + $ref: '#/components/schemas/RouteAggregationRulesChangeOperation' + allOf: + - $ref: '#/components/schemas/RouteAggregationRulesChange' + RouteAggregationRulesChangeDataResponse: + description: List of Route Aggregation Rule changes type: object properties: - filter: - $ref: "#/components/schemas/AppLinkAttachDomainFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + $ref: '#/components/schemas/Pagination' + data: type: array items: - $ref: "#/components/schemas/AppLinkAttachDomainSortCriteria" - description: Search requests containing criteria - AppLinkAttachDomainFilters: + $ref: '#/components/schemas/RouteAggregationRulesChangeData' + RouteAggregationRulesPostRequest: type: object + description: Create Route Aggregation Rule POST request properties: - and: - maxItems: 8 + data: + description: Route Aggregation Rule configuration type: array items: - $ref: "#/components/schemas/AppLinkAttachDomainFilter" - AppLinkAttachDomainFilter: + $ref: '#/components/schemas/RouteAggregationRulesBase' + RouteAggregationRuleAndExpression: type: object + description: AND expression containing multiple filter expressions + properties: + and: + type: array + minItems: 1 + maxItems: 8 + items: + $ref: '#/components/schemas/RouteAggregationRuleExpression' + RouteAggregationRuleExpression: + description: Filter expression that can be AND, OR, or a simple expression anyOf: - - $ref: "#/components/schemas/AppLinkAttachDomainSimpleExpression" - - $ref: "#/components/schemas/AppLinkAttachDomainOrFilter" - AppLinkAttachDomainSimpleExpression: + - $ref: '#/components/schemas/RouteAggregationRuleAndExpression' + - $ref: '#/components/schemas/RouteAggregationRuleOrExpression' + - $ref: '#/components/schemas/RouteAggregationRuleSimpleExpression' + RouteAggregationRuleOrExpression: + type: object + description: OR expression containing multiple filter expressions + properties: + or: + type: array + minItems: 1 + maxItems: 8 + items: + $ref: '#/components/schemas/RouteAggregationRuleExpression' + RouteAggregationRuleSimpleExpression: type: object + description: Simple filter expression with property, operator, and values properties: property: - type: string description: | Possible field names to use on filters: - * `/uuid` - App Domain attach to App Link uuid - * `/attachmentStatus` - App Domain attach to App Link status - example: /attachmentStatus - operator: + * `/type` - Route Aggregation Rules Type + * `/name` - Route Aggregation Rules Name + * `/uuid` - Route Aggregation Rules uuid + * `/state` - Route Aggregation Rules status + * `/prefix` - Route Aggregation Rule Prefix type: string + example: /name + operator: description: | Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `IN` - in - * `NOT IN` - not in - example: = + * `=` - equal + * `!=` - not equal + * `[NOT] LIKE` - (not) like + * `[NOT] IN` - (not) in + * `ILIKE` - case-insensitive like + type: string + example: '=' values: type: array + minItems: 1 + maxItems: 8 items: type: string - example: Gateway - AppLinkAttachDomainOrFilter: - type: object - properties: - or: - maxItems: 3 - type: array - items: - $ref: "#/components/schemas/AppLinkAttachDomainSimpleExpression" - AppLinkAttachDomainSortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/AppLinkAttachDomainSortDirection" - property: - $ref: "#/components/schemas/AppLinkAttachDomainSortBy" - AppLinkAttachDomainSortDirection: - type: string + example: Route_Aggregation_Rule_Demo + RouteAggregationRulesFilter: + description: Top-level filter that can be either an AND expression or OR expression + anyOf: + - $ref: '#/components/schemas/RouteAggregationRuleAndExpression' + - $ref: '#/components/schemas/RouteAggregationRuleOrExpression' + RouteAggregationRuleSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - AppLinkAttachDomainSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/uuid` - App Domain attach to App Link uuid - * `/attachmentStatus` - App Domain attach to App Link status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime + RouteAggregationRuleSortBy: + description: Possible field names to use on sorting default: /changeLog/updatedDateTime - AppLinkAttachDomainSearchResponse: + type: string + enum: + - /type + - /uuid + - /name + - /state + - /prefix + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + RouteAggregationRuleSortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/RouteAggregationRuleSortDirection' + property: + $ref: '#/components/schemas/RouteAggregationRuleSortBy' + RouteAggregationRulesSearchRequest: type: object + description: Search route aggregation rules properties: + filter: + $ref: '#/components/schemas/RouteAggregationRulesFilter' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppLinkAppDomainAttachment" - AttachedAppDomainAttachmentStatus: - type: array - description: Filter attached App Domains by attachment lifecycle state. - example: - - ATTACHED - - ATTACHING - items: - $ref: "#/components/schemas/AppLinkAttachState" - AttachedAppDomainOrder: - type: string - description: Sort order for attached App Domains. - example: DESC - default: DESC - enum: - - DESC - - ASC - AppLinkAttachedAppDomains: + $ref: '#/components/schemas/RouteAggregationRuleSortCriteria' + RouteAggregationRulesSearchResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: + description: List of route aggregation rules type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppLinkAttachedAppDomain" - AppServiceId: - type: string - description: App Service UUID - format: uuid - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - AppLinkAppServiceAttachment: + $ref: '#/components/schemas/RouteAggregationRulesData' + CloudRouterPostRequest: + allOf: + - $ref: '#/components/schemas/CloudRouterPostRequestBase' required: - - destinationIp - - geoScope - - uuid + - type + - name + - location + - package + - notifications + CloudRouterReadResponse: + description: Fabric Cloud Router read response object type: object properties: + type: + type: string + enum: + - IC_ROUTER + - XF_ROUTER + name: + description: Customer-provided Cloud Router name + type: string + 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: + description: Preferences for notifications on connection configuration or status changes + type: array + items: + $ref: '#/components/schemas/SimplifiedNotification' href: + description: Cloud Routers URI type: string - description: Resource URI format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - x-order: 1 - type: - $ref: "#/components/schemas/AppServiceType" + 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: 5008a109-9d1c-485c-b0ba-de9736f283c2 - x-order: 3 - geoScope: - type: string - description: Geo scope for the App Service - example: GLOBAL - x-order: 4 - destinationIp: type: string - description: Target IP for forwarding API requests - format: ipv4 - example: 10.10.1.110 - x-order: 5 - attachmentStatus: - $ref: "#/components/schemas/AppLinkAttachState" + format: uuid + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + state: + $ref: '#/components/schemas/CloudRouterAccessPointState' + example: PROVISIONED + equinixAsn: + description: Equinix ASN + type: integer + format: int64 + example: 30000 + connectionsCount: + description: Number of connections associated with this Access point + type: integer + minimum: 0 + marketplaceSubscription: + $ref: '#/components/schemas/marketplaceSubscription' changeLog: - $ref: "#/components/schemas/Changelog" + $ref: '#/components/schemas/Changelog' change: - $ref: "#/components/schemas/AppLinkAppServiceAttachmentChange" - description: App Link Attached App Service object - AppLinkAttachServiceRequest: - required: - - destinationIp - - geoScope + $ref: '#/components/schemas/CloudRouterChange' + CloudRouterUpdateRequest: + description: Fabric Cloud Router Update Request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/CloudRouterChangeOperation' + CloudRouterActionState: + description: Cloud router action state + type: string + enum: + - SUCCEEDED + - FAILED + - PENDING + CloudRouterActionType: + description: Cloud router action type + type: string + enum: + - BGP_SESSION_STATUS_UPDATE + - ROUTE_TABLE_ENTRY_UPDATE + - RECEIVED_ROUTE_ENTRY_UPDATE + - ADVERTISED_ROUTE_ENTRY_UPDATE + Operation: + description: Operation object for router actions type: object properties: - geoScope: + bgpIpv4RoutesCount: + description: IPV4 route count + type: integer + example: 6 + bgpIpv6RoutesCount: + description: IPV6 route count + type: integer + example: 6 + distinctIpv4PrefixesCount: + description: distinct IPV4 prefixes count + type: integer + example: 4 + distinctIpv6PrefixesCount: + description: distinct IPV6 prefixes count + type: integer + example: 4 + RouterActionsConnection: + description: Connection object for router actions + type: object + properties: + uuid: + description: Connection UUID type: string - description: Geo scope for the App Service - example: GLOBAL - destinationIp: + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + href: type: string - description: Target IP for forwarding API requests - format: ipv4 - example: 10.10.1.110 - description: Attach App Service to App Link - AppLinkAttachServiceUpdateRequest: - maxItems: 1 - minItems: 1 - type: array - description: App Service attachment Update Request - items: - $ref: "#/components/schemas/AppLinkAppServiceAttachmentChangeOperation" - AppLinkAttachServiceSearchRequest: + example: https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4 + type: + $ref: '#/components/schemas/ConnectionType' + operation: + $ref: '#/components/schemas/Operation' + RouterActionsRouter: + description: Router object for router actions type: object properties: - filter: - $ref: "#/components/schemas/AppLinkAttachServiceFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/AppLinkAttachServiceSortCriteria" - description: Search requests containing criteria - AppLinkAttachServiceFilters: + uuid: + description: Router UUID + type: string + example: a1c6b7fd-aead-410a-96b4-b1dfa1071700 + href: + type: string + example: https://api.equinix.com/fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700 + type: + type: string + enum: + - XF_ROUTER + operation: + $ref: '#/components/schemas/Operation' + CloudRouterActionResponse: + description: Cloud router actions response object type: object properties: - and: - maxItems: 8 + 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' + router: + $ref: '#/components/schemas/RouterActionsRouter' + required: + - type + - uuid + - state + - changeLog + CloudRouterActionsSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. type: array items: - $ref: "#/components/schemas/AppLinkAttachServiceFilter" - AppLinkAttachServiceFilter: + $ref: '#/components/schemas/CloudRouterActionResponse' + CloudRouterActionRequest: + description: Cloud router action request type: object - anyOf: - - $ref: "#/components/schemas/AppLinkAttachServiceSimpleExpression" - - $ref: "#/components/schemas/AppLinkAttachServiceOrFilter" - AppLinkAttachServiceSimpleExpression: + properties: + type: + $ref: '#/components/schemas/CloudRouterActionType' + connection: + $ref: '#/components/schemas/RouterActionsConnection' + required: + - type + CloudRouterActionsSearchExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: - * `/uuid` - App Service attach to App Link uuid - * `/attachmentStatus` - App Service attach to App Link status - example: /attachmentStatus - operator: + * `/type` - type of update + * `/state` - action state + * `/connection/uuid` - connection uuid associated + * `/*` - all-category search type: string + example: /type + operator: description: | Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `IN` - in - * `NOT IN` - not in - example: = + * `=` - 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 + type: string + example: '=' values: type: array items: type: string - example: Gateway - AppLinkAttachServiceOrFilter: + example: ROUTE_TABLE_ENTRY_UPDATE + CloudRouterActionsSearchOrFilter: type: object properties: or: - maxItems: 3 type: array + maxItems: 3 items: - $ref: "#/components/schemas/AppLinkAttachServiceSimpleExpression" - AppLinkAttachServiceSortCriteria: + $ref: '#/components/schemas/CloudRouterActionsSearchExpression' + CloudRouterActionsSearchFilter: + type: object + anyOf: + - $ref: '#/components/schemas/CloudRouterActionsSearchExpression' + - $ref: '#/components/schemas/CloudRouterActionsSearchOrFilter' + CloudRouterActionsSearchFilters: type: object properties: - direction: - $ref: "#/components/schemas/AppLinkAttachServiceSortDirection" - property: - $ref: "#/components/schemas/AppLinkAttachServiceSortBy" - AppLinkAttachServiceSortDirection: - type: string + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/CloudRouterActionsSearchFilter' + CloudRouterActionsSearchSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - AppLinkAttachServiceSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/uuid` - App Service attach to App Link uuid - * `/attachmentStatus` - App Service attach to App Link status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime + CloudRouterActionsSearchSortBy: + description: Possible field names to use on sorting default: /changeLog/updatedDateTime - AppLinkAttachServiceSearchResponse: - type: object - properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/AppLinkAppServiceAttachment" - AttachedAppServiceAttachmentStatus: - type: array - description: Filter attached App Services by attachment lifecycle state. - example: - - ATTACHED - - ATTACHING - items: - $ref: "#/components/schemas/AppLinkAttachState" - AttachedAppServiceOrder: type: string - description: Sort order for attached App Services. - example: DESC - default: DESC enum: - - DESC - - ASC - AppLinkAttachedAppServices: + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + - /connection/name + - /type + CloudRouterActionsSearchSortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/CloudRouterActionsSearchSortDirection' + property: + $ref: '#/components/schemas/CloudRouterActionsSearchSortBy' + CloudRouterActionsSearchRequest: type: object + description: Search requests containing criteria properties: + filter: + $ref: '#/components/schemas/CloudRouterActionsSearchFilters' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppLinkAttachedAppService" - AppProcessorId: + $ref: '#/components/schemas/CloudRouterActionsSearchSortCriteria' + CloudRouterCommandType: + description: Fabric Cloud Router Command Type type: string - description: App Processor UUID - format: uuid - example: 90ee425c-9988-454c-96d9-1128bc16350f - AppLinkAppProcessorAttachment: - required: - - uuid + enum: + - PING_COMMAND + - TRACEROUTE_COMMAND + example: PING_COMMAND + CloudRouterCommandState: + description: Fabric Cloud Router Command State + type: string + enum: + - PENDING + - SUCCEEDED + - FAILED + - DELETED + example: SUCCEEDED + CloudRouterCommandRequestConnection: + description: Connection object for Cloud Router Command type: object properties: - href: - type: string - description: Resource URI - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - x-order: 1 - type: - $ref: "#/components/schemas/AppProcessorType" uuid: + description: Connection UUID type: string - description: App Processor UUID - format: uuid - example: 90ee425c-9988-454c-96d9-1128bc16350f - x-order: 3 - config: - type: string - description: Base64-encoded configuration for the processor attachment - format: byte - example: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... - x-order: 4 - endpoint: - type: string - description: Endpoint DNS name assigned to the attached App Processor - example: 123456.privateai.link - x-order: 5 - attachmentStatus: - $ref: "#/components/schemas/AppLinkAttachState" - changeLog: - $ref: "#/components/schemas/Changelog" - description: App Link Attached App Processor object - AppLinkAttachProcessorRequest: + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 required: - - config + - uuid + CloudRouterCommandRequestResponse: + description: Fabric Cloud Router Command Request type: object properties: - config: + destination: + description: Fabric Cloud Router Ping or Traceroute Command Destination type: string - description: Base64-encoded configuration for the processor attachment - format: byte - description: Attach App Processor to App Link - AppLinkAttachProcessorSearchRequest: + example: 8.8.8.8 + sourceConnection: + $ref: '#/components/schemas/CloudRouterCommandRequestConnection' + timeout: + description: | + Timeout in seconds for Fabric Cloud Router Command: + - For `PING_COMMAND`: Packet timeout duration. The default value is 5. + - For `TRACEROUTE_COMMAND`: Probe timeout duration. + The default value is 2 and it is not configurable. + type: integer + example: 2 + dataBytes: + description: | + Ping Command DataBytes. + This field is only applicable for commands of type `PING_COMMAND`. + type: integer + default: 64 + minimum: 16 + maximum: 9000 + example: 100 + interval: + description: | + Time in milliseconds between sending each packet. + This field is only applicable for commands of type `PING_COMMAND`. + type: integer + default: 1000 + example: 1000 + count: + description: | + Total number of ping requests. + This field is only applicable for commands of type `PING_COMMAND`. + type: integer + default: 5 + example: 5 + probes: + description: | + Number of probes for Fabric Cloud Router Traceroute Command. + This field is only applicable for commands of type `TRACEROUTE_COMMAND` and is not configurable. + type: integer + default: 3 + example: 3 + hopsMax: + description: | + Maximum number of hops for the traceroute command. + This field is only applicable for commands of type `TRACEROUTE_COMMAND`. + type: integer + default: 20 + maximum: 30 + example: 20 + OutputStructuredPingResponseItem: type: object properties: - filter: - $ref: "#/components/schemas/AppLinkAttachProcessorFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/AppLinkAttachProcessorSortCriteria" - description: Search requests containing criteria - AppLinkAttachProcessorFilters: + 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 + OutputStructuredPing: type: object properties: - and: - maxItems: 8 + 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/AppLinkAttachProcessorFilter" - AppLinkAttachProcessorFilter: - type: object - anyOf: - - $ref: "#/components/schemas/AppLinkAttachProcessorSimpleExpression" - - $ref: "#/components/schemas/AppLinkAttachProcessorOrFilter" - AppLinkAttachProcessorSimpleExpression: + $ref: '#/components/schemas/OutputStructuredPingResponseItem' + CloudRouterCommandPingResponse: type: object properties: - property: - type: string - description: | - Possible field names to use on filters: - * `/uuid` - App Processor attach to App Link uuid - * `/attachmentStatus` - App Processor attach to App Link status - example: /attachmentStatus - operator: + output: type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `IN` - in - * `NOT IN` - not in - example: = - values: + outputStructuredPing: + $ref: '#/components/schemas/OutputStructuredPing' + errors: type: array items: - type: string - example: ATTACHED - AppLinkAttachProcessorOrFilter: + $ref: '#/components/schemas/Error' + Hop: type: object properties: - or: - maxItems: 3 + hop: + type: integer + example: 1 + probes: type: array items: - $ref: "#/components/schemas/AppLinkAttachProcessorSimpleExpression" - AppLinkAttachProcessorSortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/AppLinkAttachProcessorSortDirection" - property: - $ref: "#/components/schemas/AppLinkAttachProcessorSortBy" - AppLinkAttachProcessorSortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - AppLinkAttachProcessorSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/uuid` - App Processor attach to App Link uuid - * `/attachmentStatus` - App Processor attach to App Link status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime - default: /changeLog/updatedDateTime - AppLinkAttachProcessorSearchResponse: + type: object + properties: + name: + type: string + example: dns.google + ip: + type: string + example: 8.8.8.8 + asn: + type: integer + example: 15169 + rtt: + type: string + example: 11.764 + annotation: + type: string + example: null + OutputStructuredTraceroute: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + destinationIp: + type: string + example: 8.8.8.8 + destinationName: + type: string + example: 8.8.8.8 + packetBytes: + type: integer + example: 60 + hopsMax: + type: integer + example: 10 + hops: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppLinkAppProcessorAttachment" - AttachedAppProcessorAttachmentStatus: - type: array - description: Filter attached App Processors by attachment lifecycle state. - example: - - ATTACHED - - ATTACHING - items: - $ref: "#/components/schemas/AppLinkAttachState" - AttachedAppProcessorOrder: - type: string - description: Sort order for attached App Processors. - example: DESC - default: DESC - enum: - - DESC - - ASC - AppLinkAttachedAppProcessors: + $ref: '#/components/schemas/Hop' + CloudRouterCommandTracerouteResponse: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + output: + type: string + outputStructuredTraceroute: + $ref: '#/components/schemas/OutputStructuredTraceroute' + errors: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppLinkAppProcessorAttachment" - AppProcessor: - required: - - marketplace - - name - - project - - registryId - - type + $ref: '#/components/schemas/Error' + CloudRouterCommandResponse: + type: object + oneOf: + - $ref: '#/components/schemas/CloudRouterCommandPingResponse' + - $ref: '#/components/schemas/CloudRouterCommandTracerouteResponse' + CloudRouterCommand: + description: Get Fabric Cloud Router Command response object type: object properties: href: type: string - description: Resource URI - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - x-order: 1 + example: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/commands/1e9414f1-763e-4c0a-86c6-0bc8336048d9 type: - $ref: "#/components/schemas/AppProcessorType" + $ref: '#/components/schemas/CloudRouterCommandType' uuid: type: string - description: Equinix-assigned access point identifier format: uuid - example: 90ee425c-9988-454c-96d9-1128bc16350f - x-order: 3 + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 name: - maxLength: 50 - minLength: 1 + description: Customer-provided Cloud Router name type: string - description: Customer-provided App Processor name format: string - example: agent-gateway - x-order: 4 + example: test-fg-1 description: - maxLength: 255 - minLength: 1 type: string - description: Customer-provided App Processor description - format: string - example: llm-routing, a2a-routing, mcp-routing - x-order: 5 + example: description state: - $ref: "#/components/schemas/AppProcessorState" - registryId: - maxLength: 255 - minLength: 1 - type: string - description: Container image reference for the processor runtime - format: string - example: agentgateway/agentgateway:1.3.0 - x-order: 7 - marketplace: - $ref: "#/components/schemas/AppProcessorMarketplace" + $ref: '#/components/schemas/CloudRouterCommandState' project: - $ref: "#/components/schemas/Project" + $ref: '#/components/schemas/Project' + request: + $ref: '#/components/schemas/CloudRouterCommandRequestResponse' + response: + $ref: '#/components/schemas/CloudRouterCommandResponse' changeLog: - $ref: "#/components/schemas/Changelog" - change: - $ref: "#/components/schemas/AppProcessorChange" - description: App Processor object - AppProcessorSearchRequest: + $ref: '#/components/schemas/Changelog' + GetAllCloudRouterCommands: + description: List of Fabric Cloud Router Command type: object properties: - filter: - $ref: "#/components/schemas/AppProcessorFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + $ref: '#/components/schemas/Pagination' + data: type: array items: - $ref: "#/components/schemas/AppProcessorSortCriteria" - description: Search requests containing criteria - AppProcessorFilters: + $ref: '#/components/schemas/CloudRouterCommand' + CloudRouterCommandRequestPayload: + description: Fabric Cloud Router Command Request type: object properties: - and: - maxItems: 8 - type: array - items: - $ref: "#/components/schemas/AppProcessorFilter" - AppProcessorFilter: + destination: + description: Fabric Cloud Router Ping or Traceroute Command Destination + type: string + example: 8.8.8.8 + sourceConnection: + $ref: '#/components/schemas/CloudRouterCommandRequestConnection' + timeout: + description: | + Timeout in seconds for Fabric Cloud Router Command: + - For `PING_COMMAND`: Packet timeout duration. The default value is 5. + - For `TRACEROUTE_COMMAND`: Probe timeout duration. + The default value is 2 and it is not configurable. + type: integer + example: 2 + dataBytes: + description: | + Ping Command DataBytes. + This field is only applicable for commands of type `PING_COMMAND`. + type: integer + default: 64 + minimum: 16 + maximum: 9000 + example: 100 + probes: + description: | + Number of probes for Fabric Cloud Router Traceroute Command. + This field is only applicable for commands of type `TRACEROUTE_COMMAND` and is not configurable. + type: integer + default: 3 + example: 3 + hopsMax: + description: | + Maximum number of hops for the traceroute command. + This field is only applicable for commands of type `TRACEROUTE_COMMAND`. + type: integer + default: 20 + maximum: 30 + example: 20 + required: + - destination + - sourceConnection + CloudRouterCommandPostRequest: type: object - anyOf: - - $ref: "#/components/schemas/AppProcessorSimpleExpression" - - $ref: "#/components/schemas/AppProcessorOrFilter" - AppProcessorSimpleExpression: + description: Execute Cloud Router Command Request + properties: + type: + $ref: '#/components/schemas/CloudRouterCommandType' + name: + description: Customer-provided Cloud Router Command name + type: string + description: + description: Customer-provided Cloud Router Command description + type: string + project: + $ref: '#/components/schemas/Project' + request: + $ref: '#/components/schemas/CloudRouterCommandRequestPayload' + required: + - type + - project + - request + CloudRouterCommandSearchExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: - * `/project/projectId` - project id - * `/uuid` - App Processor uuid - * `/name` - App Processor name - * `/description` - App Processor description - * `/state` - App Processor status - * `/ipv4Subnet` - App Processor ipv4 subnet - * `/bandwidth` - App Processor bandwidth - * `/changeLog/createdDateTime` - App Processor creation timestamp - * `/changeLog/updatedDateTime` - App Processor last updated timestamp - * `/changeLog/deletedDateTime` - App Processor deletion timestamp - example: /name - operator: + * `/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 type: string + example: /state + operator: description: | Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `>` - greater than - * `<` - less than - * `IN` - in - * `NOT IN` - not in - * `LIKE` - like - * `ILIKE` - case-insensitive like - * `BETWEEN` - between - * `NOT BETWEEN` - not between - example: = + * `=` - 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 + type: string + example: '=' values: type: array items: type: string - example: Gateway - AppProcessorOrFilter: + example: PING_COMMAND + CloudRouterCommandSearchOrFilter: type: object properties: or: - maxItems: 3 type: array + maxItems: 3 items: - $ref: "#/components/schemas/AppProcessorSimpleExpression" - AppProcessorSortCriteria: + $ref: '#/components/schemas/CloudRouterCommandSearchExpression' + CloudRouterCommandSearchFilter: + type: object + anyOf: + - $ref: '#/components/schemas/CloudRouterCommandSearchExpression' + - $ref: '#/components/schemas/CloudRouterCommandSearchOrFilter' + CloudRouterCommandSearchFilters: type: object properties: - direction: - $ref: "#/components/schemas/AppProcessorSortDirection" - property: - $ref: "#/components/schemas/AppProcessorSortBy" - AppProcessorSortDirection: - type: string + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/CloudRouterCommandSearchFilter' + CloudRouterCommandSearchSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - AppProcessorSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/name` - App Processor name - * `/uuid` - App Processor uuid - * `/state` - App Processor status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime + CloudRouterCommandSearchSortBy: + description: Possible field names to use on sorting default: /changeLog/updatedDateTime - AppProcessorSearchResponse: + type: string + enum: + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + - /name + - /type + CloudRouterCommandSearchSortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/CloudRouterCommandSearchSortDirection' + property: + $ref: '#/components/schemas/CloudRouterCommandSearchSortBy' + CloudRouterCommandSearchRequest: type: object + description: Search requests containing criteria properties: + filter: + $ref: '#/components/schemas/CloudRouterCommandSearchFilters' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array + items: + $ref: '#/components/schemas/CloudRouterCommandSearchSortCriteria' + CloudRouterCommandSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: description: Data returned from the API call. + type: array items: - $ref: "#/components/schemas/AppProcessor" - AppServicePostRequest: - required: - - endpoint - - name - - project - - type - type: object - properties: - type: - $ref: "#/components/schemas/AppServiceType" - name: - maxLength: 50 - minLength: 1 - type: string - description: Customer-provided App Service name - format: string - example: Atlassian App Service - description: - type: string - description: Customer-provided App Service description - format: string - example: Atlassian App Service in SV - endpoint: - type: string - description: Accessible endpoint through this service - example: equinixjira.atlassian.net - sourceDomains: - type: array - description: List of source domains from where traffic is allowed - items: - type: string - example: equinix.com - project: - $ref: "#/components/schemas/Project" - description: Create App Service - AppService: - required: - - name - - type - type: object - properties: - href: - type: string - description: Resource URI - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - x-order: 1 - type: - $ref: "#/components/schemas/AppServiceType" - uuid: - type: string - description: Equinix-assigned access point identifier - format: uuid - example: 5008a109-9d1c-485c-b0ba-de9736f283c2 - x-order: 3 - name: - type: string - description: Customer-provided App Service name - format: string - example: Atlassian App Service - x-order: 4 - description: - type: string - description: Customer-provided App Service description - format: string - example: Atlassian App Service in SV - x-order: 5 - state: - $ref: "#/components/schemas/AppServiceState" - endpoint: - type: string - description: Accessible endpoint through this service - example: equinixjira.atlassian.net - x-order: 7 - sourceDomains: - type: array - description: List of source domains from where traffic is allowed - items: - type: string - example: equinix.com - x-order: 8 - account: - $ref: "#/components/schemas/SimplifiedAccount" - project: - $ref: "#/components/schemas/Project" - changeLog: - $ref: "#/components/schemas/Changelog" - change: - $ref: "#/components/schemas/AppServiceChange" - description: App Service object - AppServiceUpdateRequest: - maxItems: 1 - minItems: 1 - type: array - description: App Service Update Request - items: - $ref: "#/components/schemas/AppServiceChangeOperation" - AppServiceSearchRequest: - type: object - properties: - filter: - $ref: "#/components/schemas/AppServiceFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/AppServiceSortCriteria" - description: Search requests containing criteria - AppServiceFilters: - type: object - properties: - and: - maxItems: 8 - type: array - items: - $ref: "#/components/schemas/AppServiceFilter" - AppServiceFilter: - type: object - anyOf: - - $ref: "#/components/schemas/AppServiceSimpleExpression" - - $ref: "#/components/schemas/AppServiceOrFilter" - AppServiceSimpleExpression: + $ref: '#/components/schemas/CloudRouterCommand' + RouteTableEntrySimpleExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: - * `/project/projectId` - project id - * `/uuid` - App Service uuid - * `/name` - App Service name - * `/description` - App Service description - * `/state` - App Service status - * `/endpoint` - App Service endpoint - * `/sourceDomains` - App Service source domains - * `/changeLog/createdDateTime` - App Service creation timestamp - * `/changeLog/updatedDateTime` - App Service last updated timestamp - * `/changeLog/deletedDateTime` - App Service deletion timestamp - example: /name - operator: + * `/type` - Route table entry type + * `/prefix` - Route table entry prefix + * `/nextHop` - Route table entry nextHop + * `/state` - Route table entry state + * `/MED` - Route table entry med + * `/*` - all-category search type: string + example: /type + operator: description: | Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `>` - greater than - * `<` - less than - * `IN` - in - * `NOT IN` - not in - * `LIKE` - like - * `ILIKE` - case-insensitive like - * `BETWEEN` - between - * `NOT BETWEEN` - not between - example: = + * `=` - 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 + type: string + example: '=' values: type: array items: type: string - example: Gateway - AppServiceOrFilter: + example: IPv4_BGP_ROUTE + RouteTableEntryOrFilter: type: object properties: or: - maxItems: 3 type: array + maxItems: 3 items: - $ref: "#/components/schemas/AppServiceSimpleExpression" - AppServiceSortCriteria: + $ref: '#/components/schemas/RouteTableEntrySimpleExpression' + RouteTableEntryFilter: + type: object + anyOf: + - $ref: '#/components/schemas/RouteTableEntrySimpleExpression' + - $ref: '#/components/schemas/RouteTableEntryOrFilter' + RouteTableEntryFilters: type: object properties: - direction: - $ref: "#/components/schemas/AppServiceSortDirection" - property: - $ref: "#/components/schemas/AppServiceSortBy" - AppServiceSortDirection: - type: string + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/RouteTableEntryFilter' + RouteTableEntrySortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - AppServiceSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/name` - App Service name - * `/uuid` - App Service uuid - * `/state` - App Service status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime + RouteTableEntrySortBy: + description: Possible field names to use on sorting default: /changeLog/updatedDateTime - AppServiceSearchResponse: + type: string + enum: + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + - /prefix + - /nextHop + - /connection/name + - /type + - /MED + RouteTableEntrySortCriteria: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/AppService" - AttachedAppLinkState_1: - type: array - description: Filter attached App Links by lifecycle state. - example: - - PROVISIONED - - PROVISIONING - items: - $ref: "#/components/schemas/AppLinkState" - AppServiceAttachedAppLinks: + direction: + $ref: '#/components/schemas/RouteTableEntrySortDirection' + property: + $ref: '#/components/schemas/RouteTableEntrySortBy' + RouteTableEntrySearchRequest: type: object + description: Search requests containing criteria properties: + filter: + $ref: '#/components/schemas/RouteTableEntryFilters' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppServiceAttachedAppLink" - AttachedAppSubscriptionState: - type: array - description: Filter attached App Subscriptions by lifecycle state. - example: - - PROVISIONED - - PROVISIONING - items: - $ref: "#/components/schemas/AppSubscriptionState" - AttachedAppSubscriptionOrder: + $ref: '#/components/schemas/RouteTableEntrySortCriteria' + RouteTableEntryState: + description: Route table entry state type: string - description: Sort order for attached App Subscriptions. - example: DESC - default: DESC enum: - - DESC - - ASC - AppServiceAttachedAppSubscriptions: + - ACTIVE + RouteTableEntry: + description: Route table entry object + type: object + properties: + type: + $ref: '#/components/schemas/RouteTableEntryType' + example: IPv4_BGP_SESSION + protocolType: + $ref: '#/components/schemas/RouteTableEntryProtocolType' + example: BGP + state: + $ref: '#/components/schemas/RouteTableEntryState' + example: ACTIVE + 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 + example: '20100' + connection: + type: object + properties: + uuid: + type: string + example: 81331c52-04c0-4656-a4a7-18c52669348f + name: + type: string + example: connection_1 + href: + type: string + format: uri + changeLog: + $ref: '#/components/schemas/Changelog' + required: + - type + - state + - changeLog + RouteTableEntrySearchResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: - type: array description: Data returned from the API call. + type: array items: - $ref: "#/components/schemas/AppServiceAttachedAppSubscription" - AppServiceAttachedAppSubscriptionSearchRequest: + $ref: '#/components/schemas/RouteTableEntry' + ValidateRequest: type: object + description: Validate connection auth api key or vlan properties: filter: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + type: object + description: Filters + properties: + and: + type: array + items: + type: object + properties: + property: + description: Path to property + type: string + operator: + description: Type of operation + type: string + values: + description: Values for the given property + type: array + items: + type: string + ValidateSubnetResponse: + description: ValidateResponse + type: object + properties: + additionalInfo: + description: Additional information type: array items: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionSortCriteria" - description: Search requests containing criteria - AppServiceAttachedAppSubscriptionFilters: + $ref: '#/components/schemas/ConnectionSideAdditionalInfo' + CloudRouterRouteFilterAndExpression: type: object + description: AND expression containing multiple filter expressions properties: and: - maxItems: 8 type: array + minItems: 1 + maxItems: 8 items: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionFilter" - AppServiceAttachedAppSubscriptionFilter: - type: object + $ref: '#/components/schemas/CloudRouterRouteFilterExpression' + CloudRouterRouteFilterExpression: + description: Filter expression that can be AND, OR, or a simple expression anyOf: - - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionSimpleExpression" - - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionOrFilter" - AppServiceAttachedAppSubscriptionSimpleExpression: + - $ref: '#/components/schemas/CloudRouterRouteFilterAndExpression' + - $ref: '#/components/schemas/CloudRouterRouteFilterOrExpression' + - $ref: '#/components/schemas/CloudRouterRouteFilterSimpleExpression' + CloudRouterRouteFilterOrExpression: + type: object + description: OR expression containing multiple filter expressions + properties: + or: + type: array + minItems: 1 + maxItems: 8 + items: + $ref: '#/components/schemas/CloudRouterRouteFilterExpression' + CloudRouterRouteFilterSimpleExpression: type: object properties: property: type: string - description: | - Possible field names to use on filters: - * `/uuid` - App Subscription UUID - * `/state` - App Subscription lifecycle state - example: /state + enum: + - /type + - /direction + - /attachmentStatus + - /changeLog/createdDateTime + - /changeLog/updatedDateTime operator: type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `IN` - in - * `NOT IN` - not in - example: IN values: type: array + minItems: 1 + maxItems: 8 items: type: string - example: PROVISIONED - AppServiceAttachedAppSubscriptionOrFilter: - type: object - properties: - or: - maxItems: 3 - type: array - items: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionSimpleExpression" - AppServiceAttachedAppSubscriptionSortCriteria: + CloudRouterRouteFiltersFilter: + description: Top-level filter that can be either an AND expression or OR expression + anyOf: + - $ref: '#/components/schemas/CloudRouterRouteFilterAndExpression' + - $ref: '#/components/schemas/CloudRouterRouteFilterOrExpression' + RfAttachmentSortItem: type: object properties: - direction: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionSortDirection" property: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionSortBy" - AppServiceAttachedAppSubscriptionSortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - AppServiceAttachedAppSubscriptionSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/uuid` - App Subscription UUID - * `/state` - App Subscription lifecycle state - format: string - example: /uuid - default: /uuid - AppServiceAttachedAppSubscriptionSearchResponse: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + enum: + - /type + - /uuid + - /direction + - /attachmentStatus + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + direction: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + CloudRouterRouteFiltersSearchBase: type: object properties: + filter: + $ref: '#/components/schemas/CloudRouterRouteFiltersFilter' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/Pagination' + sort: type: array - description: Data returned from the API call. + minItems: 1 + maxItems: 3 items: - $ref: "#/components/schemas/AppServiceAttachedAppSubscription" - AppSubscriptionPostRequest: - required: - - project - - type - type: object - properties: - type: - $ref: "#/components/schemas/AppSubscriptionType" - source: - $ref: "#/components/schemas/AppSubscriptionSourceRequest" - target: - $ref: "#/components/schemas/AppSubscriptionTargetRequest" - project: - $ref: "#/components/schemas/Project" - description: Create App Subscription - AppSubscription: - required: - - project - - source - - target - - type - type: object - properties: - href: - type: string - description: Resource URI - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - x-order: 1 - type: - $ref: "#/components/schemas/AppSubscriptionType" - uuid: - type: string - description: Equinix-assigned access point identifier - format: uuid - example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - x-order: 3 - source: - $ref: "#/components/schemas/AppSubscriptionSource" - target: - $ref: "#/components/schemas/AppSubscriptionTarget" - state: - $ref: "#/components/schemas/AppSubscriptionState" - project: - $ref: "#/components/schemas/Project" - changeLog: - $ref: "#/components/schemas/Changelog" - change: - $ref: "#/components/schemas/AppSubscriptionChange" - description: App Subscription object - AppSubscriptionId: - type: string - description: App Subscription UUID - format: uuid - example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - AppSubscriptionUpdateRequest: - minItems: 1 - type: array - description: App Subscription Update Request - items: - $ref: "#/components/schemas/AppSubscriptionChangeOperation" - AppSubscriptionSearchRequest: + $ref: '#/components/schemas/RfAttachmentSortItem' + CloudRouterRouteFiltersSearchResponse: type: object properties: - filter: - $ref: "#/components/schemas/AppSubscriptionFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + $ref: '#/components/schemas/Pagination' + data: + description: List of route filter attachments for a given cloud router type: array items: - $ref: "#/components/schemas/AppSubscriptionSortCriteria" - description: Search requests containing criteria - AppSubscriptionFilters: + $ref: '#/components/schemas/ConnectionRouteFilterData' + CloudRouterRouteAggregationAndExpression: type: object + description: AND expression containing multiple filter expressions properties: and: - maxItems: 8 type: array + minItems: 1 + maxItems: 8 items: - $ref: "#/components/schemas/AppSubscriptionFilter" - AppSubscriptionFilter: - type: object + $ref: '#/components/schemas/CloudRouterRouteAggregationExpression' + CloudRouterRouteAggregationExpression: + description: Filter expression that can be AND, OR, or a simple expression anyOf: - - $ref: "#/components/schemas/AppSubscriptionSimpleExpression" - - $ref: "#/components/schemas/AppSubscriptionOrFilter" - AppSubscriptionSimpleExpression: + - $ref: '#/components/schemas/CloudRouterRouteAggregationAndExpression' + - $ref: '#/components/schemas/CloudRouterRouteAggregationOrExpression' + - $ref: '#/components/schemas/CloudRouterRouteAggregationSimpleExpression' + CloudRouterRouteAggregationOrExpression: + type: object + description: OR expression containing multiple filter expressions + properties: + or: + type: array + minItems: 1 + maxItems: 8 + items: + $ref: '#/components/schemas/CloudRouterRouteAggregationExpression' + CloudRouterRouteAggregationSimpleExpression: type: object properties: property: type: string - description: | - Possible field names to use on filters: - * `/project/projectId` - project id - * `/uuid` - App Subscription uuid - * `/state` - App Subscription status - * `/source/appLink/uuid` - Source App Link uuid - * `/source/ipSubnets` - Source App Link ip subnets - * `/target/appService/uuid` - Target App Service uuid - * `/target/geoScope` - Target App Service geo scope - * `/target/prioritization` - Target App Service prioritization - * `/changeLog/createdDateTime` - App Subscription creation timestamp - * `/changeLog/updatedDateTime` - App Subscription last updated timestamp - * `/changeLog/deletedDateTime` - App Subscription deletion timestamp - example: /name + enum: + - /type + - /attachmentStatus + - /changeLog/createdDateTime + - /changeLog/updatedDateTime operator: type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `>` - greater than - * `<` - less than - * `IN` - in - * `NOT IN` - not in - * `LIKE` - like - * `ILIKE` - case-insensitive like - * `BETWEEN` - between - * `NOT BETWEEN` - not between - example: = values: type: array items: type: string - example: Gateway - AppSubscriptionOrFilter: + CloudRouterRouteAggregationsFilter: + description: Top-level filter that can be either an AND expression or OR expression + anyOf: + - $ref: '#/components/schemas/CloudRouterRouteAggregationAndExpression' + - $ref: '#/components/schemas/CloudRouterRouteAggregationOrExpression' + RaAttachmentSortItem: type: object properties: - or: - maxItems: 3 + property: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + enum: + - /type + - /uuid + - /attachmentStatus + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + direction: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + CloudRouterRouteAggregationsSearchBase: + type: object + properties: + filter: + $ref: '#/components/schemas/CloudRouterRouteAggregationsFilter' + pagination: + $ref: '#/components/schemas/Pagination' + sort: type: array + minItems: 1 + maxItems: 3 items: - $ref: "#/components/schemas/AppSubscriptionSimpleExpression" - AppSubscriptionSortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/AppSubscriptionSortDirection" - property: - $ref: "#/components/schemas/AppSubscriptionSortBy" - AppSubscriptionSortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - AppSubscriptionSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/uuid` - App Subscription uuid - * `/state` - App Subscription status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime - default: /changeLog/updatedDateTime - AppSubscriptionSearchResponse: + $ref: '#/components/schemas/RaAttachmentSortItem' + CloudRouterRouteAggregationsSearchResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: + description: List of route aggregation attachments for a given cloud router type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppSubscription" - GatewaySearchRequest: + $ref: '#/components/schemas/ConnectionRouteAggregationData' + CloudRouterExpression: type: object properties: - filter: - $ref: "#/components/schemas/SearchFilter" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + and: + $ref: '#/components/schemas/CloudRouterExpressions' + or: + $ref: '#/components/schemas/CloudRouterExpressions' + property: + $ref: '#/components/schemas/SearchField' + operator: + 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 + type: string + values: type: array items: - $ref: "#/components/schemas/GatewaySortCriteria" - description: Search gateways - GatewaySortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/GatewaySortDirection" - property: - $ref: "#/components/schemas/GatewaySortBy" - GatewaySortDirection: + type: string + CloudRouterExpressions: + type: array + items: + $ref: '#/components/schemas/CloudRouterExpression' + SearchField: + 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 + * `/type` - Fabric Cloud Router type + * `/connectionsCount` - Fabric Cloud Router attached connections count + * `/changeLog/createdDateTime` - Fabric Cloud Router creation timestamp + * `/changeLog/updatedDateTime` - Fabric Cloud Router last updated timestamp + * `/changeLog/deletedDateTime` - Fabric Cloud Router deletion timestamp + * `/*` - all-category search type: string + example: /name + CloudRouterSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - GatewaySortBy: - type: string - description: | - Possible field names to use on sorting: - * `/name` - Gateway name - * `/uuid` - Gateway uuid - * `/state` - Gateway status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - example: /changeLog/updatedDateTime + CloudRouterSortBy: + description: Possible field names to use on sorting default: /changeLog/updatedDateTime - GatewayId: type: string - description: Gateway UUID - format: uuid - example: 6658cc3b-18e0-437c-b972-62b51a419a1e - GatewayPackageCode: - type: string - description: Gateway package code enum: - - LAB - GatewayTunnelSearchRequest: + - /name + - /uuid + - /state + - /location/metroCode + - /location/metroName + - /package/code + - /type + - /connectionsCount + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + - /changeLog/deletedDateTime + - /order/termLength + CloudRouterSortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/CloudRouterSortDirection' + property: + $ref: '#/components/schemas/CloudRouterSortBy' + CloudRouterSearchRequest: type: object + description: Search requests containing criteria properties: filter: - $ref: "#/components/schemas/SearchFilter" + $ref: '#/components/schemas/CloudRouterExpression' pagination: - $ref: "#/components/schemas/PaginationRequest" + $ref: '#/components/schemas/PaginationRequest' sort: type: array items: - $ref: "#/components/schemas/GatewayTunnelSortCriteria" - description: Search Gateway Tunnels - GatewayTunnelSortCriteria: + $ref: '#/components/schemas/CloudRouterSortCriteria' + SearchResponse: type: object properties: - direction: - $ref: "#/components/schemas/GatewayTunnelSortDirection" - property: - $ref: "#/components/schemas/GatewayTunnelSortBy" - GatewayTunnelSortDirection: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/CloudRouterReadResponse' + code: + description: Cloud Router package code type: string - description: Sorting direction - default: DESC enum: - - DESC - - ASC - GatewayTunnelSortBy: - type: string - description: | - Possible field names to use on sorting: - * `/name` - Gateway Tunnel name - * `/uuid` - Gateway Tunnel uuid - * `/state` - Gateway Tunnel status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime - default: /changeLog/updatedDateTime - 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 - Changelog: + - LAB + - BASIC + - STANDARD + - ADVANCED + - PREMIUM + example: LAB + PackageChangeLog: + description: Cloud Router package change log 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 + example: '2020-11-06T07:00:00Z' 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: + example: '2020-11-06T07:00:00Z' + CloudRouterPackage: + description: Fabric Cloud Router Package + type: object + properties: + href: + description: Cloud Router package URI type: string - description: Deleted by User Full Name - example: John Smith - deletedByEmail: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/routerPackages/LAB + type: + description: Type of Router package type: string - description: Deleted by User Email Address - example: john.smith@example.com - deletedDateTime: + enum: + - ROUTER_PACKAGE + example: ROUTER_PACKAGE + code: + $ref: '#/components/schemas/code' + description: + description: Fabric Cloud Router Package description type: string - description: Deleted by Date and Time - format: date-time - example: 2020-11-06T07:00:00Z - description: Change log - PaginationRequest: - type: object - properties: - offset: + totalIPv4RoutesMax: + description: Cloud Router package BGP IPv4 routes limit + type: integer minimum: 0 + example: 50 + totalIPv6RoutesMax: + description: Cloud Router package BGP IPv6 routes limit type: integer - description: Index of the first element. - default: 0 - limit: - minimum: 1 + minimum: 0 + example: 50 + routeFilterSupported: + description: CloudRouter package route filter support + type: boolean + vcCountMax: + description: CloudRouter package Max Connection limit 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 - Project: - required: - - projectId - type: object - properties: - projectId: - type: string - description: Subscriber-assigned project ID - example: 44f4c4f8-2f39-494e-838c-d8e640591be5 - AsnOwnershipChallengeDetails: - required: - - type + minimum: 0 + example: 10 + crCountMax: + description: CloudRouter package Max CloudRouter limit + type: integer + minimum: 0 + example: 3 + vcBandwidthMax: + description: CloudRouter package Max Bandwidth limit + type: integer + minimum: 0 + example: 50 + changeLog: + $ref: '#/components/schemas/PackageChangeLog' + PackageResponse: type: object properties: - type: - $ref: "#/components/schemas/AsnOwnershipChallengeType" - description: Ownership challenge details for public ASN verification - discriminator: - propertyName: type - mapping: - RPKI: "#/components/schemas/AsnOwnershipChallengeRpki" - LOA: "#/components/schemas/AsnOwnershipChallengeLoa" - AsnOwnershipChallengeType: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/CloudRouterPackage' + RouterPackageCode: + description: Router package code type: string - description: Type of ownership challenge enum: - - RPKI - - LOA - x-enum-varnames: - - RPKI - - LOA - AsnOwnershipChallengeRpki: - allOf: - - $ref: "#/components/schemas/AsnOwnershipChallengeDetails" - - type: object - properties: - message: - type: string - description: Challenge message to sign - example: eqx-rpki-challenge-2026-04-21T11:20:00Z-64497 - signature: - type: string - description: Signed challenge value - example: MEUCIQCrExampleBase64SignatureValue7h4Yg== - AsnOwnershipChallengeLoa: - allOf: - - $ref: "#/components/schemas/AsnOwnershipChallengeDetails" - - type: object - properties: - contentFormat: - type: string - description: Document content format - example: pdf - documentReference: - type: string - description: Document reference identifier - example: loa-2026-00019 - SimplifiedLocation: + - LAB + - BASIC + - STANDARD + - ADVANCED + - PREMIUM + ApiServices: + description: Available services details 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: + route: + description: service routes type: string - example: AM - ibx: + status: + description: service status type: string - example: AM1 - deprecated: true - CloudEventData: - type: object - properties: - message: + changedDateTime: + description: service status change date type: string - description: Cloud Event message - resource: - $ref: "#/components/schemas/ResourceData" - auth: - $ref: "#/components/schemas/AuthContext" - ResourceData: + HealthResponse: + description: GET Services Health type: object properties: href: + description: The Canonical URL at which the resource resides. type: string - description: Cloud Event asset href - uuid: - type: string - description: Cloud Event asset uuid - type: + version: + description: Indicator of a version type: string - description: Cloud Event asset type - name: + release: + description: release details. type: string - description: Cloud Event asset name state: + description: status of a service type: string - description: Cloud Event asset state - operation: - $ref: "#/components/schemas/OperationalStatus" - OperationalStatus: - type: object - properties: - operationalStatus: - type: string - description: Operational status for the resource target of the event - AuthContext: + apiServices: + $ref: '#/components/schemas/ApiServices' + ValidateConnectionResponse: + description: Validate Connection specification 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: + uuid: + description: Equinix-assigned connection identifier type: string - description: Cloud Event email - Metric: + bandwidth: + description: Connection bandwidth in Mbps + type: integer + minimum: 0 + maximum: 100000 + redundancy: + $ref: '#/components/schemas/ConnectionRedundancy' + aSide: + $ref: '#/components/schemas/ConnectionSide' + zSide: + $ref: '#/components/schemas/ConnectionSide' + ConnectionResponse: + description: ValidateResponse type: object properties: - type: - type: string - description: Equinix supported metric type - name: - type: string - description: Metric name - unit: - type: string - description: Metric unit - interval: - type: string - description: Metric interval (set automatically based on search range) - resource: - $ref: "#/components/schemas/Metric_resource" - summary: - type: string - description: Metric summary - datapoints: + additionalInfo: + description: Additional information type: array - description: Metric data points items: - $ref: "#/components/schemas/Metric_datapoints" - description: Metric object - maintenanceState: - type: string - description: Maintenance lifecycle state - example: SCHEDULED - enum: - - SCHEDULED - - IN_PROGRESS - - COMPLETED - - CANCELLED - - POSTPONED - SearchFilter: - description: Top-level filter that can be either an AND expression or OR expression - oneOf: - - $ref: "#/components/schemas/SearchAndExpression" - - $ref: "#/components/schemas/SearchOrExpression" - SearchAndExpression: - required: - - and - type: object - properties: - and: - maxItems: 8 - minItems: 1 + $ref: '#/components/schemas/ConnectionSideAdditionalInfo' + data: + description: Connection response data type: array items: - $ref: "#/components/schemas/SearchFilterExpression" - SearchFilterExpression: - description: Filter expression that can be AND, OR, or a simple expression - oneOf: - - $ref: "#/components/schemas/SearchAndExpression" - - $ref: "#/components/schemas/SearchOrExpression" - - $ref: "#/components/schemas/SearchSimpleExpression" - SearchOrExpression: - required: - - or + $ref: '#/components/schemas/ValidateConnectionResponse' + NetworkPostRequest: type: object + description: Create Network properties: - or: - maxItems: 8 - minItems: 1 + type: + $ref: '#/components/schemas/NetworkType' + name: + description: Customer-provided network name + type: string + scope: + $ref: '#/components/schemas/NetworkScope' + location: + $ref: '#/components/schemas/SimplifiedLocation' + project: + $ref: '#/components/schemas/Project' + notifications: + description: Preferences for notifications on network configuration or status changes type: array items: - $ref: "#/components/schemas/SearchFilterExpression" - SearchSimpleExpression: + $ref: '#/components/schemas/SimplifiedNotification' required: - - operator - - property - - values + - type + - name + - scope + - notifications + Network: + description: Network specification + type: object + allOf: + - type: object + properties: + href: + description: Network URI + type: string + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784 + uuid: + description: Equinix-assigned network identifier + type: string + format: uuid + example: 92dc376a-a932-43aa-a6a2-c806dedbd784 + state: + $ref: '#/components/schemas/NetworkState' + example: ACTIVE + 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: + description: Network sub-resources links + type: array + readOnly: true + items: + $ref: '#/components/schemas/Link' + required: + - href + - uuid + - state + - changeLog + - $ref: '#/components/schemas/NetworkPostRequest' + NetworkChangeOperation: + description: Network change operation data type: object properties: - property: + op: + description: Handy shortcut for operation name type: string - operator: + enum: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter + type: string + example: /name + value: + description: new value for updated parameter + required: + - op + - path + - value + NetworkUpdateRequest: + description: Fabric Network Update Request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/NetworkChangeOperation' + NetworkFilter: + type: object + properties: + and: + $ref: '#/components/schemas/NetworkSimpleExpression' + or: + $ref: '#/components/schemas/NetworkSimpleExpression' + property: + $ref: '#/components/schemas/NetworkSearchFieldName' + operator: type: string - description: | - "~*" is a case-insensitive glob match, equivalent to ILIKE - the same single "*" wildcard, not POSIX regex - kept as its own operator only because existing callers already send it. - example: = enum: - - = - - "!=" - - IN - - NOT IN - - LIKE - - ILIKE - - BETWEEN - - ">" - - ">=" + - '=' + - '!=' + - '>' + - '>=' - < - <= - - ~* - x-enum-varnames: - - EQUAL - - NOT_EQUAL - - IN - - NOT_IN + - BETWEEN + - NOT BETWEEN - LIKE + - NOT LIKE - ILIKE - - BETWEEN - - GREATER_THAN - - GREATER_THAN_OR_EQUAL_TO - - LESS_THAN - - LESS_THAN_OR_EQUAL_TO - - CASE_INSENSITIVE_REGEX + - NOT ILIKE + - IN + - NOT IN + example: '=' values: - maxItems: 8 - minItems: 1 type: array items: type: string - description: Simple filter expression with property, operator, and values - ConnectionType: + example: Network-1 + NetworkSimpleExpression: + type: array + items: + $ref: '#/components/schemas/NetworkFilter' + NetworkSearchFieldName: + description: Possible field names to use on filters type: string - description: Connection type enum: - - EVPL_VC - - EPL_VC - - EC_VC - - IP_VC - - ACCESS_EPL_VC - - EIA_VC - - EVPLAN_VC - - EPLAN_VC - - EVPTREE_VC - - EPTREE_VC - - IPWAN_VC - - IA_VC - - MC_VC - - IX_VC - - GW_VC - - IPX_VC - Order: + - /name + - /uuid + - /scope + - /type + - /state + - /operation/equinixStatus + - /location/region + - /location/metroCode + - /connectionsCount + - /project/projectId + - /account/globalCustId + - /account/orgId + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + - /changeLog/deletedDateTime + - /* + example: /name + NetworkSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + NetworkSortBy: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + enum: + - /name + - /uuid + - /scope + - /operation/equinixStatus + - /location/region + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + NetworkSortCriteria: 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: 60 - minimum: 1 - type: integer - description: Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case). - default: 1 - contractedBandwidth: - type: integer - description: Contracted bandwidth - SimplifiedNotification: - required: - - emails - - type + direction: + $ref: '#/components/schemas/NetworkSortDirection' + property: + $ref: '#/components/schemas/NetworkSortBy' + NetworkSearchRequest: type: object + description: Search requests containing criteria properties: - type: - type: string - description: Notification Type - example: BANDWIDTH_ALERT - enum: - - NOTIFICATION - - BANDWIDTH_ALERT - - CONNECTION_APPROVAL - - PROFILE_LIFECYCLE - - ALL - - SALES_REP_NOTIFICATIONS - - TECHNICAL - - ORDERING - - QUOTE_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 - phone: + filter: + $ref: '#/components/schemas/NetworkFilter' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array - description: Array of contact phone numbers items: - $ref: "#/components/schemas/Phone" - ConnectionRedundancy: + $ref: '#/components/schemas/NetworkSortCriteria' + NetworkSortDirectionResponse: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + NetworkSortByResponse: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + enum: + - /name + - /type + - /uuid + - /state + - /scope + - /location/region + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + NetworkSortCriteriaResponse: type: object properties: - group: - type: string - description: Redundancy group identifier (UUID of primary connection) - priority: - $ref: "#/components/schemas/ConnectionPriority" - name: - type: string - description: Customer-provided name for the redundancy group - description: - type: string - description: Customer-provided description for the redundancy group - description: Connection redundancy configuration - ConnectionSide: + direction: + $ref: '#/components/schemas/NetworkSortDirectionResponse' + property: + $ref: '#/components/schemas/NetworkSortByResponse' + NetworkSearchResponse: + description: List of networks type: object properties: - serviceToken: - $ref: "#/components/schemas/ServiceToken" - accessPoint: - $ref: "#/components/schemas/AccessPoint" - additionalInfo: + pagination: + $ref: '#/components/schemas/Pagination' + sort: 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 - ConnectionSideAdditionalInfo: + $ref: '#/components/schemas/NetworkSortCriteriaResponse' + data: + type: array + items: + $ref: '#/components/schemas/Network' + NetworkConnections: + description: List of network changes type: object properties: - key: - type: string - description: Key - value: - type: string - description: Value - description: Additional information - marketplaceSubscription: + pagination: + $ref: '#/components/schemas/Pagination' + data: + type: array + items: + $ref: '#/components/schemas/Connection' + NetworkChangeStatus: + description: Current outcome of the change flow + type: string + enum: + - APPROVED + - COMPLETED + - FAILED + - REJECTED + - REQUESTED + - SUBMITTED_FOR_APPROVAL + NetworkChange: + description: Current state of latest network change type: object properties: href: + description: Network URI 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 - - PROVISIONING - - "" - Change: - required: - - createdDateTime - - type - type: object - properties: + 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 - type: type: string - description: Type of change - enum: - - CONNECTION_CREATION - - CONNECTION_UPDATE - - CONNECTION_DELETION - - CONNECTION_PROVIDER_STATUS_REQUEST + format: uuid + example: 4b17da68-3d6b-436d-9c8f-2105f3b950d9 + type: + $ref: '#/components/schemas/NetworkChangeType' + example: NETWORK_CREATION status: - type: string - description: Current outcome of the change flow - enum: - - APPROVED - - COMPLETED - - FAILED - - REJECTED - - REQUESTED - - SUBMITTED_FOR_APPROVAL + $ref: '#/components/schemas/NetworkChangeStatus' + example: COMPLETED createdDateTime: - type: string description: Set when change flow starts + type: string format: date-time - example: 2020-11-06T07:00:00Z + 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 + format: date-time + example: '2020-11-06T07:00:00Z' data: - $ref: "#/components/schemas/ConnectionChangeOperation" - description: Current state of latest connection change - ConnectionOperation: + type: array + items: + $ref: '#/components/schemas/NetworkChangeOperation' + NetworkChangeResponse: + description: List of network changes type: object properties: - providerStatus: - $ref: "#/components/schemas/ProviderStatus" - equinixStatus: - $ref: "#/components/schemas/EquinixStatus" - operationalStatus: - type: string - description: Connection operational status - enum: - - UP - - DOWN - errors: + pagination: + $ref: '#/components/schemas/Pagination' + data: 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 - maintenanceStatus: - allOf: - - $ref: "#/components/schemas/maintenanceState" - lockEnabled: - type: boolean - description: Indicates whether the connection configuration is locked due to an ongoing or scheduled maintenance. - example: true - description: Connection type-specific operational data - SimplifiedAccount: + $ref: '#/components/schemas/NetworkChange' + virtualConnectionUuid: + title: fabricConnectionUuid type: object + description: UUID of the Fabric Connection Instance + example: + uuid: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f 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: + href: + description: Connection URI type: string - description: Account name - deprecated: true - resellerAccountNumber: - type: integer - description: Reseller account number - format: int64 - resellerAccountName: + format: uri + readOnly: true + type: type: string - description: Reseller account name - resellerUcmId: + description: Connection Type + uuid: type: string - description: Reseller account ucmId - resellerOrgId: - type: integer - description: Reseller customer organization identifier - format: int64 - ConnectionChangeOperation: + format: uuid + description: Connection UUID. required: - - op - - path - - value + - uuid + ipv4: type: object + description: EPT service network information + title: ipv4 properties: - op: + primary: type: string - description: Handy shortcut for operation name - example: add - path: + format: ipv4 + description: Primary Timing Server IP Address + secondary: 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 - - CONNECTION_CREATION_RETRY - - CONNECTION_DELETION_RETRY - - CONNECTION_PROVIDER_STATUS_UPDATE_REQUEST - ConnectionAcceptanceData: - type: object - properties: - zSide: - $ref: "#/components/schemas/ConnectionSide" - providerBandwidth: - type: integer - description: Authorization key bandwidth in Mbps - readOnly: true - operation: - $ref: "#/components/schemas/ConnectionOperation" - description: Connection acceptance data - ConnectionRouteTableEntry: + format: ipv4 + description: Secondary Timing Server IP Address + networkMask: + type: string + format: ipv4 + description: Network Mask + defaultGateway: + type: string + format: ipv4 + description: Gateway Interface IP address + example: + primary: 10.0.0.1 + secondary: 10.0.0.2 + networkMask: 255.255.255.240 + defaultGateway: 10.0.0.3 required: - - changeLog - - type + - primary + - secondary + - networkMask + md5: type: object properties: type: - $ref: "#/components/schemas/RouteTableEntryType" - protocolType: - $ref: "#/components/schemas/RouteTableEntryProtocolType" - state: type: string - example: ACTIVE enum: - - ACTIVE - - INACTIVE - prefix: + - ASCII + - HEX + keyNumber: + type: integer + minimum: 1 + maximum: 65535 + example: 10 + description: The authentication Key ID. + key: type: string - example: 192.168.10.0/24 - nextHop: + format: byte + pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ + description: The plaintext authentication key. Must be Base64 encoded. For ASCII type, the key must contain printable ASCII characters, range 10-20 characters. For HEX type, range should be 10-40 characters. + ntpAdvanceConfiguration: + type: array + description: NTP Advanced configuration - MD5 Authentication. + items: + $ref: '#/components/schemas/md5' + ptpAdvanceConfiguration: + type: object + description: PTP Advanced Configuration. + properties: + timeScale: 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: + enum: + - ARB + - PTP + example: ARB + description: Time Scale value, ARB denotes Arbitrary and PTP denotes Precision Time Protocol. + domain: type: integer - description: Inbound Multi Exit Discriminator attribute - format: int64 - example: 1000 - outboundMED: + minimum: 0 + maximum: 127 + example: 0 + description: The PTP domain value. + priority1: type: integer - description: Outbound Multi Exit Discriminator attribute - format: int64 - example: 2000 - routesMax: + minimum: 0 + maximum: 248 + example: 128 + description: The priority1 value determines the best primary clock, Lower value indicates higher priority. + priority2: 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: + minimum: 0 + maximum: 248 + example: 128 + 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. + logAnnounceInterval: type: integer - description: AS path prepend count - format: int64 - example: 3 - inboundMED: + 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: Inbound Multi Exit Discriminator attribute - format: int64 - example: 1000 - outboundMED: + 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: Outbound Multi Exit Discriminator attribute - format: int64 - example: 2000 - routesMax: + example: -4 + description: Logarithmic value that controls the rate of PTP DelayReq packets. Default is -4 (16 packets per second), Unit packets/second.. + enum: + - -5 + - -4 + - -3 + - -2 + - -1 + - 0 + - 1 + transportMode: + type: string + enum: + - MULTICAST + - UNICAST + - HYBRID + grantTime: type: integer - description: Maximum learnt prefixes limit - format: int64 - example: 1000 - operation: - $ref: "#/components/schemas/BGPConnectionOperation" - RoutingProtocolBFD: - required: - - enabled + 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. + minimum: 30 + maximum: 7200 + example: 300 + precisionTimeOrder: + title: precisionTimeOrder type: object + description: Precision Time Order properties: - enabled: - type: boolean - interval: + purchaseOrderNumber: + description: Purchase order number type: string - example: "100" - DirectConnectionIpv4: + customerReferenceNumber: + description: Customer reference number + type: string + orderNumber: + description: Order Reference Number + type: string + precisionTimeServiceRequest: + title: precisionTimeServiceRequest type: object + description: Create Precision Time Service Request Schema. properties: - equinixIfaceIp: + type: type: string - description: Equinix side Interface IP address - example: 192.168.100.0/30 - DirectConnectionIpv6: + enum: + - NTP + - PTP + description: Precision Time Service Type refers to the corresponding Protocol. + 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' required: - - equinixIfaceIp + - name + - type + - package + - connections + - ipv4 + timeServiceOperation: + description: time service operational data type: object properties: - equinixIfaceIp: + operationalStatus: + description: time service operational status type: string - description: Equinix side Interface IP address - example: 2001:db8:c59b::/1 - RoutingProtocolBGPData: + enum: + - UP + - DOWN + - DEGRADED + precisionTimePackagePostResponse: + title: precisionTimePackagePostResponse type: object + example: + href: https://api.equinix.com/fabric/v4/timeServicePackage/NTP_STANDARD + code: NTP_STANDARD properties: - type: - type: string - description: Routing protocol type - enum: - - BGP - name: + href: 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: + format: uri + code: type: string - description: BGP authorization key - example: testAuthKey - asOverrideEnabled: - type: boolean - description: Enable AS number override - bfd: - $ref: "#/components/schemas/RoutingProtocolBFD" + enum: + - NTP_STANDARD + - NTP_ENTERPRISE + - PTP_STANDARD + - PTP_ENTERPRISE + required: + - code + virtualConnectionSide: + title: fabricConnectionAccessPoint + type: object + description: Fabric Connection access point object. + properties: + accessPoint: + $ref: '#/components/schemas/AccessPoint' + virtualConnectionTimeServiceResponse: + title: fabricConnectionResponse + type: object + description: Fabric Connection Precision Time Service Response Object + properties: href: + description: Connection URI 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 + readOnly: true + type: + type: string + description: Connection Type. 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" - project: - $ref: "#/components/schemas/RoutingProtocolProject" - connection: - $ref: "#/components/schemas/RoutingProtocolConnection" - RoutingProtocolDirectData: + description: Connection UUID. + aSide: + $ref: '#/components/schemas/virtualConnectionSide' + zSide: + $ref: '#/components/schemas/virtualConnectionSide' + precisionTimeServiceResponse: + title: precisionTimeServiceResponse type: object + description: Precision Time Service Response Schema. properties: + href: + type: string + format: uri + description: Precision Time Service URI. type: type: string - description: Routing protocol type + description: Precision Time Service type refers to the corresponding protocol. enum: - - DIRECT + - NTP + - PTP 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 + description: Precision Time Service Name. uuid: type: string - description: Routing protocol identifier format: uuid - example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + description: Precision Time Service UUID. state: + description: Precision Time Service Status. type: string enum: - - PROVISIONED + - CANCELLED + - CANCELLING + - CONFIGURING + - CONFIGURING_FAILED + - DRAFT + - DEPROVISIONING + - DEPROVISIONING_FAILED - DEPROVISIONED + - PROVISIONED - PROVISIONING - - DEPROVISIONING + - PROVISIONING_FAILED - REPROVISIONING - - FAILED + - REPROVISIONING_FAILED operation: - $ref: "#/components/schemas/RoutingProtocolOperation" - change: - $ref: "#/components/schemas/RoutingProtocolChange" - changelog: - $ref: "#/components/schemas/Changelog" + $ref: '#/components/schemas/timeServiceOperation' + package: + $ref: '#/components/schemas/precisionTimePackagePostResponse' + connections: + type: array + description: Fabric Connections associated with Precision Time Service. + minItems: 1 + maxItems: 2 + uniqueItems: true + items: + $ref: '#/components/schemas/virtualConnectionTimeServiceResponse' + ipv4: + $ref: '#/components/schemas/ipv4' + ntpAdvancedConfiguration: + $ref: '#/components/schemas/ntpAdvanceConfiguration' + ptpAdvancedConfiguration: + $ref: '#/components/schemas/ptpAdvanceConfiguration' project: - $ref: "#/components/schemas/RoutingProtocolProject" - connection: - $ref: "#/components/schemas/RoutingProtocolConnection" - 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: + $ref: '#/components/schemas/Project' + account: + $ref: '#/components/schemas/SimplifiedAccount' + order: + $ref: '#/components/schemas/precisionTimeOrder' + changeLog: + $ref: '#/components/schemas/Changelog' required: - - type - uuid + - href + - type + - state + - package + precisionTimeChangeOperation: 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 + description: Fabric Precision Timing change operation data properties: op: type: string description: Handy shortcut for operation name enum: - - add - replace + - add - remove path: type: string description: path inside document leading to updated parameter - example: / + enum: + - /name + - /package/code + - /ipv4 + - /ntpAdvancedConfiguration + - /ptpAdvancedConfiguration value: - $ref: "#/components/schemas/RoutingProtocolBase" - description: Routing Protocol change operation data - PublicPeeringConnectionRequest: - type: object - properties: - uuid: - type: string - description: connection id - format: uuid - example: b44c6e6c-2c36-4488-b3f1-47064357b5b4 - description: Public Peering Connection - RoutingProtocolRequest: - type: object - properties: - customerAsn: - type: integer - description: Customer Autonomous System Number (ASN) - example: 1100 - macAddress: - type: string - description: MAC address of the customer interface - example: 00:11:22:33:44:55 - bgpIpv4: - $ref: "#/components/schemas/ExchangeServiceRequestBgp" - bgpIpv6: - $ref: "#/components/schemas/ExchangeServiceRequestBgp" - ExchangeServiceOrder: - type: object - properties: - purchaseOrderNumber: - type: string - description: Purchase order number reference. - example: "156576" - orderId: - type: string - description: Equinix-assigned order identifier. - readOnly: true - customerReferenceId: - type: string - description: Your own reference for this Exchange Service. - orderNumber: - type: string - description: Equinix order reference number. - example: 1-129105284100 - orderLineItemNumber: - type: string - description: Order Reference Number for Sales Assisted Order - readOnly: true - domainOrderNumber: - type: string - description: product domain Order Number for Sales Assisted Order - readOnly: true - uuid: - type: string - description: Equinix-assigned order identifier, this is a derived response attribute - format: uuid - readOnly: true - description: Ordering and billing reference details for this Exchange Service. - ExchangeServiceNotification: + description: new value for updated parameter required: - - registeredUsers - - type + - op + - path + - value + TimeServiceSimpleExpression: type: object properties: - type: + property: + 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 type: string - description: Internet Exchange Service Notification Type - enum: - - NOTIFICATION - - TECHNICAL - - PEERING - - ESCALATION - - ORDERING - registeredUsers: + example: /name + operator: + 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 + type: string + example: '=' + values: type: array - description: Array of registered users items: type: string - PublicPeeringConnectionResponse: + example: FabricPrecisionTimeService-1 + TimeServiceOrFilter: type: object properties: - type: - type: string - description: Connection type IX_VC - format: enum - example: IX_VC - href: - type: string - description: URI - format: string - example: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 - uuid: - type: string - description: uuid - format: uuid - example: b44c6e6c-2c36-4488-b3f1-47064357b5b4 - RoutingProtocolResponse: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/TimeServiceSimpleExpression' + TimeServiceFilter: + type: object + anyOf: + - $ref: '#/components/schemas/TimeServiceSimpleExpression' + - $ref: '#/components/schemas/TimeServiceOrFilter' + TimeServiceFilters: type: object properties: - customerAsn: - type: integer - description: Customer Autonomous System Number (ASN) - example: 1100 - macAddress: - type: string - description: MAC address of the customer interface - example: 00:11:22:33:44:55 - vlan: - type: integer - description: VLAN ID - format: int64 - example: 3292 - routeServerAsn: - type: integer - description: Equinix Route Server ASN - format: int64 - example: 1100 - bgpIpv4: - $ref: "#/components/schemas/ExchangeServiceResponseBgp" - bgpIpv6: - $ref: "#/components/schemas/ExchangeServiceResponseBgp" - routeCollector: - $ref: "#/components/schemas/RouteCollector" - PlatformChangelog: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/TimeServiceFilter' + TimeServiceSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + TimeServiceSortBy: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + enum: + - /name + - /uuid + - /state + - /type + - /package/code + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + TimeServiceSortCriteria: type: object properties: - createdBy: - type: string - description: Created by User Key - example: johnsmith - 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 - 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 - deletedDateTime: - type: string - description: Deleted by Date and Time - format: date-time - example: 2020-11-06T07:00:00Z - description: Change log - ExchangeServiceAdditionalInfo: + direction: + $ref: '#/components/schemas/TimeServiceSortDirection' + property: + $ref: '#/components/schemas/TimeServiceSortBy' + TimeServicesSearchRequest: type: object + description: Search requests containing criteria properties: - errorCode: - type: string - description: Error code shown if an operation on the Exchange Service fails - errorMessage: - type: string - description: Generic message shown if an operation on the Exchange Service fails - description: Additional information regarding the specified Exchange Service - InternetAccessBillingType: - type: string - enum: - - FIXED - - USAGE_BASED - - BURST_BASED - x-enum-varnames: - - FIXED - - USAGE_BASED - - BURST_BASED - InternetAccessAccount: - required: - - accountNumber + filter: + $ref: '#/components/schemas/TimeServiceFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/TimeServiceSortCriteria' + ServiceSearchResponse: type: object properties: - accountNumber: - type: string - description: Account number - href: - type: string - description: Account URL path - format: uri - example: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 - InternetAccessRoutingProtocolType: - type: string - enum: - - BGP - - DIRECT - - STATIC - x-enum-varnames: - - BGP - - DIRECT - - STATIC - InternetAccessExportPolicy: - type: string - description: Denotes which routes should be advertised to the internet - example: FULL - enum: - - FULL - - DEFAULT - - FULL_DEFAULT - - PARTIAL - x-enum-varnames: - - FULL - - DEFAULT - - FULL_DEFAULT - - PARTIAL - InternetAccessCustomerAsnRange: - type: string - description: Customer Autonomous System Number range. Based on the value a proper private ASN will be generated. - enum: - - BITS_16 - - BITS_32 - x-enum-varnames: - - BITS_16 - - BITS_32 - InternetAccessChange: - required: - - href + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/precisionTimeServiceResponse' + connectionLink: type: object properties: href: type: string - description: URI of the change object format: uri - InternetAccessLocation: - required: - - ibx - - metroCode - - metroHref - - region + 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 + precisionTimeServiceConnectionsResponse: + title: precisionTimeServiceConnectionResponse type: object + description: EPT service instance's L2 connections properties: - metroHref: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call + type: array + items: + $ref: '#/components/schemas/connectionLink' + precisionTimePackageResponse: + title: precisionTimePackageRespose + type: object + 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' + description: EPT Service Package Information + properties: + href: type: string - description: Metro URL path for the linked resource format: uri - example: https://api.equinix.com/fabric/v4/metros/WA - metroCode: - pattern: ^[A-Z]{2}$ + type: type: string - description: Code representing the metro - example: WA - region: + enum: + - TIME_SERVICE_PACKAGE + code: type: string - description: Geographic region - example: EMEA enum: - - APAC - - EMEA - - AMER - ibx: + - NTP_STANDARD + - NTP_ENTERPRISE + - PTP_STANDARD + - PTP_ENTERPRISE + bandwidth: + type: integer + example: 10 + description: Connection bandwidth in Mbps. + clientsPerSecondMax: + type: integer + minimum: 0 + example: 100 + description: Max. number of clients that can be synchronized per second at a packet rate of 1 per second. + redundancySupported: + type: boolean + example: false + description: Is Redundant virtual connection supported for the package code. + multiSubnetSupported: + type: boolean + example: true + description: Is Multiple subnet supported for the package code. + accuracySlaUnit: type: string - description: IBX data center code - example: WA1 - InternetAccessRoutingProtocol: + example: microseconds + description: Accuracy SLA unit. + accuracySla: + type: integer + example: 50 + description: Accuracy SLA for the package code, -1 value denotes the accuracySla is not published. + accuracySlaMin: + type: integer + example: 1 + minimum: 1 + description: Typical minimum Accuracy for the package code. + accuracySlaMax: + type: integer + minimum: 1 + example: 10 + description: Typical maximum Accuracy for the package code. + changelog: + $ref: '#/components/schemas/Changelog' required: - - connections - - customerRoutes - type + - code + - bandwidth + precisionTimeServicePackagesResponse: + title: precisionTimeServicePackagesResponse type: object + description: Precision Packages properties: - type: - $ref: "#/components/schemas/InternetAccessRoutingProtocolType" - customerRoutes: - type: array - items: - $ref: "#/components/schemas/InternetAccessCustomerRoute" - connections: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call type: array items: - $ref: "#/components/schemas/InternetAccessConnection" - discriminator: - propertyName: type - mapping: - BGP: "#/components/schemas/InternetAccessRoutingProtocolBgp" - DIRECT: "#/components/schemas/InternetAccessRoutingProtocolDirect" - STATIC: "#/components/schemas/InternetAccessRoutingProtocolStatic" - InternetAccessCustomerRoute: - type: object - properties: - ipBlock: - $ref: "#/components/schemas/InternetAccessIpBlock" - InternetAccessRoutingProtocolBgp: - allOf: - - $ref: "#/components/schemas/InternetAccessRoutingProtocol" - - required: - - exportPolicy - type: object - properties: - exportPolicy: - $ref: "#/components/schemas/InternetAccessExportPolicy" - asn: - $ref: "#/components/schemas/InternetAccessRoutingProtocolBgp_asn" - customerAsn: - type: integer - description: Customer ASN. Valid range is 1-64495 or 131072-4199999999. Currently this option is only available for EIA over dedicated port. - format: int64 - example: 11111 - deprecated: true - bgpAuthKey: - type: string - description: BGP authentication key. This field is deprecated and will be removed in future releases. Please use bgpAuthType instead to determine if a BGP authentication key is configured. - example: SecretKey - deprecated: true - bgpAuthType: - $ref: "#/components/schemas/InternetAccessBgpAuthType" - customerAsnRange: - $ref: "#/components/schemas/InternetAccessCustomerAsnRange" - InternetAccessBgpAuthType: + $ref: '#/components/schemas/precisionTimePackageResponse' + SubscriptionState: type: string - description: Indicates whether a BGP authentication key is configured. AUTH_KEY when bgpAuthKey is set, NONE otherwise. - example: AUTH_KEY - default: NONE + description: Subscription State enum: - - AUTH_KEY - - NONE - x-enum-varnames: - - AUTH_KEY - - NONE - InternetAccessRoutingProtocolDirect: - allOf: - - $ref: "#/components/schemas/InternetAccessRoutingProtocol" - InternetAccessRoutingProtocolStatic: - allOf: - - $ref: "#/components/schemas/InternetAccessRoutingProtocol" - InternetAccessBilling: - required: - - type + - ACTIVE + - EXPIRED + - CANCELLED + - GRACE_PERIOD + SubscriptionTrial: type: object + description: Free Trial Subscription properties: - type: - $ref: "#/components/schemas/InternetAccessBillingType" enabled: type: boolean - description: Indicates whether the billing is enabled - startDate: + description: Free Trial Enabled + expiryDateTime: type: string - description: The start date for the billing period format: date-time - InternetAccessOrder: - allOf: - - $ref: "#/components/schemas/Order" - - type: object - properties: - href: - type: string - description: Order URI - format: uri - example: https://api.equinix.com/colocations/v2/orders/100200300 - InternetAccessUseCase: - type: string - enum: - - MAIN - - MANAGEMENT_ACCESS - x-enum-varnames: - - MAIN - - MANAGEMENT_ACCESS - SearchSort: - type: array - items: - $ref: "#/components/schemas/SearchSortItem" - SearchSortItem: - required: - - direction - - property + description: Free Trial Expiry Date + SubscriptionRouterPackageType: type: object + description: Cloud Router Package Type properties: - direction: - type: string - example: ASC - enum: - - ASC - - DESC - property: + code: type: string - IpBlockLocation: - required: - - metroCode + description: Cloud Router package code + SubscriptionAsset: type: object + description: Asset information properties: - metroHref: - type: string - description: Metro URL path for the linked resource - example: https://api.equinix.com/fabric/v4/metros/WA - metroCode: - pattern: ^[A-Z]{2}$ + type: type: string - example: WA - TypeOfIpBlockProduct: - type: string - enum: - - IPV4_IP_BLOCK - - IPV6_IP_BLOCK - x-enum-varnames: - - IPV4_IP_BLOCK - - IPV6_IP_BLOCK - IpBlockProjectRequest: - required: - - projectId + 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 + SubscriptionEntitlementResponse: type: object + description: Subscription entitlement properties: - projectId: + uuid: type: string - description: project id - IpBlockAccount: - required: - - accountNumber + description: Subscription Entitlement Id + format: uuid + quantityEntitled: + type: integer + minimum: 0 + description: Quantity entitled for the subscription + quantityConsumed: + type: integer + minimum: 0 + description: Quantity consumed from the entitlement + quantityAvailable: + type: integer + minimum: 0 + description: Quantity available from the entitlement + asset: + $ref: '#/components/schemas/SubscriptionAsset' + SubscriptionResponse: type: object + description: Subscription Response properties: - accountNumber: + href: type: string - description: account number - IpBlockOrderRequest: - type: object - properties: - purchaseOrderNumber: + format: uri + description: Subscription URL + uuid: type: string - description: Purchase order number - nullable: true - orderNumber: + format: uuid + description: Unique identifier of the Subscription + state: + $ref: '#/components/schemas/SubscriptionState' + marketplace: type: string - description: Order Number - nullable: true - orderLine: + description: Marketplace Type + enum: + - AWS + - GCP + - AZURE + - REDHAT + offerType: type: string - description: Order Line Number - nullable: true - IpBlockRegulations: - required: - - addressingPlans - - questions - type: object - properties: - addressingPlans: + 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 addressing plans items: - $ref: "#/components/schemas/IpBlockAddressingPlan" - questions: - $ref: "#/components/schemas/IpBlockRegulations_questions" - IpBlockAddressingPlan: + type: string + description: List of available metro + entitlements: + type: array + items: + $ref: '#/components/schemas/SubscriptionEntitlementResponse' + description: List of entitlements associated with the subscription + changelog: + $ref: '#/components/schemas/Changelog' required: - - purpose - - size + - state + - marketplace + - entitlements + Stream: + description: Stream object type: object properties: - purpose: + href: + description: Stream URI type: string - description: purpose - size: - type: integer - description: size - format: int32 - IpBlockPrefixLength: - maximum: 128 - minimum: 1 - type: integer - description: IpBlockPrefix length - IpBlockPrefix: - type: string - description: CIDR prefix - IpBlockState: - type: string - description: Current state of the IP Block - enum: - - PENDING - - ACTIVE - - DELETING - - DELETED - - FAILED - IpBlockOwnership: - type: string - description: IpBlockOwnership of the IP Block - enum: - - EQUINIX - - CUSTOMER - IpBlockOrderResponse: - required: - - href - - orderNumber - type: object - properties: - href: - type: string - description: Order URI format: uri - example: https://api.equinix.com/colocations/v2/orders/1-34834234 - orderNumber: + readOnly: true + example: https://api.equinix.com/fabric/v4/streams/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + uuid: + description: Equinix-assigned access point identifier type: string - description: Order number - IpBlockProject: - required: - - projectId - type: object - properties: - href: + format: uuid + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + type: + description: type type: string - description: URI of the project - format: uri - projectId: + enum: + - TELEMETRY_STREAM + name: + description: Customer-provided stream name type: string - description: project id - IpBlockAsset: - required: - - href - - type - - uuid - type: object - properties: - type: - $ref: "#/components/schemas/IpBlockProductType" - uuid: + description: + description: Customer-provided stream description type: string - description: Unique identifier for the asset - format: uuid - href: + project: + $ref: '#/components/schemas/Project' + account: + $ref: '#/components/schemas/SimplifiedAccount' + notifications: + description: Preferences for stream notifications, set at creation + type: array + items: + $ref: '#/components/schemas/SimplifiedNotification' + state: + description: Stream provision state type: string - description: Resource URL path for the linked resource - example: https://api.equinix.com/fabric/v4/internetAccesses/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - IpBlockChange: - required: - - href + enum: + - PROVISIONING + - PROVISIONED + - REPROVISIONING + - DEPROVISIONING + - DEPROVISIONED + - FAILED + assetsCount: + description: Stream assets count + type: integer + example: 1 + streamSubscriptionsCount: + description: Stream subscriptions count + type: integer + example: 2 + alertRulesCount: + description: Stream alert rules count + type: integer + example: 3 + changeLog: + $ref: '#/components/schemas/Changelog' + GetAllStreamResponse: type: object properties: - href: - type: string - description: URI of the IpBlockChange object - format: uri - IpBlockChangeLog: - required: - - createdDateTime + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/Stream' + StreamPostRequest: type: object + description: Create Stream + required: + - type + - name + - project properties: - createdDateTime: + type: type: string - format: date-time - updatedDateTime: + enum: + - TELEMETRY_STREAM + name: + description: Customer-provided stream name type: string - format: date-time - deletedDateTime: + description: + description: Customer-provided stream description type: string - format: date-time - PatchIpBlockRequestBodyItem: - required: - - op - - path + project: + $ref: '#/components/schemas/Project' + account: + $ref: '#/components/schemas/SimplifiedAccount' + notifications: + description: Preferences for stream notifications. Optional; at most one entry, of type ALL, with up to 12 emails. Set at creation only. + type: array + maxItems: 1 + items: + $ref: '#/components/schemas/SimplifiedNotification' + StreamSearchSimpleExpression: type: object properties: - op: + property: + description: | + Possible field names to use on filters: + * `/uuid` - Stream uuid + * `/name` - Stream name + * `/state` - Stream state (`DEPROVISIONED` returned only when explicitly requested) + * `/type` - Stream type + * `/description` - Stream description + * `/project/projectId` - Stream project id + * `/changeLog/createdDateTime` - Stream created date time + * `/changeLog/updatedDateTime` - Stream updated date time type: string - description: operation - enum: - - add - - remove - path: + example: /name + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `>` - greater than + * `>=` - greater than or equal to + * `<` - less than + * `<=` - less than or equal to + * `BETWEEN` - between + * `NOT BETWEEN` - not between + * `LIKE` - like + * `ILIKE` - like case-insensitive + * `IN` - in + * `NOT IN` - not in type: string - description: path - value: - $ref: "#/components/schemas/PatchIpBlockRequestBodyItem_value" - SortDirection: - type: string + example: '=' + values: + type: array + minItems: 1 + maxItems: 100 + items: + type: string + example: stream-dev-01 + StreamSearchOrFilter: + type: object + properties: + or: + type: array + maxItems: 10 + items: + $ref: '#/components/schemas/StreamSearchSimpleExpression' + StreamSearchFilter: + type: object + anyOf: + - $ref: '#/components/schemas/StreamSearchSimpleExpression' + - $ref: '#/components/schemas/StreamSearchOrFilter' + StreamSearchFilters: + type: object + required: + - and + properties: + and: + type: array + minItems: 1 + maxItems: 10 + items: + $ref: '#/components/schemas/StreamSearchFilter' + StreamSearchSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - SortBy: - type: string + StreamSearchSortBy: description: Possible field names to use on sorting - default: /changeLog/updatedDateTime + default: /changeLog/createdDateTime + type: string 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/role - - /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 - - /operation/maintenanceStatus - - /redundancy/priority - SortCriteriaResponse: + StreamSearchSortCriteria: type: object + required: + - direction + - property properties: direction: - $ref: "#/components/schemas/SortDirection" + $ref: '#/components/schemas/StreamSearchSortDirection' property: - $ref: "#/components/schemas/SortBy" - Price: + $ref: '#/components/schemas/StreamSearchSortBy' + StreamSearchRequest: type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/StreamSearchFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/StreamSearchSortCriteria' + SearchStreamResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/Stream' + StreamPutRequest: + type: object + description: Update Stream + required: + - name 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: + description: Customer-provided stream name type: string - description: Full product name description: + description: Customer-provided stream description type: string - description: Product description - account: - $ref: "#/components/schemas/SimplifiedAccount" - charges: + StreamAssetSimpleExpression: + type: object + properties: + property: + description: | + Possible field names to use on filters: + * `/uuid` - Asset uuid (`=` and `IN` only) + * `/streamUuid` - Stream uuid (`=` and `IN` only) + * `/attachmentStatus` - Asset attachment status (`=`, `IN`, and `NOT IN`) + type: string + example: /streamUuid + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `IN` - in + * `NOT IN` - not in + type: string + example: '=' + values: type: array + minItems: 1 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 - - 60 - 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" - opticalConnect: - allOf: - - $ref: "#/components/schemas/OpticalConnectPrice" - ServiceProfileTypeEnum: - type: string - description: Service profile type - example: L2_PROFILE - enum: - - L2_PROFILE - - L3_PROFILE - - IA_PROFILE - - IX_PROFILE - - IC_PROFILE - - LMAAS_PROFILE - x-eqx-api-linter-skip-rules: - - 40 - ServiceProfileVisibilityEnum: - type: string - enum: - - PRIVATE - - PUBLIC - ServiceProfileStateEnum: + type: string + example: 4719e319-65ae-4001-aabf-ca5f107b9b29 + StreamAssetOrFilter: + type: object + properties: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/StreamAssetSimpleExpression' + StreamAssetFilter: + type: object + anyOf: + - $ref: '#/components/schemas/StreamAssetSimpleExpression' + - $ref: '#/components/schemas/StreamAssetOrFilter' + StreamAssetFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/StreamAssetFilter' + StreamAssetSortDirection: + description: Sorting direction + default: DESC type: string - description: Equinix assigned state. - example: ACTIVE enum: - - ACTIVE - - PENDING_APPROVAL - - DELETED - - REJECTED - ServiceTokenType: + - DESC + - ASC + StreamAssetSortBy: + description: Possible field names to use on sorting + default: /uuid type: string - description: Type of Service Token enum: - - VC_TOKEN - - EPL_TOKEN - ServiceTokenConnection: + - /uuid + - /streamUuid + StreamAssetSortCriteria: + type: object + required: + - direction + - property + properties: + direction: + $ref: '#/components/schemas/StreamAssetSortDirection' + property: + $ref: '#/components/schemas/StreamAssetSortBy' + StreamAssetSearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/StreamAssetFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/StreamAssetSortCriteria' + StreamSearchAsset: + description: Stream object type: object properties: - type: - type: string - description: Type of Connection - enum: - - EVPL_VC - - EPL_VC - - EVPLAN_VC - - EPLAN_VC - - IPWAN_VC - - IP_VC - - EVPTREE_VC - - EPTREE_VC href: + description: Stream Asset URI type: string - description: An absolute URL that is the subject of the link's context. format: uri readOnly: true uuid: + description: Equinix-assigned access point identifier type: string - description: Equinix-assigned connection identifier format: uuid - allowRemoteConnection: - type: boolean - description: Authorization to connect remotely - default: false - allowCustomBandwidth: + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + streamUuid: + description: Equinix-assigned access point identifier + type: string + format: uuid + example: d4b8e7a2-f3b1-4576-a4a9-1366a63df171 + type: + description: Asset type + type: string + example: XF_PORT + metricsEnabled: + description: enable metric 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: + example: true + attachmentStatus: + description: asset status type: string - description: Handy shortcut for operation name enum: - - replace - - add - - remove - path: + - ATTACHING + - ATTACHED + - DETACHED + - DETACHING + - FAILED + projectId: + description: project ic 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 + example: 123 + SearchStreamAssetResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/StreamSearchAsset' + Asset: enum: - - RESEND_EMAIL_NOTIFICATION - OpticalConnectRedundancy: + - ports + - connections + - routers + - metros + - organizations + - projects + - companyProfiles + type: string + StreamAsset: + description: Stream object type: object properties: - priority: + href: + description: Stream Asset URI type: string - description: | - Role within the diverse pair.
PRIMARY - first connection of the pair.
SECONDARY - the diverse connection on a separate path. - example: PRIMARY - enum: - - PRIMARY - - SECONDARY - group: + format: uri + readOnly: true + uuid: + description: Equinix-assigned access point identifier type: string - description: Redundancy group identifier format: uuid - description: | - Optical Connect redundancy configuration.
Required only for DUAL_DIVERSE connection. - OpticalConnectASideRequest: - type: object - properties: - demarcationPoint: - $ref: "#/components/schemas/OpticalConnectDemarcationPoint" - description: | - A-Side configuration. Always a patch panel port from your cage. - OpticalConnectZSideRequest: + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + type: + description: Asset types + type: string + enum: + - XF_PORT + - IP_VC + - EVPLAN_VC + - EVPL_VC + - XF_METRO + - XF_ROUTER + - ORGANIZATION + - PROJECT + - VIRTUAL_DEVICE + - DATA + - MGMT + - SSH + - FAB + - CTRL + metricsEnabled: + description: enable metric + type: boolean + example: false + attachmentStatus: + description: asset status + type: string + enum: + - ATTACHING + - ATTACHED + - DETACHED + - DETACHING + - FAILED + StreamAssetPutRequest: type: object + description: Update Stream Asset properties: - demarcationPoint: - $ref: "#/components/schemas/OpticalConnectDemarcationPoint" - location: - $ref: "#/components/schemas/OpticalConnectLocation" - loa: - $ref: "#/components/schemas/OpticalConnectLOA" - description: | - Z-Side configuration.
For COLO, specify the destination patch panel and ports.
For BMMR and REMOTE, specify the location and Letter of Authorization. - OpticalConnectOrder: + metricsEnabled: + description: enable metric + type: boolean + default: false + example: false + StreamDeviceInterfaceRequest: type: object - properties: - purchaseOrderNumber: - type: string - description: Purchase order number reference. - example: PO-156576 - customerReferenceId: - type: string - description: Your own reference for this connection. - orderNumber: - type: string - description: Equinix order reference number. - example: 1-129105284100 - description: Ordering and billing reference details for this connection. - OpticalConnectNotification: + description: Network Edge Device interface required: - - emails - - type + - id + properties: + id: + description: Network Edge Device interface identifier + type: integer + format: int32 + example: 5 + StreamDevicePutRequest: type: object + description: Attach Network Edge Device interfaces to a Stream properties: - type: - type: string + metricsEnabled: + description: enable metric. Must be true when interfaces are provided + type: boolean + default: false + example: true + interfaces: description: | - Notification category.
NOTIFICATION - states and configuration updates.
ORDERING - order and fulfilment correspondence.
TECHNICAL - maintenance and technical advisories. - example: NOTIFICATION - enum: - - NOTIFICATION - - ORDERING - - TECHNICAL - emails: - type: array - description: Email addresses to notify. - items: - type: string - format: email - registeredUsers: + Complete desired set of Network Edge Device interfaces attached to the stream. Interfaces not in the list are detached; an empty or absent list detaches all interfaces. type: array - description: Usernames of registered Equinix Portal users to notify. items: - type: string - description: Notification preferences for this connection. - OpticalConnectState: - type: string - description: Optical Connect lifecycle states. - readOnly: true - example: PROVISIONED - enum: - - PROVISIONING - - PROVISIONED - - PROVISIONING_FAILED - - REPROVISIONING - - REPROVISIONING_FAILED - - DEPROVISIONING - - DEPROVISIONED - OpticalConnectASideResponse: - type: object - properties: - demarcationPoint: - $ref: "#/components/schemas/OpticalConnectResponseDemarcationPoint" - location: - $ref: "#/components/schemas/OpticalConnectLocation" - description: Originating end as provisioned, with the demarcation point and IBX location. - OpticalConnectZSideResponse: - type: object - properties: - demarcationPoint: - $ref: "#/components/schemas/OpticalConnectResponseDemarcationPoint" - location: - $ref: "#/components/schemas/OpticalConnectLocation" - loa: - $ref: "#/components/schemas/OpticalConnectLOA" - description: Terminating end as provisioned, with the demarcation point and IBX location. - PortType: - type: string - description: Type of Port - enum: - - XF_PORT - PortState: + $ref: '#/components/schemas/StreamDeviceInterfaceRequest' + StreamSubscriptionSelectorExpression: type: string - description: Port lifecycle state - enum: - - PENDING - - PROVISIONING - - REPROVISIONING - - PENDING_CROSS_CONNECT - - PROVISIONED - - ACTIVE - - DEPROVISIONING - - DEPROVISIONED - - INACTIVE - - FAILED - - ADDED - - DELETED - - TO_BE_ADDED - - TO_BE_DELETED - PortOrder: - type: object - properties: - purchaseOrder: - $ref: "#/components/schemas/PortOrderPurchaseOrder" - customerReferenceId: - type: string - description: Customer order reference Id - signature: - $ref: "#/components/schemas/PortOrderSignature" - PortOperation: + description: | + Supported event or metric types to use on event and metric selectors: + * `*` - all events or metrics + * `equinix.fabric.company_profile.*` - company profile events + * `equinix.fabric.connection.*` - connection events, metrics, or alerts + * `equinix.fabric.connection_bgpipv4_session.*` - connection BGP IPv4 session events + * `equinix.fabric.connection_bgpipv6_session.*` - connection BGP IPv6 session events + * `equinix.fabric.connection_maintenance.*` - connection maintenance events + * `equinix.fabric.connection_route_aggregation.*` - connection route aggregation events + * `equinix.fabric.connection_route_filter.*` - connection route filter events + * `equinix.fabric.connection_routing_protocol.*` - connection routing protocol events + * `equinix.fabric.internet_access.*` - internet access service events + * `equinix.fabric.ip_block.*` - IP block events + * `equinix.fabric.metric` - metric collection events + * `equinix.fabric.metro.*` - metro metrics or alerts + * `equinix.fabric.network.*` - network events + * `equinix.fabric.physical_port.*` - physical port events + * `equinix.fabric.port.*` - virtual port events, metrics, or alerts + * `equinix.fabric.port_maintenance.*` - port maintenance events + * `equinix.fabric.route_aggregation.*` - route aggregation events + * `equinix.fabric.route_aggregation_rule.*` - route aggregation rule events + * `equinix.fabric.route_filter.*` - route filter events + * `equinix.fabric.route_filter_rule.*` - route filter rule events + * `equinix.fabric.router.*` - cloud router events or alerts + * `equinix.fabric.router_action.*` - cloud router action events + * `equinix.fabric.router_command.*` - cloud router command events + * `equinix.fabric.routing_protocol_action.*` - routing protocol action events + * `equinix.fabric.service_profile_connection.*` - service profile connection events + * `equinix.fabric.service_token.*` - service token events + * `equinix.fabric.time_service.*` - precision time service events + * `equinix.network.maintenance.*` - network maintenance events + * `equinix.network.repair.*` - network repair events + * `equinix.network_edge.*` - network edge events, metrics, or alerts + * `equinix.network_edge.acl.*` - network edge acl events + * `equinix.network_edge.device.*` - network edge device events + * `equinix.network_edge.device_interface.*` - network edge device interface metrics or alerts + * `equinix.network_edge.devicelinkgroup.*` - network edge device link group events + * `equinix.access_manager.*` - identity access manager events + * `equinix.access_manager.user.role.*` - identity access manager user role events + * `equinix.iam.principal.*` - IAM principal authorization and token events + * `equinix.identity.user.*` - identity user events + * `equinix.identity.organization.*` - identity organization membership events + * `equinix.resource_manager.organization.*` - resource manager organization events + * `equinix.resource_manager.project.*` - resource manager project events + example: equinix.fabric.connection.* + StreamSubscriptionSelector: 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 - maintenanceStatus: - allOf: - - $ref: "#/components/schemas/maintenanceState" - lockEnabled: - type: boolean - description: Indicates whether the port configuration is locked due to an ongoing or scheduled maintenance. - example: true - description: Operational specifications for ports. - PortChange: + include: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/StreamSubscriptionSelectorExpression' + except: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/StreamSubscriptionSelectorExpression' + StreamSubscriptionSinkCredential: type: object + description: Stream subscription sink credentials properties: - uuid: - type: string - description: Uniquely identifies a change type: type: string - description: Type of change + description: credential type enum: - - PORT_CREATION - - PORT_UPDATE - - PORT_DELETION - status: + - ACCESS_TOKEN + - INTEGRATION_KEY + - API_KEY + - USERNAME_PASSWORD + - API_TOKEN + accessToken: type: string - description: Current outcome of the change flow - enum: - - COMPLETED - - FAILED - - REQUESTED - information: + description: passed as Authorization header value + integrationKey: type: string - description: Additional information - data: - $ref: "#/components/schemas/PortChangeOperation" - createdDateTime: + description: passed as Authorization header value + apiKey: type: string - description: Set when change flow starts - format: date-time - example: 2020-11-06T07:00:00Z - updatedDateTime: + description: passed as Authorization header value + username: 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 - PortServiceCode: - type: string - description: Identifies the service type associated with this port - enum: - - CX - - IX - - IA - - MC - PortDevice: - type: object - properties: - name: + description: passed as Authorization header value + password: type: string - description: Device name - deprecated: true - redundancy: - $ref: "#/components/schemas/PortDeviceRedundancy" - vcBandwidthMax: - type: integer - description: Maximum bandwidth allowed for connection. - format: int64 - description: Port device - PortInterface: - type: object - properties: - type: + description: passed as Authorization header value + apiToken: type: string - description: Port interface type - description: Port interface - PortDemarcationPoint: + description: passed as Authorization header value + StreamSubscriptionSinkSetting: type: object + description: Stream subscription sink settings properties: - cabinetUniqueSpaceId: - type: string - description: Port cabinet unique space id - cageUniqueSpaceId: + eventIndex: type: string - description: Port cage unique space id - patchPanel: + description: event index + metricIndex: type: string - description: Port patch panel - patchPanelName: + description: metric index + source: type: string - description: Port patch panel - deprecated: true - patchPanelPortA: + description: source + applicationKey: type: string - description: Port patch panel port A - patchPanelPortB: + description: Application key + eventUri: type: string - description: Port patch panel port B - connectorType: + description: event uri + metricUri: type: string - description: Port connector type - ibx: + description: metric uri + format: type: string - description: Port ibx identifier - description: Customer physical Port - PortRedundancy: + description: webhook message format + default: CLOUDEVENT + enum: + - CLOUDEVENT + - OPENTELEMETRY + StreamSubscriptionSinkResponse: type: object + description: Create Stream destination properties: - enabled: - type: boolean - description: Access point redundancy - group: + uri: + description: any publicly reachable http endpoint 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 + description: destination type enum: - - DOT1Q - - QINQ - - UNTAGGED - tagProtocolId: + - DATADOG + - DYNATRACE + - GOOGLE_PUBSUB + - PAGERDUTY + - SERVICENOW + - SLACK + - SPLUNK_HEC + - TEAMS + - WEBHOOK + 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: + description: sink host type: string - description: Port encapsulation tag protocol identifier - description: Port encapsulation configuration - PortLag: + StreamSubscriptionOperationAdditionalInfo: type: object + description: External error information from subscription sink properties: - id: + property: + description: Additional attribute for error information type: string - description: id - enabled: - type: boolean - description: enabled - deprecated: true - name: + statusCode: + description: HTTP error status code response from sink type if error occurred type: string - description: name - memberStatus: + reason: + description: HTTP error message response from sink type if error occurred type: string - description: member status - description: Port Lag - Package: + StreamSubscriptionOperationErrors: type: object + description: Error information for stream subscription delivery properties: - code: + errorCode: + description: Equinix Observability error code type: string - description: Type of Port Package - enum: - - STANDARD - - UNLIMITED - - UNLIMITED_PLUS - 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 - packageType: + errorMessage: + description: Equinix Observability error message type: string - description: Type of Port Package - deprecated: true - enum: - - STANDARD - - UNLIMITED - - UNLIMITED_PLUS - description: Port configuration settings - PortNotification: - required: - - registeredUsers - - type + dateTime: + description: Equinix Observability error date time + format: date-time + type: string + additionalInfo: + $ref: '#/components/schemas/StreamSubscriptionOperationAdditionalInfo' + StreamSubscriptionOperation: type: object + description: Stream subscription operational information properties: - type: + eventsDeliveredCount: + type: integer + description: count of delivered events + metricsDeliveredCount: + type: integer + description: count of delivered metrics + alertsDeliveredCount: + type: integer + description: count of delivered alerts + lastSuccessfulDeliveryDateTime: type: string - description: Notification Type - enum: - - NOTIFICATION - - TECHNICAL - - PEERING - - ESCALATION - registeredUsers: + format: date-time + description: last successful date time of delivered event, metric, or alert + suspendedDateTime: + type: string + format: date-time + description: suspended date time of stream subscription delivery for event, metric, or alert + errors: type: array - description: Array of registered users + description: List of error information for stream subscription delivery items: - type: string - PortAdditionalInfo: + $ref: '#/components/schemas/StreamSubscriptionOperationErrors' + StreamSubscription: + description: Stream Subscription object type: object properties: - key: + href: + description: Stream Subscription URI type: string - description: Key - value: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + uuid: + description: Equinix-assigned access point identifier type: string - description: Value - description: Additional information - PortLoa: - type: object - properties: - uuid: - type: string - description: uuid + format: uuid + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: + description: type type: string - description: Loa type - example: DIGITAL_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: + enum: + - STREAM_SUBSCRIPTION + name: + description: Customer-provided subscription name type: string - description: z-side/Equinix IBX - description: Port physical connection - PhysicalPortSettings: - type: object - properties: - errorMessage: + description: + description: Customer-provided subscription description type: string - packageType: + state: + description: Steam subscription provision state type: string - deprecated: true - description: Physical Port configuration settings - SimplifiedAccountRequest: - required: - - accountNumber + enum: + - PROVISIONING + - PROVISIONED + - REPROVISIONING + - DEPROVISIONING + - DEPROVISIONED + - FAILED + enabled: + description: Stream subscription enabled status + type: boolean + metricSelector: + $ref: '#/components/schemas/StreamSubscriptionSelector' + eventSelector: + $ref: '#/components/schemas/StreamSubscriptionSelector' + sink: + $ref: '#/components/schemas/StreamSubscriptionSinkResponse' + operation: + $ref: '#/components/schemas/StreamSubscriptionOperation' + changeLog: + $ref: '#/components/schemas/Changelog' + GetAllStreamSubscriptionResponse: type: object properties: - accountNumber: - type: integer - description: Account number - format: int64 - SimplifiedLocationRequest: - required: - - metroCode + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/StreamSubscription' + StreamSubscriptionSink: type: object - properties: - metroCode: - type: string - example: AM - PortChangeOperation: + description: Create Stream destination 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 + - type properties: - href: - type: string - description: LinkProtocol URI - format: uri - readOnly: true - uuid: + uri: + description: any publicly reachable http endpoint 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: string + description: destination type + enum: + - DATADOG + - DYNATRACE + - GOOGLE_PUBSUB + - PAGERDUTY + - SERVICENOW + - SLACK + - SPLUNK_HEC + - TEAMS + - WEBHOOK + batchEnabled: + type: boolean + description: batch mode on/off + example: false + batchSizeMax: type: integer - example: 20 - vlanCTagMax: + description: maximum batch size + batchWaitTimeMax: 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 - - /name - - /state - - /location/metroName - - /demarcationPointIbx - - /device/redundancy/priority - - /lagEnabled - - /physicalPortsSpeed - - /encapsulation/type - - /physicalPorts/tether/crossConnectId - - /package/code - - /changeLog/updatedDateTime - - /changeLog/createdDateTime - - /bandwidth - - /serviceCode - - /operation/maintenanceStatus - PortPackage: + description: maximum batch waiting time + credential: + $ref: '#/components/schemas/StreamSubscriptionSinkCredential' + settings: + $ref: '#/components/schemas/StreamSubscriptionSinkSetting' + host: + description: sink host + type: string + StreamSubscriptionPostRequest: + type: object + description: Create Stream Subscription required: - - code - type - type: object + - name + - sink properties: - href: - type: string - description: Port Package URI - readOnly: true type: type: string - description: Port Package Type enum: - - PORT_PACKAGE - code: + - STREAM_SUBSCRIPTION + name: + description: Customer-provided stream subscription name type: string - description: Port Package code - vcBandwidthMax: - type: integer - description: Maximum virtual connection bandwidth in Mbps - vcRemoteSupported: + description: + description: Customer-provided stream subscription description + type: string + enabled: + description: Stream subscription enabled status type: boolean - description: Indicates if remote virtual connections are supported - supportedServiceTypes: + default: true + example: true + metricSelector: + $ref: '#/components/schemas/StreamSubscriptionSelector' + eventSelector: + $ref: '#/components/schemas/StreamSubscriptionSelector' + sink: + $ref: '#/components/schemas/StreamSubscriptionSink' + StreamFilterSimpleExpression: + type: object + properties: + property: + description: | + Possible field names to use on filters: + * `/subject` - subject + * `/type` - type + type: string + example: /type + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `in` - in + * `LIKE` - case-sensitive like + * `ILIKE` - case-insensitive like + type: string + example: '=' + values: + description: | + ### Supported event or metric names to use on filters with property /type: + * `*` - all events or metrics + * `equinix.fabric.company_profile.*` - company profile events + * `equinix.fabric.connection.*` - connection events, metrics, or alerts + * `equinix.fabric.connection_bgpipv4_session.*` - connection BGP IPv4 session events + * `equinix.fabric.connection_bgpipv6_session.*` - connection BGP IPv6 session events + * `equinix.fabric.connection_maintenance.*` - connection maintenance events + * `equinix.fabric.connection_route_aggregation.*` - connection route aggregation events + * `equinix.fabric.connection_route_filter.*` - connection route filter events + * `equinix.fabric.connection_routing_protocol.*` - connection routing protocol events + * `equinix.fabric.internet_access.*` - internet access service events + * `equinix.fabric.ip_block.*` - IP block events + * `equinix.fabric.metric` - metric collection events + * `equinix.fabric.metro.*` - metro metrics or alerts + * `equinix.fabric.network.*` - network events + * `equinix.fabric.physical_port.*` - physical port events + * `equinix.fabric.port.*` - virtual port events, metrics, or alerts + * `equinix.fabric.port_maintenance.*` - port maintenance events + * `equinix.fabric.route_aggregation.*` - route aggregation events + * `equinix.fabric.route_aggregation_rule.*` - route aggregation rule events + * `equinix.fabric.route_filter.*` - route filter events + * `equinix.fabric.route_filter_rule.*` - route filter rule events + * `equinix.fabric.router.*` - cloud router events or alerts + * `equinix.fabric.router_action.*` - cloud router action events + * `equinix.fabric.router_command.*` - cloud router command events + * `equinix.fabric.routing_protocol_action.*` - routing protocol action events + * `equinix.fabric.service_profile_connection.*` - service profile connection events + * `equinix.fabric.service_token.*` - service token events + * `equinix.fabric.time_service.*` - precision time service events + * `equinix.network.maintenance.*` - network maintenance events + * `equinix.network.repair.*` - network repair events + * `equinix.network_edge.*` - network edge events, metrics, or alerts + * `equinix.network_edge.acl.*` - network edge acl events + * `equinix.network_edge.device.*` - network edge device events + * `equinix.network_edge.device_interface.*` - network edge device interface metrics or alerts + * `equinix.network_edge.devicelinkgroup.*` - network edge device link group events + * `equinix.access_manager.*` - identity access manager events + * `equinix.access_manager.user.role.*` - identity access manager user role events + * `equinix.iam.principal.*` - IAM principal authorization and token events + * `equinix.identity.user.*` - identity user events + * `equinix.identity.organization.*` - identity organization membership events + * `equinix.resource_manager.organization.*` - resource manager organization events + * `equinix.resource_manager.project.*` - resource manager project 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/ports//maintenances/` - port maintenance events + * `/fabric/v4/connections/` - connection events or metrics + * `/fabric/v4/connections//maintenances/` - connection maintenance events + * `/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 type: array - description: List of supported service types items: type: string - description: Port Package Service Type - enum: - - MSP - supportedSourceTypes: + StreamFilterOrFilter: + type: object + properties: + or: type: array - description: List of supported source types + maxItems: 3 items: - $ref: "#/components/schemas/PortPackageSourceType" - supportedMetros: + $ref: '#/components/schemas/StreamFilterSimpleExpression' + StreamFilter: + type: object + anyOf: + - $ref: '#/components/schemas/StreamFilterSimpleExpression' + - $ref: '#/components/schemas/StreamFilterOrFilter' + StreamSubscriptionFilter: + type: object + properties: + and: type: array - description: List of supported metros + maxItems: 8 items: - type: string - description: Port Package details - RouteFilterState: - type: string - description: Route Filter status - enum: - - PROVISIONING - - REPROVISIONING - - DEPROVISIONING - - PROVISIONED - - DEPROVISIONED - - NOT_PROVISIONED - - NOT_DEPROVISIONED - RouteFiltersChange: + $ref: '#/components/schemas/StreamFilter' + StreamSubscriptionPutRequest: + type: object + description: Update Stream Subscription required: - type - - uuid - type: object + - name + - sink 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: + - STREAM_SUBSCRIPTION + name: + description: Customer-provided stream subscription name type: string - description: Handy shortcut for operation name - example: replace - path: + description: + description: Customer-provided stream subscription description 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 + enabled: + description: Stream subscription enabled status + type: boolean + example: true + filters: + $ref: '#/components/schemas/StreamSubscriptionFilter' + metricSelector: + $ref: '#/components/schemas/StreamSubscriptionSelector' + eventSelector: + $ref: '#/components/schemas/StreamSubscriptionSelector' + sink: + $ref: '#/components/schemas/StreamSubscriptionSink' + StreamSubscriptionSearchSimpleExpression: type: object properties: - op: + property: + description: | + Possible field names to use on filters: + * `/uuid` - Subscription uuid + * `/streamUuid` - Stream uuid the subscription belongs to + * `/state` - Subscription state (`DEPROVISIONED` returned only when explicitly requested) + * `/name` - Subscription name + * `/project/projectId` - Subscription project id + * `/description` - Subscription description + * `/changeLog/createdDateTime` - Subscription created date time + * `/changeLog/updatedDateTime` - Subscription updated date time type: string - description: Handy shortcut for operation name - enum: - - add - - replace - - remove - path: + example: /streamUuid + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `>` - greater than + * `>=` - greater than or equal to + * `<` - less than + * `<=` - less than or equal to + * `BETWEEN` - between + * `NOT BETWEEN` - not between + * `LIKE` - like + * `ILIKE` - like case-insensitive + * `IN` - in + * `NOT IN` - not in type: string - description: path inside document leading to updated parameter - example: / - value: - $ref: "#/components/schemas/RouteFiltersBase" - description: Route filter change operation data - RouteFilterConnectionsData: + example: '=' + values: + type: array + minItems: 1 + items: + type: string + example: 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 + StreamSubscriptionSearchOrFilter: 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 - RouteFilterSortCriteria: + or: + type: array + items: + $ref: '#/components/schemas/StreamSubscriptionSearchSimpleExpression' + StreamSubscriptionSearchFilter: + type: object + anyOf: + - $ref: '#/components/schemas/StreamSubscriptionSearchSimpleExpression' + - $ref: '#/components/schemas/StreamSubscriptionSearchOrFilter' + StreamSubscriptionSearchFilters: type: object + required: + - and properties: - direction: - $ref: "#/components/schemas/RouteFilterSortDirection" - property: - $ref: "#/components/schemas/RouteFilterSortBy" - RouteFilterSortDirection: - type: string + and: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/StreamSubscriptionSearchFilter' + StreamSubscriptionSearchSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - RouteFilterSortBy: - type: string + StreamSubscriptionSearchSortBy: description: Possible field names to use on sorting - default: /changeLog/updatedDateTime + default: /changeLog/createdDateTime + type: string enum: - - /type - - /uuid - - /name - - /project/projectId - - /state - /changeLog/createdDateTime - /changeLog/updatedDateTime - - /changeLog/deletedDateTime - RouteFilterRuleState: - type: string - description: Route filter rule status - enum: - - PROVISIONING - - REPROVISIONING - - DEPROVISIONING - - PROVISIONED - - DEPROVISIONED - - NOT_PROVISIONED - - NOT_DEPROVISIONED - RouteFilterRulesChange: + StreamSubscriptionSearchSortCriteria: + type: object required: - - type - - uuid + - direction + - property + properties: + direction: + $ref: '#/components/schemas/StreamSubscriptionSearchSortDirection' + property: + $ref: '#/components/schemas/StreamSubscriptionSearchSortBy' + StreamSubscriptionSearchRequest: + type: object + description: Search requests containing criteria + required: + - filter + properties: + filter: + $ref: '#/components/schemas/StreamSubscriptionSearchFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/StreamSubscriptionSearchSortCriteria' + SearchStreamSubscriptionResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/StreamSubscription' + MetricSelectorResponse: + type: object + properties: + include: + description: Stream alert rule filtered by metric name + type: array + items: + type: string + example: equinix.fabric.metro.sv_da.latency + ResourceSelectorResponse: + type: object + properties: + include: + description: | + ### Supported metric names to use on filters with property /subject: + * `/fabric/v4/ports/` - port metrics + * `/fabric/v4/connections/` - connection metrics + * `/fabric/v4/metros/` - metro latency metrics + type: array + items: + type: string + DetectionMethodResponse: type: object properties: - uuid: - type: string - description: Uniquely identifies a change type: + description: | + * THRESHOLD - Alert when a metric crosses a defined threshold by user. + * OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric. 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 + - THRESHOLD + - OUTLIER + windowSize: + description: Stream alert rule metric window size + type: string + example: PT15M + operand: + description: Stream alert rule metric operand + type: string + enum: + - ABOVE + - BELOW + warningThreshold: + description: Stream alert rule metric warning threshold + type: string + criticalThreshold: + description: Stream alert rule metric critical threshold + type: string + StreamAlertRule: + description: Stream object + type: object + properties: href: + description: Stream Alert Rule URI type: string - description: Route Filter Change URI format: uri - description: Current state of latest route filter rule change - RouteFilterRulesPatchRequestItem: + readOnly: true + uuid: + description: Equinix-assigned access point identifier + type: string + format: uuid + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + type: + description: Stream subscription type + type: string + enum: + - METRIC_ALERT + name: + description: Customer-provided stream alert rule name + type: string + description: + description: Customer-provided stream alert rule description + type: string + state: + description: Steam subscription provision state + type: string + enum: + - ACTIVE + - INACTIVE + enabled: + description: Stream alert rule enabled status + type: boolean + default: true + metricSelector: + $ref: '#/components/schemas/MetricSelectorResponse' + resourceSelector: + $ref: '#/components/schemas/ResourceSelectorResponse' + detectionMethod: + $ref: '#/components/schemas/DetectionMethodResponse' + changeLog: + $ref: '#/components/schemas/Changelog' + GetAllStreamAlertRuleResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/StreamAlertRule' + MetricSelector: + type: object required: - - op - - path - - value + - include + properties: + include: + description: Stream alert rule filtered by metric name + type: array + items: + type: string + example: equinix.fabric.metro.sv_da.latency + ResourceSelector: type: object + required: + - include properties: - op: + include: + description: | + ### Supported metric names to use on filters with property /subject: + * `/fabric/v4/ports/` - port metrics + * `/fabric/v4/connections/` - connection metrics + * `/fabric/v4/metros/` - metro latency metrics + type: array + items: + type: string + DetectionMethod: + type: object + required: + - type + properties: + type: + description: | + * THRESHOLD - Alert when a metric crosses a defined threshold by user. + * OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric. type: string - description: Handy shortcut for operation name - example: replace - path: + enum: + - THRESHOLD + - OUTLIER + windowSize: + description: Stream alert rule metric window size 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 + example: PT15M + operand: + description: Stream alert rule metric operand + type: string + enum: + - ABOVE + - BELOW + warningThreshold: + description: Stream alert rule metric warning threshold + type: string + criticalThreshold: + description: Stream alert rule metric critical threshold + type: string + AlertRulePostRequest: type: object + description: Create Stream Alert Rules + required: + - type + - name + - metricSelector + - resourceSelector + - detectionMethod properties: - op: + type: type: string - description: Handy shortcut for operation name enum: - - add - - replace - - remove - path: + - METRIC_ALERT + name: + description: Customer-provided stream name 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: + description: + description: Customer-provided stream description + type: string + enabled: + description: Stream alert rule enabled status + type: boolean + default: true + example: true + metricSelector: + $ref: '#/components/schemas/MetricSelector' + resourceSelector: + $ref: '#/components/schemas/ResourceSelector' + detectionMethod: + $ref: '#/components/schemas/DetectionMethod' + AlertRulePutRequest: + type: object + description: Create Stream Alert Rules required: - type - - uuid - type: object + - name + - metricSelector + - resourceSelector + - detectionMethod properties: - uuid: + name: + description: Customer-provided stream name 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: + - METRIC_ALERT + description: + description: Customer-provided stream description type: string - description: Route AGGREGATION Change URI - format: uri - description: Current state of latest Route Aggregation change - RouteAggregationsPatchRequestItem: - required: - - op - - path - - value + enabled: + description: Stream alert rule enabled status + type: boolean + default: true + metricSelector: + $ref: '#/components/schemas/MetricSelector' + resourceSelector: + $ref: '#/components/schemas/ResourceSelector' + detectionMethod: + $ref: '#/components/schemas/DetectionMethod' + CompanyProfileContact: type: object properties: - op: + type: + description: Contact Type + example: SUPPORT type: string - description: Handy shortcut for operation name - example: replace - path: + enum: + - SUPPORT + contacts: + type: array + items: + properties: + name: + type: string + role: + type: string + email: + type: string + required: + - email + CompanyProfileRequest: + type: object + properties: + type: type: string - description: path to change - example: /name - value: - type: object - description: new value for updated parameter - description: Route Aggregation change operation data - RouteAggregationsChangeOperation: + example: COMPANY_PROFILE + name: + type: string + minLength: 1 + maxLength: 50 + example: Equinix + summary: + type: string + minLength: 1 + maxLength: 125 + example: Global interconnection and data center company + description: + type: string + minLength: 1 + maxLength: 450 + example: Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers. + pointOfContacts: + type: array + items: + $ref: '#/components/schemas/CompanyProfileContact' + example: + - type: SUPPORT + contacts: + - name: Peter Griffin + role: Vice President of Sales + email: example1@example.com + - name: Taylor Swift + role: Director of Marketing + email: example2@example.com + - name: Darth Vader + role: Head of Engineering + email: example3@example.com + notifications: + type: array + items: + $ref: '#/components/schemas/SimplifiedNotification' + example: + - type: NOTIFICATION + emails: + - example1@example.com + - example2@example.com + overview: + type: string + example: About Initech Corp

lorem ipsum

+ webUrl: + type: string + example: https://www.equinix.com + contactUrl: + type: string + example: https://www.equinix.com/contact-us required: - - op - - path - - value + - type + - name + - summary + - description + - webUrl + CompanyProfileState: + type: string + description: Company Profile State + CompanyMetro: type: object properties: - op: + href: type: string - description: Handy shortcut for operation name - enum: - - add - - replace - - remove - path: + metroCode: type: string - description: path inside document leading to updated parameter - example: / - value: - $ref: "#/components/schemas/RouteAggregationsBase" - description: Route Aggregation change operation data - RouteAggregationConnectionsData: + CompanyLogo: + type: object + properties: + href: + type: string + uuid: + type: string + extensionType: + type: string + TagResponse: + description: Equinix Fabric Tag Response Object 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" + example: https://api.equinix.com/fabric/v4/tags/18a127ad-9d0c-46e2-a66d-8ed85d1858b0 uuid: type: string - description: Route Aggregation identifier format: uuid - example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d + example: 18a127ad-9d0c-46e2-a66d-8ed85d1858b0 + type: + type: string + example: PREDEFINED_TAG name: type: string - example: connection-1 - RouteAggregationSortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/RouteAggregationSortDirection" - property: - $ref: "#/components/schemas/RouteAggregationSortBy" - RouteAggregationSortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - RouteAggregationSortBy: - type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime - enum: - - /type - - /uuid - - /name - - /project/projectId - - /state - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - - /changeLog/deletedDateTime - RouteAggregationRuleState: - type: string - description: Route Aggregation Rule status - enum: - - PROVISIONING - - REPROVISIONING - - DEPROVISIONING - - PROVISIONED - - DEPROVISIONED - - NOT_PROVISIONED - - NOT_DEPROVISIONED - RouteAggregationRulesChange: - required: - - type - - uuid + example: equinix.fabric.spotlight.ai.llm + displayName: + type: string + example: LLM + state: + type: string + enum: + - APPROVED + - PENDING_APPROVAL + - REJECTED + description: Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT + example: PENDING_APPROVAL + notifications: + example: + - type: NOTIFICATION + emails: + - example1@example.com + - example2@example.com + type: array + items: + $ref: '#/components/schemas/SimplifiedNotification' + changeLog: + $ref: '#/components/schemas/Changelog' + weight: + type: integer + example: 30000 + CompanyServiceProfile: type: object properties: + href: + type: string 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 + $ref: '#/components/schemas/ServiceProfileTypeEnum' + PrivateService: + type: object + properties: href: type: string - description: Route Aggregation Change URI - format: uri - description: Current state of latest Route Aggregation Rule change - RouteAggregationRulesPatchRequestItem: - required: - - op - - path - - value + uuid: + type: string + CompanyProfileChangeItem: type: object properties: op: - type: string description: Handy shortcut for operation name + type: string example: replace path: + description: path inside document leading to updated parameter type: string - description: path to change - example: /prefix + example: /name value: - type: object description: new value for updated parameter - description: Route Aggregation Rule change operation data - RouteAggregationRulesChangeOperation: required: - op - path - value + CompanyProfileChange: type: object properties: - op: + uuid: type: string - description: Handy shortcut for operation name - enum: - - add - - replace - - remove - path: + type: 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: + status: type: string - example: AMER, APAC, EMEA - metroName: + createdDateTime: type: string - example: Amsterdam - metroCode: + format: date-time + updatedDateTime: type: string - example: AM - CloudRouterPostRequestPackage: - required: - - code + format: date-time + data: + type: array + default: [] + items: + $ref: '#/components/schemas/CompanyProfileChangeItem' + CompanyProfileResponse: type: object properties: href: type: string - description: Fabric Cloud Router URI - format: uri - example: https://api.equinix.com/fabric/v4/routerPackages/LAB + example: https://api.equinix.com/fabric/v4/companyProfiles/123e4567-e89b-12d3-a456-426614174000 + uuid: + type: string + example: 123e4567-e89b-12d3-a456-426614174000 type: type: string - description: Cloud Router package type - example: ROUTER_PACKAGE - enum: - - ROUTER_PACKAGE - code: + example: COMPANY_PROFILE + name: type: string - description: Cloud Router package code - example: LAB - enum: - - LAB - - BASIC - - STANDARD - - ADVANCED - - PREMIUM - description: Fabric Cloud Router Package Type - CloudRouterAccessPointState: + example: Equinix + minLength: 1 + maxLength: 50 + summary: + example: Global interconnection and data center company + type: string + minLength: 1 + maxLength: 125 + description: + example: Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers. + type: string + minLength: 1 + maxLength: 450 + state: + $ref: '#/components/schemas/CompanyProfileState' + metros: + type: array + items: + $ref: '#/components/schemas/CompanyMetro' + example: + - href: https://api.equinix.com/fabric/v4/metros/SV + metroCode: SV + logo: + $ref: '#/components/schemas/CompanyLogo' + tags: + type: array + items: + $ref: '#/components/schemas/TagResponse' + example: + - href: https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387 + uuid: 260af68b-42f0-4f2e-9c5c-2fbd44b4b387 + type: RESOURCE_TAG + name: environment + displayName: Environment + weight: 30000 + serviceProfiles: + type: array + items: + $ref: '#/components/schemas/CompanyServiceProfile' + example: + - href: https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387 + uuid: 423af68b-42f0-4f2e-9c5c-2fbd44b4b387 + type: L2_PROFILE + privateServices: + type: array + items: + $ref: '#/components/schemas/PrivateService' + example: + - href: https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387 + uuid: 460af68b-42f0-4f2e-9c5c-2fbd44b4b387 + - href: https://api.equinix.com/fabric/v4/privateServices/8a5685a6-063d-41ac-9279-d32431e8d8f6 + uuid: 8a5685a6-063d-41ac-9279-d32431e8d8f6 + pointOfContacts: + type: array + items: + $ref: '#/components/schemas/CompanyProfileContact' + example: + - type: SUPPORT + contacts: + - name: Peter Griffin + role: Vice President of Sales + email: example1@example.com + - name: Taylor Swift + role: Director of Marketing + email: example2@example.com + - name: Darth Vader + role: Head of Engineering + email: example3@example.com + notifications: + type: array + items: + $ref: '#/components/schemas/SimplifiedNotification' + example: + - type: NOTIFICATION + emails: + - example1@example.com + - example2@example.com + overview: + type: string + example: About Initech Corp

lorem ipsum

+ webUrl: + type: string + example: https://www.equinix.com + contactUrl: + type: string + example: https://www.equinix.com/contact-us + change: + $ref: '#/components/schemas/CompanyProfileChange' + changeLog: + $ref: '#/components/schemas/Changelog' + CompanyProfileSearchFieldName: type: string - description: Access point lifecycle state + description: Searchable field names in company profile enum: - - PROVISIONED - - PROVISIONING - - DEPROVISIONING - - DEPROVISIONED - - REPROVISIONING - - NOT_PROVISIONED - - NOT_DEPROVISIONED - CloudRouterChange: + - /name + - /uuid + - /tags/name + - /tags/uuid + - /tags/displayName + - /state + - /metros/metroCode + - /change/status + example: /tags/name + OperatorEnum: + type: string + description: Comparison operators for filtering + enum: + - '=' + - '!=' + - LIKE + - NOT LIKE + - ILIKE + - NOT ILIKE + - IN + - NOT IN + example: '=' + CompanyProfileSearchSimpleExpression: + type: object required: - - type - - updatedDateTime + - property + - operator + - values + properties: + property: + allOf: + - $ref: '#/components/schemas/CompanyProfileSearchFieldName' + description: | + Searchable field name. Properties are grouped by their supported operators: + String properties (support all operators): + * `/name` - Company profile name + * `/uuid` - Company profile UUID + * `/tags/name` - Tag name + * `/tags/uuid` - Tag UUID + * `/tags/displayName` - Tag display name + + Discrete value properties (only support `=`, `!=`, `IN`, `NOT IN`): + * `/state` - Company profile state (`PENDING`, `PROVISIONED`, `DEPROVISIONED`, `REJECTED`) + * `/metros/metroCode` - Metro code (e.g. `SV`, `NY`, `DC`) + * `/change/status` - Change status (`PENDING`, `COMPLETED`, `REJECTED`) — seller and admin users only + example: /state + operator: + allOf: + - $ref: '#/components/schemas/OperatorEnum' + description: | + Comparison operator. `LIKE`, `NOT LIKE`, `ILIKE`, and `NOT ILIKE` require exactly one value. All other operators accept one or more values. + * `=` - equal; equivalent to `IN` when multiple values are provided + * `!=` - not equal; equivalent to `NOT IN` when multiple values are provided + * `LIKE` - case-sensitive partial match (single value) + * `NOT LIKE` - case-sensitive partial non-match (single value) + * `ILIKE` - case-insensitive partial match (single value) + * `NOT ILIKE` - case-insensitive partial non-match (single value) + * `IN` - matches any of the provided values + * `NOT IN` - does not match any of the provided values + example: IN + values: + type: array + minItems: 1 + example: + - PROVISIONED + - PENDING + items: + type: string + CompanyProfileSearchOrFilter: + type: object + description: | + Groups multiple simple expressions with OR logic. At most one `or` group is allowed within the top-level `and` array. + required: + - or + properties: + or: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/CompanyProfileSearchSimpleExpression' + CompanyProfileSearchFilter: + type: object + oneOf: + - $ref: '#/components/schemas/CompanyProfileSearchSimpleExpression' + - $ref: '#/components/schemas/CompanyProfileSearchOrFilter' + CompanyProfileSearchFilters: type: object + description: | + Filter criteria for company profile search. The `and` array combines conditions where all must match. Each item in `and` is either a simple expression (property/operator/values) or an `or` group. At most one `or` group is allowed per request. properties: - uuid: + and: + type: array + items: + $ref: '#/components/schemas/CompanyProfileSearchFilter' + CompanyProfileSortDirection: + description: Sorting direction + default: ASC + type: string + enum: + - DESC + - ASC + Sort: + type: object + properties: + property: type: string - description: Uniquely identifies a change + description: | + Property to sort by. Supported values: + * `/name` - Company profile name + * `/state` - Company profile state + * `/changeLog/updatedDateTime` - Date and time the profile was last updated + * `/changeLog/createdDateTime` - Date and time the profile was created + example: /changeLog/updatedDateTime + direction: + $ref: '#/components/schemas/CompanyProfileSortDirection' + CompanyProfileSearchRequest: + type: object + properties: + filter: + $ref: '#/components/schemas/CompanyProfileSearchFilters' + pagination: + $ref: '#/components/schemas/Pagination' + sort: + $ref: '#/components/schemas/Sort' + example: + filter: + and: + - property: /state + operator: '=' + values: + - PROVISIONED + - or: + - property: /name + operator: ILIKE + values: + - equinix + - property: /tags/name + operator: '=' + values: + - environment + pagination: + offset: 0 + limit: 20 + total: 0 + sort: + property: /changeLog/updatedDateTime + direction: DESC + CompanyProfileSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + type: array + items: + $ref: '#/components/schemas/CompanyProfileResponse' + required: + - pagination + - data + ServiceProfileListResponse: + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/CompanyServiceProfile' + description: List of service profiles + example: + - href: https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387 + uuid: 423af68b-42f0-4f2e-9c5c-2fbd44b4b387 + AttachServiceProfileResponse: + type: object + properties: + href: + type: string + description: URL to the attached service profile + example: https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387 type: type: string - description: Type of change - enum: - - ROUTER_UPDATE - status: + description: Type of the service or attachment + example: SERVICE_PROFILE + uuid: type: string - description: Current outcome of the change flow - enum: - - COMPLETED - - FAILED - - REQUESTED - createdDateTime: + description: Unique identifier for the service profile + example: 423af68b-42f0-4f2e-9c5c-2fbd44b4b387 + attachmentStatus: type: string - description: Set when change flow starts - format: date-time - example: 2020-11-06T07:00:00Z - updatedDateTime: + description: Status of the attachment operation + example: ATTACHED + required: + - type + - uuid + TagListResponse: + description: Equinix Fabric Tag List Response Object + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/TagResponse' + pagination: + $ref: '#/components/schemas/Pagination' + AttachTagResponse: + type: object + properties: + href: type: string - description: Set when change object is updated - format: date-time - example: 2020-11-06T07:00:00Z - information: + description: URL to the attached tag + example: https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387 + type: type: string - description: Additional information + description: Type of the tag or attachment + example: TAG + uuid: + type: string + description: Unique identifier for the tag + example: 260af68b-42f0-4f2e-9c5c-2fbd44b4b387 + attachmentStatus: + type: string + description: Status of the attachment operation + example: ATTACHED + required: + - type + - uuid + PrivateServiceListResponse: + type: object + properties: data: type: array items: - $ref: "#/components/schemas/CloudRouterChangeOperation" - description: Current state of latest CloudRouter change - CloudRouterChangeOperation: - required: - - op - - path - - value + $ref: '#/components/schemas/PrivateService' + description: List of private services + example: + - href: https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387 + uuid: 460af68b-42f0-4f2e-9c5c-2fbd44b4b387 + AttachPrivateServiceResponse: type: object properties: - op: + href: type: string - description: Handy shortcut for operation name - enum: - - replace - - add - - remove - path: + description: URL to the attached private service + example: https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387 + type: 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: + description: Type of the private service or attachment + example: PRIVATE_SERVICE + uuid: + type: string + description: Unique identifier for the private service + example: 460af68b-42f0-4f2e-9c5c-2fbd44b4b387 + attachmentStatus: + type: string + description: Status of the attachment operation + example: ATTACHED + required: + - type + - uuid + LogoRequest: + description: Equinix Fabric Logo Request Object type: object + required: + - logo + - name + - type + - description properties: - uuid: + logo: type: string - description: Connection UUID - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - href: + format: binary + description: Logo image file + name: type: string - example: https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4 + minLength: 1 + maxLength: 24 + description: Name of the Logo + example: Equinix Logo + description: + type: string + minLength: 1 + maxLength: 125 + description: Description of the logo + example: Company branding logo type: - $ref: "#/components/schemas/ConnectionType" - operation: - $ref: "#/components/schemas/Operation" - description: Connection object for router actions - RouterActionsRouter: + type: string + description: Type of logo + example: COMPANY_LOGO + LogoResponse: + description: Equinix Fabric Logo Response Object type: object properties: - uuid: - type: string - description: Router UUID - example: a1c6b7fd-aead-410a-96b4-b1dfa1071700 href: type: string - example: https://api.equinix.com/fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700 + format: uri + example: https://api.equinix.com/fabric/v4/logos/18a127ad-9d0c-46e2-a66d-8ed85d1858b0 + uuid: + type: string + format: uuid + example: 18a127ad-9d0c-46e2-a66d-8ed85d1858b0 type: type: string - enum: - - XF_ROUTER - operation: - $ref: "#/components/schemas/Operation" - description: Router object for router actions - CloudRouterCommandType: + description: Type of logo + example: COMPANY_LOGO + name: + type: string + example: Equinix Logo + description: + type: string + example: Company branding logo + status: + type: string + example: CREATED + extensionType: + type: string + example: .png + changelog: + $ref: '#/components/schemas/Changelog' + LoaType: type: string - description: Fabric Cloud Router Command Type - example: PING_COMMAND + description: | + Type of Letter of Authorization enum: - - PING_COMMAND - - TRACEROUTE_COMMAND - CloudRouterCommandRequestPayload: - required: - - destination - - sourceConnection + - CAGE_LOA + - PATCH_PANEL_LOA + - PATCH_PANEL_PORT_LOA + example: PATCH_PANEL_PORT_LOA + LoaProductType: + type: string + description: | + Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge + enum: + - XC + - XF_PORT + - VD + example: XC + LoaRequest: + description: Create Loa type: object properties: - destination: + type: + $ref: '#/components/schemas/LoaType' + name: type: string - description: Fabric Cloud Router Ping or Traceroute Command Destination - example: 8.8.8.8 - sourceConnection: - $ref: "#/components/schemas/CloudRouterCommandRequestConnection" - timeout: - type: integer - description: | - Timeout in seconds for Fabric Cloud Router Command: - - For `PING_COMMAND`: Packet timeout duration. The default value is 5. - - For `TRACEROUTE_COMMAND`: Probe timeout duration. - The default value is 2 and it is not configurable. - example: 2 - dataBytes: - maximum: 9000 - minimum: 16 - type: integer - description: | - Ping Command DataBytes. - This field is only applicable for commands of type `PING_COMMAND`. - example: 100 - default: 64 - probes: - type: integer - description: | - Number of probes for Fabric Cloud Router Traceroute Command. - This field is only applicable for commands of type `TRACEROUTE_COMMAND` and is not configurable. - example: 3 - default: 3 - hopsMax: - maximum: 30 + description: A short, descriptive name for this LOA. + minLength: 3 + maxLength: 50 + example: LOA-Equinix-SV1-2026 + description: + type: string + description: Additional context about this LOA. + minLength: 0 + maxLength: 450 + example: Authorization for patch panel port access to Equinix at SV1 + authorizedProductType: + $ref: '#/components/schemas/LoaProductType' + required: + - type + - name + - authorizedProductType + LoaExpiration: + description: | + Date and time when this LOA expires.
Default to 3 months from the creation date + type: string + format: date-time + example: '2026-11-06T07:00:00Z' + LoaRequestor: + description: Requestor + type: object + properties: + email: + type: string + format: email + description: Email address of the requestor contact. + example: user@org1.com + orgId: type: integer - description: | - Maximum number of hops for the traceroute command. - This field is only applicable for commands of type `TRACEROUTE_COMMAND`. - example: 20 - default: 20 - description: Fabric Cloud Router Command Request - CloudRouterCommandState: + description: Organization ID of the requestor. + example: 9257 + orgName: + type: string + description: Organization name of the requestor. + example: ABC Inc. + LoaPatchPanelConnectorType: type: string - description: Fabric Cloud Router Command State - example: SUCCEEDED + description: Connector Type enum: - - PENDING - - SUCCEEDED - - FAILED - - DELETED - CloudRouterCommandRequestResponse: + - FC + - SC + - LC + - ST + example: SC + LoaDemarcationPoint: + description: | + Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB + and connectorType is required. type: object properties: - destination: + cageUniqueSpaceId: + type: string + description: Unique identifier of the Cage. + example: SV1:00:000000 + cabinetUniqueSpaceId: + type: string + description: Unique identifier of the Cabinet. + example: SV1:00:000000:0105 + patchPanelId: type: string - description: Fabric Cloud Router Ping or Traceroute Command Destination - example: 8.8.8.8 - sourceConnection: - $ref: "#/components/schemas/CloudRouterCommandRequestConnection" - timeout: - type: integer - description: | - Timeout in seconds for Fabric Cloud Router Command: - - For `PING_COMMAND`: Packet timeout duration. The default value is 5. - - For `TRACEROUTE_COMMAND`: Probe timeout duration. - The default value is 2 and it is not configurable. - example: 2 - dataBytes: - maximum: 9000 - minimum: 16 - type: integer - description: | - Ping Command DataBytes. - This field is only applicable for commands of type `PING_COMMAND`. - example: 100 - default: 64 - interval: - type: integer - description: | - Time in milliseconds between sending each packet. - This field is only applicable for commands of type `PING_COMMAND`. - example: 1000 - default: 1000 - count: - type: integer description: | - Total number of ping requests. - This field is only applicable for commands of type `PING_COMMAND`. - example: 5 - default: 5 - probes: + Unique identifier of the Patch Panel. + example: CP:Demarc:1259684 + patchPanelPortA: type: integer description: | - Number of probes for Fabric Cloud Router Traceroute Command. - This field is only applicable for commands of type `TRACEROUTE_COMMAND` and is not configurable. - example: 3 - default: 3 - hopsMax: - maximum: 30 + Specify the desired port number.
When ports are not provided, next available ports will be used. + example: 23 + patchPanelPortB: type: integer description: | - Maximum number of hops for the traceroute command. - This field is only applicable for commands of type `TRACEROUTE_COMMAND`. - example: 20 - default: 20 - description: Fabric Cloud Router Command Request - CloudRouterCommandResponse: + Specify the desired port number.
When ports are not provided, next available ports will be used.
Required for Connector type FC and ST only. + example: 24 + connectorType: + $ref: '#/components/schemas/LoaPatchPanelConnectorType' + IssueLoa: + title: IssueLoa + description: Issue Loa type: object - oneOf: - - $ref: "#/components/schemas/CloudRouterCommandPingResponse" - - $ref: "#/components/schemas/CloudRouterCommandTracerouteResponse" - RouteTableEntry: - required: - - changeLog - - state - - type + allOf: + - $ref: '#/components/schemas/LoaRequest' + - type: object + properties: + expirationDateTime: + $ref: '#/components/schemas/LoaExpiration' + requestor: + $ref: '#/components/schemas/LoaRequestor' + demarcationPoint: + $ref: '#/components/schemas/LoaDemarcationPoint' + required: + - type + - demarcationPoint + LoaIssuer: + description: Issuer type: object properties: - type: - $ref: "#/components/schemas/RouteTableEntryType" - protocolType: - $ref: "#/components/schemas/RouteTableEntryProtocolType" - state: - $ref: "#/components/schemas/RouteTableEntryState" - prefix: - type: string - example: 192.168.10.0/24 - nextHop: + email: type: string - example: 10.10.10.5 - MED: - type: integer - example: 5 - localPreference: + format: email + description: Email address of the issuer contact. + example: user@org1.com + orgId: type: integer - example: 200 - asPath: - type: array - items: - type: string - example: "20100" - connection: - $ref: "#/components/schemas/RouteTableEntry_connection" - changeLog: - $ref: "#/components/schemas/Changelog" - description: Route table entry object - code: + description: Organization ID of the issuer. + example: 9257 + orgName: + type: string + description: Organization name of the issuer. + example: ABC Inc. + LoaLocation: + description: Eligible location where LOA can be issued. + type: object + properties: + ibxCode: + type: string + description: IBX Code + example: AM1 + RequestLoa: + title: RequestLoa + description: Request Loa + allOf: + - $ref: '#/components/schemas/LoaRequest' + - type: object + properties: + issuer: + $ref: '#/components/schemas/LoaIssuer' + location: + $ref: '#/components/schemas/LoaLocation' + required: + - type + - location + CreateLoa: + description: Create Loa + oneOf: + - $ref: '#/components/schemas/IssueLoa' + - $ref: '#/components/schemas/RequestLoa' + LoaState: type: string - description: Cloud Router package code - example: LAB + description: Current lifecycle state of the LOA. enum: - - LAB - - BASIC - - STANDARD - - ADVANCED - - PREMIUM - PackageChangeLog: + - PENDING + - FAILED + - PENDING_AUTHORIZATION + - PENDING_ACCEPTANCE + - CANCELLED + - INACTIVE + - ACTIVE + - EXPIRED + example: ACTIVE + LoaChangelog: + description: Change log type: object properties: - createdDateTime: + createdBy: type: string - format: date-time - example: 2020-11-06T07:00:00Z - updatedDateTime: + example: johnsmith + description: Created by User Key + createdByFullName: + type: string + example: John Smith + description: Created by User Full Name + createdByEmail: + type: string + example: john.smith@example.com + description: Created by User Email Address + createdDateTime: type: string format: date-time - example: 2020-11-06T07:00:00Z - description: Cloud Router package change log - ApiServices: - type: object - properties: - route: + example: '2020-11-06T07:00:00Z' + description: Created by Date and Time + updatedBy: type: string - description: service routes - status: + example: johnsmith + description: Updated by User Key + updatedByFullName: type: string - description: service status - changedDateTime: + example: John Smith + description: Updated by User Full Name + updatedByEmail: type: string - description: service status change date - description: Available services details - ValidateConnectionResponse: - type: object - properties: - uuid: + example: john.smith@example.com + description: Updated by User Email Address + updatedDateTime: type: string - description: Equinix-assigned connection identifier - bandwidth: - maximum: 100000 - 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: + format: date-time + example: '2020-11-06T07:00:00Z' + description: Updated by Date and Time + LoaResponse: + description: Loa Response type: object properties: href: type: string - description: Network URI + description: URI of this LOA resource. format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9 + example: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 uuid: type: string - description: Uniquely identifies a change + description: Unique identifier of this LOA. format: uuid - example: 4b17da68-3d6b-436d-9c8f-2105f3b950d9 + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 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: + $ref: '#/components/schemas/LoaType' + name: type: string - description: Http method type - contentType: + description: A short, descriptive name for this LOA + example: LOA-Equinix-SV1-2026 + description: type: string - description: Content type for the response - authenticate: - type: boolean - description: Authentication required or not - NetworkChangeOperation: + description: Additional context about this LOA + example: Authorization for patch panel port access to Equinix at SV1 + authorizedProductType: + $ref: '#/components/schemas/LoaProductType' + state: + $ref: '#/components/schemas/LoaState' + operation: + type: object + properties: + consumersCount: + type: integer + description: Number of consumers associated with this LOA. + example: 10 + requestor: + $ref: '#/components/schemas/LoaRequestor' + issuer: + $ref: '#/components/schemas/LoaIssuer' + demarcationPoint: + $ref: '#/components/schemas/LoaDemarcationPoint' + location: + $ref: '#/components/schemas/LoaLocation' + expirationDateTime: + $ref: '#/components/schemas/LoaExpiration' + changeLog: + $ref: '#/components/schemas/LoaChangelog' + LoaOpEnum: + description: Operation to be performed + type: string + enum: + - replace + - add + - remove + LoaPath: + description: | + ### A JSON Pointer path. + * `/name` - Name of the Loa + * `/description` - Description of the Loa + * `/requestor/email` - Email of the requestor contact + * `/requestor/orgName` - Organization name of the requestor + * `/issuer/email` - Email of the issuer contact + * `/issuer/orgName` - Organization name of the issuer + * `/demarcationPoint/patchPanelId` - Patch Panel Identifier + * `/demarcationPoint/patchPanelPortA` - Patch Panel Port A + * `/demarcationPoint/patchPanelPortB` - Patch Panel Port B + * `/demarcationPoint/connectorType` - Connector Type + * `/demarcationPoint/cageUniqueSpaceId` - Cage Unique Space Identifier + * `/expirationDateTime` - Expiration date and time of the Loa + * `/location/ibxCode` - IBX code of the Eligible location + type: string + LoaReplaceOperation: + description: Replace attribute value or sub-resource in the existing model + type: object required: - op - path - value - type: object properties: op: - type: string - description: Handy shortcut for operation name - enum: - - replace - - add - - remove + $ref: '#/components/schemas/LoaOpEnum' path: - type: string - description: path inside document leading to updated parameter - example: /name + $ref: '#/components/schemas/LoaPath' 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: + description: New value for updated parameter + LoaUpdate: + type: array + items: + $ref: '#/components/schemas/LoaReplaceOperation' + LoaActionType: type: string - description: Type of change + description: Action to perform on the LOA. enum: - - NETWORK_CREATION - - NETWORK_UPDATE - - NETWORK_DELETION - NetworkChangeStatus: + - LOA_ISSUER_AUTHORIZATION + - LOA_REQUESTOR_ACCEPTANCE + - LOA_COPY_LINK + - LOA_SEND_EMAIL_NOTIFICATION + - LOA_CANCEL + example: LOA_ISSUER_AUTHORIZATION + LoaMagicLink: + description: | + Portal URL for the LOA to either accept from requestor
or authorize from the issuer. type: string - description: Current outcome of the change flow - enum: - - APPROVED - - COMPLETED - - FAILED - - REJECTED - - REQUESTED - - SUBMITTED_FOR_APPROVAL - precisionTimePackageRequest: - title: precisionTimePackageRequest - required: - - code + readOnly: true + example: https://portal.equinix.com/fabric/loa/inventory/issuer/29cc7878-54e3-4e1a-8651-87a61354bac2/authorize + LoaActionData: + description: | + Action Data.
For LOA_ISSUER_AUTHORIZATION — always required. 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 + demarcationPoint: + $ref: '#/components/schemas/LoaDemarcationPoint' + expirationDateTime: + $ref: '#/components/schemas/LoaExpiration' + portalUrl: + $ref: '#/components/schemas/LoaMagicLink' + LoaActionRequest: + description: Action Request + title: AuthorizeLoa + properties: + type: + $ref: '#/components/schemas/LoaActionType' + data: + $ref: '#/components/schemas/LoaActionData' required: - - uuid + - type + LoaActionState: + description: Action State + type: string + enum: + - COMPLETED + - FAILED + - PENDING + LoaActionResponse: + description: Action Response type: object properties: href: type: string - description: Connection URI + description: Action URI format: uri - readOnly: true - type: - type: string - description: Connection Type + example: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 uuid: type: string - description: Connection UUID. + description: Action Identifier 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: + example: 30cc7878-54e3-4e1a-8651-87a61354bad4 + state: + $ref: '#/components/schemas/LoaActionState' + type: + $ref: '#/components/schemas/LoaActionType' + data: + $ref: '#/components/schemas/LoaActionData' + changeLog: + $ref: '#/components/schemas/LoaChangelog' + LoaFieldName: + description: Possible field names to use on filters + type: string + enum: + - /uuid + - /state + - /type + - /name + - /authorizedProductType + - /expirationDateTime + - /requestor/email + - /requestor/orgId + - /requestor/orgName + - /issuer/email + - /issuer/orgId + - /issuer/orgName + - /demarcationPoint/patchPanelId + - /demarcationPoint/patchPanelPortA + - /demarcationPoint/patchPanelPortB + - /demarcationPoint/connectorType + - /demarcationPoint/cageUniqueSpaceId + - /location/ibxCode + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + example: /name + LoaSimpleExpression: type: object properties: - timeScale: + property: + $ref: '#/components/schemas/LoaFieldName' + operator: 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 + - '=' + - '!=' + - LIKE + - ILIKE + - BETWEEN + - NOT BETWEEN + - IN + - NOT IN + - '>' + - < + - '>=' + - <= + example: '=' + values: + type: array + items: + type: string + example: + - Loa-2026 + LoaOrFilter: + type: object + properties: + or: + type: array + items: + $ref: '#/components/schemas/LoaSimpleExpression' + LoaFilter: + type: object + anyOf: + - $ref: '#/components/schemas/LoaSimpleExpression' + - $ref: '#/components/schemas/LoaOrFilter' + LoaSearchFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/LoaFilter' + LoaSortCriteria: + type: object + properties: + direction: + description: Sorting direction + default: DESC + type: string enum: - - -5 - - -4 - - -3 - - -2 - - -1 - - 0 - - 1 - transportMode: + - DESC + - ASC + property: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime 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 + - /name + - /expirationDateTime + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + LoaSearchRequest: type: object + description: Search loas based on filter criteria 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 - timeServiceOperation: + filter: + $ref: '#/components/schemas/LoaSearchFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/LoaSortCriteria' + LoaSearchResponse: + description: List of LOAs type: object properties: - operationalStatus: + pagination: + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/LoaSortCriteria' + data: + type: array + items: + $ref: '#/components/schemas/LoaResponse' + LoaActionFieldName: + description: Possible field names to use on filters + type: string + enum: + - /type + - /state + - /uuid + LoaActionSearchSimpleExpressions: + type: object + properties: + property: + $ref: '#/components/schemas/LoaActionFieldName' + operator: type: string - description: time service operational status enum: - - UP - - DOWN - - DEGRADED - description: time service operational data - precisionTimePackagePostResponse: - title: precisionTimePackagePostResponse - required: - - code + - '=' + - '!=' + - LIKE + - ILIKE + - BETWEEN + - NOT BETWEEN + - IN + - NOT IN + - '>' + - < + - '>=' + - <= + values: + type: array + items: + type: string + example: LOA_ACCEPTANCE + LoaActionOrFilter: type: object properties: - href: + or: + type: array + items: + $ref: '#/components/schemas/LoaActionSearchSimpleExpressions' + LoaActionFilter: + type: object + anyOf: + - $ref: '#/components/schemas/LoaActionSearchSimpleExpressions' + - $ref: '#/components/schemas/LoaActionOrFilter' + LoaActionSearchFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/LoaActionFilter' + LoaActionSortCriteria: + type: object + properties: + direction: + description: Sorting direction + default: DESC type: string - format: uri - code: + enum: + - DESC + - ASC + property: + description: Possible field names to use on sorting + default: /changeLog/createdDateTime 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 + - /changeLog/createdDateTime + LoaActionSearchRequest: + type: object + description: Search loa actions based on filter criteria + properties: + filter: + $ref: '#/components/schemas/LoaActionSearchFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/LoaActionSortCriteria' + LoaActionSearchResponse: + description: List of LOA Actions + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/LoaActionSortCriteria' + data: + type: array + items: + $ref: '#/components/schemas/LoaActionResponse' + LoaConsumer: + description: Associated consumer response type: object properties: href: type: string - description: Connection URI + description: Consumer URI format: uri - readOnly: true - type: - type: string - description: Connection Type. + example: https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2 uuid: type: string - description: Connection UUID. + description: Consumer Identifier format: uuid - aSide: - $ref: "#/components/schemas/virtualConnectionSide" - zSide: - $ref: "#/components/schemas/virtualConnectionSide" - description: Fabric Connection Precision Time Service Response Object - precisionTimePrice: - title: precisionTimePrice + example: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: + $ref: '#/components/schemas/LoaProductType' + changeLog: + $ref: '#/components/schemas/LoaChangelog' + LoaConsumersResponse: + description: List of Consumers associated with a LOA type: object properties: - currency: - type: string - description: offering price currency - charges: + pagination: + $ref: '#/components/schemas/Pagination' + data: type: array items: - $ref: "#/components/schemas/PriceCharge" - description: Precision Time Price - connectionLink: + $ref: '#/components/schemas/LoaConsumer' + LoaNoteDetails: + description: | + Represents a note added to a LOA by an authorized user from either the issuer or requestor organization 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 - StreamSearchAsset: - type: object - properties: + - ISSUER + - REQUESTOR + description: | + Indicates which party added the note.
ISSUER — note was added by a user from the issuer organization.
REQUESTOR — note was added by a user from the requestor organization. + example: ISSUER href: type: string - description: Stream Asset URI format: uri - readOnly: true + description: URI to note resource. + example: https://api.equinix.com/fabric/v4/loas/b7e14c2d-93f8-4a61-8d5b-c29f71e4a306/notes/e41f485e-3094-42de-8797-0ef19a51df79 uuid: type: string - description: Equinix-assigned access point identifier format: uuid - example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 - streamUuid: + description: Unique identifier of this note. + example: e41f485e-3094-42de-8797-0ef19a51df79 + comments: type: string - description: Equinix-assigned access point identifier - format: uuid - example: d4b8e7a2-f3b1-4576-a4a9-1366a63df171 - type: + description: Content of the note as submitted by the user. + example: LOA under review by our team. Expected response within 2 business days + createdDateTime: type: string - description: Asset type - example: XF_PORT - metricsEnabled: - type: boolean - description: enable metric - example: true - attachmentStatus: + format: date-time + description: Date and time when the note was created. + example: '2023-08-01T12:34:56Z' + LoaNotesResponse: + description: List of Loa note details + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/LoaNoteDetails' + CreateLoaNote: + description: Create Loa Note + type: object + properties: + comments: + type: string + description: | + The note content to add to this LOA. Notes are visible to both the issuer and requestor organizations. Use notes to communicate updates, clarifications, or additional context about the LOA. + minLength: 0 + maxLength: 4000 + example: LOA under review by our team. Expected response within 2 business days + required: + - comments + CrossConnectType: + description: Type of Cross Connect. + type: string + enum: + - XC + example: XC + BmmrType: + description: Cross Connect BMMR Type. + type: string + enum: + - EQUINIX + - SELF + example: EQUINIX + CrossConnectRedundancy: + description: Cross Connect Redundancy. + type: object + properties: + group: + type: string + description: | + Redundancy group identifier. When placing a diverse Cross Connect against an existing one, provide either this identifier or the serial number of the existing Cross Connect. + example: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: type: string - description: asset status enum: - - ATTACHING - - ATTACHED - - DETACHED - - DETACHING - - FAILED - projectId: + - PRIMARY + - SECONDARY + description: Priority within the redundancy group. + example: PRIMARY + CrossConnectConnectorType: + description: Connector Type. + type: string + example: SC + CrossConnectDemarcationPoint: + description: Cross Connect Demarcation Point - patch panel and port details. + type: object + properties: + patchPanelId: type: string - description: project ic - example: "123" - description: Stream object - StreamAssetInterface: + description: Patch Panel Identifier. + example: CP:Demarc:1259684 + patchPanelPortA: + type: integer + description: | + Specify the desired port number. When ports are not provided, next available ports will be used. + example: 35 + patchPanelPortB: + type: integer + description: | + Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only. + example: 32 + connectorType: + $ref: '#/components/schemas/CrossConnectConnectorType' + CrossConnectASideRequest: + title: CrossConnectASideRequest + description: A-Side connection details. + type: object + properties: + demarcationPoint: + allOf: + - $ref: '#/components/schemas/CrossConnectDemarcationPoint' + - required: + - patchPanelId + - connectorType + CrossConnectZSideRequestDemarcationPoint: + description: | + Z-Side demarcation point.
Specify the destination patch panel and ports.
Specify cageUniqueSpaceId and cabinetUniqueSpaceId to identify the destination space. + allOf: + - $ref: '#/components/schemas/CrossConnectDemarcationPoint' + - type: object + properties: + cageUniqueSpaceId: + type: string + description: Unique identifier of the Cage. + example: SV2:00:000000 + cabinetUniqueSpaceId: + type: string + description: Unique identifier of the Cabinet. + example: SV2:00:000000:0100 + CrossConnectLocation: + description: Cross Connect Location details. + type: object + properties: + ibxCode: + type: string + description: IBX Code. + example: SV1 + CrossConnectLoaRef: + description: | + LOA Reference for Cross Connect. Provide either uuid or digitalLoaId. type: object properties: href: type: string - description: Network Edge Device interface URI format: uri readOnly: true - example: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5 - id: - type: integer - description: Network Edge Device interface identifier - format: int32 - example: 5 + description: LOA URI. + example: https://api.equinix.com/fabric/v4/loas/c61f485e-3094-42de-8797-0ef19a51df79 uuid: type: string - description: Network Edge Device interface UUID format: uuid - example: 4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d + description: LOA Identifier - Attachment UUID or LOA UUID. + example: c61f485e-3094-42de-8797-0ef19a51df79 + CrossConnectZSideRequest: + title: CrossConnectZSideRequest + description: | + Z-Side connection details. Provide the demarcationPoint for a patch panel to patch panel Cross Connect, or location when connecting to a BMMR. loa is mandatory for a Cross Connect with LOA and when bmmrType is EQUINIX - provide either loa.uuid or loa.digitalLoaId. + type: object + properties: + demarcationPoint: + allOf: + - $ref: '#/components/schemas/CrossConnectZSideRequestDemarcationPoint' + description: Required for a patch panel to patch panel Cross Connect. + location: + allOf: + - $ref: '#/components/schemas/CrossConnectLocation' + description: Required when connecting to a BMMR. + loa: + allOf: + - $ref: '#/components/schemas/CrossConnectLoaRef' + description: Required for a Cross Connect with LOA and when bmmrType is EQUINIX. + ScheduleType: + description: Schedule Code. + type: string + enum: + - STANDARD + - FLEXIBLE + - EXPEDITE + example: STANDARD + ScheduleRequest: + description: Cross Connect Installation Schedule. + type: object + properties: type: type: string - description: Network Edge Device interface type + description: Schedule type. enum: - - DATA - - MGMT - - SSH - - FAB - - CTRL - state: + - XC_INSTALL_SCHEDULE + example: XC_INSTALL_SCHEDULE + code: + $ref: '#/components/schemas/ScheduleType' + autoConvertToStandard: + type: boolean + description: | + Applicable only when the code is EXPEDITE. When true, Equinix schedules the Cross Connect as STANDARD when no EXPEDITE scheduling is available. + example: true + readinessDateTime: type: string - description: Network Edge Device interface usage status - example: ASSIGNED - attachmentStatus: + format: date-time + description: | + Carrier Circuit delivery date is the date when the Carrier commits to enable the circuit. Your order will be placed on hold, pending the date you enter. Equinix will wait for the Carrier to deliver the service and then will complete the installation. + example: '2026-02-26T07:21:39Z' + requestedDateTime: type: string - description: interface attachment status - enum: - - ATTACHING - - ATTACHED - - DETACHED - - DETACHING - - FAILED - description: Network Edge Device interface attached to a stream - StreamSubscriptionSinkResponse: + format: date-time + description: Requested Installation Date and Time. + example: '2026-02-27T07:21:39Z' + required: + - code + CrossConnectServiceType: + description: | + Type of service ordered alongside the Cross Connect.
XC_LINK_LIGHT_VERIFICATION - To verify transmit and receive alignment after the Cross Connect is Provisioned.
XC_PATCH_EQUIPMENT - Equinix will install the Cross Connect from the demarcation panel to your equipment device. + type: string + enum: + - XC_LINK_LIGHT_VERIFICATION + - XC_PATCH_EQUIPMENT + example: XC_LINK_LIGHT_VERIFICATION + PatchEquipmentRequest: + description: Patch equipment installed for the Cross Connect. type: object properties: - uri: - type: string - description: any publicly reachable http endpoint - type: + cabinetUniqueSpaceId: type: string - description: destination type - enum: - - DATADOG - - DYNATRACE - - GOOGLE_PUBSUB - - PAGERDUTY - - SERVICENOW - - SLACK - - SPLUNK_HEC - - TEAMS - - WEBHOOK - batchEnabled: - type: boolean - description: batch mode on/off - example: false - batchSizeMax: - type: integer - description: maximum batch size - batchWaitTimeMax: + description: Unique identifier of the Cabinet. + example: SV2:00:000000:0100 + port: 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 - StreamSubscriptionOperation: + description: Port number. + example: 32 + connectorType: + $ref: '#/components/schemas/CrossConnectConnectorType' + required: + - cabinetUniqueSpaceId + - port + - connectorType + CrossConnectServiceRequest: + description: | + Service to order alongside the Cross Connect.
Send one entry per service.
device and description apply to the XC_PATCH_EQUIPMENT service only. type: object properties: - eventsDeliveredCount: - type: integer - description: count of delivered events - metricsDeliveredCount: - type: integer - description: count of delivered metrics - alertsDeliveredCount: - type: integer - description: count of delivered alerts - lastSuccessfulDeliveryDateTime: - type: string - description: last successful date time of delivered event, metric, or alert - format: date-time - suspendedDateTime: + type: + $ref: '#/components/schemas/CrossConnectServiceType' + device: + allOf: + - $ref: '#/components/schemas/PatchEquipmentRequest' + description: | + Patch equipment device details. Required for the XC_PATCH_EQUIPMENT service. + description: type: string - description: suspended date time of stream subscription delivery for event, metric, or alert - format: date-time - errors: - type: array - description: List of error information for stream subscription delivery - items: - $ref: "#/components/schemas/StreamSubscriptionOperationErrors" - description: Stream subscription operational information - StreamSubscriptionOperationErrors: + description: | + Additional notes for the service. Required for the XC_PATCH_EQUIPMENT service. + example: additional notes for patch equipment + maxLength: 100 + required: + - type + NotificationType: + description: Notification Type. + type: string + enum: + - ORDERING + - TECHNICAL + - NOTIFICATION + - PROVIDER_NOTIFICATION + - TECHNICAL_UNREGISTERED + example: TECHNICAL + CrossConnectContactAvailability: + description: Availability preference. + type: string + enum: + - ANYTIME + - NEVER + - WORK_HOURS + - IBX_HOURS + example: ANYTIME + CrossConnectContactPreference: + description: Cross Connect Contact Preference. type: object properties: - errorCode: - type: string - description: Equinix Observability error code - errorMessage: - type: string - description: Equinix Observability error message - dateTime: + timezone: type: string - description: Equinix Observability error date time - format: date-time - additionalInfo: - $ref: "#/components/schemas/StreamSubscriptionOperationAdditionalInfo" - description: Error information for stream subscription delivery - StreamSubscriptionOperationAdditionalInfo: + description: Timezone. + example: PST + availability: + $ref: '#/components/schemas/CrossConnectContactAvailability' + CrossConnectPhone: + description: Contact phone number. type: object properties: - property: - type: string - description: Additional attribute for error information - statusCode: + type: type: string - description: HTTP error status code response from sink type if error occurred - reason: + description: Phone number type. + enum: + - MOBILE + - OFFICE + example: MOBILE + number: type: string - description: HTTP error message response from sink type if error occurred - description: External error information from subscription sink - 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: + description: Phone number. + pattern: ^\+[1-9]\d{1,14}$ + example: '+14085551234' + contactPreference: + $ref: '#/components/schemas/CrossConnectContactPreference' + CrossConnectNotification: + description: Cross Connect Notification. type: object properties: - property: + type: + $ref: '#/components/schemas/NotificationType' + firstName: type: string description: | - Possible field names to use on filters: - * `/subject` - subject - * `/type` - type - example: /type - operator: + First name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type. + example: John + lastName: type: string description: | - Possible operators to use on filters: - * `=` - equal - * `in` - in - * `LIKE` - case-sensitive like - * `ILIKE` - case-insensitive like - example: = - values: + Last name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type. + example: Doe + emails: type: array - description: | - ### Supported event or metric names to use on filters with property /type: - * `*` - all events or metrics - * `equinix.fabric.company_profile.*` - company profile events - * `equinix.fabric.connection.*` - connection events, metrics, or alerts - * `equinix.fabric.connection_bgpipv4_session.*` - connection BGP IPv4 session events - * `equinix.fabric.connection_bgpipv6_session.*` - connection BGP IPv6 session events - * `equinix.fabric.connection_maintenance.*` - connection maintenance events - * `equinix.fabric.connection_route_aggregation.*` - connection route aggregation events - * `equinix.fabric.connection_route_filter.*` - connection route filter events - * `equinix.fabric.connection_routing_protocol.*` - connection routing protocol events - * `equinix.fabric.internet_access.*` - internet access service events - * `equinix.fabric.ip_block.*` - IP block events - * `equinix.fabric.metric` - metric collection events - * `equinix.fabric.metro.*` - metro metrics or alerts - * `equinix.fabric.network.*` - network events - * `equinix.fabric.physical_port.*` - physical port events - * `equinix.fabric.port.*` - virtual port events, metrics, or alerts - * `equinix.fabric.port_maintenance.*` - port maintenance events - * `equinix.fabric.route_aggregation.*` - route aggregation events - * `equinix.fabric.route_aggregation_rule.*` - route aggregation rule events - * `equinix.fabric.route_filter.*` - route filter events - * `equinix.fabric.route_filter_rule.*` - route filter rule events - * `equinix.fabric.router.*` - cloud router events or alerts - * `equinix.fabric.router_action.*` - cloud router action events - * `equinix.fabric.router_command.*` - cloud router command events - * `equinix.fabric.routing_protocol_action.*` - routing protocol action events - * `equinix.fabric.service_profile_connection.*` - service profile connection events - * `equinix.fabric.service_token.*` - service token events - * `equinix.fabric.time_service.*` - precision time service events - * `equinix.network.maintenance.*` - network maintenance events - * `equinix.network.repair.*` - network repair events - * `equinix.network_edge.*` - network edge events, metrics, or alerts - * `equinix.network_edge.acl.*` - network edge acl events - * `equinix.network_edge.device.*` - network edge device events - * `equinix.network_edge.device_interface.*` - network edge device interface metrics or alerts - * `equinix.network_edge.devicelinkgroup.*` - network edge device link group events - * `equinix.access_manager.*` - identity access manager events - * `equinix.access_manager.user.role.*` - identity access manager user role events - * `equinix.iam.principal.*` - IAM principal authorization and token events - * `equinix.identity.user.*` - identity user events - * `equinix.identity.organization.*` - identity organization membership events - * `equinix.resource_manager.organization.*` - resource manager organization events - * `equinix.resource_manager.project.*` - resource manager project 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/ports//maintenances/` - port maintenance events - * `/fabric/v4/connections/` - connection events or metrics - * `/fabric/v4/connections//maintenances/` - connection maintenance events - * `/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" - MetricSelectorResponse: - type: object - properties: - include: + format: email + description: Email addresses for notifications. + example: + - abc@test.com + registeredUsers: type: array - description: Stream alert rule filtered by metric name items: type: string - example: equinix.fabric.metro.sv_da.latency - ResourceSelectorResponse: - type: object - properties: - include: + description: Registered users for notifications. + phone: type: array - description: | - ### Supported metric names to use on filters with property /subject: - * `/fabric/v4/ports/` - port metrics - * `/fabric/v4/connections/` - connection metrics - * `/fabric/v4/metros/` - metro latency metrics items: - type: string - DetectionMethodResponse: + $ref: '#/components/schemas/CrossConnectPhone' + description: Contact phone numbers. + required: + - type + - emails + PurchaseOrder: + description: Purchase Order information associated with the account. type: object properties: - type: + number: type: string - description: | - * THRESHOLD - Alert when a metric crosses a defined threshold by user. - * OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric. - enum: - - THRESHOLD - - OUTLIER - windowSize: + description: Purchase Order number. + example: '1233' + amount: type: string - description: Stream alert rule metric window size - example: PT15M - operand: + description: Purchase Order amount. + example: '10000' + startDate: type: string - description: Stream alert rule metric operand - enum: - - ABOVE - - BELOW - warningThreshold: + format: date + description: Date the Purchase Order takes effect. + example: '2026-02-26' + endDate: type: string - description: Stream alert rule metric warning threshold - criticalThreshold: + format: date + description: Date the Purchase Order expires. + example: '2027-02-26' + attachmentId: type: string - description: Stream alert rule metric critical threshold - CompanyProfileContact: - type: object - properties: + format: uuid + description: Identifier of the uploaded purchase order document. + example: e41f485e-3094-42de-8797-0ef19a51df79 type: type: string - description: Contact Type - example: SUPPORT + description: Purchase Order type. enum: - - SUPPORT - contacts: - type: array - items: - $ref: "#/components/schemas/CompanyProfileContact_contacts" - CompanyProfileState: - type: string - description: Company Profile State - CompanyMetro: - type: object - properties: - href: - type: string - metroCode: - type: string - CompanyLogo: + - EXEMPTION + - EXISTING + - NEW + example: NEW + OrderRequest: + description: Cross Connect Order. type: object properties: - href: + orderNumber: type: string - uuid: + description: Order Number. + example: 1-1234567890 + orderLineItemNumber: type: string - extensionType: + description: Order Line Item Number. + example: 1-1234567890 + purchaseOrder: + $ref: '#/components/schemas/PurchaseOrder' + customerReferenceId: type: string - CompanyServiceProfile: + description: Customer Reference Identifier. + example: '12345' + CrossConnectNoteRequest: + description: Cross Connect Note. type: object properties: - href: - type: string - uuid: + comments: type: string - type: - $ref: "#/components/schemas/ServiceProfileTypeEnum" - PrivateService: + description: Note comments. + example: test note + maxLength: 4000 + required: + - comments + CrossConnectAttachment: + description: Cross Connect Attachment. type: object properties: - href: - type: string - uuid: + attachmentId: type: string - CompanyProfileChange: + format: uuid + description: Attachment Identifier. + example: a11f485e-3094-42de-8797-0ef19a51df79 + required: + - attachmentId + CreateCrossConnect: + title: CreateCrossConnect + description: | + Create Cross Connect request. A single request body supports all Cross Connect connection types - patch panel to patch panel, connection with LOA and connection to a BMMR (by Equinix or by Self). Refer to the request examples for each use case. type: object properties: - uuid: - type: string type: + $ref: '#/components/schemas/CrossConnectType' + name: type: string - status: - type: string - createdDateTime: - type: string - format: date-time - updatedDateTime: + description: A short, descriptive name for this Cross Connect. + minLength: 3 + maxLength: 50 + example: My-CC-service + bmmrType: + allOf: + - $ref: '#/components/schemas/BmmrType' + description: | + Required when connecting to a BMMR.
Use EQUINIX when BMMR Extension is required and Equinix installs it, or SELF when you install it yourself. + circuitId: type: string - format: date-time - data: + description: Circuit identifier of the Cross Connect. + redundancy: + allOf: + - $ref: '#/components/schemas/CrossConnectRedundancy' + description: | + Provide it to place a diverse Cross Connect against an existing one - set group to the redundancy group id or the serial number of the existing Cross Connect, and priority to SECONDARY. + aSide: + allOf: + - $ref: '#/components/schemas/CrossConnectASideRequest' + description: A-Side connection details. + zSide: + allOf: + - $ref: '#/components/schemas/CrossConnectZSideRequest' + description: | + Z-Side connection details.
Provide the DemarcationPoint, the LOA reference or the BMMR location depending on the Cross Connect being requested. + schedule: + allOf: + - $ref: '#/components/schemas/ScheduleRequest' + description: | + Preferred installation schedule. When omitted, the Cross Connect is scheduled with the STANDARD schedule code. + services: type: array items: - $ref: "#/components/schemas/CompanyProfileChangeItem" - default: [] - CompanyProfileSortDirection: + $ref: '#/components/schemas/CrossConnectServiceRequest' + description: Cross Connect Services. + notifications: + type: array + items: + $ref: '#/components/schemas/CrossConnectNotification' + description: | + Preferences for notifications on Cross Connect configuration or status changes. + order: + $ref: '#/components/schemas/OrderRequest' + notes: + type: array + maxItems: 1 + items: + $ref: '#/components/schemas/CrossConnectNoteRequest' + description: Additional Note. + attachments: + type: array + maxItems: 5 + items: + $ref: '#/components/schemas/CrossConnectAttachment' + description: Additional Attachments. + required: + - type + - name + - aSide + - zSide + CrossConnectState: + description: Cross Connect State. type: string - description: Sorting direction - default: ASC enum: - - DESC - - ASC - IssueLoa: - title: IssueLoa - type: object - description: Issue Loa - allOf: - - $ref: "#/components/schemas/LoaRequest" - - required: - - demarcationPoint - type: object - properties: - expirationDateTime: - $ref: "#/components/schemas/LoaExpiration" - requestor: - $ref: "#/components/schemas/LoaRequestor" - demarcationPoint: - $ref: "#/components/schemas/LoaDemarcationPoint" - RequestLoa: - title: RequestLoa - description: Request Loa - allOf: - - $ref: "#/components/schemas/LoaRequest" - - required: - - location - type: object - properties: - issuer: - $ref: "#/components/schemas/LoaIssuer" - location: - $ref: "#/components/schemas/LoaLocation" - LoaType: - type: string + - PENDING + - PENDING_ACTION + - PROVISIONING + - PROVISIONED + - DEPROVISIONING + - DEPROVISIONED + - CANCELLING + - CANCELLED + - FAILED + example: PENDING + CrossConnectActionType: description: | - Type of Letter of Authorization - example: PATCH_PANEL_PORT_LOA - enum: - - CAGE_LOA - - PATCH_PANEL_LOA - - PATCH_PANEL_PORT_LOA - LoaProductType: + Action to perform on the Cross Connect. The applicable action types are listed in the allowedActions of the Cross Connect.
XC_SIGNATURE_SUBMISSION - resend the quote to the customer email for signature.
XC_PROPOSED_DATE_TIME_ACCEPTANCE - accept the date and time proposed by Equinix.
XC_PROPOSED_DATE_TIME_REJECTION - reject the date and time proposed by Equinix. The expedite is cancelled and the Cross Connect is scheduled as STANDARD.
XC_CANCEL - cancel the Cross Connect before it is provisioned.
XC_DEINSTALL - remove a provisioned Cross Connect. Provide the removal schedule, and optionally the services, the notification contacts and the order details, in data.
XC_INFORMATION_UPDATE - provide the requested information as a note and an attachment. type: string - description: | - Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge - example: XC - enum: - - XC - - XF_PORT - - VD - LoaState: - type: string - description: Current lifecycle state of the LOA. - example: ACTIVE - enum: - - PENDING - - FAILED - - PENDING_AUTHORIZATION - - PENDING_ACCEPTANCE - - CANCELLED - - INACTIVE - - ACTIVE - - EXPIRED - LoaRequestor: - type: object - properties: - email: - type: string - description: Email address of the requestor contact. - format: email - example: user@org1.com - orgId: - type: integer - description: Organization ID of the requestor. - example: 9257 - orgName: - type: string - description: Organization name of the requestor. - example: ABC Inc. - description: Requestor - LoaIssuer: - type: object - properties: - email: - type: string - description: Email address of the issuer contact. - format: email - example: user@org1.com - orgId: - type: integer - description: Organization ID of the issuer. - example: 9257 - orgName: - type: string - description: Organization name of the issuer. - example: ABC Inc. - description: Issuer - LoaDemarcationPoint: - type: object - properties: - cageUniqueSpaceId: - type: string - description: Unique identifier of the Cage. - example: SV1:00:000000 - cabinetUniqueSpaceId: - type: string - description: Unique identifier of the Cabinet. - example: SV1:00:000000:0105 - patchPanelId: - type: string - description: | - Unique identifier of the Patch Panel. - example: CP:Demarc:1259684 - patchPanelPortA: - type: integer - description: | - Specify the desired port number.
When ports are not provided, next available ports will be used. - example: 23 - patchPanelPortB: - type: integer - description: | - Specify the desired port number.
When ports are not provided, next available ports will be used.
Required for Connector type FC and ST only. - example: 24 - connectorType: - $ref: "#/components/schemas/LoaPatchPanelConnectorType" - description: | - Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB - and connectorType is required. - LoaLocation: - type: object - properties: - ibxCode: - type: string - description: IBX Code - example: AM1 - description: Eligible location where LOA can be issued. - LoaExpiration: - type: string - description: | - Date and time when this LOA expires.
Default to 3 months from the creation date - format: date-time - example: 2026-11-06T07:00:00Z - LoaChangelog: - 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 - description: Change log - LoaActionType: - type: string - description: Action to perform on the LOA. - example: LOA_ISSUER_AUTHORIZATION - enum: - - LOA_ISSUER_AUTHORIZATION - - LOA_REQUESTOR_ACCEPTANCE - - LOA_COPY_LINK - - LOA_SEND_EMAIL_NOTIFICATION - - LOA_CANCEL - LoaActionData: - type: object - properties: - demarcationPoint: - $ref: "#/components/schemas/LoaDemarcationPoint" - expirationDateTime: - $ref: "#/components/schemas/LoaExpiration" - portalUrl: - $ref: "#/components/schemas/LoaMagicLink" - description: | - Action Data.
For LOA_ISSUER_AUTHORIZATION — always required. - LoaActionState: - type: string - description: Action State - enum: - - COMPLETED - - FAILED - - PENDING - LoaConsumer: - type: object - properties: - href: - type: string - description: Consumer URI - format: uri - example: https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: - type: string - description: Consumer Identifier - format: uuid - example: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: - $ref: "#/components/schemas/LoaProductType" - changeLog: - $ref: "#/components/schemas/LoaChangelog" - description: Associated consumer response - CrossConnectType: - type: string - description: Type of Cross Connect. - example: XC - enum: - - XC - BmmrType: - type: string - description: Cross Connect BMMR Type. - example: EQUINIX - enum: - - EQUINIX - - SELF - CrossConnectRedundancy: - type: object - properties: - group: - type: string - description: | - Redundancy group identifier. When placing a diverse Cross Connect against an existing one, provide either this identifier or the serial number of the existing Cross Connect. - example: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: - type: string - description: Priority within the redundancy group. - example: PRIMARY - enum: - - PRIMARY - - SECONDARY - description: Cross Connect Redundancy. - CrossConnectASideRequest: - title: CrossConnectASideRequest - type: object - properties: - demarcationPoint: - allOf: - - $ref: "#/components/schemas/CrossConnectDemarcationPoint" - - required: - - connectorType - - patchPanelId - type: object - description: A-Side connection details. - CrossConnectZSideRequest: - title: CrossConnectZSideRequest - type: object - properties: - demarcationPoint: - description: Required for a patch panel to patch panel Cross Connect. - allOf: - - $ref: "#/components/schemas/CrossConnectZSideRequestDemarcationPoint" - location: - description: Required when connecting to a BMMR. - allOf: - - $ref: "#/components/schemas/CrossConnectLocation" - loa: - description: Required for a Cross Connect with LOA and when bmmrType is EQUINIX. - allOf: - - $ref: "#/components/schemas/CrossConnectLoaRef" - description: | - Z-Side connection details. Provide the demarcationPoint for a patch panel to patch panel Cross Connect, or location when connecting to a BMMR. loa is mandatory for a Cross Connect with LOA and when bmmrType is EQUINIX - provide either loa.uuid or loa.digitalLoaId. - ScheduleRequest: - required: - - code - type: object - properties: - type: - type: string - description: Schedule type. - example: XC_INSTALL_SCHEDULE - enum: - - XC_INSTALL_SCHEDULE - code: - $ref: "#/components/schemas/ScheduleType" - autoConvertToStandard: - type: boolean - description: | - Applicable only when the code is EXPEDITE. When true, Equinix schedules the Cross Connect as STANDARD when no EXPEDITE scheduling is available. - example: true - readinessDateTime: - type: string - description: | - Carrier Circuit delivery date is the date when the Carrier commits to enable the circuit. Your order will be placed on hold, pending the date you enter. Equinix will wait for the Carrier to deliver the service and then will complete the installation. - format: date-time - example: 2026-02-26T07:21:39Z - requestedDateTime: - type: string - description: Requested Installation Date and Time. - format: date-time - example: 2026-02-27T07:21:39Z - description: Cross Connect Installation Schedule. - CrossConnectServiceRequest: - required: - - type - type: object - properties: - type: - $ref: "#/components/schemas/CrossConnectServiceType" - device: - description: | - Patch equipment device details. Required for the XC_PATCH_EQUIPMENT service. - allOf: - - $ref: "#/components/schemas/PatchEquipmentRequest" - description: - maxLength: 100 - type: string - description: | - Additional notes for the service. Required for the XC_PATCH_EQUIPMENT service. - example: additional notes for patch equipment - description: | - Service to order alongside the Cross Connect.
Send one entry per service.
device and description apply to the XC_PATCH_EQUIPMENT service only. - CrossConnectNotification: - required: - - emails - - type - type: object - properties: - type: - $ref: "#/components/schemas/NotificationType" - firstName: - type: string - description: | - First name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type. - example: John - lastName: - type: string - description: | - Last name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type. - example: Doe - emails: - type: array - description: Email addresses for notifications. - example: - - abc@test.com - items: - type: string - format: email - registeredUsers: - type: array - description: Registered users for notifications. - items: - type: string - phone: - type: array - description: Contact phone numbers. - items: - $ref: "#/components/schemas/CrossConnectPhone" - description: Cross Connect Notification. - OrderRequest: - type: object - properties: - orderNumber: - type: string - description: Order Number. - example: 1-1234567890 - orderLineItemNumber: - type: string - description: Order Line Item Number. - example: 1-1234567890 - purchaseOrder: - $ref: "#/components/schemas/PurchaseOrder" - customerReferenceId: - type: string - description: Customer Reference Identifier. - example: "12345" - description: Cross Connect Order. - CrossConnectProject: - required: - - projectId - type: object - properties: - projectId: - type: string - description: Project Identifier. - format: uuid - example: e41f485e-3094-42de-8797-0ef19a51df79 - description: Cross Connect Project. - CrossConnectEndCustomer: - type: object - properties: - isDisclosed: - type: boolean - description: Indicates if the end customer is disclosed. - example: true - name: - type: string - description: End customer name. - example: Acme Corporation - mdmId: - type: string - description: | - Master Data Management identifier of the end customer, as held by Equinix. - description: End customer details for the Cross Connect. - CrossConnectState: - type: string - description: Cross Connect State. - example: PENDING - enum: - - PENDING - - PENDING_ACTION - - PROVISIONING - - PROVISIONED - - DEPROVISIONING - - DEPROVISIONED - - CANCELLING - - CANCELLED - - FAILED - CrossConnectActionType: - type: string - description: | - Action to perform on the Cross Connect. The applicable action types are listed in the allowedActions of the Cross Connect.
XC_SIGNATURE_SUBMISSION - resend the quote to the customer email for signature.
XC_PROPOSED_DATE_TIME_ACCEPTANCE - accept the date and time proposed by Equinix.
XC_PROPOSED_DATE_TIME_REJECTION - reject the date and time proposed by Equinix. The expedite is cancelled and the Cross Connect is scheduled as STANDARD.
XC_CANCEL - cancel the Cross Connect before it is provisioned.
XC_DEINSTALL - remove a provisioned Cross Connect. Provide the removal schedule, and optionally the services, the notification contacts and the order details, in data.
XC_INFORMATION_UPDATE - provide the requested information as a note and an attachment. - example: XC_SIGNATURE_SUBMISSION enum: - XC_SIGNATURE_SUBMISSION - XC_PROPOSED_DATE_TIME_ACCEPTANCE @@ -35871,36 +67765,72 @@ components: - XC_CANCEL - XC_DEINSTALL - XC_INFORMATION_UPDATE + example: XC_SIGNATURE_SUBMISSION + CrossConnectASideDemarcationPoint: + description: | + A-Side demarcation point.
cageUniqueSpaceId and cabinetUniqueSpaceId identify the A-Side space. + allOf: + - $ref: '#/components/schemas/CrossConnectDemarcationPoint' + - type: object + properties: + cageUniqueSpaceId: + type: string + readOnly: true + description: Unique identifier of the Cage. + example: SV1:00:000000 + cabinetUniqueSpaceId: + type: string + readOnly: true + description: Unique identifier of the Cabinet. + example: SV1:00:000000:0100 CrossConnectASideResponse: title: CrossConnectASideResponse + description: A-Side connection details. type: object properties: demarcationPoint: - $ref: "#/components/schemas/CrossConnectASideDemarcationPoint" + $ref: '#/components/schemas/CrossConnectASideDemarcationPoint' location: - $ref: "#/components/schemas/CrossConnectLocation" - description: A-Side connection details. + $ref: '#/components/schemas/CrossConnectLocation' + CrossConnectZSideResponseDemarcationPoint: + description: | + Z-Side demarcation point.
cageUniqueSpaceId and cabinetUniqueSpaceId identify the Z-Side space. + allOf: + - $ref: '#/components/schemas/CrossConnectDemarcationPoint' + - type: object + properties: + cageUniqueSpaceId: + type: string + readOnly: true + description: Unique identifier of the Cage. + example: SV2:00:000000 + cabinetUniqueSpaceId: + type: string + readOnly: true + description: Unique identifier of the Cabinet. + example: SV2:00:000000:0100 CrossConnectZSideResponse: title: CrossConnectZSideResponse + description: Z-Side connection details. type: object properties: demarcationPoint: - $ref: "#/components/schemas/CrossConnectZSideResponseDemarcationPoint" + $ref: '#/components/schemas/CrossConnectZSideResponseDemarcationPoint' location: - $ref: "#/components/schemas/CrossConnectLocation" + $ref: '#/components/schemas/CrossConnectLocation' loa: - $ref: "#/components/schemas/CrossConnectLoaRef" - description: Z-Side connection details. + $ref: '#/components/schemas/CrossConnectLoaRef' CrossConnectAccount: + description: Account the Cross Connect belongs to. type: object properties: accountNumber: type: integer - description: Account number. format: int64 + description: Account number. example: 123456 - description: Account the Cross Connect belongs to. OrderResponse: + description: Cross Connect Order. type: object properties: orderNumber: @@ -35912,241 +67842,637 @@ components: description: Order Line Item Number. example: 1-1234567890 purchaseOrder: - $ref: "#/components/schemas/PurchaseOrder" + $ref: '#/components/schemas/PurchaseOrder' customerReferenceId: type: string description: Customer Reference Identifier. - example: "12345" - description: Cross Connect Order. + example: '12345' CrossConnectLink: + description: Link to a Cross Connect sub-resource. type: object properties: href: type: string - description: Sub-resource URI. format: uri readOnly: true + description: Sub-resource URI. example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules rel: type: string - description: Operation identifier of the linked sub-resource. readOnly: true + description: Operation identifier of the linked sub-resource. example: getCrossConnectSchedulesByUuid method: type: string - description: HTTP method to use on the sub-resource. readOnly: true + description: HTTP method to use on the sub-resource. example: GET contentType: type: string - description: Content type returned by the sub-resource. readOnly: true + description: Content type returned by the sub-resource. example: application/json authenticate: type: boolean - description: Whether authentication is required. readOnly: true + description: Whether authentication is required. example: true - description: Link to a Cross Connect sub-resource. CrossConnectChangelog: + description: Cross Connect Change Log. type: object properties: createdDateTime: type: string - description: Created Date and Time. format: date-time - example: 2026-02-28T07:21:39Z + description: Created Date and Time. + example: '2026-02-28T07:21:39Z' createdBy: type: string description: User key of the user who created the resource. - example: "1234" + example: '1234' updatedDateTime: type: string - description: Updated Date and Time. format: date-time - example: 2026-02-28T07:21:39Z + description: Updated Date and Time. + example: '2026-02-28T07:21:39Z' updatedBy: type: string description: User key of the user who last updated the resource. - example: "1234" - description: Cross Connect Change Log. - DeinstallScheduleRequest: - required: - - requestedDateTime - type: object - properties: - type: - type: string - description: Schedule type. - example: XC_DEINSTALL_SCHEDULE - enum: - - XC_DEINSTALL_SCHEDULE - code: - type: string - description: | - Schedule code of the removal. Only STANDARD is supported, and it is applied when the code is omitted. - example: STANDARD - default: STANDARD - enum: - - STANDARD - requestedDateTime: - type: string - description: Requested Removal Date and Time. - format: date-time - example: 2026-06-14T17:21:25.586Z - deinstallationDateTime: - type: string - description: Deinstallation Date and Time. - format: date-time - example: 2026-06-16T17:21:25.586Z - description: Cross Connect Deinstallation Schedule. - CrossConnectScheduleResponse: + example: '1234' + CrossConnectResponse: + description: Cross Connect Response. type: object properties: href: type: string - description: Schedule URI. format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/e41f485e-3094-42de-8797-0ef19a51df79 + description: Cross Connect URI. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: + $ref: '#/components/schemas/CrossConnectType' uuid: type: string - description: Schedule Identifier. format: uuid - readOnly: true - example: e41f485e-3094-42de-8797-0ef19a51df79 - type: + description: Cross Connect Identifier. + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + name: type: string - description: | - Sub-resource type.
XC_INSTALL_SCHEDULE - Installation schedule.
XC_DEINSTALL_SCHEDULE - Deinstallation schedule. - readOnly: true - example: XC_INSTALL_SCHEDULE - enum: - - XC_INSTALL_SCHEDULE - - XC_DEINSTALL_SCHEDULE - code: - readOnly: true - allOf: - - $ref: "#/components/schemas/ScheduleType" + description: A short, descriptive name for this Cross Connect. + example: My-CC-service state: + $ref: '#/components/schemas/CrossConnectState' + allowedActions: + type: array readOnly: true - allOf: - - $ref: "#/components/schemas/CrossConnectScheduleState" - autoConvertToStandard: - type: boolean description: | - Indicates whether the Cross Connect is scheduled as STANDARD when no EXPEDITE scheduling is available. Returned only for EXPEDITE schedule. - readOnly: true - example: true - readinessDateTime: + List of actions that can be performed on the Cross Connect based on its current state. Use these values to determine which action types are valid to submit to the actions endpoint. + items: + type: object + properties: + type: + $ref: '#/components/schemas/CrossConnectActionType' + bmmrType: + $ref: '#/components/schemas/BmmrType' + mediaType: type: string - description: | - Carrier Circuit delivery date is the date when the Carrier commits to enable the circuit. Your order will be placed on hold, pending the date you enter. Equinix will wait for the Carrier to deliver the service and then will complete the installation. - format: date-time - readOnly: true - example: 2026-08-23T07:21:39Z - requestedDateTime: + description: Media type of the Cross Connect. + example: SINGLE_MODE_FIBER + mediaSubType: type: string - description: Requested Installation Date and Time. - format: date-time - readOnly: true - example: 2026-08-24T07:21:39Z - equinixProposedDateTime: + description: Media sub-type of the Cross Connect. + example: SINGLE_MODE_FIBER + circuitId: type: string - description: | - Date and Time proposed by Equinix when the EXPEDITE schedule is not available. - format: date-time - readOnly: true - example: 2026-08-25T07:21:39Z - installationDateTime: + description: Circuit identifier of the Cross Connect. + serialNumber: type: string - description: Installation Date and Time. - format: date-time readOnly: true - example: 2026-08-25T09:21:39Z - deinstallationDateTime: - type: string - description: Deinstallation Date and Time. Returned for a removal schedule. - format: date-time + description: Serial number of the Cross Connect. + example: '234567890' + redundancy: + $ref: '#/components/schemas/CrossConnectRedundancy' + aSide: + $ref: '#/components/schemas/CrossConnectASideResponse' + zSide: + $ref: '#/components/schemas/CrossConnectZSideResponse' + account: + $ref: '#/components/schemas/CrossConnectAccount' + notifications: + type: array + items: + $ref: '#/components/schemas/CrossConnectNotification' + description: | + Preferences for notifications on Cross Connect configuration or status changes. + order: + $ref: '#/components/schemas/OrderResponse' + links: + type: array readOnly: true - example: 2026-09-16T17:21:25.586Z + description: | + Links to the Cross Connect sub-resources - schedules, services, notes and attachments. + items: + $ref: '#/components/schemas/CrossConnectLink' changeLog: - $ref: "#/components/schemas/CrossConnectChangelog" + $ref: '#/components/schemas/CrossConnectChangelog' + DiverseCrossConnectRequest: + title: DiverseCrossConnectRequest + description: | + Request to create several Cross Connects in a single order. Use it to order a diverse pair - one PRIMARY and one SECONDARY entry provisioned at the same time on separate paths - or to order multiple Cross Connects at once by sending one entry per Cross Connect. + type: object + properties: + data: + type: array + minItems: 1 + description: | + For a diverse pair, send two entries - one with redundancy.priority PRIMARY and one with SECONDARY - and omit redundancy.group, which Equinix assigns. + items: + $ref: '#/components/schemas/CreateCrossConnect' + required: + - data + CrossConnectDiverse: + title: CrossConnectDiverse + description: | + Cross Connects returned by a diverse order. One item is returned per Cross Connect requested; a diverse pair returns the PRIMARY and the SECONDARY Cross Connect sharing one redundancy group. + type: object + properties: + data: + type: array + description: The Cross Connects the diverse order applies to. + items: + $ref: '#/components/schemas/CrossConnectResponse' + CrossConnectFieldName: + description: Possible field names to use on filters. + type: string + enum: + - /uuid + - /name + - /type + - /state + - /bmmrType + - /circuitId + - /serialNumber + - /redundancy/group + - /redundancy/priority + - /aSide/demarcationPoint/patchPanelId + - /aSide/demarcationPoint/patchPanelPortA + - /aSide/demarcationPoint/patchPanelPortB + - /aSide/location/ibxCode + - /zSide/demarcationPoint/patchPanelId + - /zSide/demarcationPoint/patchPanelPortA + - /zSide/demarcationPoint/patchPanelPortB + - /zSide/location/ibxCode + - /zSide/loa/uuid + - /account/accountNumber + - /order/orderNumber + - /order/customerReferenceId + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + example: /name + CrossConnectSearchSimpleExpressions: + type: object + properties: + property: + $ref: '#/components/schemas/CrossConnectFieldName' + operator: + type: string + enum: + - '=' + - '!=' + - LIKE + - ILIKE + - BETWEEN + - NOT BETWEEN + - IN + - NOT IN + - '>' + - < + - '>=' + - <= + example: '=' + values: + type: array + items: + type: string + example: + - My-CC-service + CrossConnectOrFilter: + type: object + properties: + or: + type: array + items: + $ref: '#/components/schemas/CrossConnectSearchSimpleExpressions' + CrossConnectFilter: + type: object + anyOf: + - $ref: '#/components/schemas/CrossConnectSearchSimpleExpressions' + - $ref: '#/components/schemas/CrossConnectOrFilter' + CrossConnectSearchFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/CrossConnectFilter' + CrossConnectSortCriteria: + type: object + properties: + direction: + description: Sorting direction. + default: DESC + type: string + enum: + - DESC + - ASC + property: + description: Possible field names to use on sorting. + default: /changeLog/updatedDateTime + type: string + enum: + - /name + - /state + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + CrossConnectSearchRequest: + type: object + description: Search Cross Connects based on filter criteria. + properties: + filter: + $ref: '#/components/schemas/CrossConnectSearchFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/CrossConnectSortCriteria' + CrossConnectSearchResponse: + description: List of Cross Connects. + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/CrossConnectSortCriteria' + data: + type: array + items: + $ref: '#/components/schemas/CrossConnectResponse' + CrossConnectScheduleState: + description: Cross Connect Schedule State. + type: string + enum: + - PENDING + - COMPLETED + - FAILED + - CANCELLED + - PENDING_ACTION + example: COMPLETED + CrossConnectScheduleResponse: description: Schedule of a Cross Connect. - CrossConnectServiceResponse: type: object properties: href: type: string - description: Service URI. format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/e41f485e-3094-42de-8797-0ef19a51df79 + description: Schedule URI. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/e41f485e-3094-42de-8797-0ef19a51df79 uuid: type: string - description: Service Identifier. format: uuid readOnly: true + description: Schedule Identifier. example: e41f485e-3094-42de-8797-0ef19a51df79 type: + type: string readOnly: true + description: | + Sub-resource type.
XC_INSTALL_SCHEDULE - Installation schedule.
XC_DEINSTALL_SCHEDULE - Deinstallation schedule. + enum: + - XC_INSTALL_SCHEDULE + - XC_DEINSTALL_SCHEDULE + example: XC_INSTALL_SCHEDULE + code: allOf: - - $ref: "#/components/schemas/CrossConnectServiceType" + - $ref: '#/components/schemas/ScheduleType' + readOnly: true state: + allOf: + - $ref: '#/components/schemas/CrossConnectScheduleState' + readOnly: true + autoConvertToStandard: + type: boolean + readOnly: true + description: | + Indicates whether the Cross Connect is scheduled as STANDARD when no EXPEDITE scheduling is available. Returned only for EXPEDITE schedule. + example: true + readinessDateTime: + type: string + format: date-time + readOnly: true + description: | + Carrier Circuit delivery date is the date when the Carrier commits to enable the circuit. Your order will be placed on hold, pending the date you enter. Equinix will wait for the Carrier to deliver the service and then will complete the installation. + example: '2026-08-23T07:21:39Z' + requestedDateTime: + type: string + format: date-time + readOnly: true + description: Requested Installation Date and Time. + example: '2026-08-24T07:21:39Z' + equinixProposedDateTime: + type: string + format: date-time + readOnly: true + description: | + Date and Time proposed by Equinix when the EXPEDITE schedule is not available. + example: '2026-08-25T07:21:39Z' + installationDateTime: + type: string + format: date-time + readOnly: true + description: Installation Date and Time. + example: '2026-08-25T09:21:39Z' + deinstallationDateTime: + type: string + format: date-time + readOnly: true + description: Deinstallation Date and Time. Returned for a removal schedule. + example: '2026-09-16T17:21:25.586Z' + changeLog: + $ref: '#/components/schemas/CrossConnectChangelog' + SchedulesResponse: + description: Schedules of the Cross Connect. + type: object + properties: + data: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectScheduleResponse' + CrossConnectServiceState: + description: Service status. + type: string + enum: + - PENDING + - COMPLETED + - FAILED + example: COMPLETED + PatchEquipmentResponse: + description: Patch equipment installed for the Cross Connect. + type: object + properties: + cabinetUniqueSpaceId: + type: string + description: Unique identifier of the Cabinet. + example: SV2:00:000000:0100 + port: + type: integer + description: Port number. + example: 32 + connectorType: + $ref: '#/components/schemas/CrossConnectConnectorType' + CrossConnectServiceResponse: + description: Service ordered alongside the Cross Connect. + type: object + properties: + href: + type: string + format: uri + readOnly: true + description: Service URI. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: + type: string + format: uuid readOnly: true + description: Service Identifier. + example: e41f485e-3094-42de-8797-0ef19a51df79 + type: allOf: - - $ref: "#/components/schemas/CrossConnectServiceState" - device: - description: Patch equipment device details. Returned for the XC_PATCH_EQUIPMENT service. + - $ref: '#/components/schemas/CrossConnectServiceType' readOnly: true + state: + allOf: + - $ref: '#/components/schemas/CrossConnectServiceState' + readOnly: true + device: allOf: - - $ref: "#/components/schemas/PatchEquipmentResponse" + - $ref: '#/components/schemas/PatchEquipmentResponse' + readOnly: true + description: Patch equipment device details. Returned for the XC_PATCH_EQUIPMENT service. description: - maxLength: 100 type: string - description: Additional notes captured for the service. readOnly: true + description: Additional notes captured for the service. example: additional notes for patch equipment + maxLength: 100 changeLog: - $ref: "#/components/schemas/CrossConnectChangelog" - description: Service ordered alongside the Cross Connect. + $ref: '#/components/schemas/CrossConnectChangelog' + CrossConnectServicesResponse: + description: List of services ordered alongside the Cross Connect. + type: object + properties: + data: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectServiceResponse' + CrossConnectAttachmentResponse: + description: Document attached to a Cross Connect. + type: object + properties: + href: + type: string + format: uri + readOnly: true + description: URI to the attachment resource. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: + type: string + format: uuid + readOnly: true + description: Attachment resource Identifier. + example: e41f485e-3094-42de-8797-0ef19a51df79 + type: + type: string + readOnly: true + description: Sub-resource type. + enum: + - ATTACHMENT + example: ATTACHMENT + source: + type: string + readOnly: true + description: Attachment Source. + enum: + - CUSTOMER + - EQUINIX + example: CUSTOMER + attachmentId: + type: string + format: uuid + readOnly: true + description: Attachment Identifier. + example: a11f485e-3094-42de-8797-0ef19a51df79 + downloadHref: + type: string + format: uri + readOnly: true + description: | + URI to download the attachment file content from the Equinix attachment service. + example: https://api.equinix.com/ecp/attachments/a11f485e-3094-42de-8797-0ef19a51df79 + changeLog: + $ref: '#/components/schemas/CrossConnectChangelog' + CrossConnectAttachmentsResponse: + description: List of documents attached to the Cross Connect. + type: object + properties: + data: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectAttachmentResponse' CrossConnectParentNote: + description: Note that this note is responding to. + type: object + properties: + href: + type: string + format: uri + readOnly: true + description: Parent note URI. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: + type: string + format: uuid + description: Parent note UUID. + example: e41f485e-3094-42de-8797-0ef19a51df79 required: - uuid + CrossConnectNoteResponse: + description: Cross Connect Note. type: object properties: href: type: string - description: Parent note URI. format: uri readOnly: true + description: Note URI. example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 uuid: type: string - description: Parent note UUID. format: uuid + readOnly: true + description: Note Identifier. example: e41f485e-3094-42de-8797-0ef19a51df79 - description: Note that this note is responding to. + type: + type: string + readOnly: true + description: Sub-resource type. + enum: + - NOTE + example: NOTE + source: + type: string + readOnly: true + description: Party that added the note. + enum: + - CUSTOMER + - EQUINIX + example: CUSTOMER + comments: + type: string + readOnly: true + description: Note comments. + example: this is reply to the technician note. + maxLength: 4000 + parentNote: + allOf: + - $ref: '#/components/schemas/CrossConnectParentNote' + readOnly: true + description: | + The note this note is responding to. Returned when the note was added in response to an Equinix note. + changeLog: + $ref: '#/components/schemas/CrossConnectChangelog' + CrossConnectNotesResponse: + description: List of notes added to the Cross Connect. + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectNoteResponse' + CrossConnectActionNote: + description: Note supplied by the customer when responding to an action. + type: object + properties: + parentNote: + $ref: '#/components/schemas/CrossConnectParentNote' + comments: + type: string + description: Note comments. + example: Please proceed + maxLength: 4000 + required: + - comments + DeinstallScheduleRequest: + description: Cross Connect Deinstallation Schedule. + type: object + properties: + type: + type: string + description: Schedule type. + enum: + - XC_DEINSTALL_SCHEDULE + example: XC_DEINSTALL_SCHEDULE + code: + type: string + description: | + Schedule code of the removal. Only STANDARD is supported, and it is applied when the code is omitted. + enum: + - STANDARD + default: STANDARD + example: STANDARD + requestedDateTime: + type: string + format: date-time + description: Requested Removal Date and Time. + example: '2026-06-14T17:21:25.586Z' + deinstallationDateTime: + type: string + format: date-time + description: Deinstallation Date and Time. + example: '2026-06-16T17:21:25.586Z' + required: + - requestedDateTime CrossConnectActionData: + description: | + Action Data.
notes and attachments are applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.
schedule is required for XC_DEINSTALL, where liveTrafficConsentProvided, services, notifications and order are applicable.
Not applicable to the other action types. type: object properties: notes: - maxItems: 1 type: array - description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. + maxItems: 1 items: - $ref: "#/components/schemas/CrossConnectActionNote" + $ref: '#/components/schemas/CrossConnectActionNote' + description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. attachments: - maxItems: 5 type: array - description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. + maxItems: 5 items: - $ref: "#/components/schemas/CrossConnectAttachment" + $ref: '#/components/schemas/CrossConnectAttachment' + description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. schedule: + allOf: + - $ref: '#/components/schemas/DeinstallScheduleRequest' description: | Removal schedule. Required for XC_DEINSTALL - the requestedDateTime is mandatory and only the STANDARD schedule type is supported. - allOf: - - $ref: "#/components/schemas/DeinstallScheduleRequest" liveTrafficConsentProvided: type: boolean description: | @@ -36154,141 +68480,465 @@ components: example: true services: type: array + items: + $ref: '#/components/schemas/CrossConnectServiceRequest' description: | Applicable for XC_DEINSTALL. Only XC_PATCH_EQUIPMENT is supported for deinstall. - items: - $ref: "#/components/schemas/CrossConnectServiceRequest" notifications: type: array + items: + $ref: '#/components/schemas/CrossConnectNotification' description: | Applicable for XC_DEINSTALL. The contacts are appended to the ones already held on the Cross Connect. - items: - $ref: "#/components/schemas/CrossConnectNotification" order: + allOf: + - $ref: '#/components/schemas/OrderRequest' description: | Applicable for XC_DEINSTALL. The purchase order and the customer reference identifier replace the ones already held on the Cross Connect. - allOf: - - $ref: "#/components/schemas/OrderRequest" - description: | - Action Data.
notes and attachments are applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.
schedule is required for XC_DEINSTALL, where liveTrafficConsentProvided, services, notifications and order are applicable.
Not applicable to the other action types. + CrossConnectActionRequest: + description: Cross Connect Action Request. + type: object + properties: + type: + $ref: '#/components/schemas/CrossConnectActionType' + data: + $ref: '#/components/schemas/CrossConnectActionData' + required: + - type CrossConnectActionState: - type: string description: Cross Connect Action State. - example: COMPLETED + type: string enum: - PENDING - COMPLETED - FAILED - CrossConnectActionResponseData: + example: COMPLETED + CrossConnectActionNoteResponse: + description: Note the action applies to. type: object properties: - notes: - maxItems: 1 - type: array - description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. - readOnly: true - items: - $ref: "#/components/schemas/CrossConnectActionNoteResponse" - attachments: - maxItems: 5 - type: array - description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. + href: + type: string + format: uri readOnly: true - items: - $ref: "#/components/schemas/CrossConnectActionAttachmentResponse" - schedule: - description: Applicable for XC_DEINSTALL. + description: Note URI. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: + type: string + format: uuid readOnly: true + description: Note Identifier. + example: e41f485e-3094-42de-8797-0ef19a51df79 + parentNote: allOf: - - $ref: "#/components/schemas/CrossConnectScheduleResponse" - liveTrafficConsentProvided: - type: boolean - description: | - Applicable for XC_DEINSTALL. Confirms the customer consents to the removal even though the Cross Connect may still be carrying live traffic. + - $ref: '#/components/schemas/CrossConnectParentNote' readOnly: true - example: true - services: - type: array description: | - Applicable for XC_DEINSTALL. Only XC_PATCH_EQUIPMENT is supported for deinstall. + The note this note is responding to. Returned when the note was added in response to an Equinix note. + comments: + type: string readOnly: true - items: - $ref: "#/components/schemas/CrossConnectServiceResponse" - notifications: - type: array - description: | - Applicable for XC_DEINSTALL. The contacts are appended to the ones already held on the Cross Connect. + description: Note comments. + example: Please proceed + maxLength: 4000 + CrossConnectActionAttachmentResponse: + description: Document the action applies to. + type: object + properties: + href: + type: string + format: uri readOnly: true - items: - $ref: "#/components/schemas/CrossConnectNotification" + description: URI to the attachment resource. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: + type: string + format: uuid + readOnly: true + description: Attachment resource Identifier. + example: e41f485e-3094-42de-8797-0ef19a51df79 + attachmentId: + type: string + format: uuid + readOnly: true + description: Attachment Identifier. + example: a11f485e-3094-42de-8797-0ef19a51df79 + CrossConnectActionResponseData: + description: | + Action Data.
notes and attachments are applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.
schedule, services, liveTrafficConsentProvided, notifications and order are applicable for XC_DEINSTALL.
Each schedule, service, note and attachment carries the href and the uuid of the sub-resource it refers to.
Not applicable to the other action types. + type: object + properties: + notes: + type: array + maxItems: 1 + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectActionNoteResponse' + description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. + attachments: + type: array + maxItems: 5 + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectActionAttachmentResponse' + description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. + schedule: + allOf: + - $ref: '#/components/schemas/CrossConnectScheduleResponse' + readOnly: true + description: Applicable for XC_DEINSTALL. + liveTrafficConsentProvided: + type: boolean + readOnly: true + description: | + Applicable for XC_DEINSTALL. Confirms the customer consents to the removal even though the Cross Connect may still be carrying live traffic. + example: true + services: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectServiceResponse' + description: | + Applicable for XC_DEINSTALL. Only XC_PATCH_EQUIPMENT is supported for deinstall. + notifications: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectNotification' + description: | + Applicable for XC_DEINSTALL. The contacts are appended to the ones already held on the Cross Connect. order: + allOf: + - $ref: '#/components/schemas/OrderResponse' + readOnly: true description: | Applicable for XC_DEINSTALL. The purchase order and the customer reference identifier replace the ones already held on the Cross Connect. + CrossConnectActionResponse: + description: Cross Connect Action Response. + type: object + properties: + href: + type: string + format: uri + readOnly: true + description: Action URI. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: + type: string + format: uuid readOnly: true + description: Action Identifier. + example: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: allOf: - - $ref: "#/components/schemas/OrderResponse" - description: | - Action Data.
notes and attachments are applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.
schedule, services, liveTrafficConsentProvided, notifications and order are applicable for XC_DEINSTALL.
Each schedule, service, note and attachment carries the href and the uuid of the sub-resource it refers to.
Not applicable to the other action types. + - $ref: '#/components/schemas/CrossConnectActionType' + readOnly: true + state: + allOf: + - $ref: '#/components/schemas/CrossConnectActionState' + readOnly: true + data: + allOf: + - $ref: '#/components/schemas/CrossConnectActionResponseData' + readOnly: true + changeLog: + allOf: + - $ref: '#/components/schemas/CrossConnectChangelog' + readOnly: true + CrossConnectActionFieldName: + description: Possible field names to use on filters. + type: string + enum: + - /type + - /state + - /uuid + CrossConnectActionSearchSimpleExpressions: + type: object + properties: + property: + $ref: '#/components/schemas/CrossConnectActionFieldName' + operator: + type: string + enum: + - '=' + - '!=' + - LIKE + - ILIKE + - BETWEEN + - NOT BETWEEN + - IN + - NOT IN + - '>' + - < + - '>=' + - <= + values: + type: array + items: + type: string + example: XC_SIGNATURE_SUBMISSION + CrossConnectActionOrFilter: + type: object + properties: + or: + type: array + items: + $ref: '#/components/schemas/CrossConnectActionSearchSimpleExpressions' + CrossConnectActionFilter: + type: object + anyOf: + - $ref: '#/components/schemas/CrossConnectActionSearchSimpleExpressions' + - $ref: '#/components/schemas/CrossConnectActionOrFilter' + CrossConnectActionSearchFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/CrossConnectActionFilter' + CrossConnectActionSortCriteria: + type: object + properties: + direction: + description: Sorting direction. + default: DESC + type: string + enum: + - DESC + - ASC + property: + description: Possible field names to use on sorting. + default: /changeLog/createdDateTime + type: string + enum: + - /changeLog/createdDateTime + CrossConnectActionSearchRequest: + type: object + description: Search Cross Connect actions based on filter criteria. + properties: + filter: + $ref: '#/components/schemas/CrossConnectActionSearchFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/CrossConnectActionSortCriteria' + CrossConnectActionSearchResponse: + description: List of Cross Connect Actions. + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/CrossConnectActionSortCriteria' + data: + type: array + items: + $ref: '#/components/schemas/CrossConnectActionResponse' + CrossConnectScheduleFieldName: + description: Possible field names to use on filters. + type: string + enum: + - /type + - /code + - /aSide/location/ibxCode + - /zSide/location/ibxCode + example: /aSide/location/ibxCode + CrossConnectScheduleSearchSimpleExpressions: + type: object + properties: + property: + $ref: '#/components/schemas/CrossConnectScheduleFieldName' + operator: + type: string + enum: + - '=' + - '!=' + - IN + - NOT IN + example: '=' + values: + type: array + items: + type: string + example: + - SV11 + CrossConnectScheduleSearchFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/CrossConnectScheduleSearchSimpleExpressions' + CrossConnectScheduleSortCriteria: + type: object + properties: + direction: + description: Sorting direction. + default: DESC + type: string + enum: + - DESC + - ASC + property: + description: Possible field names to use on sorting. + default: /startDateTime + type: string + enum: + - /code + - /startDateTime + - /endDateTime + CrossConnectScheduleSearchRequest: + type: object + description: Search Cross Connect schedules based on filter criteria. + properties: + filter: + $ref: '#/components/schemas/CrossConnectScheduleSearchFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/CrossConnectScheduleSortCriteria' CrossConnectScheduleAvailability: + description: Cross Connect schedule window offered at an IBX. type: object properties: href: type: string - description: Schedule URI. format: uri readOnly: true + description: Schedule URI. example: https://api.equinix.com/fabric/v4/crossConnectSchedules/EXPEDITE type: type: string + readOnly: true description: | Sub-resource type.
XC_INSTALL_SCHEDULE - Installation schedule windows. - readOnly: true - example: XC_INSTALL_SCHEDULE enum: - XC_INSTALL_SCHEDULE + example: XC_INSTALL_SCHEDULE code: - readOnly: true allOf: - - $ref: "#/components/schemas/ScheduleType" + - $ref: '#/components/schemas/ScheduleType' + readOnly: true aSide: - $ref: "#/components/schemas/CrossConnectScheduleAvailability_aSide" + type: object + readOnly: true + description: A-Side of the schedule window. + properties: + location: + $ref: '#/components/schemas/CrossConnectLocation' zSide: - $ref: "#/components/schemas/CrossConnectScheduleAvailability_zSide" + type: object + readOnly: true + description: Z-Side of the schedule window. + properties: + location: + $ref: '#/components/schemas/CrossConnectLocation' startDateTime: type: string - description: Start of the schedule window. format: date-time readOnly: true - example: 2026-03-05T17:00:00Z + description: Start of the schedule window. + example: '2026-03-05T17:00:00Z' endDateTime: type: string - description: End of the schedule window. format: date-time readOnly: true - example: 2026-03-10T17:24:00Z + description: End of the schedule window. + example: '2026-03-10T17:24:00Z' unavailableDates: type: array + readOnly: true description: | Dates within the schedule window when the IBX is unavailable, such as the holidays observed at the IBX. - readOnly: true items: type: string format: date - example: 2026-03-07 - description: Cross Connect schedule window offered at an IBX. + example: '2026-03-07' + SearchSchedulesResponse: + description: List of Cross Connect schedule windows offered at an IBX. + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/CrossConnectScheduleSortCriteria' + data: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectScheduleAvailability' + TagRequest: + description: Equinix Fabric Tag Request Object + type: object + required: + - type + - displayName + properties: + type: + type: string + description: Type of tag + example: PREDEFINED_TAG + displayName: + type: string + minLength: 1 + maxLength: 24 + description: Display name of the Tag + example: LLM + notifications: + example: + - type: NOTIFICATION + emails: + - example1@example.com + - example2@example.com + type: array + items: + $ref: '#/components/schemas/SimplifiedNotification' AppDomainType: - type: string description: App Domain Type - example: APP_DOMAIN - default: APP_DOMAIN + type: string enum: - APP_DOMAIN + default: APP_DOMAIN + example: APP_DOMAIN x-order: 2 + AppDomainPostRequest: + type: object + description: Create App Domain + properties: + type: + $ref: '#/components/schemas/AppDomainType' + name: + description: Customer-provided App Domain name + type: string + format: string + minLength: 1 + maxLength: 50 + example: atlassian.net + description: + description: Customer-provided App Domain description + type: string + format: string + example: Atlassian Domain + project: + $ref: '#/components/schemas/Project' + required: + - type + - name + - project AppDomainState: - type: string description: App Domain lifecycle state + type: string format: string - example: PENDING_VERIFICATION enum: - PENDING_VERIFICATION - PROVISIONING_FAILED @@ -36296,31968 +68946,2468 @@ components: - DEPROVISIONING - DEPROVISIONING_FAILED - DEPROVISIONED + example: PENDING_VERIFICATION x-order: 6 - AppDomainChange: + AppDomainChangeOperation: + description: App Domain change operation data + type: object + properties: + op: + description: operation type applied to the resource + type: string + enum: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter + type: string + enum: + - /description + value: + description: new value for updated parameter + x-go-type: json.RawMessage required: - - type - - updatedDateTime + - op + - path + - value + AppDomainChange: + description: Current state of latest AppDomain change type: object properties: uuid: - type: string description: Uniquely identifies a change - type: type: string + type: description: Type of change + type: string enum: - APP_DOMAIN_UPDATE status: - type: string description: Current outcome of the change flow + type: string enum: - COMPLETED - FAILED - REQUESTED createdDateTime: - type: string description: Set when change flow starts + type: string format: date-time - example: 2026-06-29T07:00:00Z + example: '2026-06-29T07:00:00Z' updatedDateTime: - type: string description: Set when change object is updated + type: string format: date-time - example: 2026-06-29T07:15:00Z + example: '2026-06-29T07:15:00Z' data: type: array items: - $ref: "#/components/schemas/AppDomainChangeOperation" - description: Current state of latest AppDomain change - AppDomainChangeOperation: - required: - - op - - path - - value - type: object - properties: - op: - type: string - description: operation type applied to the resource - enum: - - replace - - add - - remove - path: - type: string - description: path inside document leading to updated parameter - enum: - - /description - value: - type: object - description: new value for updated parameter - x-go-type: json.RawMessage - description: App Domain change operation data - AppLinkState: - type: string - description: App Link lifecycle state - format: string - example: PROVISIONING - enum: - - PROVISIONING - - PROVISIONING_FAILED - - PROVISIONED - - DEPROVISIONING - - DEPROVISIONING_FAILED - - DEPROVISIONED - - REPROVISIONING - x-order: 6 - AppDomainAttachedAppLink: + $ref: '#/components/schemas/AppDomainChangeOperation' required: - type - - uuid + - updatedDateTime + AppDomain: + description: App Domain object type: object properties: href: - type: string description: Resource URI + type: string format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + example: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 x-order: 1 type: - $ref: "#/components/schemas/AppLinkType" + $ref: '#/components/schemas/AppDomainType' uuid: - type: string description: Equinix-assigned access point identifier + type: string format: uuid - example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 x-order: 3 name: + description: Customer-provided App Domain name type: string - description: Customer-provided App Link name format: string - example: Atlassian App Link + example: atlassian.net x-order: 4 description: + description: Customer-provided App Domain description type: string - description: Customer-provided App Link description format: string - example: Atlassian App Link in SV + example: Atlassian Domain x-order: 5 state: - $ref: "#/components/schemas/AppLinkState" - router: - $ref: "#/components/schemas/AppLinkCloudRouter" - ipv4Subnet: - type: string - description: Customer-provided IP subnet for AppLink setup (/29 or larger subnet) - example: 192.168.10.0/29 - x-order: 8 - ipv4Address: - type: string - description: App Link IP address - format: ipv4 - example: 192.168.10.1 - x-order: 9 - bandwidth: - type: integer - description: App Link aggregated data transfer capacity in Mbps - example: 1000 - x-order: 10 + $ref: '#/components/schemas/AppDomainState' project: - $ref: "#/components/schemas/Project" - description: App Link object - AppLinkType: - type: string - description: App Link Type - example: APP_LINK - default: APP_LINK - enum: - - APP_LINK - x-order: 2 - AppLinkPostRequestRouter: - required: - - uuid - type: object - properties: - uuid: - type: string - description: Cloud Router UUID - format: uuid - example: 36204584-2ae1-44f6-980f-08ecd555d9c6 - description: Cloud Router reference for App Link - AppLinkCloudRouter: - type: object - properties: - href: - type: string - description: Resource URI - format: uri - example: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - x-order: 1 - type: - type: string - description: Cloud Router Type - example: XF_ROUTER - enum: - - XF_ROUTER - x-order: 2 - uuid: - type: string - description: Cloud Router UUID - format: uuid - example: 36204584-2ae1-44f6-980f-08ecd555d9c6 - x-order: 3 - description: App Link Cloud Router - x-order: 7 - AppLinkChange: + $ref: '#/components/schemas/Project' + changeLog: + $ref: '#/components/schemas/Changelog' + change: + $ref: '#/components/schemas/AppDomainChange' required: - type - - updatedDateTime + - name + - project + AppDomainUpdateRequest: + description: App Domain Update Request + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/AppDomainChangeOperation' + AppDomainSimpleExpression: type: object properties: - uuid: + property: + description: | + Possible field names to use on filters: + * `/project/projectId` - project id + * `/uuid` - App Domain uuid + * `/name` - App Domain name + * `/description` - App Domain description + * `/state` - App Domain status + * `/changeLog/createdDateTime` - App Domain creation timestamp + * `/changeLog/updatedDateTime` - App Domain last updated timestamp + * `/changeLog/deletedDateTime` - App Domain deletion timestamp type: string - description: Uniquely identifies a change - type: + example: /name + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `>` - greater than + * `<` - less than + * `IN` - in + * `NOT IN` - not in + * `LIKE` - like + * `ILIKE` - case-insensitive like + * `BETWEEN` - between + * `NOT BETWEEN` - not between type: string - description: Type of change - enum: - - APP_LINK_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: 2026-06-29T07:00:00Z - updatedDateTime: - type: string - description: Set when change object is updated - format: date-time - example: 2026-06-29T07:15:00Z - data: + example: '=' + values: type: array items: - $ref: "#/components/schemas/AppLinkChangeOperation" - description: Current state of latest AppLink change - AppLinkChangeOperation: - required: - - op - - path - - value + type: string + example: Gateway + AppDomainOrFilter: type: object properties: - op: - type: string - description: operation type applied to the resource - enum: - - replace - - add - - remove - path: - type: string - description: path inside document leading to updated parameter - enum: - - /name - - /description - - /bandwidth - - /ipv4Subnet - value: - type: object - description: new value for updated parameter - x-go-type: json.RawMessage - description: App Link change operation data - AppLinkAttachState: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppDomainSimpleExpression' + AppDomainFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppDomainSimpleExpression' + - $ref: '#/components/schemas/AppDomainOrFilter' + AppDomainFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/AppDomainFilter' + AppDomainSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + AppDomainSortBy: + description: | + Possible field names to use on '400_InvalidSorting': + * `/name` - App Domain name + * `/uuid` - App Domain uuid + * `/state` - App Domain status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime + type: string + format: string + example: /changeLog/updatedDateTime + AppDomainSortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/AppDomainSortDirection' + property: + $ref: '#/components/schemas/AppDomainSortBy' + AppDomainSearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/AppDomainFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppDomainSortCriteria' + AppDomainSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppDomain' + AppLinkState: + description: App Link lifecycle state type: string - description: App Link attachment lifecycle state format: string - example: ATTACHED enum: - - ATTACHING - - ATTACHING_FAILED - - ATTACHED - - DETACHING - - DETACHING_FAILED - - DETACHED - - REATTACHING - - REATTACHING_FAILED - x-order: 10 - AppLinkAttachedAppDomain: - required: - - type - - uuid + - PROVISIONING + - PROVISIONING_FAILED + - PROVISIONED + - DEPROVISIONING + - DEPROVISIONING_FAILED + - DEPROVISIONED + - REPROVISIONING + example: PROVISIONING + x-order: 6 + AttachedAppLinkState: + description: Filter attached App Links by lifecycle state. + type: array + items: + $ref: '#/components/schemas/AppLinkState' + example: + - PROVISIONED + - PROVISIONING + AttachedAppLinkOrder: + description: Sort order for attached App Links. + type: string + enum: + - DESC + - ASC + default: DESC + example: DESC + Style: + description: Detail level of the response. + type: string + enum: + - MIN + - MEDIUM + - FULL + default: MEDIUM + example: MEDIUM + AppLinkType: + description: App Link Type + type: string + enum: + - APP_LINK + default: APP_LINK + example: APP_LINK + x-order: 2 + AppLinkCloudRouter: + description: App Link Cloud Router type: object + x-order: 7 properties: href: + description: Resource URI + type: string + format: uri + example: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + x-order: 1 + type: + type: string + description: Cloud Router Type + enum: + - XF_ROUTER + example: XF_ROUTER + x-order: 2 + uuid: type: string + description: Cloud Router UUID + format: uuid + example: 36204584-2ae1-44f6-980f-08ecd555d9c6 + x-order: 3 + AppDomainAttachedAppLink: + description: App Link object + type: object + properties: + href: description: Resource URI + type: string format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + example: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 x-order: 1 type: - $ref: "#/components/schemas/AppDomainType" + $ref: '#/components/schemas/AppLinkType' uuid: - type: string description: Equinix-assigned access point identifier + type: string format: uuid - example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 x-order: 3 name: + description: Customer-provided App Link name type: string - description: Customer-provided App Domain name format: string - example: atlassian.net + example: Atlassian App Link x-order: 4 description: + description: Customer-provided App Link description type: string - description: Customer-provided App Domain description format: string - example: Atlassian Domain + example: Atlassian App Link in SV x-order: 5 state: - $ref: "#/components/schemas/AppDomainState" + $ref: '#/components/schemas/AppLinkState' + router: + $ref: '#/components/schemas/AppLinkCloudRouter' + ipv4Subnet: + description: Customer-provided IP subnet for AppLink setup (/29 or larger subnet) + type: string + example: 192.168.10.0/29 + x-order: 8 + ipv4Address: + description: App Link IP address + type: string + format: ipv4 + example: 192.168.10.1 + x-order: 9 + bandwidth: + description: App Link aggregated data transfer capacity in Mbps + type: integer + example: 1000 + x-order: 10 project: - $ref: "#/components/schemas/Project" - attachmentStatus: - $ref: "#/components/schemas/AppLinkAttachState" - description: App Domain object associated with App Link - AppServiceType: - type: string - description: App Service Type - example: APP_SERVICE - default: APP_SERVICE - enum: - - APP_SERVICE - x-order: 2 - AppLinkAppServiceAttachmentChange: + $ref: '#/components/schemas/Project' required: - type - - updatedDateTime + - uuid + AppDomainAttachedAppLinks: type: object properties: - uuid: - type: string - description: Uniquely identifies a change - type: - type: string - description: Type of change - enum: - - APP_SERVICE_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: 2026-06-29T07:00:00Z - updatedDateTime: - type: string - description: Set when change object is updated - format: date-time - example: 2026-06-29T07:15:00Z + pagination: + $ref: '#/components/schemas/Pagination' data: + description: Data returned from the API call. type: array items: - $ref: "#/components/schemas/AppLinkChangeOperation" - description: Current state of latest AppLink change - AppLinkAppServiceAttachmentChangeOperation: - required: - - op - - path - - value + $ref: '#/components/schemas/AppDomainAttachedAppLink' + AppLinkPostRequestRouter: type: object + description: Cloud Router reference for App Link properties: - op: - type: string - description: operation type applied to the resource - enum: - - replace - - add - - remove - path: + uuid: type: string - description: path inside document leading to updated parameter - enum: - - /destinationIp - value: - type: object - description: new value for updated parameter - x-go-type: json.RawMessage - description: App Link change operation data - AppLinkAttachedAppService: + description: Cloud Router UUID + format: uuid + example: 36204584-2ae1-44f6-980f-08ecd555d9c6 required: - - destinationIp - - geoScope - - type - uuid + AppLinkPostRequest: type: object + description: Create App Link properties: - href: - type: string - description: Resource URI - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - x-order: 1 type: - $ref: "#/components/schemas/AppServiceType" - uuid: - type: string - description: Equinix-assigned access point identifier - format: uuid - example: 5008a109-9d1c-485c-b0ba-de9736f283c2 - x-order: 3 + $ref: '#/components/schemas/AppLinkType' name: + description: Customer-provided App Link name type: string - description: Customer-provided App Service name format: string - example: Atlassian App Service - x-order: 4 + minLength: 1 + maxLength: 50 + example: Atlassian App Link description: + description: Customer-provided App Link description type: string - description: Customer-provided App Service description format: string - example: Atlassian App Service in SV - x-order: 5 - state: - $ref: "#/components/schemas/AppServiceState" - endpoint: + example: Atlassian App Link in SV + router: + $ref: '#/components/schemas/AppLinkPostRequestRouter' + ipv4Subnet: + description: Customer-provided IP subnet for AppLink setup (/29 or larger subnet) type: string - description: Accessible endpoint through this service - example: equinixjira.atlassian.net - x-order: 7 - sourceDomains: - type: array - description: List of source domains from where traffic is allowed - items: - type: string - example: equinix.com - x-order: 8 + example: 192.168.10.0/29 + bandwidth: + description: App Link aggregated data transfer capacity in Mbps + type: integer + example: 1000 project: - $ref: "#/components/schemas/Project" - geoScope: - type: string - description: Geo scope for the App Service - example: GLOBAL - x-order: 4 - destinationIp: - type: string - description: Target IP for forwarding API requests - format: ipv4 - example: 10.10.1.110 - x-order: 5 - attachmentStatus: - $ref: "#/components/schemas/AppLinkAttachState" - description: App Service object associated with App Link - AppProcessorType: - type: string - description: App Processor Type - example: APP_PROCESSOR - default: APP_PROCESSOR - enum: - - APP_PROCESSOR - x-order: 2 - AppProcessorState: - type: string - description: App Processor lifecycle state - format: string - example: PROVISIONING - enum: - - PROVISIONING - - PROVISIONING_FAILED - - PROVISIONED - - DEPROVISIONING - - DEPROVISIONING_FAILED - - DEPROVISIONED - - REPROVISIONING - x-order: 6 - AppProcessorMarketplace: - required: - - visibility - type: object - properties: - visibility: - type: string - description: App Processor marketplace visibility - format: string - example: PUBLIC - default: PUBLIC - enum: - - PUBLIC - - PRIVATE - description: App Processor marketplace settings - x-order: 8 - AppProcessorChange: + $ref: '#/components/schemas/Project' required: - type - - updatedDateTime + - name + - router + - ipv4Subnet + - bandwidth + - project + AppLinkChangeOperation: + description: App Link change operation data type: object properties: - uuid: - type: string - description: Uniquely identifies a change - type: + op: + description: operation type applied to the resource type: string - description: Type of change enum: - - APP_PROCESSOR_UPDATE - status: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter 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: 2026-06-29T07:00:00Z - updatedDateTime: - type: string - description: Set when change object is updated - format: date-time - example: 2026-06-29T07:15:00Z - data: - type: array - items: - $ref: "#/components/schemas/AppProcessorChangeOperation" - description: Current state of latest AppProcessor change - AppServiceState: - type: string - description: App Service lifecycle state - example: PROVISIONING - enum: - - PROVISIONING - - PROVISIONED - - DEPROVISIONING - - DEPROVISIONED - - REPROVISIONING - x-order: 6 - AppServiceChange: + - /name + - /description + - /bandwidth + - /ipv4Subnet + value: + description: new value for updated parameter + x-go-type: json.RawMessage required: - - type - - updatedDateTime + - op + - path + - value + AppLinkChange: + description: Current state of latest AppLink change type: object properties: uuid: - type: string description: Uniquely identifies a change - type: type: string + type: description: Type of change + type: string enum: - - APP_SERVICE_UPDATE + - APP_LINK_UPDATE status: - type: string description: Current outcome of the change flow + type: string enum: - COMPLETED - FAILED - REQUESTED createdDateTime: - type: string description: Set when change flow starts + type: string format: date-time - example: 2026-06-29T07:00:00Z + example: '2026-06-29T07:00:00Z' updatedDateTime: - type: string description: Set when change object is updated + type: string format: date-time - example: 2026-06-29T07:15:00Z + example: '2026-06-29T07:15:00Z' data: type: array items: - $ref: "#/components/schemas/AppServiceChangeOperation" - description: Current state of latest AppService change - AppServiceChangeOperation: - required: - - op - - path - - value - type: object - properties: - op: - type: string - description: operation type applied to the resource - enum: - - replace - - add - - remove - path: - type: string - description: path inside document leading to updated parameter - enum: - - /name - - /description - - /sourceDomains - value: - type: object - description: new value for updated parameter - x-go-type: json.RawMessage - description: App Service change operation data - AppServiceAttachedAppLink: + $ref: '#/components/schemas/AppLinkChangeOperation' required: - type - - uuid + - updatedDateTime + AppLink: + description: App Link object type: object properties: href: - type: string description: Resource URI + type: string format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 x-order: 1 type: - $ref: "#/components/schemas/AppLinkType" + $ref: '#/components/schemas/AppLinkType' uuid: - type: string description: Equinix-assigned access point identifier + type: string format: uuid example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 x-order: 3 name: - type: string description: Customer-provided App Link name + type: string format: string example: Atlassian App Link x-order: 4 description: - type: string description: Customer-provided App Link description + type: string format: string example: Atlassian App Link in SV x-order: 5 state: - $ref: "#/components/schemas/AppLinkState" + $ref: '#/components/schemas/AppLinkState' router: - $ref: "#/components/schemas/AppLinkCloudRouter" + $ref: '#/components/schemas/AppLinkCloudRouter' ipv4Subnet: - type: string description: Customer-provided IP subnet for AppLink setup (/29 or larger subnet) + type: string example: 192.168.10.0/29 x-order: 8 ipv4Address: - type: string description: App Link IP address + type: string format: ipv4 example: 192.168.10.1 x-order: 9 bandwidth: - type: integer description: App Link aggregated data transfer capacity in Mbps + type: integer example: 1000 x-order: 10 project: - $ref: "#/components/schemas/Project" - description: App Link object - AppSubscriptionState: - type: string - description: App Subscription lifecycle state - example: PROVISIONING - enum: - - PROVISIONING - - PROVISIONING_FAILED - - PROVISIONED - - DEPROVISIONING - - DEPROVISIONING_FAILED - - DEPROVISIONED - - REPROVISIONING - x-order: 6 - AppServiceAttachedAppSubscription: + $ref: '#/components/schemas/Project' + changeLog: + $ref: '#/components/schemas/Changelog' + change: + $ref: '#/components/schemas/AppLinkChange' required: - - state - type - - uuid + - name + - router + - ipv4Subnet + - bandwidth + - project + AppLinkUpdateRequest: + description: App Link Update Request + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/AppLinkChangeOperation' + AppLinkSimpleExpression: type: object properties: - href: + property: + description: | + Possible field names to use on filters: + * `/project/projectId` - project id + * `/uuid` - App Link uuid + * `/name` - App Link name + * `/description` - App Link description + * `/state` - App Link status + * `/ipv4Subnet` - App Link ipv4 subnet + * `/bandwidth` - App Link bandwidth + * `/changeLog/createdDateTime` - App Link creation timestamp + * `/changeLog/updatedDateTime` - App Link last updated timestamp + * `/changeLog/deletedDateTime` - App Link deletion timestamp + type: string + example: /name + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `>` - greater than + * `<` - less than + * `IN` - in + * `NOT IN` - not in + * `LIKE` - like + * `ILIKE` - case-insensitive like + * `BETWEEN` - between + * `NOT BETWEEN` - not between type: string + example: '=' + values: + type: array + items: + type: string + example: Gateway + AppLinkOrFilter: + type: object + properties: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppLinkSimpleExpression' + AppLinkFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppLinkSimpleExpression' + - $ref: '#/components/schemas/AppLinkOrFilter' + AppLinkFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/AppLinkFilter' + AppLinkSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + AppLinkSortBy: + description: | + Possible field names to use on '400_InvalidSorting': + * `/name` - App Link name + * `/uuid` - App Link uuid + * `/state` - App Link status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime + type: string + format: string + example: /changeLog/updatedDateTime + AppLinkSortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/AppLinkSortDirection' + property: + $ref: '#/components/schemas/AppLinkSortBy' + AppLinkSearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/AppLinkFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppLinkSortCriteria' + AppLinkSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppLink' + AppLinkAttachState: + description: App Link attachment lifecycle state + type: string + format: string + enum: + - ATTACHING + - ATTACHING_FAILED + - ATTACHED + - DETACHING + - DETACHING_FAILED + - DETACHED + - REATTACHING + - REATTACHING_FAILED + example: ATTACHED + x-order: 10 + AppLinkAppDomainAttachment: + description: App Link Attached App Domain object + type: object + properties: + href: description: Resource URI + type: string format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 x-order: 1 type: - $ref: "#/components/schemas/AppSubscriptionType" + $ref: '#/components/schemas/AppDomainType' uuid: - type: string description: Equinix-assigned access point identifier + type: string format: uuid example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 x-order: 3 - state: - $ref: "#/components/schemas/AppSubscriptionState" - account: - $ref: "#/components/schemas/SimplifiedAccount" - description: App Subscription object attached to an App Service - AppSubscriptionType: - type: string - description: App Subscription Type - example: APP_SUBSCRIPTION - default: APP_SUBSCRIPTION - enum: - - APP_SUBSCRIPTION - x-order: 2 - AppSubscriptionSourceRequest: + name: + description: Customer-provided App Domain name + type: string + example: atlassian.net + x-order: 4 + attachmentStatus: + $ref: '#/components/schemas/AppLinkAttachState' + changeLog: + $ref: '#/components/schemas/Changelog' required: - - ipSubnets + - uuid + AppLinkAttachDomainSimpleExpression: type: object properties: - appLink: - $ref: "#/components/schemas/AppSubscriptionSourceRequestAppLink" - ipSubnets: + property: + description: | + Possible field names to use on filters: + * `/uuid` - App Domain attach to App Link uuid + * `/attachmentStatus` - App Domain attach to App Link status + type: string + example: /attachmentStatus + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `IN` - in + * `NOT IN` - not in + type: string + example: '=' + values: type: array - description: List of IP subnets in CIDR notation items: type: string - format: ipv4-cidr - example: 192.168.100.0/24 - description: Source details for the Subscription - x-order: 4 - AppSubscriptionTargetRequest: - required: - - geoScope - - prioritization + example: Gateway + AppLinkAttachDomainOrFilter: type: object properties: - appService: - $ref: "#/components/schemas/AppSubscriptionTargetRequestAppService" - geoScope: - type: string - description: Geo scope - example: GLOBAL - prioritization: - $ref: "#/components/schemas/AppSubscriptionPrioritization" - description: Target details for the Subscription - x-order: 5 - AppSubscriptionSource: - required: - - ipSubnets + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppLinkAttachDomainSimpleExpression' + AppLinkAttachDomainFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppLinkAttachDomainSimpleExpression' + - $ref: '#/components/schemas/AppLinkAttachDomainOrFilter' + AppLinkAttachDomainFilters: type: object properties: - appLink: - $ref: "#/components/schemas/AppSubscriptionSourceAppLink" - ipSubnets: + and: type: array - description: List of IP subnets in CIDR notation + maxItems: 8 items: - type: string - format: ipv4-cidr - example: 192.168.100.0/24 - description: Source details for the Subscription - x-order: 4 - AppSubscriptionTarget: - required: - - geoScope - - prioritization + $ref: '#/components/schemas/AppLinkAttachDomainFilter' + AppLinkAttachDomainSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + AppLinkAttachDomainSortBy: + description: | + Possible field names to use on '400_InvalidSorting': + * `/uuid` - App Domain attach to App Link uuid + * `/attachmentStatus` - App Domain attach to App Link status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime + type: string + format: string + example: /changeLog/updatedDateTime + AppLinkAttachDomainSortCriteria: type: object properties: - appService: - $ref: "#/components/schemas/AppSubscriptionTargetAppService" - geoScope: + direction: + $ref: '#/components/schemas/AppLinkAttachDomainSortDirection' + property: + $ref: '#/components/schemas/AppLinkAttachDomainSortBy' + AppLinkAttachDomainSearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/AppLinkAttachDomainFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppLinkAttachDomainSortCriteria' + AppLinkAttachDomainSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppLinkAppDomainAttachment' + AttachedAppDomainAttachmentStatus: + description: Filter attached App Domains by attachment lifecycle state. + type: array + items: + $ref: '#/components/schemas/AppLinkAttachState' + example: + - ATTACHED + - ATTACHING + AttachedAppDomainOrder: + description: Sort order for attached App Domains. + type: string + enum: + - DESC + - ASC + default: DESC + example: DESC + AppLinkAttachedAppDomain: + description: App Domain object associated with App Link + type: object + properties: + href: + description: Resource URI type: string - description: Geo scope - example: GLOBAL - prioritization: - $ref: "#/components/schemas/AppSubscriptionPrioritization" - description: Target details for the Subscription - x-order: 5 - AppSubscriptionChange: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + x-order: 1 + type: + $ref: '#/components/schemas/AppDomainType' + uuid: + description: Equinix-assigned access point identifier + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + x-order: 3 + name: + description: Customer-provided App Domain name + type: string + format: string + example: atlassian.net + x-order: 4 + description: + description: Customer-provided App Domain description + type: string + format: string + example: Atlassian Domain + x-order: 5 + state: + $ref: '#/components/schemas/AppDomainState' + project: + $ref: '#/components/schemas/Project' + attachmentStatus: + $ref: '#/components/schemas/AppLinkAttachState' required: - type - - updatedDateTime + - uuid + AppLinkAttachedAppDomains: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppLinkAttachedAppDomain' + AppServiceType: + description: App Service Type + type: string + enum: + - APP_SERVICE + default: APP_SERVICE + example: APP_SERVICE + x-order: 2 + AppLinkAppServiceAttachmentChange: + description: Current state of latest AppLink change type: object properties: uuid: - type: string description: Uniquely identifies a change - type: type: string + type: description: Type of change + type: string enum: - - APP_SUBSCRIPTION_UPDATE + - APP_SERVICE_UPDATE status: - type: string description: Current outcome of the change flow + type: string enum: - COMPLETED - FAILED - REQUESTED createdDateTime: - type: string description: Set when change flow starts + type: string format: date-time - example: 2026-06-29T07:00:00Z + example: '2026-06-29T07:00:00Z' updatedDateTime: - type: string description: Set when change object is updated + type: string format: date-time - example: 2026-06-29T07:15:00Z + example: '2026-06-29T07:15:00Z' data: type: array items: - $ref: "#/components/schemas/AppSubscriptionChangeOperation" - description: Current state of latest AppSubscription change - AppSubscriptionChangeOperation: + $ref: '#/components/schemas/AppLinkChangeOperation' required: - - op - - path - - value - type: object - properties: - op: - type: string - description: operation type applied to the resource - enum: - - replace - - add - - remove - path: - type: string - description: path inside document leading to updated parameter - value: - type: object - description: new value for updated parameter - x-go-type: json.RawMessage - description: App Subscription change operation data - Router: + - type + - updatedDateTime + AppLinkAppServiceAttachment: + description: App Link Attached App Service object type: object properties: href: + description: Resource URI type: string - description: Fabric Cloud Router URI format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/routers/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 + example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 1 + type: + $ref: '#/components/schemas/AppServiceType' uuid: + description: Equinix-assigned access point identifier type: string - description: Cloud Router UUID format: uuid - example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 - type: + example: 5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 3 + geoScope: + description: Geo scope for the App Service type: string - enum: - - XF_ROUTER - Phone: + example: GLOBAL + x-order: 4 + destinationIp: + description: Target IP for forwarding API requests + type: string + format: ipv4 + example: 10.10.1.110 + x-order: 5 + attachmentStatus: + $ref: '#/components/schemas/AppLinkAttachState' + changeLog: + $ref: '#/components/schemas/Changelog' + change: + $ref: '#/components/schemas/AppLinkAppServiceAttachmentChange' + required: + - uuid + - geoScope + - destinationIp + AppLinkAttachServiceRequest: type: object + description: Attach App Service to App Link properties: - type: + geoScope: + description: Geo scope for the App Service type: string - description: Notification Type - example: MOBILE - enum: - - MOBILE - - OFFICE - number: - pattern: ^\+[1-9]\d{1,14}$ + example: GLOBAL + destinationIp: + description: Target IP for forwarding API requests type: string - description: Phone number - contactPreference: - $ref: "#/components/schemas/ContactPreference" - ConnectionPriority: - type: string - description: Connection priority in redundancy group - enum: - - PRIMARY - - SECONDARY - AccessPoint: + format: ipv4 + example: 10.10.1.110 + required: + - geoScope + - destinationIp + AppLinkAppServiceAttachmentChangeOperation: + description: App Link change operation data 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" - environment: - $ref: "#/components/schemas/ProviderEnvironment" - sellerRegion: - type: string - description: Access point seller region - peeringType: - $ref: "#/components/schemas/PeeringType" - authenticationKey: - type: string - description: Access point authentication key - activationKey: - type: string - description: Access point activation key - providerConnectionId: - type: string - description: Provider assigned Connection Id - virtualNetwork: - $ref: "#/components/schemas/VirtualNetwork" - interconnection: - $ref: "#/components/schemas/MetalInterconnection" - role: + op: + description: operation type applied to the resource type: string - description: E-Tree network connection role enum: - - LEAF - - ROOT - productOffering: - $ref: "#/components/schemas/ProductOffering" - bandwidthCommit: - maximum: 100000 - minimum: 0 - type: integer - description: Bandwidth commit in Mbps - providerIdentifier: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter type: string - description: Provider identifier - address: - $ref: "#/components/schemas/Address" - description: Access point object - InternetAccess: + enum: + - /destinationIp + value: + description: new value for updated parameter + x-go-type: json.RawMessage + required: + - op + - path + - value + AppLinkAttachServiceUpdateRequest: + description: App Service attachment Update Request + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/AppLinkAppServiceAttachmentChangeOperation' + AppLinkAttachServiceSimpleExpression: type: object properties: - uuid: - type: string - description: Internet Access Service Identifier - format: uuid - description: Internet Access Details - ConnectionInvitation: - type: object - properties: - email: - type: string - description: invitee email - example: test@equinix.com - message: + property: + description: | + Possible field names to use on filters: + * `/uuid` - App Service attach to App Link uuid + * `/attachmentStatus` - App Service attach to App Link status type: string - description: invitation message - example: Hello, Please accept my invitation - ctrDraftOrderId: + example: /attachmentStatus + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `IN` - in + * `NOT IN` - not in 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 - - ERROR - - ORDERING - - DELETING - - PENDING DELETE - - N/A - - QUOTING - EquinixStatus: - type: string - description: Connection status - enum: - - REJECTED_ACK - - REJECTED - - PENDING_DELETE - - PROVISIONED - - PENDING_APPROVAL - - NOT_PROVISIONED - - DEPROVISIONING - - NOT_DEPROVISIONED - - PENDING_AUTO_APPROVAL - - PROVISIONING - - PENDING_BGP_PEERING - - PENDING_PROVIDER_VLAN - - DEPROVISIONED - - DELETED - - AUTO_APPROVAL_FAILED - - 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: + example: '=' + values: + type: array + items: + type: string + example: Gateway + AppLinkAttachServiceOrFilter: 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: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppLinkAttachServiceSimpleExpression' + AppLinkAttachServiceFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppLinkAttachServiceSimpleExpression' + - $ref: '#/components/schemas/AppLinkAttachServiceOrFilter' + AppLinkAttachServiceFilters: type: object properties: - errors: + and: type: array + maxItems: 8 items: - $ref: "#/components/schemas/Error" - RoutingProtocolProject: - required: - - projectId + $ref: '#/components/schemas/AppLinkAttachServiceFilter' + AppLinkAttachServiceSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + AppLinkAttachServiceSortBy: + description: | + Possible field names to use on '400_InvalidSorting': + * `/uuid` - App Service attach to App Link uuid + * `/attachmentStatus` - App Service attach to App Link status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime + type: string + format: string + example: /changeLog/updatedDateTime + AppLinkAttachServiceSortCriteria: type: object properties: - projectId: - type: string - description: Uniquely identifies a project - description: The Routing Protocol's project - RoutingProtocolConnection: + direction: + $ref: '#/components/schemas/AppLinkAttachServiceSortDirection' + property: + $ref: '#/components/schemas/AppLinkAttachServiceSortBy' + AppLinkAttachServiceSearchRequest: type: object + description: Search requests containing criteria properties: - uuid: - type: string - description: Equinix-assigned connection identifier - platformUuid: - type: string - description: Equinix-assigned platform connection identifier - description: Connection specification - ExchangeServiceRequestBgp: + filter: + $ref: '#/components/schemas/AppLinkAttachServiceFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppLinkAttachServiceSortCriteria' + AppLinkAttachServiceSearchResponse: type: object properties: - domainName: - maxLength: 253 - minLength: 1 - type: string - description: Domain name for BGP - example: gw01.sin.example.net - asSet: - maxLength: 48 - minLength: 2 - type: string - description: AS-SET used to filter the prefixes announced by the customer - example: AS-EC-SV - mlpeEnabled: - type: boolean - description: Whether Multi-Lateral Peering Exchange (MLPE) is enabled - example: true - default: false - md5AuthKey: - maxLength: 255 - minLength: 1 - type: string - description: MD5 key for BGP - example: TestAuthKey12345 - rcMd5AuthKey: - maxLength: 255 - minLength: 1 - type: string - description: RC MD5 key for BGP - example: TestAuthKey123456 - prefixes: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. type: array - description: List of IP prefix items: - type: string - description: IP prefix - maxPrefixLimit: - type: integer - description: Max Prefix Limit number - format: int64 - example: 300 - prependSelfEnabled: - type: boolean - description: Prepend Self Enabled - example: true - default: true - ExchangeServiceResponseBgp: + $ref: '#/components/schemas/AppLinkAppServiceAttachment' + AttachedAppServiceAttachmentStatus: + description: Filter attached App Services by attachment lifecycle state. + type: array + items: + $ref: '#/components/schemas/AppLinkAttachState' + example: + - ATTACHED + - ATTACHING + AttachedAppServiceOrder: + description: Sort order for attached App Services. + type: string + enum: + - DESC + - ASC + default: DESC + example: DESC + AppServiceState: + description: App Service lifecycle state + type: string + enum: + - PROVISIONING + - PROVISIONED + - DEPROVISIONING + - DEPROVISIONED + - REPROVISIONING + example: PROVISIONING + x-order: 6 + AppLinkAttachedAppService: + description: App Service object associated with App Link type: object properties: - customerPeerIp: - type: string - description: Customer peer IP address - example: 12.1.1.1 - domainName: - type: string - description: Domain name for BGP - example: ix-v4.gw01.sin.example.net - primaryRouteServerIp: + href: + description: Resource URI type: string - description: Primary route server IP address with prefix length - example: 206.126.239.251/22 - secondaryRouteServerIp: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 1 + type: + $ref: '#/components/schemas/AppServiceType' + uuid: + description: Equinix-assigned access point identifier type: string - description: Secondary route server IP address with prefix length - example: 206.126.239.252/22 - asSet: + format: uuid + example: 5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 3 + name: + description: Customer-provided App Service name type: string - description: AS-SET used to filter the prefixes announced by the customer - example: AS-EC-SV - mlpeEnabled: - type: boolean - description: Whether Multi-Lateral Peering Exchange (MLPE) is enabled - example: true - md5AuthKey: + format: string + example: Atlassian App Service + x-order: 4 + description: + description: Customer-provided App Service description type: string - description: MD5 key for BGP - example: TestAuthKey12345 - rcMd5AuthKey: + format: string + example: Atlassian App Service in SV + x-order: 5 + state: + $ref: '#/components/schemas/AppServiceState' + endpoint: + description: Accessible endpoint through this service type: string - description: RC MD5 key for BGP - example: TestAuthKey123456 - prefixes: + x-order: 7 + example: equinixjira.atlassian.net + sourceDomains: type: array - description: List of IP prefix + description: List of source domains from where traffic is allowed + x-order: 8 items: type: string - description: IP prefix - maxPrefixLimit: - type: integer - description: Max Prefix Limit number - format: int64 - example: 300 - prependSelfEnabled: - type: boolean - description: Prepend Self Enabled - example: true - RouteCollector: - type: object - properties: - asn: - type: integer - description: Route Collector ASN - format: int64 - example: 1238 - ipV4: + example: equinix.com + project: + $ref: '#/components/schemas/Project' + geoScope: + description: Geo scope for the App Service type: string - description: Route Collector ipV4 address - example: 206.126.239.250/22 - ipV6: + example: GLOBAL + x-order: 4 + destinationIp: + description: Target IP for forwarding API requests type: string - description: Route Collector ipV6 address - example: 2001:504:0:2:0:6:5517:1/64 - description: Route Collector - InternetAccessConnection: + format: ipv4 + example: 10.10.1.110 + x-order: 5 + attachmentStatus: + $ref: '#/components/schemas/AppLinkAttachState' required: - - href + - type - uuid + - geoScope + - destinationIp + AppLinkAttachedAppServices: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppLinkAttachedAppService' + AppProcessorType: + description: App Processor Type + type: string + enum: + - APP_PROCESSOR + default: APP_PROCESSOR + example: APP_PROCESSOR + x-order: 2 + AppLinkAppProcessorAttachment: + description: App Link Attached App Processor object type: object properties: href: + description: Resource URI type: string - description: URI of the connection format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + x-order: 1 + type: + $ref: '#/components/schemas/AppProcessorType' uuid: + description: App Processor UUID type: string - description: Unique identifier for the connection format: uuid - peeringIpv4: - $ref: "#/components/schemas/InternetAccessPeeringIpv4" - peeringIpv6: - $ref: "#/components/schemas/InternetAccessPeeringIpv6" - InternetAccessPeeringIpv4: - type: object - properties: - prefix: - pattern: ^([01]?\d\d?|2[0-4]\d|25[0-5])(?:\.(?:[01]?\d\d?|2[0-4]\d|25[0-5])){3}/(?:[1-9]|[12]\d|3[0-2])$ - type: string - description: IPv4 prefix for the peering connection - prefixLength: - maximum: 32 - minimum: 1 - type: integer - description: Determines the size of subnet - example: 30 - equinixPeerIp: - pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ - type: string - description: IPv4 peering IP address for Equinix side - customerPeerIp: - pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ - type: string - description: IPv4 peering IP address for customer side - equinixVrrpIp: - pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + example: 90ee425c-9988-454c-96d9-1128bc16350f + x-order: 3 + config: + description: Base64-encoded configuration for the processor attachment type: string - description: IPv4 address for Equinix VRRP IP - customerVrrpIp: - pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + format: byte + example: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... + x-order: 4 + endpoint: + description: Endpoint DNS name assigned to the attached App Processor type: string - description: IPv4 address for customer VRRP IP - InternetAccessPeeringIpv6: + example: 123456.privateai.link + x-order: 5 + attachmentStatus: + $ref: '#/components/schemas/AppLinkAttachState' + changeLog: + $ref: '#/components/schemas/Changelog' + required: + - uuid + AppLinkAttachProcessorRequest: type: object + description: Attach App Processor to App Link properties: - prefix: - type: string - description: IPv6 prefix for the peering connection - prefixLength: - maximum: 128 - minimum: 8 - type: integer - description: Determines the size of subnet - example: 64 - equinixPeerIp: - type: string - description: IPv6 peering IP address for Equinix side - customerPeerIp: - type: string - description: IPv6 peering IP address for customer side - equinixVrrpIp: - type: string - description: IPv6 address for Equinix VRRP IP - customerVrrpIp: + config: + description: Base64-encoded configuration for the processor attachment type: string - description: IPv6 address for customer VRRP IP - InternetAccessIpBlock: + format: byte + example: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... required: - - href - - uuid + - config + AppLinkAttachProcessorSimpleExpression: type: object properties: - href: + property: + description: | + Possible field names to use on filters: + * `/uuid` - App Processor attach to App Link uuid + * `/attachmentStatus` - App Processor attach to App Link status type: string - description: URI of the IP block - format: uri - uuid: + example: /attachmentStatus + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `IN` - in + * `NOT IN` - not in type: string - description: Unique identifier for the IP block - format: uuid - IpBlockProductType: + example: '=' + values: + type: array + items: + type: string + example: ATTACHED + AppLinkAttachProcessorOrFilter: + type: object + properties: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppLinkAttachProcessorSimpleExpression' + AppLinkAttachProcessorFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppLinkAttachProcessorSimpleExpression' + - $ref: '#/components/schemas/AppLinkAttachProcessorOrFilter' + AppLinkAttachProcessorFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/AppLinkAttachProcessorFilter' + AppLinkAttachProcessorSortDirection: + description: Sorting direction + default: DESC type: string enum: - - EIA - - FABRIC - - NE - ProductType: + - DESC + - ASC + AppLinkAttachProcessorSortBy: + description: | + Possible field names to use on '400_InvalidSorting': + * `/uuid` - App Processor attach to App Link uuid + * `/attachmentStatus` - App Processor attach to App Link status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime type: string - description: Product type - enum: - - VIRTUAL_CONNECTION_PRODUCT - - IP_BLOCK_PRODUCT - - VIRTUAL_PORT_PRODUCT - - CLOUD_ROUTER_PRODUCT - - PRECISION_TIME_PRODUCT - - OPTICAL_CONNECT_PRODUCT - PriceCharge: + format: string + example: /changeLog/updatedDateTime + AppLinkAttachProcessorSortCriteria: 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: + direction: + $ref: '#/components/schemas/AppLinkAttachProcessorSortDirection' + property: + $ref: '#/components/schemas/AppLinkAttachProcessorSortBy' + AppLinkAttachProcessorSearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/AppLinkAttachProcessorFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppLinkAttachProcessorSortCriteria' + AppLinkAttachProcessorSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppLinkAppProcessorAttachment' + AttachedAppProcessorAttachmentStatus: + description: Filter attached App Processors by attachment lifecycle state. + type: array + items: + $ref: '#/components/schemas/AppLinkAttachState' + example: + - ATTACHED + - ATTACHING + AttachedAppProcessorOrder: + description: Sort order for attached App Processors. type: string - description: Price category enum: - - COUNTRY - - CUSTOMER - VirtualConnectionPrice: + - DESC + - ASC + default: DESC + example: DESC + AppLinkAttachedAppProcessors: 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" - geoScope: - $ref: "#/components/schemas/GeoScopeType" - description: Virtual Connection Product configuration - IpBlockPrice: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppLinkAppProcessorAttachment' + AppProcessorState: + description: App Processor lifecycle state + type: string + format: string + enum: + - PROVISIONING + - PROVISIONING_FAILED + - PROVISIONED + - DEPROVISIONING + - DEPROVISIONING_FAILED + - DEPROVISIONED + - REPROVISIONING + example: PROVISIONING + x-order: 6 + AppProcessorMarketplace: + description: App Processor marketplace settings type: object + x-order: 8 properties: - uuid: + visibility: + description: App Processor marketplace visibility 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: + format: string + enum: + - PUBLIC + - PRIVATE + default: PUBLIC + example: PUBLIC + required: + - visibility + AppProcessorChangeOperation: + description: App Processor change operation data type: object properties: - uuid: + op: + description: operation type applied to the resource 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: + enum: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter + type: string + enum: + - /name + value: + description: new value for updated parameter + x-go-type: json.RawMessage + required: + - op + - path + - value + AppProcessorChange: + description: Current state of latest AppProcessor change type: object properties: uuid: + description: Uniquely identifies a change 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" - package: - $ref: "#/components/schemas/VirtualPortPackage" - serviceCode: - $ref: "#/components/schemas/VirtualPortServiceCode" - 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: + description: Type of change 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 - OpticalConnectPrice: - type: object - properties: - type: - $ref: "#/components/schemas/OpticalConnectPricePortType" - bandwidth: - minimum: 0 - type: integer - description: Bandwidth in Mbps - example: 1000 - pathType: - $ref: "#/components/schemas/OpticalConnectPricePathType" - connectionDestinationType: - $ref: "#/components/schemas/OpticalConnectConnectionDestinationType" - aSide: - $ref: "#/components/schemas/OpticalConnectPriceASide" - zSide: - $ref: "#/components/schemas/OpticalConnectPriceZSide" - description: Optical Metro Connect Port Product configuration - ServiceTokenSide: - type: object - properties: - accessPointSelectors: + - APP_PROCESSOR_UPDATE + status: + description: Current outcome of the change flow + type: string + enum: + - COMPLETED + - FAILED + - REQUESTED + createdDateTime: + description: Set when change flow starts + type: string + format: date-time + example: '2026-06-29T07:00:00Z' + updatedDateTime: + description: Set when change object is updated + type: string + format: date-time + example: '2026-06-29T07:15:00Z' + data: type: array - description: List of AccessPointSelectors items: - $ref: "#/components/schemas/AccessPointSelector" - description: Connection link protocol,virtual device or network configuration - OpticalConnectDemarcationPoint: + $ref: '#/components/schemas/AppProcessorChangeOperation' + required: + - type + - updatedDateTime + AppProcessor: + description: App Processor object type: object properties: - patchPanelId: + href: + description: Resource URI type: string - description: Unique identifier of the patch panel. - example: CP:Demarc:1259684 - patchPanelPortA: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + x-order: 1 + type: + $ref: '#/components/schemas/AppProcessorType' + uuid: + description: Equinix-assigned access point identifier + type: string + format: uuid + example: 90ee425c-9988-454c-96d9-1128bc16350f + x-order: 3 + name: + description: Customer-provided App Processor name + type: string + format: string + minLength: 1 + maxLength: 50 + example: agent-gateway + x-order: 4 + description: + description: Customer-provided App Processor description + type: string + format: string + minLength: 1 + maxLength: 255 + example: llm-routing, a2a-routing, mcp-routing + x-order: 5 + state: + $ref: '#/components/schemas/AppProcessorState' + registryId: + description: Container image reference for the processor runtime type: string + format: string + minLength: 1 + maxLength: 255 + example: agentgateway/agentgateway:1.3.0 + x-order: 7 + marketplace: + $ref: '#/components/schemas/AppProcessorMarketplace' + project: + $ref: '#/components/schemas/Project' + changeLog: + $ref: '#/components/schemas/Changelog' + change: + $ref: '#/components/schemas/AppProcessorChange' + required: + - type + - name + - registryId + - marketplace + - project + AppProcessorSimpleExpression: + type: object + properties: + property: description: | - Specify the desired port number for Port A.
When ports are not provided, next available ports will be used. - example: "10" - patchPanelPortB: + Possible field names to use on filters: + * `/project/projectId` - project id + * `/uuid` - App Processor uuid + * `/name` - App Processor name + * `/description` - App Processor description + * `/state` - App Processor status + * `/ipv4Subnet` - App Processor ipv4 subnet + * `/bandwidth` - App Processor bandwidth + * `/changeLog/createdDateTime` - App Processor creation timestamp + * `/changeLog/updatedDateTime` - App Processor last updated timestamp + * `/changeLog/deletedDateTime` - App Processor deletion timestamp type: string + example: /name + operator: description: | - Specify the desired port number for Port B.
When ports are not provided, next available ports will be used.
Required for Connector type FC, SC and ST only. - example: "11" - connectorType: + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `>` - greater than + * `<` - less than + * `IN` - in + * `NOT IN` - not in + * `LIKE` - like + * `ILIKE` - case-insensitive like + * `BETWEEN` - between + * `NOT BETWEEN` - not between type: string - description: Type of Connector - example: SC - enum: - - FC - - SC - - LC - - ST - description: | - Specifies the demarcation point: the patch panel and ports at this side. - OpticalConnectLocation: + example: '=' + values: + type: array + items: + type: string + example: Gateway + AppProcessorOrFilter: type: object properties: - ibxCode: - type: string - description: Equinix IBX data centre code. - example: SV1 - description: Destination location for BMMR and REMOTE connections. - OpticalConnectLOA: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppProcessorSimpleExpression' + AppProcessorFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppProcessorSimpleExpression' + - $ref: '#/components/schemas/AppProcessorOrFilter' + AppProcessorFilters: type: object properties: - uuid: - type: string - description: Identifier of the Letter of Authorization - example: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - description: | - Letter of Authorization granting the right to terminate at the Z-side location.
Required for BMMR and REMOTE. - OpticalConnectResponseDemarcationPoint: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/AppProcessorFilter' + AppProcessorSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + AppProcessorSortBy: description: | - Demarcation point as provisioned, with the cage and cabinet it belongs to. - allOf: - - $ref: "#/components/schemas/OpticalConnectDemarcationPoint" - - type: object - properties: - cageUniqueSpaceId: - type: string - description: Unique identifier of the cage. - example: SV1:01:002174 - cabinetUniqueSpaceId: - type: string - description: Unique identifier of the cabinet. - example: Demarc - PortOrderPurchaseOrder: + Possible field names to use on '400_InvalidSorting': + * `/name` - App Processor name + * `/uuid` - App Processor uuid + * `/state` - App Processor status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime + type: string + format: string + example: /changeLog/updatedDateTime + AppProcessorSortCriteria: type: object properties: - number: - type: string - description: purchase order number - amount: - type: string - description: purchase order amount - startDate: + direction: + $ref: '#/components/schemas/AppProcessorSortDirection' + property: + $ref: '#/components/schemas/AppProcessorSortBy' + AppProcessorSearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/AppProcessorFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppProcessorSortCriteria' + AppProcessorSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppProcessor' + AppServicePostRequest: + type: object + description: Create App Service + properties: + type: + $ref: '#/components/schemas/AppServiceType' + name: + description: Customer-provided App Service name type: string - endDate: + format: string + minLength: 1 + maxLength: 50 + example: Atlassian App Service + description: + description: Customer-provided App Service description type: string - attachmentId: + format: string + example: Atlassian App Service in SV + endpoint: + description: Accessible endpoint through this service type: string - format: uuid - selectionType: + example: equinixjira.atlassian.net + sourceDomains: + type: array + description: List of source domains from where traffic is allowed + items: + type: string + example: equinix.com + project: + $ref: '#/components/schemas/Project' + required: + - type + - name + - endpoint + - project + AppServiceChangeOperation: + description: App Service change operation data + type: object + properties: + op: + description: operation type applied to the resource type: string - deprecated: true enum: - - EXEMPTION - - EXISTING - - NEW - - BLANKET - type: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter type: string enum: - - EXEMPTION - - EXISTING - - NEW - - BLANKET - description: Purchase Order information associate to the account - PortOrderSignature: + - /name + - /description + - /sourceDomains + value: + description: new value for updated parameter + x-go-type: json.RawMessage + required: + - op + - path + - value + AppServiceChange: + description: Current state of latest AppService change type: object properties: - signatory: + uuid: + description: Uniquely identifies a change + type: string + type: + description: Type of change type: string - description: Port signature Type enum: - - DELEGATE - - SELF - - ACCOUNT_SUPPORT - delegate: - $ref: "#/components/schemas/PortOrderSignatureDelegate" - description: Port signature details - PortOrderSignatureDelegate: - type: object - properties: - firstName: + - APP_SERVICE_UPDATE + status: + description: Current outcome of the change flow type: string - description: first name of delegate - lastName: + enum: + - COMPLETED + - FAILED + - REQUESTED + createdDateTime: + description: Set when change flow starts type: string - description: last Name of delegate - email: + format: date-time + example: '2026-06-29T07:00:00Z' + updatedDateTime: + description: Set when change object is updated type: string - description: email of delegate - description: order delegate details - PortDeviceRedundancy: + format: date-time + example: '2026-06-29T07:15:00Z' + data: + type: array + items: + $ref: '#/components/schemas/AppServiceChangeOperation' + required: + - type + - updatedDateTime + AppService: + description: App Service object type: object properties: - group: + href: + description: Resource URI type: string - description: Device redundancy group - priority: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 1 + type: + $ref: '#/components/schemas/AppServiceType' + uuid: + description: Equinix-assigned access point identifier 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: + format: uuid + example: 5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 3 + name: + description: Customer-provided App Service name + type: string + format: string + example: Atlassian App Service + x-order: 4 + description: + description: Customer-provided App Service description + type: string + format: string + example: Atlassian App Service in SV + x-order: 5 + state: + $ref: '#/components/schemas/AppServiceState' + endpoint: + description: Accessible endpoint through this service + type: string + x-order: 7 + example: equinixjira.atlassian.net + sourceDomains: + type: array + description: List of source domains from where traffic is allowed + x-order: 8 + items: + type: string + example: equinix.com + account: + $ref: '#/components/schemas/SimplifiedAccount' + project: + $ref: '#/components/schemas/Project' + changeLog: + $ref: '#/components/schemas/Changelog' + change: + $ref: '#/components/schemas/AppServiceChange' + required: + - type + - name + AppServiceUpdateRequest: + description: App Service Update Request + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/AppServiceChangeOperation' + AppServiceSimpleExpression: + type: object + properties: + property: + description: | + Possible field names to use on filters: + * `/project/projectId` - project id + * `/uuid` - App Service uuid + * `/name` - App Service name + * `/description` - App Service description + * `/state` - App Service status + * `/endpoint` - App Service endpoint + * `/sourceDomains` - App Service source domains + * `/changeLog/createdDateTime` - App Service creation timestamp + * `/changeLog/updatedDateTime` - App Service last updated timestamp + * `/changeLog/deletedDateTime` - App Service deletion timestamp + type: string + example: /name + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `>` - greater than + * `<` - less than + * `IN` - in + * `NOT IN` - not in + * `LIKE` - like + * `ILIKE` - case-insensitive like + * `BETWEEN` - between + * `NOT BETWEEN` - not between + type: string + example: '=' + values: + type: array + items: + type: string + example: Gateway + AppServiceOrFilter: + type: object + properties: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppServiceSimpleExpression' + AppServiceFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppServiceSimpleExpression' + - $ref: '#/components/schemas/AppServiceOrFilter' + AppServiceFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/AppServiceFilter' + AppServiceSortDirection: + description: Sorting direction + default: DESC type: string - description: Network status enum: - - RESERVED - - RELEASED - LinkProtocolRequestType: + - DESC + - ASC + AppServiceSortBy: + description: | + Possible field names to use on '400_InvalidSorting': + * `/name` - App Service name + * `/uuid` - App Service uuid + * `/state` - App Service status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime type: string - description: Type of Link Protocol - enum: - - UNTAGGED - - DOT1Q - - QINQ - - VXLAN - SubInterface: + format: string + example: /changeLog/updatedDateTime + AppServiceSortCriteria: type: object properties: - name: - type: string - description: name of subInterface of a port - deprecated: true - unit: - type: integer - example: 200 - description: Sub Interface information - LinkProtocolConnection: + direction: + $ref: '#/components/schemas/AppServiceSortDirection' + property: + $ref: '#/components/schemas/AppServiceSortBy' + AppServiceSearchRequest: type: object + description: Search requests containing criteria 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: + filter: + $ref: '#/components/schemas/AppServiceFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppServiceSortCriteria' + AppServiceSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppService' + AppServiceAttachedAppLink: + description: App Link object type: object properties: href: + description: Resource URI type: string - description: Service Token URI format: uri readOnly: true + example: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + x-order: 1 + type: + $ref: '#/components/schemas/AppLinkType' uuid: + description: Equinix-assigned access point identifier type: string format: uuid - example: cd67f685-41b0-1b07-6de0-320a5c00eabe - type: + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + x-order: 3 + name: + description: Customer-provided App Link name type: string - example: TOKEN + format: string + example: Atlassian App Link + x-order: 4 + description: + description: Customer-provided App Link description + type: string + format: string + example: Atlassian App Link in SV + x-order: 5 + state: + $ref: '#/components/schemas/AppLinkState' + router: + $ref: '#/components/schemas/AppLinkCloudRouter' + ipv4Subnet: + description: Customer-provided IP subnet for AppLink setup (/29 or larger subnet) + type: string + example: 192.168.10.0/29 + x-order: 8 + ipv4Address: + description: App Link IP address + type: string + format: ipv4 + example: 192.168.10.1 + x-order: 9 bandwidth: + description: App Link aggregated data transfer capacity in Mbps type: integer - format: int64 example: 1000 - description: Service Token details of Link Protocol - PortPackageSourceType: - type: string - description: Port Package Source Type - enum: - - COLO - - REMOTE - - BMMR - Operation: - type: object - properties: - bgpIpv4RoutesCount: - type: integer - description: IPV4 route count - example: 6 - bgpIpv6RoutesCount: - type: integer - description: IPV6 route count - example: 6 - distinctIpv4PrefixesCount: - type: integer - description: distinct IPV4 prefixes count - example: 4 - distinctIpv6PrefixesCount: - type: integer - description: distinct IPV6 prefixes count - example: 4 - description: Operation object for router actions - CloudRouterCommandRequestConnection: + x-order: 10 + project: + $ref: '#/components/schemas/Project' required: + - type - uuid + AppServiceAttachedAppLinks: type: object properties: - uuid: - type: string - description: Connection UUID - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - description: Connection object for Cloud Router Command - CloudRouterCommandPingResponse: - type: object - properties: - output: - type: string - outputStructuredPing: - $ref: "#/components/schemas/OutputStructuredPing" - errors: - type: array - items: - $ref: "#/components/schemas/Error" - CloudRouterCommandTracerouteResponse: - type: object - properties: - output: - type: string - outputStructuredTraceroute: - $ref: "#/components/schemas/OutputStructuredTraceroute" - errors: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. type: array items: - $ref: "#/components/schemas/Error" - RouteTableEntryState: - type: string - description: Route table entry state - enum: - - ACTIVE - NetworkEquinixStatus: + $ref: '#/components/schemas/AppServiceAttachedAppLink' + AppSubscriptionState: + description: App Subscription lifecycle state type: string - description: Network status enum: - PROVISIONING + - PROVISIONING_FAILED - PROVISIONED - - NOT_PROVISIONED - DEPROVISIONING + - DEPROVISIONING_FAILED - DEPROVISIONED - - NOT_DEPROVISIONED - NetworkSortDirectionResponse: + - REPROVISIONING + example: PROVISIONING + x-order: 6 + AttachedAppSubscriptionState: + description: Filter attached App Subscriptions by lifecycle state. + type: array + items: + $ref: '#/components/schemas/AppSubscriptionState' + example: + - PROVISIONED + - PROVISIONING + AttachedAppSubscriptionOrder: + description: Sort order for attached App Subscriptions. type: string - description: Sorting direction - default: DESC enum: - DESC - ASC - NetworkSortByResponse: + default: DESC + example: DESC + AppSubscriptionType: + description: App Subscription Type 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: + - APP_SUBSCRIPTION + default: APP_SUBSCRIPTION + example: APP_SUBSCRIPTION + x-order: 2 + AppServiceAttachedAppSubscription: + description: App Subscription object attached to an App Service type: object properties: - type: + href: + description: Resource URI type: string - enum: - - ASCII - - HEX - keyNumber: - maximum: 65535 - minimum: 1 - type: integer - description: The authentication Key ID. - example: 10 - key: - pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + x-order: 1 + type: + $ref: '#/components/schemas/AppSubscriptionType' + uuid: + description: Equinix-assigned access point identifier type: string - description: The plaintext authentication key. Must be Base64 encoded. For ASCII type, the key must contain printable ASCII characters, range 10-20 characters. For HEX type, range should be 10-40 characters. - format: byte - virtualConnectionSide: - title: fabricConnectionAccessPoint + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + x-order: 3 + state: + $ref: '#/components/schemas/AppSubscriptionState' + account: + $ref: '#/components/schemas/SimplifiedAccount' + required: + - type + - uuid + - state + AppServiceAttachedAppSubscriptions: type: object properties: - accessPoint: - $ref: "#/components/schemas/AccessPoint" - description: Fabric Connection access point object. - CompanyProfileChangeItem: - required: - - op - - path - - value + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppServiceAttachedAppSubscription' + AppServiceAttachedAppSubscriptionSimpleExpression: type: object properties: - op: + property: + description: | + Possible field names to use on filters: + * `/uuid` - App Subscription UUID + * `/state` - App Subscription lifecycle state type: string - description: Handy shortcut for operation name - example: replace - path: + example: /state + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `IN` - in + * `NOT IN` - not in type: string - description: path inside document leading to updated parameter - example: /name - value: - type: object - description: new value for updated parameter - LoaRequest: - required: - - authorizedProductType - - name - - type + example: IN + values: + type: array + items: + type: string + example: PROVISIONED + AppServiceAttachedAppSubscriptionOrFilter: type: object properties: - type: - $ref: "#/components/schemas/LoaType" - name: - maxLength: 50 - minLength: 3 - type: string - description: A short, descriptive name for this LOA. - example: LOA-Equinix-SV1-2026 - description: - maxLength: 450 - minLength: 0 - type: string - description: Additional context about this LOA. - example: Authorization for patch panel port access to Equinix at SV1 - authorizedProductType: - $ref: "#/components/schemas/LoaProductType" - description: Create Loa - LoaPatchPanelConnectorType: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSimpleExpression' + AppServiceAttachedAppSubscriptionFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSimpleExpression' + - $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionOrFilter' + AppServiceAttachedAppSubscriptionFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionFilter' + AppServiceAttachedAppSubscriptionSortDirection: + description: Sorting direction + default: DESC type: string - description: Connector Type - example: SC enum: - - FC - - SC - - LC - - ST - LoaMagicLink: - type: string + - DESC + - ASC + AppServiceAttachedAppSubscriptionSortBy: description: | - Portal URL for the LOA to either accept from requestor
or authorize from the issuer. - readOnly: true - example: https://portal.equinix.com/fabric/loa/inventory/issuer/29cc7878-54e3-4e1a-8651-87a61354bac2/authorize - CrossConnectDemarcationPoint: + Possible field names to use on '400_InvalidSorting': + * `/uuid` - App Subscription UUID + * `/state` - App Subscription lifecycle state + default: /uuid + type: string + format: string + example: /uuid + AppServiceAttachedAppSubscriptionSortCriteria: type: object properties: - patchPanelId: - type: string - description: Patch Panel Identifier. - example: CP:Demarc:1259684 - patchPanelPortA: - type: integer - description: | - Specify the desired port number. When ports are not provided, next available ports will be used. - example: 35 - patchPanelPortB: - type: integer - description: | - Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only. - example: 32 - connectorType: - $ref: "#/components/schemas/CrossConnectConnectorType" - description: Cross Connect Demarcation Point - patch panel and port details. - CrossConnectZSideRequestDemarcationPoint: - description: | - Z-Side demarcation point.
Specify the destination patch panel and ports.
Specify cageUniqueSpaceId and cabinetUniqueSpaceId to identify the destination space. - allOf: - - $ref: "#/components/schemas/CrossConnectDemarcationPoint" - - type: object - properties: - cageUniqueSpaceId: - type: string - description: Unique identifier of the Cage. - example: SV2:00:000000 - cabinetUniqueSpaceId: - type: string - description: Unique identifier of the Cabinet. - example: SV2:00:000000:0100 - CrossConnectLocation: + direction: + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSortDirection' + property: + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSortBy' + AppServiceAttachedAppSubscriptionSearchRequest: type: object + description: Search requests containing criteria properties: - ibxCode: - type: string - description: IBX Code. - example: SV1 - description: Cross Connect Location details. - CrossConnectLoaRef: + filter: + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSortCriteria' + AppServiceAttachedAppSubscriptionSearchResponse: type: object properties: - href: - type: string - description: LOA URI. - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/loas/c61f485e-3094-42de-8797-0ef19a51df79 - uuid: - type: string - description: LOA Identifier - Attachment UUID or LOA UUID. - format: uuid - example: c61f485e-3094-42de-8797-0ef19a51df79 - description: | - LOA Reference for Cross Connect. Provide either uuid or digitalLoaId. - CrossConnectProvider: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppServiceAttachedAppSubscription' + AppSubscriptionSourceRequestAppLink: + description: App Link reference for App Subscription type: object properties: - name: + uuid: + description: Equinix-assigned access point identifier type: string - description: Name of the provider at the Z-Side. - example: Equinix - description: Provider at the Z-Side. - ScheduleType: - type: string - description: Schedule Code. - example: STANDARD - enum: - - STANDARD - - FLEXIBLE - - EXPEDITE - CrossConnectServiceType: - type: string - description: | - Type of service ordered alongside the Cross Connect.
XC_LINK_LIGHT_VERIFICATION - To verify transmit and receive alignment after the Cross Connect is Provisioned.
XC_PATCH_EQUIPMENT - Equinix will install the Cross Connect from the demarcation panel to your equipment device. - example: XC_LINK_LIGHT_VERIFICATION - enum: - - XC_LINK_LIGHT_VERIFICATION - - XC_PATCH_EQUIPMENT - PatchEquipmentRequest: + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 required: - - cabinetUniqueSpaceId - - connectorType - - port - type: object - properties: - cabinetUniqueSpaceId: - type: string - description: Unique identifier of the Cabinet. - example: SV2:00:000000:0100 - port: - type: integer - description: Port number. - example: 32 - connectorType: - $ref: "#/components/schemas/CrossConnectConnectorType" - description: Patch equipment installed for the Cross Connect. - NotificationType: - type: string - description: Notification Type. - example: TECHNICAL - enum: - - ORDERING - - TECHNICAL - - NOTIFICATION - - PROVIDER_NOTIFICATION - - TECHNICAL_UNREGISTERED - CrossConnectPhone: + - uuid + AppSubscriptionSourceRequest: + description: Source details for the Subscription type: object + x-order: 4 properties: - type: - type: string - description: Phone number type. - example: MOBILE - enum: - - MOBILE - - OFFICE - number: - pattern: ^\+[1-9]\d{1,14}$ - type: string - description: Phone number. - example: 14085551234 - contactPreference: - $ref: "#/components/schemas/CrossConnectContactPreference" - description: Contact phone number. - PurchaseOrder: + appLink: + $ref: '#/components/schemas/AppSubscriptionSourceRequestAppLink' + ipSubnets: + type: array + description: List of IP subnets in CIDR notation + items: + type: string + format: ipv4-cidr + example: 192.168.100.0/24 + required: + - ipSubnets + AppSubscriptionTargetRequestAppService: + description: App Service reference for App Subscription type: object properties: - number: - type: string - description: Purchase Order number. - example: "1233" - amount: - type: string - description: Purchase Order amount. - example: "10000" - startDate: - type: string - description: Date the Purchase Order takes effect. - format: date - example: 2026-02-26 - endDate: - type: string - description: Date the Purchase Order expires. - format: date - example: 2027-02-26 - attachmentId: + uuid: + description: Equinix-assigned access point identifier type: string - description: Identifier of the uploaded purchase order document. format: uuid - example: e41f485e-3094-42de-8797-0ef19a51df79 - type: - type: string - description: Purchase Order type. - example: NEW - enum: - - EXEMPTION - - EXISTING - - NEW - description: Purchase Order information associated with the account. - SignatureRequest: + example: 5008a109-9d1c-485c-b0ba-de9736f283c2 required: - - type - type: object - properties: - type: - $ref: "#/components/schemas/SignatureType" - email: - type: string - description: Signatory email address. - format: email - example: abc@test.com - description: Cross Connect Order Signature. - CrossConnectASideDemarcationPoint: - description: | - A-Side demarcation point.
cageUniqueSpaceId and cabinetUniqueSpaceId identify the A-Side space. - allOf: - - $ref: "#/components/schemas/CrossConnectDemarcationPoint" - - type: object - properties: - cageUniqueSpaceId: - type: string - description: Unique identifier of the Cage. - readOnly: true - example: SV1:00:000000 - cabinetUniqueSpaceId: - type: string - description: Unique identifier of the Cabinet. - readOnly: true - example: SV1:00:000000:0100 - CrossConnectZSideResponseDemarcationPoint: - description: | - Z-Side demarcation point.
cageUniqueSpaceId and cabinetUniqueSpaceId identify the Z-Side space. - allOf: - - $ref: "#/components/schemas/CrossConnectDemarcationPoint" - - type: object - properties: - cageUniqueSpaceId: - type: string - description: Unique identifier of the Cage. - readOnly: true - example: SV2:00:000000 - cabinetUniqueSpaceId: - type: string - description: Unique identifier of the Cabinet. - readOnly: true - example: SV2:00:000000:0100 - CrossConnectScheduleState: - type: string - description: Cross Connect Schedule State. - example: COMPLETED - enum: - - PENDING - - COMPLETED - - FAILED - - CANCELLED - - PENDING_ACTION - CrossConnectServiceState: + - uuid + AppSubscriptionPrioritization: + description: Prioritization strategy for forwarding API requests type: string - description: Service status. - example: COMPLETED enum: - - PENDING - - COMPLETED - - FAILED - PatchEquipmentResponse: + - LATENCY + - PERFORMANCE + - UTILIZATION + - THRESHOLD + - ANY_TAG + example: LATENCY + AppSubscriptionTargetRequest: + description: Target details for the Subscription type: object + x-order: 5 properties: - cabinetUniqueSpaceId: + appService: + $ref: '#/components/schemas/AppSubscriptionTargetRequestAppService' + geoScope: type: string - description: Unique identifier of the Cabinet. - example: SV2:00:000000:0100 - port: - type: integer - description: Port number. - example: 32 - connectorType: - $ref: "#/components/schemas/CrossConnectConnectorType" - description: Patch equipment installed for the Cross Connect. - CrossConnectActionNote: + description: Geo scope + example: GLOBAL + prioritization: + $ref: '#/components/schemas/AppSubscriptionPrioritization' required: - - comments + - prioritization + - geoScope + AppSubscriptionPostRequest: type: object + description: Create App Subscription properties: - parentNote: - $ref: "#/components/schemas/CrossConnectParentNote" - comments: - maxLength: 4000 - type: string - description: Note comments. - example: Please proceed - description: Note supplied by the customer when responding to an action. - CrossConnectActionNoteResponse: + type: + $ref: '#/components/schemas/AppSubscriptionType' + source: + $ref: '#/components/schemas/AppSubscriptionSourceRequest' + target: + $ref: '#/components/schemas/AppSubscriptionTargetRequest' + project: + $ref: '#/components/schemas/Project' + required: + - type + - project + AppSubscriptionSourceAppLink: + description: App Link reference for App Subscription type: object properties: href: + description: Resource URI type: string - description: Note URI. format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 + example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + x-order: 1 + type: + description: App Link Type + type: string + example: APP_LINK + x-order: 2 uuid: + description: Equinix-assigned access point identifier type: string - description: Note Identifier. format: uuid - readOnly: true - example: e41f485e-3094-42de-8797-0ef19a51df79 - parentNote: - description: | - The note this note is responding to. Returned when the note was added in response to an Equinix note. - readOnly: true - allOf: - - $ref: "#/components/schemas/CrossConnectParentNote" - comments: - maxLength: 4000 - type: string - description: Note comments. - readOnly: true - example: Please proceed - description: Note the action applies to. - CrossConnectActionAttachmentResponse: + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + x-order: 3 + required: + - uuid + AppSubscriptionSource: + description: Source details for the Subscription + type: object + x-order: 4 + properties: + appLink: + $ref: '#/components/schemas/AppSubscriptionSourceAppLink' + ipSubnets: + type: array + description: List of IP subnets in CIDR notation + items: + type: string + format: ipv4-cidr + example: 192.168.100.0/24 + required: + - ipSubnets + AppSubscriptionTargetAppService: + description: App Service reference for App Subscription type: object properties: href: + description: Resource URI type: string - description: URI to the attachment resource. format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79 + example: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 1 + type: + description: App Service Type + type: string + example: APP_SERVICE + x-order: 2 uuid: + description: Equinix-assigned access point identifier type: string - description: Attachment resource Identifier. format: uuid - readOnly: true - example: e41f485e-3094-42de-8797-0ef19a51df79 - attachmentId: + example: 5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 3 + required: + - uuid + AppSubscriptionTarget: + description: Target details for the Subscription + type: object + x-order: 5 + properties: + appService: + $ref: '#/components/schemas/AppSubscriptionTargetAppService' + geoScope: type: string - description: Attachment Identifier. - format: uuid - readOnly: true - example: a11f485e-3094-42de-8797-0ef19a51df79 - description: Document the action applies to. - AppProcessorChangeOperation: + description: Geo scope + example: GLOBAL + prioritization: + $ref: '#/components/schemas/AppSubscriptionPrioritization' required: - - op - - path - - value + - prioritization + - geoScope + AppSubscriptionChangeOperation: + description: App Subscription change operation data type: object properties: op: - type: string description: operation type applied to the resource + type: string enum: - replace - add - remove path: - type: string description: path inside document leading to updated parameter - enum: - - /name + type: string value: - type: object description: new value for updated parameter x-go-type: json.RawMessage - description: App Processor change operation data - AppSubscriptionSourceRequestAppLink: required: - - uuid + - op + - path + - value + AppSubscriptionChange: + description: Current state of latest AppSubscription change type: object properties: uuid: + description: Uniquely identifies a change type: string - description: Equinix-assigned access point identifier - format: uuid - example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - description: App Link reference for App Subscription - AppSubscriptionTargetRequestAppService: - required: - - uuid - type: object - properties: - uuid: + type: + description: Type of change type: string - description: Equinix-assigned access point identifier - format: uuid - example: 5008a109-9d1c-485c-b0ba-de9736f283c2 - description: App Service reference for App Subscription - AppSubscriptionPrioritization: - type: string - description: Prioritization strategy for forwarding API requests - example: LATENCY - enum: - - LATENCY - - PERFORMANCE - - UTILIZATION - - THRESHOLD - - ANY_TAG - AppSubscriptionSourceAppLink: - required: - - uuid - type: object - properties: - href: + enum: + - APP_SUBSCRIPTION_UPDATE + status: + description: Current outcome of the change flow type: string - description: Resource URI - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - x-order: 1 - type: + enum: + - COMPLETED + - FAILED + - REQUESTED + createdDateTime: + description: Set when change flow starts type: string - description: App Link Type - example: APP_LINK - x-order: 2 - uuid: + format: date-time + example: '2026-06-29T07:00:00Z' + updatedDateTime: + description: Set when change object is updated type: string - description: Equinix-assigned access point identifier - format: uuid - example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - x-order: 3 - description: App Link reference for App Subscription - AppSubscriptionTargetAppService: + format: date-time + example: '2026-06-29T07:15:00Z' + data: + type: array + items: + $ref: '#/components/schemas/AppSubscriptionChangeOperation' required: - - uuid + - type + - updatedDateTime + AppSubscription: + description: App Subscription object type: object properties: href: - type: string description: Resource URI + type: string format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + example: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 x-order: 1 type: - type: string - description: App Service Type - example: APP_SERVICE - x-order: 2 + $ref: '#/components/schemas/AppSubscriptionType' uuid: - type: string description: Equinix-assigned access point identifier + type: string format: uuid - example: 5008a109-9d1c-485c-b0ba-de9736f283c2 + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 x-order: 3 - description: App Service reference for App Subscription - ContactPreference: + source: + $ref: '#/components/schemas/AppSubscriptionSource' + target: + $ref: '#/components/schemas/AppSubscriptionTarget' + state: + $ref: '#/components/schemas/AppSubscriptionState' + project: + $ref: '#/components/schemas/Project' + changeLog: + $ref: '#/components/schemas/Changelog' + change: + $ref: '#/components/schemas/AppSubscriptionChange' + required: + - type + - source + - target + - project + AppSubscriptionUpdateRequest: + description: App Subscription Update Request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/AppSubscriptionChangeOperation' + AppSubscriptionSimpleExpression: type: object properties: - timezone: + property: + description: | + Possible field names to use on filters: + * `/project/projectId` - project id + * `/uuid` - App Subscription uuid + * `/state` - App Subscription status + * `/source/appLink/uuid` - Source App Link uuid + * `/source/ipSubnets` - Source App Link ip subnets + * `/target/appService/uuid` - Target App Service uuid + * `/target/geoScope` - Target App Service geo scope + * `/target/prioritization` - Target App Service prioritization + * `/changeLog/createdDateTime` - App Subscription creation timestamp + * `/changeLog/updatedDateTime` - App Subscription last updated timestamp + * `/changeLog/deletedDateTime` - App Subscription deletion timestamp type: string - description: Timezone of the contact preference - availability: + example: /name + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `>` - greater than + * `<` - less than + * `IN` - in + * `NOT IN` - not in + * `LIKE` - like + * `ILIKE` - case-insensitive like + * `BETWEEN` - between + * `NOT BETWEEN` - not between type: string - description: Availability of the contact preference - enum: - - WORK_HOURS - - ANYTIME - description: Contact preference for the phone number - AccessPointType: - type: string - description: Access point type - enum: - - VD - - VG - - SP - - IGW - - COLO - - SUBNET - - CLOUD_ROUTER - - NETWORK - - METAL_NETWORK - - VPIC_INTERFACE - - APP_LINK - - IC - SimplifiedPort: + example: '=' + values: + type: array + items: + type: string + example: Gateway + AppSubscriptionOrFilter: 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 - serviceCode: - $ref: "#/components/schemas/PortServiceCode" - 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: + or: type: array - description: Physical ports that implement this port + maxItems: 3 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" - cluster: - type: string - description: Virtual Device Cluster Information - description: Virtual Device AccessPoint Information - Interface: + $ref: '#/components/schemas/AppSubscriptionSimpleExpression' + AppSubscriptionFilter: 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 + anyOf: + - $ref: '#/components/schemas/AppSubscriptionSimpleExpression' + - $ref: '#/components/schemas/AppSubscriptionOrFilter' + AppSubscriptionFilters: 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: + and: type: array - description: Network sub-resources links - readOnly: true + maxItems: 8 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 - ProductOffering: - type: object - properties: - id: - type: string - description: Product offering identifier - name: - type: string - description: Product offering name - billingTerm: - minimum: 1 - type: integer - description: Billing term in months. - example: 12 - enum: - - 1 - - 12 - - 24 - - 36 - - 48 - - 60 - description: Product offering for connection. Applicable to zSide only. - Address: - type: object - properties: - id: - type: string - description: Address identifier - streetNr: - type: string - description: Street number of address - streetName: - type: string - description: Street name of address - city: - type: string - description: City of address - stateOrProvince: - type: string - description: State of address - postCode: - type: string - description: Postal code of address - country: - type: string - description: Country of address - description: Address. - 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 - - EVPTREE_VC - - EPTREE_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. - VirtualPortPackage: - type: object - properties: - code: - $ref: "#/components/schemas/VirtualPortPackageCode" - description: Virtual Port Package - VirtualPortServiceCode: - type: string - description: Port service code. - TimeServicePriceConnection: - type: object - properties: - aSide: - $ref: "#/components/schemas/TimeServicePriceConnectionASide" - description: Time Service Price Connection configuration - OpticalConnectPricePortType: - type: string - description: Optical Connect type. - example: OC - OpticalConnectPricePathType: + $ref: '#/components/schemas/AppSubscriptionFilter' + AppSubscriptionSortDirection: + description: Sorting direction + default: DESC type: string - description: Optical Connect Port Path type. enum: - - PROTECTED - - UNPROTECTED - - DUAL_DIVERSE - OpticalConnectConnectionDestinationType: + - DESC + - ASC + AppSubscriptionSortBy: + description: | + Possible field names to use on '400_InvalidSorting': + * `/uuid` - App Subscription uuid + * `/state` - App Subscription status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime type: string - description: Destination Port connectivity type - enum: - - COLO - - BMMR - - REMOTE - OpticalConnectPriceASide: - type: object - properties: - location: - $ref: "#/components/schemas/OpticalConnectPriceLocation" - description: Optical Connection ASide configuration - OpticalConnectPriceZSide: - type: object - properties: - location: - $ref: "#/components/schemas/OpticalConnectPriceLocation" - description: Optical Connection ZSide configuration - AccessPointSelector: + format: string + example: /changeLog/updatedDateTime + AppSubscriptionSortCriteria: 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. - OutputStructuredPing: + direction: + $ref: '#/components/schemas/AppSubscriptionSortDirection' + property: + $ref: '#/components/schemas/AppSubscriptionSortBy' + AppSubscriptionSearchRequest: type: object + description: Search requests containing criteria 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: + filter: + $ref: '#/components/schemas/AppSubscriptionFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array items: - $ref: "#/components/schemas/OutputStructuredPingResponseItem" - OutputStructuredTraceroute: + $ref: '#/components/schemas/AppSubscriptionSortCriteria' + AppSubscriptionSearchResponse: type: object properties: - destinationIp: - type: string - example: 8.8.8.8 - destinationName: - type: string - example: 8.8.8.8 - packetBytes: - type: integer - example: 60 - hopsMax: - type: integer - example: 10 - hops: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. type: array items: - $ref: "#/components/schemas/Hop" - CrossConnectConnectorType: - type: string - description: Connector Type. - example: SC - CrossConnectContactPreference: - type: object - properties: - timezone: - type: string - description: Timezone. - example: PST - availability: - $ref: "#/components/schemas/CrossConnectContactAvailability" - description: Cross Connect Contact Preference. - SignatureType: - type: string - description: Cross Connect Signature Type. - example: DELEGATE - enum: - - DELEGATE - - SELF - - ACCOUNT_SUPPORT - 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 - - BASIC - - STANDARD - - ADVANCED - - 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 - VirtualPortPackageCode: - type: string - description: Virtual port package code - example: STANDARD, UNLIMITED or UNLIMITED_PLUS - TimeServicePriceConnectionASide: - type: object - properties: - accessPoint: - $ref: "#/components/schemas/TimeServicePriceConnectionAccessPoint" - description: Time Service Price Connection ASide configuration - OpticalConnectPriceLocation: - type: object - properties: - ibxCode: - type: string - description: IBX identifier - example: SV1 - description: Optical Connect Location - 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 - name: - type: string - description: Customer-assigned Virtual Device name - type: - type: string - description: Type of Virtual Device - enum: - - EDGE - account: - $ref: "#/components/schemas/SimplifiedAccount" - 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 - - EVPTREE - - EPTREE - name: - type: string - description: Network Name - scope: - type: string - description: scope of Network - enum: - - LOCAL - - REGIONAL - - GLOBAL - location: - $ref: "#/components/schemas/SimplifiedLocation" - 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 - Hop: - type: object - properties: - hop: - type: integer - example: 1 - probes: - type: array - items: - $ref: "#/components/schemas/Hop_probes" - CrossConnectContactAvailability: - type: string - description: Availability preference. - example: ANYTIME - enum: - - ANYTIME - - NEVER - - WORK_HOURS - - IBX_HOURS - TimeServicePriceConnectionAccessPoint: - type: object - properties: - location: - $ref: "#/components/schemas/PriceLocation" - description: Time Service Price Connection Access Point configuration - InternetAccessPostRequest_billing: - required: - - type - type: object - properties: - type: - $ref: "#/components/schemas/InternetAccessBillingType" - InternetAccessRoutingProtocolBgpRequest_asn: - required: - - uuid - type: object - properties: - uuid: - type: string - description: Unique identifier of the ASN - format: uuid - example: ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91 - 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 - 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 - ValidateRequest_filter_and: - type: object - 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 - CompanyProfileResponse_account: - type: object - properties: - rootOrgId: - type: string - LoaResponse_operation: - type: object - properties: - consumersCount: - type: integer - description: Number of consumers associated with this LOA. - example: 10 - CrossConnectResponse_allowedActions: - type: object - properties: - type: - $ref: "#/components/schemas/CrossConnectActionType" - Response_incomplete_details: - type: object - properties: - reason: - type: string - description: The reason why the response is incomplete. - enum: - - max_output_tokens - - content_filter - description: | - Details about why the response is incomplete. - nullable: true - ResponseUsage_input_tokens_details: - required: - - cached_tokens - type: object - properties: - cached_tokens: - type: integer - description: | - The number of tokens that were retrieved from the cache. - [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). - description: A detailed breakdown of the input tokens. - ResponseUsage_output_tokens_details: - required: - - reasoning_tokens - type: object - properties: - reasoning_tokens: - type: integer - description: The number of reasoning tokens. - description: A detailed breakdown of the output tokens. - Gateway_ipv4: - type: object - properties: - primaryIp: - type: string - example: 192.168.1.1/30 - secondaryIp: - type: string - example: 192.168.1.2/30 - description: Gateway IPv4 address - TunnelRoutingProtocolPostRequest_ipv4: - type: object - properties: - enabled: - type: boolean - description: Enable or disable the Routing Protocol on IPv4 - example: true - description: IPv4 configuration for the Routing Protocol - TunnelRoutingProtocol_ipv4: - type: object - properties: - enabled: - type: boolean - description: Enable or disable the Routing Protocol on IPv4 - example: true - localPeerIp: - type: string - description: The local IP address - format: string - example: 192.168.1.1 - remotePeerIp: - type: string - description: The remote peer's IP address - format: string - example: 192.168.1.2 - description: IPv4 configuration for the Routing Protocol - Metric_resource: - type: object - properties: - href: - type: string - description: Metric resource href - uuid: - type: string - description: Metric resource UUID - type: - type: string - description: Metric resource type - state: - type: string - description: Metric resource state - name: - type: string - description: Metric resource name - description: - type: string - description: Metric resource description - description: Metric resource - Metric_datapoints: - type: object - properties: - endDateTime: - type: string - description: Datapoint end date and time - format: date-time - startDateTime: - type: string - description: Datapoint start date and time - format: date-time - value: - type: number - description: Datapoint value - ConnectionRouteTableEntry_connection: - type: object - properties: - uuid: - type: string - example: 81331c52-04c0-4656-a4a7-18c52669348f - name: - type: string - example: connection_1 - href: - type: string - example: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 - InternetAccessRoutingProtocolBgp_asn: - required: - - uuid - type: object - properties: - href: - type: string - description: URI of the ASN resource - example: https://api.equinix.com/fabric/v4/asns/ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91 - uuid: - type: string - description: Unique identifier of the ASN - format: uuid - example: ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91 - IpBlockRegulations_questions: - required: - - privateSpaceConsidered - - refusedPreviously - - returningAddressSpace - type: object - properties: - privateSpaceConsidered: - type: boolean - refusedPreviously: - type: boolean - returningAddressSpace: - type: boolean - PatchIpBlockRequestBodyItem_value: - required: - - uuid - type: object - properties: - uuid: - type: string - format: uuid - description: new value - RouteTableEntry_connection: - type: object - properties: - uuid: - type: string - example: 81331c52-04c0-4656-a4a7-18c52669348f - name: - type: string - example: connection_1 - href: - type: string - format: uri - CompanyProfileContact_contacts: - required: - - email - properties: - name: - type: string - role: - type: string - email: - type: string - CrossConnectScheduleAvailability_aSide: - type: object - properties: - location: - $ref: "#/components/schemas/CrossConnectLocation" - description: A-Side of the schedule window. - readOnly: true - CrossConnectScheduleAvailability_zSide: - type: object - properties: - location: - $ref: "#/components/schemas/CrossConnectLocation" - description: Z-Side of the schedule window. - readOnly: true - 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" - Hop_probes: - type: object - properties: - name: - type: string - example: dns.google - ip: - type: string - example: 8.8.8.8 - asn: - type: integer - example: 15169 - rtt: - type: string - example: "11.764" - annotation: - type: string - examples: - "400": - value: - - errorCode: EQ-3036013 - errorMessage: Invalid Query Parameter - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: presence - reason: Allowed value for presence is MY_SERVICES - "401": - value: - - errorCode: EQ-3000039 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - "403": - value: - - errorCode: EQ-3142402 - errorMessage: Do not have create connection permission on this port - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - "404": - value: - - errorCode: EQ-3045811 - 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: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - "500": - value: - - errorCode: EQ-3034003 - errorMessage: Method not supported,Please check the URL passed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: method:PATCH - AgentTemplatesGetAllResponseExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/agentTemplates/d684aa26-8276-48b7-bb42-a6d9def0a418 - type: ANO_AGENT_TEMPLATE - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - name: CONNECTION BANDWIDTH UPGRADER AGENT TEMPLATE - description: connection bandwidth upgrader Agent Template - state: PROVISIONED - enabled: true - definition: - url: /equinix/agent-factory/refs/heads/use_pdf_html/agent_factory_schema/equinix/fabric/v1/event_driven/upgrade-bw-primary-connection.md - modes: - - ON_EVENT - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - updatedBy: testuser - updatedDateTime: 2024-05-06T16:21:18.545214Z - AgentTemplate_401: - value: - - errorCode: EQ-3164013 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - AgentTemplate_403: - value: - - errorCode: EQ-3164013 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - AgentTemplate_404: - value: - - errorCode: EQ-3164811 - errorMessage: Agent Template not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: Agent Template not found or already deleted - AgentTemplate_500: - value: - - errorCode: EQ-3164004 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - AgentTemplatesResponseExample: - value: - href: https://api.equinix.com/fabric/v4/agentTemplates/d684aa26-8276-48b7-bb42-a6d9def0a418 - type: ANO_AGENT_TEMPLATE - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - name: CONNECTION BANDWIDTH UPGRADER AGENT TEMPLATE - description: connection bandwidth upgrader Agent Template - state: PROVISIONED - enabled: true - definition: - url: /equinix/agent-factory/refs/heads/use_pdf_html/agent_factory_schema/equinix/fabric/v1/event_driven/upgrade-bw-primary-connection.md - modes: - - ON_EVENT - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - updatedBy: testuser - updatedDateTime: 2024-05-06T16:21:18.545214Z - AgentTemplatesSearchExample: - value: - filter: - and: - - property: /name - operator: IN - values: - - name1 - pagination: - offset: 0 - limit: 20 - AgentTemplatesTagsResponseExample: - value: - pagination: - offset: 0 - limit: 20 - total: 3 - data: - - href: https://api.equinix.com/fabric/v4/tags/d684aa26-8276-48b7-bb42-a6d9def0a418 - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - type: PREDEFINED_TAG - name: equinix.fabric.agent_factory.templates.design - displayName: Design & Plan Agents - - href: https://api.equinix.com/fabric/v4/tags/e684aa26-8276-48b7-bb42-a6d9def0a418 - uuid: e684aa26-8276-48b7-bb42-a6d9def0a418 - type: PREDEFINED_TAG - name: equinix.fabric.agent_factory.templates.deploy - displayName: Deploy & Change Agents - - href: https://api.equinix.com/fabric/v4/tags/f684aa26-8276-48b7-bb42-a6d9def0a418 - uuid: f684aa26-8276-48b7-bb42-a6d9def0a418 - type: PREDEFINED_TAG - name: equinix.fabric.agent_factory.templates.monitor - displayName: Monitor & Report Agents - AgentTemplatesByUuidTagsResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tags/d684aa26-8276-48b7-bb42-a6d9def0a418 - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - type: PREDEFINED_TAG - name: equinix.fabric.agent_factory.templates.design - displayName: Design & Plan Agents - AgentGetAllResponseExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/agents/d684aa26-8276-48b7-bb42-a6d9def0a418 - type: ANO_AGENT - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - name: bandwidth-upgrader-agent - description: connection bandwidth upgrader agent - state: PROVISIONED - enabled: true - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - agentTemplate: - uuid: 657400f8-c0af-430c-8216-43d44f08c1c5 - mode: ON_DEMAND - configuration: - prompt: Connection uuid is . Alert rule is . Upgrade bandwidth to 10GB. - activitiesCount: 0 - operation: - latestExecution: - href: https://api.equinix.com/fabric/v4/agents/d684aa26-8276-48b7-bb42-a6d9def0a418/activities/e684aa26-8276-48b7-bb42-a6d9def0a418 - uuid: e684aa26-8276-48b7-bb42-a6d9def0a418 - status: COMPLETED - startDateTime: 2026-07-29T00:00:00.001201Z - endDateTime: 2026-07-29T00:01:00.001201Z - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - Agent_401: - value: - - errorCode: EQ-3164013 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - Agent_403: - value: - - errorCode: EQ-3164013 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - Agent_404: - value: - - errorCode: EQ-3164811 - errorMessage: Agent not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: Agent not found or already deleted - Agent_500: - value: - - errorCode: EQ-3164004 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - AgentPostRequestExample: - value: - type: ANO_AGENT - name: bandwidth-upgrader-agent - description: connection bandwidth upgrader agent - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - agentTemplate: - uuid: 657400f8-c0af-430c-8216-43d44f08c1c5 - configuration: - prompt: Connection uuid is . Alert rule is . Upgrade bandwidth to 10GB. - AgentPostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/agents/d684aa26-8276-48b7-bb42-a6d9def0a418 - type: ANO_AGENT - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - name: bandwidth-upgrader-agent - description: connection bandwidth upgrader agent - state: PROVISIONING - enabled: true - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - agentTemplate: - uuid: 657400f8-c0af-430c-8216-43d44f08c1c5 - configuration: - prompt: Connection uuid is . Alert rule is . Upgrade bandwidth to 10GB. - activitiesCount: 0 - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - deletedBy: testuser - deletedDateTime: 2024-05-10T16:21:18.545214Z - Agent_415: - value: - - errorCode: EQ-3164009 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - AgentResponseExample: - value: - href: https://api.equinix.com/fabric/v4/agents/d684aa26-8276-48b7-bb42-a6d9def0a418 - type: ANO_AGENT - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - name: bandwidth-upgrader-agent - description: connection bandwidth upgrader agent - state: PROVISIONING - enabled: true - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - agentTemplate: - uuid: 657400f8-c0af-430c-8216-43d44f08c1c5 - configuration: - prompt: Connection uuid is . Alert rule is . Upgrade bandwidth to 10GB. - activitiesCount: 0 - operation: - latestExecution: - href: https://api.equinix.com/fabric/v4/agents/d684aa26-8276-48b7-bb42-a6d9def0a418/activities/e684aa26-8276-48b7-bb42-a6d9def0a418 - uuid: e684aa26-8276-48b7-bb42-a6d9def0a418 - status: COMPLETED - startDateTime: 2026-07-29T00:00:00.001201Z - endDateTime: 2026-07-29T00:01:00.001201Z - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - AgentDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/agents/d684aa26-8276-48b7-bb42-a6d9def0a418 - type: ANO_AGENT - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - name: bandwidth-upgrader-agent - description: connection bandwidth upgrader agent - state: DEPROVISIONING - enabled: true - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - agentTemplate: - uuid: 657400f8-c0af-430c-8216-43d44f08c1c5 - configuration: - prompt: Connection uuid is . Alert rule is . Upgrade bandwidth to 10GB. - activitiesCount: 0 - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - deletedBy: testuser - deletedDateTime: 2024-05-10T16:21:18.545214Z - AgentPatchRequestExample: - value: - path: /name - op: replace - value: bandwidth-upgrader-agent-updated - AgentPatchResponseExample: - value: - href: https://api.equinix.com/fabric/v4/agents/d684aa26-8276-48b7-bb42-a6d9def0a418 - type: ANO_AGENT - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - name: bandwidth-upgrader-agent-updated - description: connection bandwidth upgrader agent updated - state: PROVISIONING - enabled: true - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - agentTemplate: - uuid: 657400f8-c0af-430c-8216-43d44f08c1c5 - configuration: - prompt: Connection uuid is . Alert rule is . Upgrade bandwidth to 10GB. - activitiesCount: 0 - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - updatedBy: testuser - updatedDateTime: 2024-05-06T16:21:18.545214Z - AgentActivitiesResponseExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/agents/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/activities - type: AGENT_ACTIVITY - uuid: 123e4567-e89b-12d3-a456-426614174000 - agent: - uuid: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 - type: ANO_AGENT - status: COMPLETED - metadata: - chatMessage: - messages: - - type: user - content: |- - Here are additional parameters: json - { - "connection_uuid": "456e4567-e89b-12d3-a456-426614174000", - "operand": "ABOVE", - "critical_threshold": 400000, - "stream_uuid": 789e4567-e89b-12d3-a456-426614174000 - }. Follow the instructions step by step and complete all the operations. - - type: assistant - content: The agent is setup process has been successfully completed. - toolCallInformation: - - name: search_connections - input: '{"query":{"filter":{"and":[{"property":"/uuid","operator":"=","values":["456e4567-e89b-12d3-a456-426614174000"]}]},"pagination":{"limit":5}}}' - response: '{"results":[{"uuid":"456e4567-e89b-12d3-a456-426614174000","name":"Primary Connection","bandwidth":"1Gbps"}]}' - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - AgentActionGetAllResponseExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/agents/e59b74d7-58ca-408e-a406-b701e3fba0a7/actions/ee8532ca-7378-4343-b5f8-d17d9aad2895 - uuid: ee8532ca-7378-4343-b5f8-d17d9aad2895 - type: EXECUTE_AGENT - status: PENDING - schedule: - executeDateTime: 2026-03-20T10:10:10.000Z - changeLog: - createdBy: testUser@equinix.com - createdDateTime: 2026-03-10T10:10:10.000Z - AgentActionPostRequestExample: - value: - type: EXECUTE_AGENT - schedule: - executeDateTime: 2026-03-20T10:10:10.000Z - AgentActionResponseExample: - value: - href: https://api.equinix.com/fabric/v4/agents/e59b74d7-58ca-408e-a406-b701e3fba0a7/actions/ee8532ca-7378-4343-b5f8-d17d9aad2895 - uuid: ee8532ca-7378-4343-b5f8-d17d9aad2895 - type: EXECUTE_AGENT - status: PENDING - schedule: - executeDateTime: 2026-03-20T10:10:10.000Z - changeLog: - createdBy: testUser@equinix.com - createdDateTime: 2026-03-10T10:10:10.000Z - AgentActionDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/agents/e59b74d7-58ca-408e-a406-b701e3fba0a7/actions/ee8532ca-7378-4343-b5f8-d17d9aad2895 - uuid: ee8532ca-7378-4343-b5f8-d17d9aad2895 - type: EXECUTE_AGENT - status: DELETED - schedule: - executeDateTime: 2026-03-20T10:10:10.000Z - changeLog: - createdBy: testUser@equinix.com - createdDateTime: 2026-03-10T10:10:10.000Z - AgentSearchExample: - value: - filter: - and: - - property: /name - operator: IN - values: - - name1 - pagination: - offset: 0 - limit: 20 - 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 - traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, - tracestate: 71a60705518f,81a607055181 - data: - message: Neighbor 100.100.100.102 address session state changed to Connect - auth: - authtype: system - authid: 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" - traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, - tracestate: 71a60705518f,81a607055181 - data: - message: Connection named TEST-CONNECTION state changed to provisioning - resource: - href: http://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: - authtype: user - authid: "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 - traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, - tracestate: 71a60705518f,81a607055181 - data: - message: Connection named TEST-CONNECTION state changed to provisioned - resource: - href: http://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: - authtype: system - authid: 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" - traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, - tracestate: 71a60705518f,81a607055181 - data: - message: Connection named TEST-CONNECTION state changed to provisioning - resource: - href: http://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: - authtype: user - authid: "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: /equinixorganization - operator: = - values: - - "526698000597331" - - property: /equinixproject - operator: = - values: - - dadd3ab6-c0af-430c-8216-43d44f08c1c5 - - property: /time - operator: ">" - values: - - 2018-04-05T17:31:00.000Z - pagination: - offset: 0 - limit: 20 - search-live-events: - value: - filter: - and: - - property: /subject - operator: IN - values: - - /fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - pagination: - offset: 0 - limit: 2 - search-live-events-response: - value: - pagination: - offset: 0 - limit: 2 - total: 1 - data: - - specversion: "1.0" - source: https://api.equinix.com/fabric/v4/cloudevents - id: 6c573287-9914-4202-8b6d-2d15e7da04b8 - type: equinix.fabric.port.status.down - subject: /fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - time: 2018-04-05T17:31:00.000Z - dataschema: https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json - datacontenttype: application/json - severitynumber: "21" - severitytext: FATAL - equinixalert: raise/AABBcCCDDeEfFf123, - equinixproject: project-123 - data: - message: Virtual port 'port-name' status changed to DOWN - resource: - href: https://api.equinix.com//fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - uuid: 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - type: XF_PORT - state: PROVISIONED - operation: - operationalStatus: DOWN - search-live-alerts: - value: - filter: - and: - - property: /equinixalert - operator: LIKE - values: - - raise/% - - property: /time - operator: BETWEEN - values: - - 2026-01-01T00:00:00.000Z - - 2026-01-02T00:00:00.000Z - - or: - - property: /equinixproject - operator: IN - values: - - 6a7ce6bb-4424-414d-bea4-7a6a05ff1919 - - property: /subject - operator: LIKE - values: - - /fabric/v4/metros/* - sort: - property: /time - order: DESC - pagination: - limit: 100 - offset: 0 - search-live-alerts-response: - value: - pagination: - offset: 0 - limit: 100 - total: 2 - data: - - specversion: "1.0" - source: https://api.equinix.com/fabric/v4/liveAlerts - id: 6c573287-9914-4202-8b6d-2d15e7da04b8 - type: equinix.fabric.connection.status.down - subject: /fabric/v4/connections/956a86fb-d03d-436c-8d5d-30d1f51f7688 - time: 2026-01-01T03:00:00.000Z - dataschema: https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json - datacontenttype: application/json - severitynumber: "19" - severitytext: CRITICAL - equinixalert: raise/NCAB543WC4lrLpET8nLX4Vm8 - equinixproject: 6a7ce6bb-4424-414d-bea4-7a6a05ff1919 - data: - message: Connection 'Test-Connection' status changed to Down - resource: - href: https://api.equinix.com/fabric/v4/connections/956a86fb-d03d-436c-8d5d-30d1f51f7688 - uuid: 956a86fb-d03d-436c-8d5d-30d1f51f7688 - type: IP_VC - state: PROVISIONED - name: Test name - - specversion: "1.0" - source: https://api.equinix.com/fabric/v4/liveAlerts - id: 6c573287-9914-4202-8b6d-2d15e7da04b8 - type: equinix.fabric.metro.sv_ch.latency - subject: /fabric/v4/metros/SV - time: 2026-01-01T03:30:00.000Z - dataschema: https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json - datacontenttype: application/json - severitynumber: "13" - severitytext: WARN - equinixalert: raise/DAEB543WC4lrLpET8nLX4Vm8 - data: - message: Abnormal detected for metro latency from Silicon to Chicago - resource: - href: https://api.equinix.com/fabric/v4/metros/SV - code: SV - type: XF_METRO - metrics: - - type: GAUGE - name: equinix.fabric.metro.sv_ch.latency - unit: ms - datapoints: - - endDateTime: 2026-01-01T03:30:00.000Z - value: 63.6634 - get-metrics-by-asset-id: - value: - pagination: - offset: 0 - limit: 10 - total: 2 - next: null - previous: null - data: - - type: GAUGE - name: equinix.fabric.port.bandwidth_rx.usage - unit: bit/s - interval: PT5M - resource: - href: https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72 - uuid: 0689734d-25c6-40d1-a9ff-3e4edea07a72 - type: XF_PORT - state: PROVISIONED - name: my-port-name - summary: - mean: 102.15384615384616 - max: 107 - datapoints: - - endDateTime: 2025-05-14T13:57:56.000Z - value: 107 - - endDateTime: 2025-05-14T14:02:48.000Z - value: 97 - - endDateTime: 2025-05-14T14:07:58.000Z - value: 105 - - endDateTime: 2025-05-14T14:12:36.000Z - value: 102 - - endDateTime: 2025-05-14T14:18:00.000Z - value: 96 - - endDateTime: 2025-05-14T14:23:03.000Z - value: 106 - - endDateTime: 2025-05-14T14:27:59.000Z - value: 104 - - endDateTime: 2025-05-14T14:32:56.000Z - value: 104 - - endDateTime: 2025-05-14T14:37:51.000Z - value: 103 - - endDateTime: 2025-05-14T14:42:59.000Z - value: 100 - - endDateTime: 2025-05-14T14:47:58.000Z - value: 105 - - endDateTime: 2025-05-14T14:53:08.000Z - value: 94 - - endDateTime: 2025-05-14T14:57:46.000Z - value: 105 - - type: GAUGE - name: equinix.fabric.port.bandwidth_tx.usage - unit: bit/s - interval: PT5M - resource: - href: https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72 - uuid: 0689734d-25c6-40d1-a9ff-3e4edea07a72 - summary: - mean: 255.92307692307693 - max: 295 - datapoints: - - endDateTime: 2025-05-14T13:57:56.000Z - value: 259 - - endDateTime: 2025-05-14T14:02:48.000Z - value: 234 - - endDateTime: 2025-05-14T14:07:58.000Z - value: 242 - - endDateTime: 2025-05-14T14:12:36.000Z - value: 280 - - endDateTime: 2025-05-14T14:18:00.000Z - value: 243 - - endDateTime: 2025-05-14T14:23:03.000Z - value: 262 - - endDateTime: 2025-05-14T14:27:59.000Z - value: 247 - - endDateTime: 2025-05-14T14:32:56.000Z - value: 295 - - endDateTime: 2025-05-14T14:37:51.000Z - value: 284 - - endDateTime: 2025-05-14T14:42:59.000Z - value: 227 - - endDateTime: 2025-05-14T14:47:58.000Z - value: 260 - - endDateTime: 2025-05-14T14:53:08.000Z - value: 251 - - endDateTime: 2025-05-14T14:57:46.000Z - value: 243 - maintenancesGetAll: - value: - pagination: - offset: 0 - limit: 20 - total: 2 - data: - - href: https://api.equinix.com/fabric/v4/ports/b2d93b39-02db-2dbc-ace0-30fa5c00ad04/maintenances/a1d93b39-02db-2dbc-ace0-30fa5c00ad04 - uuid: a1d93b39-02db-2dbc-ace0-30fa5c00ad04 - type: XF_MAINTENANCE - category: NETWORK_UPGRADE - state: POSTPONED - incidentRefId: CHG0123456 - root: - href: https://api.equinix.com/fabric/v4/ports/b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - type: XF_PORT - uuid: b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - startDateTime: 2026-07-10T00:00:00Z - endDateTime: 2026-07-10T08:00:00Z - group: - uuid: c3d93b39-02db-2dbc-ace0-30fa5c00ad04 - scope: ASIDE - changeLog: - createdBy: admin_user - createdDateTime: 2026-07-01T09:00:00Z - updatedBy: test_user - updatedDateTime: 2026-07-05T14:30:00Z - - href: https://api.equinix.com/fabric/v4/ports/b2d93b39-02db-2dbc-ace0-30fa5c00ad04/maintenances/b1d93b39-02db-2dbc-ace0-30fa5c00ad04 - uuid: b1d93b39-02db-2dbc-ace0-30fa5c00ad04 - type: XF_MAINTENANCE - category: NETWORK_UPGRADE - state: SCHEDULED - incidentRefId: CHG0123457 - root: - href: https://api.equinix.com/fabric/v4/ports/b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - type: XF_PORT - uuid: b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - startDateTime: 2026-07-11T00:00:00Z - endDateTime: 2026-07-11T08:00:00Z - group: - uuid: c3d93b39-02db-2dbc-ace0-30fa5c00ad04 - scope: ZSIDE - changeLog: - createdBy: admin_user - createdDateTime: 2026-07-01T09:00:00Z - updatedBy: test_user - updatedDateTime: 2026-07-05T14:30:00Z - maintenanceGet: - value: - href: https://api.equinix.com/fabric/v4/ports/b2d93b39-02db-2dbc-ace0-30fa5c00ad04/maintenances/a1d93b39-02db-2dbc-ace0-30fa5c00ad04 - uuid: a1d93b39-02db-2dbc-ace0-30fa5c00ad04 - type: XF_MAINTENANCE - category: NETWORK_UPGRADE - state: POSTPONED - incidentRefId: CHG0123456 - root: - href: https://api.equinix.com/fabric/v4/ports/b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - type: XF_PORT - uuid: b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - startDateTime: 2026-07-10T00:00:00Z - endDateTime: 2026-07-10T08:00:00Z - group: - uuid: c3d93b39-02db-2dbc-ace0-30fa5c00ad04 - scope: ASIDE - changeLog: - createdBy: admin_user - createdDateTime: 2026-07-01T09:00:00Z - updatedBy: test_user - updatedDateTime: 2026-07-05T14:30:00Z - maintenanceActionsGetAll: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2/maintenances/a1d93b39-02db-2dbc-ace0-30fa5c00ad04/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: MAINTENANCE_POSTPONE - state: COMPLETED - notes: Deferring maintenance at customer request. - changeLog: - createdBy: admin_user - createdDateTime: 2025-10-21T10:30:00Z - maintenanceActionRequest: - value: - type: MAINTENANCE_POSTPONE - notes: Deferring maintenance at customer request. - maintenanceActionPost: - value: - href: https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2/maintenances/a1d93b39-02db-2dbc-ace0-30fa5c00ad04/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: MAINTENANCE_POSTPONE - state: PENDING - notes: Deferring maintenance at customer request. - changeLog: - createdBy: admin_user - createdDateTime: 2025-10-21T10:30:00Z - maintenanceActionSearchRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - MAINTENANCE_POSTPONE - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - maintenanceActionGet: - value: - href: https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2/maintenances/a1d93b39-02db-2dbc-ace0-30fa5c00ad04/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: MAINTENANCE_POSTPONE - state: COMPLETED - notes: Deferring maintenance at customer request. - changeLog: - createdBy: admin_user - createdDateTime: 2025-10-21T10:30:00Z - maintenanceSearchByAssetId: - value: - filter: - property: /root/uuid - operator: IN - values: - - b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - - f2d93b39-02db-2dbc-ace0-30fa5c00ad08 - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - maintenanceSearchByOptionalFilters: - value: - filter: - and: - - property: /state - operator: IN - values: - - POSTPONED - - SCHEDULED - - IN_PROGRESS - - COMPLETED - - CANCELLED - - or: - - property: /root/uuid - operator: IN - values: - - b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - - f2d93b39-02db-2dbc-ace0-30fa5c00ad08 - - property: /uuid - operator: IN - values: - - a1d93b39-02db-2dbc-ace0-30fa5c00ad04 - pagination: - offset: 0 - limit: 20 - sort: - - property: /startDateTime - direction: ASC - - property: /changeLog/updatedDateTime - direction: DESC - maintenanceSearchRangeOperators: - value: - filter: - and: - - property: /startDateTime - operator: BETWEEN - values: - - 2026-07-01T00:00:00Z - - 2026-07-31T23:59:59Z - - property: /endDateTime - operator: BETWEEN - values: - - 2026-07-01T00:00:00Z - - 2026-07-31T23:59:59Z - - property: /state - operator: IN - values: - - SCHEDULED - - POSTPONED - - IN_PROGRESS - - COMPLETED - - CANCELLED - pagination: - offset: 0 - limit: 50 - sort: - - property: /startDateTime - direction: ASC - get-metrics-by-name: - value: - pagination: - offset: 0 - limit: 5000 - total: 3 - data: - - type: GAUGE - name: equinix.fabric.metro.at_am.latency - unit: ms - resource: - href: https://uatapi.equinix.com/fabric/v4/metros/AT - type: XF_METRO - description: Atlanta to Amsterdam intermetro latency, average in milliseconds - datapoints: - - endDateTime: 2026-02-03T23:05:04Z - value: 94.8 - - type: GAUGE - name: equinix.fabric.metro.at_ba.latency - unit: ms - resource: - href: https://uatapi.equinix.com/fabric/v4/metros/AT - type: XF_METRO - description: Atlanta to Barcelona intermetro latency, average in milliseconds - datapoints: - - endDateTime: 2026-02-03T23:05:04Z - value: 111 - - type: GAUGE - name: equinix.fabric.metro.at_bg.latency - unit: ms - resource: - href: https://uatapi.equinix.com/fabric/v4/metros/AT - type: XF_METRO - description: Atlanta to Bogota intermetro latency, average in milliseconds - datapoints: - - endDateTime: 2026-02-03T23:05:04Z - value: 69.8 - search-metrics: - value: - filter: - and: - - property: /subject - operator: = - values: - - /fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - - property: /name - operator: IN - values: - - equinix.fabric.port.bandwidth_rx.usage - - equinix.fabric.port.bandwidth_tx.usage - - equinix.fabric.port.packets_dropped_rx.count - - equinix.fabric.port.packets_dropped_tx.count - - property: /dataPoints/endDateTime - operator: BETWEEN - values: - - 2025-09-01T19:19:50Z - - 2025-09-03T19:19:50Z - pagination: - offset: 0 - limit: 10 - COLO2COLO-Dot1q2Dot1q: - value: - type: EVPL_VC - name: My-Port-2-Port-Connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a8ba52de-faae-43b5-b0b1-6904d37ee063 - linkProtocol: - type: DOT1Q - vlanTag: 1001 - zSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2COLO-Dot1q2Dot1q-withTerms: - value: - type: EVPL_VC - name: My-Port-2-Port-Connection-1 - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 24 - aSide: - accessPoint: - type: COLO - port: - uuid: a8ba52de-faae-43b5-b0b1-6904d37ee063 - linkProtocol: - type: DOT1Q - vlanTag: 1001 - zSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2COLO-Dot1q2Dot1q-withGeoScope: - value: - type: EVPL_VC - name: My-Port-2-Port-Connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a867f685-41b0-1b07-6de0-320a5c00abdd - linkProtocol: - type: DOT1Q - vlanTag: 1001 - zSide: - accessPoint: - type: COLO - port: - uuid: b067f685-49b0-1a09-6fe0-360a5d00afdd - linkProtocol: - type: DOT1Q - vlanTag: 1001 - geoScope: CONUS - project: - projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 - notifications: - - type: ALL - emails: - - test@test.com - COLO2COLO-Dot1Q2QinQ: - value: - type: EVPL_VC - name: My-Port-2-Port-Connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - zSide: - accessPoint: - type: COLO - port: - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - linkProtocol: - type: QINQ - vlanSTag: 1001 - vlanCTag: 1002 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2COLO-Qinq2Qinq: - value: - type: EVPL_VC - name: My-Port-2-Port-Connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: QINQ - vlanSTag: 12 - zSide: - accessPoint: - type: COLO - port: - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - linkProtocol: - type: QINQ - vlanSTag: 13 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2COLO-Qinq2Dot1q: - value: - type: EVPL_VC - name: My-Port-2-Port-Connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: QINQ - vlanSTag: 1001 - vlanCTag: 1125 - 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 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - COLO2COLO-MetroConnect: - value: - type: MC_VC - name: metro-connect-P2P - bandwidth: 1000 - 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: - value: - type: EPL_VC - name: My-Port-2-Port-Connection-1 - order: - purchaseOrderNumber: po1234 - termLength: 1 - bandwidth: 100 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - zSide: - accessPoint: - type: COLO - port: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - COLO2COLO-AccessEpl: - value: - type: ACCESS_EPL_VC - name: My-Port-2-Port-Connection-1 - order: - purchaseOrderNumber: 1-129105284100 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - COLO2SPwithDot1q: - value: - type: EVPL_VC - name: My-Layer2-Connection-3 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2SPwithGeoScope: - value: - type: EVPL_VC - name: My-Port-2-GenSP-Conn-1 - bandwidth: 50 - redundancy: - priority: PRIMARY - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: c4d93b39-034e-34ec-ace0-30fa5c00ad01 - linkProtocol: - type: DOT1Q - vlanTag: 23 - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 5a76497a-ff00-4a89-a605-b0680799c6aa - location: - metroCode: DC - geoScope: CONUS - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - COLO2SPNonGenwithGeoScope: - value: - type: EVPL_VC - name: My-Port-2-NonGenSP-Conn-1 - bandwidth: 100 - redundancy: - priority: PRIMARY - order: - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: c4d93b39-0341-341c-ace0-30fa5c00ad01 - linkProtocol: - type: QINQ - vlanSTag: 23 - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: bfb74121-7e2c-4f74-99b3-69cdafb03b41 - location: - metroCode: SV - authenticationKey: xxxx-xxx-xxxx - geoScope: CONUS - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - COLO2AlibabaSPwithDot1q: - value: - type: EVPL_VC - name: port2alibaba-connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2AWSSPwithDot1q-Primary: - value: - type: EVPL_VC - name: Primary-Aws - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2AzureSP-Primary: - value: - type: EVPL_VC - name: port2azure-connection-1 - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: d166b9ce-79ed-4ea6-8f8b-785fd69f3dcc - linkProtocol: - type: DOT1Q - vlanTag: 123 - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: a1390b22-abe0-4e93-ad37-85beef9d254a - location: - metroCode: DC - peeringType: PRIVATE - authenticationKey: xxx-xxx-xxx - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2LMaaSSP: - value: - type: EVPL_VC - name: Last Mile Connection 1 - bandwidth: 10 - redundancy: - priority: PRIMARY - order: - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: d4db1048-ef3d-f3d6-49e0-306a5c00a341 - linkProtocol: - type: QINQ - vlanSTag: 121 - vlanCTag: 145 - zSide: - accessPoint: - type: SP - profile: - uuid: 8236fbb9-51e5-428f-86bf-6b67e1223ac1 - location: - metroCode: DC - productOffering: - id: sample-product-offering-id - name: Sample product offering 1 - billingTerm: 12 - bandwidthCommit: 50 - address: - id: lmaas-addr-sample-id - streetNr: "1234" - streetName: Main St - city: San Jose - stateOrProvince: CA - postCode: "95101" - country: United States - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - someone@sample.com - - type: ORDERING - emails: - - someone@sample.com - phone: - - type: OFFICE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: MOBILE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: TECHNICAL - emails: - - someone@sample.com - phone: - - type: OFFICE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: MOBILE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - COLO2GoogleSPwithDot1q: - value: - type: EVPL_VC - name: My-Layer2-Connection-3 - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@test.com - COLO2IBM_1: - value: - type: EVPL_VC - name: My-Layer2-Connection-3 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - 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 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - 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 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2ServiceToken: - value: - type: EVPL_VC - name: Conn-1 - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - location: - metroCode: SV - zSide: - serviceToken: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - COLO2NETWORKwithDot1q: - value: - type: EVPLAN_VC - name: colo2network-evplan-vc - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - COLO2NETWORKwithEPL: - value: - type: EPLAN_VC - name: colo2network-eplan-vc - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 - zSide: - accessPoint: - type: NETWORK - network: - uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - COLO2NETWORK_EVPTREE_withDot1q: - value: - type: EVPTREE_VC - name: colo2network-evptree-vc - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - role: LEAF - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - COLO2NETWORK_EPTREE_withEPL: - value: - type: EPTREE_VC - name: colo2network-eptree-vc - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 - zSide: - accessPoint: - type: NETWORK - network: - uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 - role: LEAF - 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 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: VD - virtualDevice: - type: EDGE - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - interface: - type: NETWORK - id: 3 - zSide: - accessPoint: - type: NETWORK - network: - uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 - 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 - order: - purchaseOrderNumber: 1-1234567890 - termLength: 1 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - Vd2AzureSP: - value: - type: EVPL_VC - name: vd2azure-connection-1 - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - Vd2OracleSP: - value: - type: EVPL_VC - name: vd2oracle-connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 24 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - Vd2Ibm_1: - value: - type: EVPL_VC - name: vd2ibm10-connection-1 - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - Vd2Ibm_2: - value: - type: EVPL_VC - name: vd2ibm20-connection-1 - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - Vd2AlibabaSP: - value: - type: EVPL_VC - name: vd2alibaba-connection-1 - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - Vd2GoogleSP: - value: - type: EVPL_VC - name: vd2googleSp-connection-1 - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 24 - 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 - notifications: - - type: ALL - emails: - - fabric@equinx.com - Vd2Sp-Primary: - value: - type: EVPL_VC - name: Network Device to SP - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: VD - virtualDevice: - type: EDGE - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - interface: - type: NETWORK - id: 3 - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 - authenticationKey: xx-xx-xx - sellerRegion: us-west-1 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Vd2Sp-Secondary: - value: - type: EVPL_VC - name: Network Device to SP - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: 3 - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 - authenticationKey: xx-xx-xx - sellerRegion: us-west-1 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Vd2Colo: - value: - type: EVPL_VC - name: vd to COLO - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 24 - aSide: - accessPoint: - type: VD - virtualDevice: - type: EDGE - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - interface: - type: NETWORK - id: 3 - zSide: - accessPoint: - type: COLO - port: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - linkProtocol: - type: DOT1Q - vlanTag: 300 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - VD2COLO-Dot1q-withGeoScope: - value: - type: EVPL_VC - name: My-VD-2-COLO-Connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: VD - virtualDevice: - uuid: a867f685-41b0-1b07-6de0-320a5c00abdd - interface: - type: NETWORK - id: 1 - location: - metroCode: FR - zSide: - accessPoint: - type: COLO - port: - uuid: b067f685-49b0-1a09-6fe0-360a5d00afd0 - linkProtocol: - type: DOT1Q - vlanTag: 1001 - location: - metroCode: AM - geoScope: EU - project: - projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 - notifications: - - type: ALL - emails: - - test@test.com - Vd2Colo-VlanTag: - value: - type: EVPL_VC - name: vd to COLO - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: VD - virtualDevice: - type: EDGE - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - interface: - type: NETWORK - id: 3 - zSide: - accessPoint: - type: COLO - port: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - linkProtocol: - type: DOT1Q - vlanTagMin: 300 - vlanTagMax: 1099 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Vd2Colo-VlanCTag: - value: - type: EVPL_VC - name: vd to COLO - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: VD - virtualDevice: - type: EDGE - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - interface: - type: NETWORK - id: 3 - zSide: - accessPoint: - type: COLO - port: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - linkProtocol: - type: QINQ - vlanCTag: 300 - vlanSTag: 301 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Vd2ColoUntagged: - value: - type: EVPL_VC - name: vd to SP - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: VD - virtualDevice: - type: EDGE - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - interface: - type: NETWORK - id: 3 - zSide: - accessPoint: - type: COLO - port: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - linkProtocol: - type: UNTAGGED - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Vd2ServiceToken: - value: - type: EVPL_VC - name: vd2token-conn-1 - order: - purchaseOrderNumber: po1234 - termLength: 1 - bandwidth: 10 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: VD - virtualDevice: - type: EDGE - uuid: 207667ba-3211-452c-b0a8-8b9046e122a2 - zSide: - serviceToken: - uuid: 557411a5-16a6-4aef-beea-7f622e94f1e0 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcda - Fcr2Colo: - value: - type: IP_VC - name: My-FCR-Connection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Sp-Google: - value: - type: IP_VC - name: My-FCR-GCPConnection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Sp-Azure: - value: - type: IP_VC - name: My-FCR-AzureConnection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Sp-IBM: - value: - type: IP_VC - name: My-FCR-IBMConnection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: CLOUD_ROUTER - router: - uuid: 66a21614-1c4a-11ec-9621-0242ac130002 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - additionalInfo: - - key: Global - value: "false" - - key: IBM IPv4 CIDR - value: 172.16.0.18/30 - - key: CER IPv4 CIDR - value: 172.16.0.19/30 - Fcr2Sp-Generic: - value: - type: IP_VC - name: My-FCR-GenericConnection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - 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 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - 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 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Sp-Aws: - value: - type: IP_VC - name: My-FCR-AWSConnection - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Sp-Oracle: - value: - type: IP_VC - name: My-FCR-OracleConnection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - Fcr2Sp-Alibaba: - value: - type: IP_VC - name: My-FCR-AlibabaConnection - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - authenticationKey: xx-xx-xx - sellerRegion: us-west-1 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Vd: - value: - type: IP_VC - name: My-GW-VDConnection - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: 3 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Vd-Redundant-Secondary: - value: - type: IP_VC - name: My-GW-VDConnection-Secondary - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: 3 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2IpWan: - value: - type: IPWAN_VC - name: MY-IPWAN-CONNECTION-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: CLOUD_ROUTER - router: - uuid: 66a21614-1c4a-11ec-9621-0242ac130002 - zSide: - accessPoint: - type: NETWORK - network: - uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Sp-Aws-marketplaceSubscription: - value: - type: IP_VC - name: My-FCR-AWSConnection - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2ServiceToken: - value: - type: IP_VC - name: My-FCR-Connection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: CLOUD_ROUTER - router: - uuid: 66a21614-1c4a-11ec-9621-0242ac130002 - location: - metroCode: SV - zSide: - serviceToken: - uuid: 4cc30499-d472-4edb-9114-1381ed17e356 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - AsideServiceToken2PortWithDot1q: - value: - type: EVPL_VC - name: Aside-token - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - AsideServiceToken2PortWithQinq: - value: - type: EVPL_VC - name: Aside-Token - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - AsideServiceToken2PrivateSP-NE: - value: - type: EVPL_VC - name: Token2PrivateSP-NE - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - serviceToken: - uuid: 41a9e1ef-18bb-485b-a9b3-99801ac03684 - zSide: - accessPoint: - type: SP - profile: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 - location: - metroCode: SV - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - AsideServiceToken2ZsideServiceToken: - value: - type: EVPL_VC - name: Aside to zside token connection - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - serviceToken: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - zSide: - serviceToken: - uuid: 4f9c5438-90eb-4295-b109-7754119a1e8d - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - Metal2Sp-Aws: - value: - type: EVPL_VC - name: My-Metal-sp-connection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - Metal2Sp-Azure: - value: - type: EVPL_VC - name: Metal2Azure Connection - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: 16799d66-ef43-445c-ba29-d17522d8a137 - notifications: - - type: ALL - emails: - - eqxfabricamcrh@gmail.com - Metal2Sp-GCP: - value: - type: EVPL_VC - name: Metal2GCP-Connection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - Metal2Sp-Oracle: - value: - type: EVPL_VC - name: Metal2Oracle-Connection - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: 16799d66-ef43-445c-ba29-d17522d8a137 - notifications: - - type: ALL - emails: - - test@gmail.com - Metal2Sp-IBM: - value: - type: EVPL_VC - name: Metal2IBM-Connection - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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" - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - Metal2Port-Dot1q: - value: - type: EVPL_VC - name: Metal2Port-dot1q - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: METAL_NETWORK - authenticationKey: xxxxxxxxx - zSide: - accessPoint: - type: COLO - port: - uuid: 6c73d02c-87e1-4642-8e18-01eb4b87e243 - linkProtocol: - type: DOT1Q - vlanTag: 128 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - Metal2Port-Qinq: - value: - type: EVPL_VC - name: Metal2Port-qinq - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - Metal2ServiceToken: - value: - type: EVPL_VC - name: Metal2ServiceToken - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: METAL_NETWORK - authenticationKey: xxxxxxxxx - zSide: - serviceToken: - uuid: bc1383be-579a-4d75-ae19-b0d487bbff90 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - Metal2Sp-Generic: - value: - type: EVPL_VC - name: Metal2Generic - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: METAL_NETWORK - authenticationKey: xxxxxxxxx - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - Vd2IAProfile-Request: - value: - type: IA_VC - name: Network Device to IA SP - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - CreateConnectionDryRunRequest: - value: - type: EVPL_VC - name: My-EVPL-Connection - bandwidth: 500 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - notifications: - - type: ALL - emails: - - test@test.com - IXDedicatedPublicPeeringConnection: - value: - type: IX_VC - name: Virtual-Connection-1 - bandwidth: 1000 - aSide: - accessPoint: - type: COLO - port: - uuid: 99e83e59-fd26-4134-b1b3-4c5dea6924d6 - zSide: - accessPoint: - type: SP - profile: - uuid: 0f6bdb36-e130-4924-b038-ee1785fad166 - notifications: - - type: ALL - emails: - - test@test.com - project: - projectId: 03ed2230-604a-494c-bca2-c042d38d80bc - 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 - COLO2COLO-Dot1q2Dot1q-withTerms-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/6c157170-f84d-424a-9396-b5d6ee723296 - type: EVPL_VC - uuid: 6c157170-f84d-424a-9396-b5d6ee723296 - name: My-Port-2-Port-Connection-1 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: po1234 - billingTier: Up to 100 MB - termLength: 24 - contractedBandwidth: 100 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - changeLog: - createdBy: fabric_user - createdDateTime: 2026-04-11T19:26:58.847Z - updatedBy: fabric_user - updatedDateTime: 2026-04-11T19:26:58.847Z - bandwidth: 10 - redundancy: - group: d630b469-2322-481b-9c32-d04a35ca7a60 - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033a-33ac-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033a-33ac-ace0-30fa5c00ad01 - name: port-001-NK-709 - linkProtocol: - type: DOT1Q - vlanTag: 23 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DA - metroCode: DA - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-0348-348c-ace0-30fa5c00ad04 - type: XF_PORT - uuid: c4d93b39-0348-348c-ace0-30fa5c00ad09 - name: port-001-NK-710 - linkProtocol: - type: DOT1Q - vlanTag: 24 - COLO2COLO-Dot1q2Dot1q-withGeoScope-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/3656347c-4ed2-4d13-8907-f4238b8a057a - type: EVPL_VC - uuid: 3656347c-4ed2-4d13-8907-f4238b8a057a - name: My-Port-2-Port-Connection-1 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - changeLog: - createdBy: fabric_user - createdDateTime: 2026-04-11T19:42:50.774Z - updatedBy: fabric_user - updatedDateTime: 2026-04-11T19:42:50.774Z - bandwidth: 50 - geoScope: CONUS - redundancy: - group: 6e26930e-9fbb-449e-b9eb-cd98c97725er - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033b-33bc-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033b-33bc-ace0-30fa5c00ad01 - name: reg-001-CH2-JUN-698 - linkProtocol: - type: DOT1Q - vlanTag: 39 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033a-33ac-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033a-33ac-ace0-30fa5c00ad01 - name: reg-001-CH2-JUN-694 - linkProtocol: - type: DOT1Q - vlanTag: 40 - 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 - COLO2SPwithGeoScope-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/0bbd1d06-35df-47b7-b358-2f435cecb198 - type: EVPL_VC - uuid: 0bbd1d06-35df-47b7-b358-2f435cecb198 - name: My-Port-2-GenSP-Conn-1 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PENDING_APPROVAL - order: - billingTier: Up to 10 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - changeLog: - createdBy: fabric_user - createdDateTime: 2026-05-11T20:23:48.480Z - updatedBy: fabric_user - updatedDateTime: 2026-05-11T20:23:48.480Z - bandwidth: 10 - geoScope: CONUS - redundancy: - group: b19a678b-bcf7-428f-963b-55ea07eb1ef7 - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033a-83ac-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033a-83ac-ace0-30fa5c00ad01 - name: reg-001-JUN-691 - linkProtocol: - type: DOT1Q - vlanTag: 37 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - metroCode: DC - profile: - href: https://api.equinix.com/fabric/v4/serviceProfiles/5a76497a-ff00-4a89-a605-b0680799c6aa - type: L2_PROFILE - name: Fabric_L2_SP - uuid: 5a76497a-ff00-4a89-a605-b0680799c6aa - COLO2SPNonGenwithGeoScope-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/360a076f-0d2f-454c-b227-c5e6f48920ea - type: EVPL_VC - uuid: 360a076f-0d2f-454c-b227-c5e6f48920ea - name: My-Port-2-NonGenSP-Conn-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - billingTier: Up to 1G - termLength: 1 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - changeLog: - createdBy: fabric_user - createdDateTime: 2026-04-11T20:07:16.611Z - updatedBy: fabric_user - updatedDateTime: 2026-04-11T20:07:16.611Z - bandwidth: 1000 - geoScope: CONUS - redundancy: - group: 27d24507-3222-4654-9b97-ce16c8313b01 - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-0341-341c-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-0341-341c-ace0-30fa5c00ad01 - name: reg-001-JUN-703 - linkProtocol: - type: QINQ - vlanSTag: 23 - vlanCTag: 24 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - profile: - href: https://api.equinix.com/fabric/v4/serviceProfiles/bfb74121-7e2c-4f74-99b3-69cdafb03b41 - type: L2_PROFILE - name: Azure Express Route - uuid: bfb74121-7e2c-4f74-99b3-69cdafb03b12 - authenticationKey: xxxx-xxx-xxxx - COLO2COLO-MetroConnect-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 - type: MC_VC - uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 - name: metro-connect-P2P - bandwidth: 1000 - 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: UNTAGGED - location: - metroCode: ME - zSide: - accessPoint: - type: COLO - port: - href: https://api.equinix.com/fabric/v4/ports/20d32a80-0d61-4333-bc03-707b591ae2f4 - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - linkProtocol: - type: UNTAGGED - location: - metroCode: ME - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - changeLog: - createdDateTime: 2020-05-21T10:30:00Z - project: - projectId: 37c8212c-c393-465c-8267-09d28c49774c - COLO2AzureSP-Primary-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/5901c429-cd23-4149-b1cc-5f1b10cc5041 - type: EVPL_VC - uuid: 5901c429-cd23-4149-b1cc-5f1b10cc5041 - name: port2azure-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-129105284100 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabricuser - createdDateTime: 2026-03-10T02:26:31.546Z - updatedBy: fabricuser - updatedDateTime: 2026-03-10T02:26:31.546Z - bandwidth: 100 - redundancy: - group: ce76ec16-5857-4472-9067-2fa3d7a9f52q - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DA - metroCode: DA - port: - href: https://api.equinix.com/fabric/v4/ports/d966b9ce-79ed-4ea6-8f8a-785fd69f3dcb - type: XF_PORT - uuid: d966b9ce-79ed-4ea6-8f8a-785fd69f3dcb - name: 1-DA1-CX-PRI-012345 - linkProtocol: - type: DOT1Q - vlanTag: 123 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - metroCode: DC - profile: - href: https://api.equinix.com/fabric/v4/serviceProfiles/a1390b22-bbe0-4e93-ad37-85beef9d254a - type: L2_PROFILE - name: Azure ExpressRoute - uuid: a1390b22-bbe0-4e93-ad37-85beef9d254a - authenticationKey: xxxx-xxx-xxxx - COLO2LMaaSSP-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/8236fbb9-51e5-428f-86bf-6b67e1223ac1 - uuid: 8236fbb9-51e5-428f-86bf-6b67e1223ac1 - type: EVPL_VC - name: Last Mile Connection 1 - bandwidth: 10 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PENDING_APPROVAL - redundancy: - group: d4db1048-ef3d-f3d6-49e0-306a5c00a341 - priority: PRIMARY - order: - billingTier: Up to 10 MB - termLength: 1 - aSide: - accessPoint: - location: - metroCode: DC - port: - href: https://api.equinix.com/fabric/v4/ports/c4d9350e-780f-80fd-1ce0-306a5c00a600 - type: XF_PORT - uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 - name: Sample Port DC - linkProtocol: - type: QINQ - vlanSTag: 121 - vlanCTag: 145 - zSide: - accessPoint: - location: - metroCode: DC - profile: - href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 - uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 - type: LMAAS_PROFILE - name: Last Mile Service Profile 1 - productOffering: - id: sample-product-offering-id - name: Sample product offering 1 - billingTerm: 12 - bandwidthCommit: 50 - address: - id: lmaas-addr-sample-id - streetNr: "1234" - streetName: Main St - city: San Jose - stateOrProvince: CA - postCode: "95101" - country: United States - notifications: - - type: ALL - emails: - - someone@sample.com - - type: ORDERING - emails: - - someone@sample.com - phone: - - type: OFFICE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: MOBILE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: TECHNICAL - emails: - - someone@sample.com - phone: - - type: OFFICE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: MOBILE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - changeLog: - createdBy: sampleuser - createdByFullName: Sample User - createdByEmail: someone@sample.com - createdDateTime: 2026-01-01T00:00:00.000Z - updatedBy: sampleuser - updatedByFullName: Sample User - updatedByEmail: someone@sample.com - updatedDateTime: 2026-01-01T00:00:00.000Z - COLO2GoogleSPwithDot1q-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/f662d4c4-fcd8-40ba-b95b-64fc7e0a61fb - type: EVPL_VC - uuid: f662d4c4-fcd8-40ba-b95b-64fc7e0a61fb - name: My-Layer2-Connection-3 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: po1234 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-25T14:25:30.509Z - updatedBy: fabric - updatedDateTime: 2024-04-25T14:25:30.509Z - bandwidth: 50 - redundancy: - group: 2673c07d-9bd3-43c2-9827-91e940d01a54 - priority: PRIMARY - aSide: - accessPoint: - location: - metroCode: DA - port: - href: https://api.equinix.com/fabric/v4/ports/33353aa1-18f2-4b32-94d6-59a12500f7e2 - type: XF_PORT - 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: - href: https://api.equinix.com/fabric/v4/connections/2c7bb68e-f560-41ac-9950-e62c87be191e - type: EVPL_VC - uuid: 2c7bb68e-f560-41ac-9950-e62c87be191e - name: port2alibaba-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - billingTier: Up to 50 MB - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-05-02T20:07:38.626Z - updatedBy: fabric - updatedDateTime: 2024-05-02T20:07:38.626Z - bandwidth: 50 - redundancy: - group: 6aafb605-f3e4-4380-a9c0-1eddf829bca0 - priority: PRIMARY - aSide: - accessPoint: - location: - metroCode: SV - port: - href: https://api.equinix.com/fabric/v4/ports/b54d71a6-aecb-40cc-b458-8a4103f5cdba - type: XF_PORT - 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: - href: https://api.equinix.com/fabric/v4/connections/6c157170-f84d-424a-9396-b5d6ee723296 - type: EVPL_VC - uuid: 6c157170-f84d-424a-9396-b5d6ee723296 - name: vd2oracle-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-129105284100 - billingTier: Up to 1G - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-05-02T20:25:09.841Z - updatedBy: fabric - updatedDateTime: 2024-05-02T20:25:09.841Z - bandwidth: 1000 - redundancy: - group: e8400059-34e1-47f1-9914-cb5907ee7913 - priority: PRIMARY - aSide: - accessPoint: - location: - metroCode: SV - port: - href: https://api.equinix.com/fabric/v4/ports/b54d71a6-aecb-40cc-b458-8a4103f5cdba - type: XF_PORT - 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 - termLength: 1 - 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/e3bf3fa5-2b8f-4437-8171-688175240a1a - type: EVPL_VC - uuid: e3bf3fa5-2b8f-4437-8171-688175240a1a - name: vd2token-conn-1 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: po1234 - billingTier: Up to 10 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - changeLog: - createdBy: fabric_user - createdDateTime: 2026-04-11T20:49:02.630Z - updatedBy: fabric_user - updatedDateTime: 2026-04-11T20:49:02.630Z - bandwidth: 10 - redundancy: - group: 7c2b584c-f184-43ab-9626-52533a2cdb2a - priority: PRIMARY - aSide: - accessPoint: - interface: - uuid: 09918b27-0fb6-428e-a9c5-c26334e825ca - id: 10 - type: CLOUD - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - metroCode: DC - linkProtocol: - type: DOT1Q - vlanTag: 788 - virtualDevice: - uuid: 207667ba-3211-452c-b0a8-8b9046e122a1 - type: EDGE - zSide: - serviceToken: - href: https://api.equinix.com/fabric/v4/serviceTokens/557411a5-16a6-4aef-beea-7f622e94f1e1 - uuid: 557411a5-16a6-4aef-beea-7f622e94f1e1 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee965 - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DA - metroCode: DA - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-0348-348c-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-0348-348c-ace0-30fa5c00ad01 - name: reg-NK-710 - linkProtocol: - type: DOT1Q - vlanTag: 101 - 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 - termLength: 1 - 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 - linkProtocol: - type: DOT1Q - vlanTag: 1522 - 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-Dot1q-withGeoScope-response: - value: - href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f3e9-4f84-8c8f-1505b43df5e2 - uuid: 3a58dd05-f3e9-4f84-8c8f-1505b43df5e2 - type: EVPL_VC - name: My-VD-2-COLO-Connection-1 - state: ACTIVE - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: VD - virtualDevice: - uuid: a867f685-41b0-1b07-6de0-320a5c00abdd - name: my-virtual-device - interface: - type: NETWORK - id: 1 - location: - metroHref: https://api.equinix.com/fabric/v4/metros/FR - metroCode: FR - zSide: - accessPoint: - type: COLO - port: - uuid: b067f685-49b0-1a09-6fe0-360a5d00afd9 - name: my-port - linkProtocol: - type: DOT1Q - vlanTag: 1001 - location: - metroCode: AM - geoScope: EU - project: - projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 - notifications: - - type: ALL - emails: - - test@test.com - operation: - providerStatus: AVAILABLE - equinixStatus: PROVISIONED - changeLog: - createdDateTime: 2023-01-15T10:00:00Z - updatedDateTime: 2023-01-15T10:05:00Z - 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 - termLength: 1 - 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-27T16:25:37.229Z - aSide: - accessPoint: - virtualDevice: - type: EDGE - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - interface: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f8 - 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 - termLength: 1 - 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 - termLength: 1 - 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 - 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 - 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: - purchaseOrderNumber: 1-129105284100 - billingTier: Up to 50 MB - termLength: 1 - 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 - 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 - termLength: 1 - 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 - createdDateTime: 2022-05-12T17:53:45.401Z - AsideServiceToken2PortResponseWithDot1q: - value: - href: https://api.equinix.com/fabric/v4/connections/e972bd9b-5726-4062-b046-7086fe9921ab - type: EVPL_VC - uuid: e972bd9b-5726-4062-b046-7086fe9921ab - name: token2port-conn-1 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - billingTier: Up to 10 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - changeLog: - createdBy: fabric_user - createdDateTime: 2026-05-11T21:03:02.631Z - updatedBy: fabric_user - updatedDateTime: 2026-05-11T21:03:02.631Z - bandwidth: 10 - redundancy: - group: 48852efe-f68a-4f0d-8449-36abd43a4afa - priority: PRIMARY - aSide: - serviceToken: - href: https://api.equinix.com/fabric/v4/serviceTokens/f10d177b-4afb-461a-bb23-b65b021af367 - type: VC_TOKEN - uuid: f10d177b-4afb-461a-bb23-b65b021af367 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee96a - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033f-33fc-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033f-33fc-ace0-30fa5c00ad01 - name: reg-JUN-701 - linkProtocol: - type: DOT1Q - vlanTag: 45 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033e-33ec-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033e-33ec-ace0-30fa5c00ad01 - name: reg-JUN-700 - linkProtocol: - type: DOT1Q - vlanTag: 34 - AsideServiceToken2PortResponseWithQinq: - value: - href: https://api.equinix.com/fabric/v4/connections/e972bd9b-5726-4062-b046-7086fe9921ab - type: EVPL_VC - uuid: e972bd9b-5726-4062-b046-7086fe9921ab - name: token2port-conn-1 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - billingTier: Up to 10 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - changeLog: - createdBy: fabric_user - createdDateTime: 2026-05-11T21:03:02.631Z - updatedBy: fabric_user - updatedDateTime: 2026-05-11T21:03:02.631Z - bandwidth: 10 - redundancy: - group: 48852efe-f68a-4f0d-8449-36abd43a4afa - priority: PRIMARY - aSide: - serviceToken: - href: https://api.equinix.com/fabric/v4/serviceTokens/f10d177b-4afb-461a-bb23-b65b021af367 - type: VC_TOKEN - uuid: f10d177b-4afb-461a-bb23-b65b021af367 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee96a - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033f-33fc-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033f-33fc-ace0-30fa5c00ad01 - name: reg-JUN-701 - linkProtocol: - type: QINQ - vlanSTag: 45 - vlanCTag: 46 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033e-33ec-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033e-33ec-ace0-30fa5c00ad01 - name: reg-JUN-700 - linkProtocol: - type: QINQ - vlanSTag: 34 - vlanCTag: 35 - 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 - redundancy: - group: 3cbd354d-d147-4552-bfd0-78c559b4cc91 - priority: PRIMARY - aSide: - accessPoint: - type: METAL_NETWORK - virtualNetwork: - href: https://api.equinix.com/metal/v1/virtual-networks/a867f685-41b0-1b07-6de0-320a5c00abd0 - uuid: a867f685-41b0-1b07-6de0-320a5c00abd0 - 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: - accountNumber: 123213 - notifications: - - type: ALL - emails: - - fabric@gmail.com - - fabric1@gmail.com - changeLog: - createdBy: fabric - createdDateTime: 2020-05-21T10:30:00Z - Metal2Sp-Azure-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/d3b69c6b-3b23-4ac0-a1bb-8db16460714d - type: EVPL_VC - 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 - createdDateTime: 2024-03-21T20:14:04.072Z - updatedBy: fabric - 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: - href: https://api.equinix.com/fabric/v4/connections/d3b69c6b-3b23-4ac0-a1bb-8db16460714d - type: EVPL_VC - 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 - createdDateTime: 2024-03-21T20:14:04.072Z - updatedBy: fabric - 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: - href: https://api.equinix.com/fabric/v4/connections/7a21d5d8-f153-45f8-ad76-f92babf3f103 - type: EVPL_VC - 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 - createdDateTime: 2024-03-19T23:09:15.547Z - updatedBy: fabric - 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: - href: https://api.equinix.com/fabric/v4/connections/f0e56501-d92f-4ca3-b047-f95628d4a32a - type: EVPL_VC - 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 - createdDateTime: 2024-03-06T17:20:41.574Z - updatedBy: fabric - 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: - href: https://api.equinix.com/fabric/v4/connections/02b7b7d4-1726-4451-9598-e28091c096cd - type: EVPL_VC - 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 - createdDateTime: 2024-03-20T00:39:07.648Z - updatedBy: fabric - 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: - href: https://api.equinix.com/fabric/v4/connections/d87489aa-c32d-4756-a81a-6f557afb871d - type: EVPL_VC - 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 - createdDateTime: 2024-03-21T23:44:22.347Z - updatedBy: fabric - 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: - href: https://api.equinix.com/fabric/v4/connections/f712745e-ccf9-4a0d-9e4d-83c1bb5b9028 - type: EVPL_VC - 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 - createdDateTime: 2024-03-20T20:12:08.595Z - updatedBy: fabric - 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: - href: https://api.equinix.com/fabric/v4/connections/1a9ffa8f-d4d4-44ab-9733-362c9a36ec94 - type: EVPL_VC - 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 - createdDateTime: 2024-03-22T00:42:35.386Z - updatedBy: fabric - 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 - COLO2NETWORKwithDot1q-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/f3dd7395-7196-45f4-9b6f-54094aa75f53 - type: EVPLAN_VC - 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: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-23T02:51:07.675Z - updatedBy: fabric - updatedDateTime: 2024-04-23T02:51:07.675Z - bandwidth: 50 - redundancy: - group: ecebee55-975b-4017-857c-74617f821b87 - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DA - metroCode: DA - port: - href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 - type: XF_PORT - 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 - COLO2NETWORKwithEPL-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/cce170c5-a496-4928-8426-507e00818887 - type: EPLAN_VC - 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: 1 - notifications: - - type: ALL - emails: - - fabric@test.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-23T03:07:17.587Z - updatedBy: fabric - updatedDateTime: 2024-04-23T03:07:17.587Z - bandwidth: 50 - redundancy: - group: dbab0e00-db97-4abf-aebe-76c7a40a371e - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SP - metroCode: SP - port: - href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 - type: XF_PORT - 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 - COLO2NETWORK_EVPTREE_withDot1q-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/f3dd7395-7196-45f4-9b6f-54094aa75f53 - type: EVPTREE_VC - uuid: f3dd7395-7196-45f4-9b6f-54094aa75f53 - name: colo2network-evptree-vc - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-129105284100 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-23T02:51:07.675Z - updatedBy: fabric - updatedDateTime: 2024-04-23T02:51:07.675Z - bandwidth: 50 - redundancy: - group: ecebee55-975b-4017-857c-74617f821b87 - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DA - metroCode: DA - port: - href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 - type: XF_PORT - 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: EVPTREE-GLOBAL - platformUuid: afe28606-8021-4161-802c-b80d4bc22f20 - state: ACTIVE - type: EVPTREE - scope: GLOBAL - role: LEAF - COLO2NETWORK_EPTREE_withEPL-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/cce170c5-a496-4928-8426-507e00818887 - type: EPTREE_VC - uuid: cce170c5-a496-4928-8426-507e00818887 - name: colo2network-eptree-vc - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-129105284100 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@test.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-23T03:07:17.587Z - updatedBy: fabric - updatedDateTime: 2024-04-23T03:07:17.587Z - bandwidth: 50 - redundancy: - group: dbab0e00-db97-4abf-aebe-76c7a40a371e - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SP - metroCode: SP - port: - href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 - type: XF_PORT - 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: EPTREE-GLOBAL - platformUuid: 47aedd04-64dc-4e86-8da3-f88a9755a214 - state: ACTIVE - type: EPTREE - scope: GLOBAL - role: LEAF - Vd2IAProfile-Response: - value: - href: https://uatapi.npclouda.equinix.com/fabric/v4/connections/ce42ca81-538d-4f38-b020-d45fb48d20c7 - type: IA_VC - uuid: ce42ca81-538d-4f38-b020-d45fb48d20c7 - name: vd2eia-connection-1 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-30T20:19:44.279Z - updatedBy: fabric - 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: - metroHref: https://api.equinix.com/fabric/v4/metros/SY - 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: - href: https://api.equinix.com/fabric/v4/connections/e1f165fd-29bb-4c15-8ec7-56242677e6fc - type: EVPLAN_VC - uuid: e1f165fd-29bb-4c15-8ec7-56242677e6fc - name: vd2network-connection - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-1234567890 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-23T02:12:20.334Z - updatedBy: fabric - 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: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - 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 - Vd2AwsSP-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/f0a954e7-bdc5-4727-90cc-869f990e289f - type: EVPL_VC - uuid: f0a954e7-bdc5-4727-90cc-869f990e289f - name: vd2aws-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-1234567890 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-27T00:32:21.879Z - updatedBy: fabric - 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: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - 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: - href: https://api.equinix.com/fabric/v4/connections/3da14bba-d81c-4497-93c3-3f4a3cb0bc40 - type: EVPL_VC - uuid: 3da14bba-d81c-4497-93c3-3f4a3cb0bc40 - name: vd2azure-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-1234567890 - billingTier: Up to 200 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-25T20:30:24.632Z - updatedBy: fabric - 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: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - 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: - href: https://api.equinix.com/fabric/v4/connections/53c89f1a-0be7-44a1-9c03-28059632a72d - type: EVPL_VC - uuid: 53c89f1a-0be7-44a1-9c03-28059632a72d - name: vd2oracle-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-129105284100 - billingTier: Up to 1G - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-25T20:40:40.676Z - updatedBy: fabric - 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: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - 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: - href: https://api.equinix.com/fabric/v4/connections/66ed4e8a-584c-4027-9788-748fecb5ce35 - type: EVPL_VC - uuid: 66ed4e8a-584c-4027-9788-748fecb5ce35 - name: vd2alibaba-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: po1234 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-25T20:43:43.199Z - updatedBy: fabric - 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: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - 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: - href: https://api.equinix.com/fabric/v4/connections/50ae793c-b466-4d71-9724-c32b5e402bbe - type: EVPL_VC - uuid: 50ae793c-b466-4d71-9724-c32b5e402bbe - name: vd2googleSp-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-1234567890 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinx.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-25T14:06:48.933Z - updatedBy: fabric - 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: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - 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 - IXDedicatedPublicPeeringConnectionResponse: - value: - href: https://api.equinix.com/fabric/v4/connections/a8ba52de-faae-43b5-b0b1-6904d37ee011 - uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 - type: IX_VC - name: Virtual-Connection-1 - bandwidth: 1000 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - aSide: - accessPoint: - type: COLO - port: - href: https://api.equinix.com/fabric/v4/ports/99e83e59-fd26-4134-b1b3-4c5dea6924d6 - uuid: 99e83e59-fd26-4134-b1b3-4c5dea6924d6 - type: XF_PORT - name: A-IX-Port - linkProtocol: - type: DOT1Q - vlanTag: 99 - zSide: - accessPoint: - type: SP - profile: - href: https://api.equinix.com/fabric/v4/serviceProfiles/0f6bdb36-e130-4924-b038-ee1785fad166 - uuid: 0f6bdb36-e130-4924-b038-ee1785fad166 - type: IX_PROFILE - name: Equinix Internet Exchange Peering Profile - project: - projectId: 03ed2230-604a-494c-bca2-c042d38d80bc - notifications: - - type: ALL - emails: - - test@test.com - 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 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - - type: EVPL_VC - name: Conn-1 - order: - purchaseOrderNumber: 1-129105284100 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Vd2Colo-Redundant: - value: - data: - - type: EVPL_VC - name: Conn-1 - order: - purchaseOrderNumber: 1-129105284100 - termLength: 1 - 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 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - - type: EVPL_VC - name: Conn-1 - order: - purchaseOrderNumber: 1-129105284100 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Vd2ServiceToken-Redundant: - value: - data: - - type: EVPL_VC - name: VD2ST-Conn-1 - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - termLength: 1 - 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 - termLength: 1 - 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 - termLength: 1 - 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 - termLength: 1 - 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 - termLength: 1 - 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 - termLength: 1 - 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: 1829 - 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 - termLength: 1 - notifications: - - type: ALL - emails: - - test@equinix.com - changeLog: - createdBy: test - createdDateTime: 2023-03-01T22:57:15.874Z - updatedBy: test - 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: 1830 - 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 - createdDateTime: 2023-03-01T22:57:15.918Z - updatedBy: test - updatedDateTime: 2023-03-01T22:57:15.918Z - ConnectionBulkMigrationRequest: - value: - - op: replace - path: /aSide/accessPoint/port/uuid - value: c791f8cb-594a-94a0-8ce0-306a5c00a4ee - ConnectionBulkMigrationResponse: - value: - 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-02T07:17:41.663Z - updatedBy: testBuyer - updatedDateTime: 2021-12-02T07:17:41.663Z - change: - uuid: 2f395804-c197-4796-b7b3-359d5fa5d853 - type: CONNECTION_UPDATE - status: APPROVED - createdDateTime: 2021-12-06T22:11:18.616Z - 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: ACTIVE - 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 - ColoToColoWithMaintenanceResponseExample: - 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-ColoToColo-280122023234849 - state: ACTIVE - operation: - providerStatus: AVAILABLE - equinixStatus: PROVISIONED - maintenanceStatus: SCHEDULED - lockEnabled: true - order: - purchaseOrderNumber: PO754587184643 - notifications: - - type: ALL - emails: - - fake@mail.com - account: - accountNumber: 270001 - orgId: 91997 - globalOrgId: 0016u000003JZ4sAAG - changeLog: - createdBy: admin_user - createdDateTime: 2022-01-28T02:32:36.402Z - updatedBy: test_user - updatedDateTime: 2022-01-29T02: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 - type: XF_PORT - uuid: c791f8cb-5a41-a410-8ce0-306a5c00a4ee - name: testBuyer-DA1-L-Dot1q-STD-PRI-10G-NK-329 - linkProtocol: - type: DOT1Q - vlanTag: 1043 - zSide: - 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-5a49-a490-8ce0-306a5c00a4ee - type: XF_PORT - uuid: c791f8cb-5a49-a490-8ce0-306a5c00a4ee - name: testBuyer-DA1-L-Dot1q-STD-SEC-10G-NK-337 - linkProtocol: - type: DOT1Q - vlanTag: 3322 - LMaaSConnectionResponse: - value: - href: https://api.equinix.com/fabric/v4/connections/8236fbb9-51e5-428f-86bf-6b67e1223ac1 - uuid: 8236fbb9-51e5-428f-86bf-6b67e1223ac1 - type: EVPL_VC - name: Last Mile Connection 1 - state: ACTIVE - operation: - providerStatus: AVAILABLE - equinixStatus: PROVISIONED - order: - billingTier: Up to 10 MB - termLength: 1 - bandwidth: 10 - redundancy: - group: d4db1048-ef3d-f3d6-49e0-306a5c00a341 - priority: PRIMARY - isRemote: false - direction: INCOMING - account: - accountNumber: 201257 - orgId: 91955 - globalOrgId: "" - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - changeLog: - createdBy: sampleuser - createdDateTime: 2026-01-01T00:00:00.000Z - updatedBy: sampleuser - updatedDateTime: 2026-01-01T00:00:00.000Z - notifications: - - type: ALL - emails: - - someone@sample.com - - type: ORDERING - emails: - - someone@sample.com - phone: - - type: OFFICE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: MOBILE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: TECHNICAL - emails: - - someone@sample.com - phone: - - type: OFFICE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: MOBILE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - aSide: - accessPoint: - type: COLO - account: - accountNumber: 201257 - organizationName: Sample Organization - location: - region: AMER - metroName: Ashburn - metroCode: DC - ibx: DC11 - port: - href: https://api.equinix.com/fabric/v4/ports/c4d9350e-780f-80fd-1ce0-306a5c00a600 - uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 - name: Sample Port DC - redundancy: - priority: SECONDARY - linkProtocol: - type: QINQ - vlanSTag: 121 - vlanCTag: 145 - zSide: - accessPoint: - type: SP - account: - organizationName: Sample Provider Organization - location: - region: AMER - metroName: Ashburn - metroCode: DC - ibx: DC11 - profile: - href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 - type: LMAAS_PROFILE - name: Last Mile Service Profile 1 - uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 - productOffering: - id: sample-product-offering-id - name: Sample product offering 1 - billingTerm: 12 - bandwidthCommit: 50 - address: - id: lmaas-addr-sample-id - streetNr: "1234" - streetName: Main St - city: San Jose - stateOrProvince: CA - postCode: "95101" - country: United States - 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 - 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 - ConnectionUpdateTermLengthRequest: - value: - - op: replace - path: /order/termLength - value: 12 - 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 - ConnectionPriorityMigrationAsideVirtualDeviceRequest: - value: - - op: replace - path: /aSide/accessPoint/fabricEdgePriority - value: PRIMARY - 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 - ConnectionUpdateTermLengthResponse: - value: - href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 - type: EVPL_VC - uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 - name: dha_p2p_CH_1m - change: - uuid: 9b9f8a9b-4583-4649-9d91-a48494f822a7 - type: CONNECTION_UPDATE - createdDateTime: 2025-09-10T12:33:42.916Z - data: - op: replace - path: /order/termLength - value: 12 - operation: - providerStatus: AVAILABLE - equinixStatus: PROVISIONED - order: - billingTier: Up to 200 MB - termLength: 12 - notifications: - - type: ALL - emails: - - testuser@equinix.com - changeLog: - createdBy: testuser - createdDateTime: 2025-09-10T12:26:12.344Z - updatedBy: testuser - updatedDateTime: 2025-09-10T12:33:42.996Z - bandwidth: 200 - redundancy: - group: 561082c7-d979-4beb-9536-520cc5b9d0ac - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - metroCode: DC - port: - href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d - type: XF_PORT - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - name: gen-l2-qa-01-auto-DC5-NL-Dot1q-STD-PRI-1G-JUN-51 - linkProtocol: - type: DOT1Q - vlanTag: 1246 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d - type: XF_PORT - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - name: gen-l2-qa-01-auto-CH1-L-Dot1q-BO-PRI-10G-JUN-189 - linkProtocol: - type: DOT1Q - vlanTag: 1247 - 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 - Connection_Provider_Status_Update: - value: - type: CONNECTION_PROVIDER_STATUS_UPDATE_REQUEST - data: - operation: - providerStatus: QUOTING - 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 - ConnectionRoutesSearchByPrefix: - value: - filter: - and: - - property: /prefix - operator: = - values: - - 192.168.10.0/24 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - ConnectionRoutesSearchByNextHop: - value: - filter: - and: - - property: /nextHop - operator: = - values: - - 10.10.10.5 - 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 - CloudRouterAdvertisedRoutesSearchResponse: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - type: IPv4_BGP_ROUTE - protocolType: BGP - state: ACTIVE - prefix: 192.168.10.0/24 - nextHop: 10.10.10.5 - MED: 5 - asPath: - - "20001" - connection: - href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 - uuid: 81331c52-04c0-4656-a4a7-18c52669348f - name: connection_1 - changeLog: - createdBy: johnsmith - createdByFullName: John Smith - createdByEmail: john.smith@example.com - createdDateTime: 2020-11-06T07:00:00Z - updatedBy: johnsmith - updatedByFullName: John Smith - updatedByEmail: john.smith@example.com - updatedDateTime: 2020-11-06T07:00:00Z - deletedBy: johnsmith - deletedByFullName: John Smith - deletedByEmail: john.smith@example.com - deletedDateTime: 2020-11-06T07:00:00Z - CloudRouterReceivedRoutesSearchResponse: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - type: IPv4_BGP_ROUTE - protocolType: BGP - state: ACTIVE - prefix: 192.168.10.0/24 - nextHop: 10.10.10.5 - MED: 5 - asPath: - - "20001" - connection: - href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 - uuid: 81331c52-04c0-4656-a4a7-18c52669348f - name: connection_1 - changeLog: - createdBy: johnsmith - createdByFullName: John Smith - createdByEmail: john.smith@example.com - createdDateTime: 2020-11-06T07:00:00Z - updatedBy: johnsmith - updatedByFullName: John Smith - updatedByEmail: john.smith@example.com - updatedDateTime: 2020-11-06T07:00:00Z - deletedBy: johnsmith - deletedByFullName: John Smith - deletedByEmail: john.smith@example.com - deletedDateTime: 2020-11-06T07:00:00Z - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: - enabled: true - customerPeerIp: 10.1.1.2 - equinixPeerIp: 192.168.100.1 - bgpIpv6: - enabled: true - 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: - enabled: true - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: - enabled: true - customerPeerIp: 10.1.1.2 - equinixPeerIp: 192.168.100.1 - outboundASPrependCount: 3 - inboundMED: 1000 - outboundMED: 2000 - bgpIpv6: - enabled: true - customerPeerIp: 2001:db8:c59b::2 - equinixPeerIp: 2001:db8:c59b::1 - outboundASPrependCount: 3 - inboundMED: 1000 - outboundMED: 2000 - customerAsn: 0 - asOverrideEnabled: true - bgpAuthKey: string - bfd: - enabled: true - interval: "100" - CreateRoutingWithDirectAndBGP: - value: - data: - - type: BGP - bgpIpv4: - enabled: true - customerPeerIp: 192.168.100.2 - equinixPeerIp: 192.168.100.1 - outboundASPrependCount: 3 - inboundMED: 1000 - outboundMED: 2000 - bgpIpv6: - enabled: true - customerPeerIp: 2001:db8:c59b::2 - equinixPeerIp: 2001:db8:c59b::1 - outboundASPrependCount: 3 - inboundMED: 1000 - outboundMED: 2000 - customerAsn: 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: - enabled: true - customerPeerIp: 192.168.100.2 - equinixPeerIp: 192.168.100.1 - outboundASPrependCount: 3 - inboundMED: 1000 - outboundMED: 2000 - bgpIpv6: - enabled: true - customerPeerIp: 2001:db8:c59b::2 - equinixPeerIp: 2001:db8:c59b::1 - outboundASPrependCount: 3 - customerAsn: 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - updatedDateTime: 2021-10-30T07:21:39Z - deletedBy: fabric - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: 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 - createdDateTime: 2020-05-21T10:20:00Z - updatedBy: 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 - 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 - 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 - 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 - 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 - 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 - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: 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: - enabled: true - 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: - enabled: true - 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 - 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: - enabled: true - 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: - enabled: true - 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 - 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: - enabled: true - customerPeerIp: 10.1.1.3 - equinixPeerIp: 10.1.1.4 - operation: - operationalStatus: UP - opStatusChangedAt: 2021-10-30T07:21:39Z - bgpIpv6: - enabled: true - customerPeerIp: 2001:db8:c59b::1 - equinixPeerIp: 2001:db8:c59b::1 - operation: - operationalStatus: UP - opStatusChangedAt: 2021-10-30T07:21:39Z - customerAsn: 0 - bgpAuthKey: string - bfd: - enabled: true - interval: "100" - ExchangeServiceCreateRequest: - value: - type: IX - name: ix_exchange_service - publicPeeringConnection: - uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 - description: ix_exchange_service - routingProtocol: - customerAsn: 5555 - macAddress: 00:11:22:33:44:55 - bgpIpv4: - domainName: gw01.sin.example.net - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5KEY12345 - prefixes: - - 203.0.113.0/24 - bgpIpv6: - domainName: gw01.sin.example.net - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5KEY123456 - prefixes: - - 2001:DB8:123::/48 - order: - purchaseOrderNumber: 1-3456576 - notifications: - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - project: - projectId: e275485c-7072-439f-943a-c923548b2be5 - account: - accountNumber: 100179 - ExchangeServiceResponse: - value: - href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 - uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 - type: IX - name: ix_exchange_service - bandwidth: 400000 - description: ix_exchange_service - state: PROVISIONING - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - publicPeeringConnection: - type: IX_VC - href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 - uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 - routingProtocol: - customerAsn: 5555 - macAddress: 00:11:22:33:44:55 - vlan: 99 - routeServerAsn: 24115 - bgpIpv4: - customerPeerIp: 12.1.1.1 - domainName: gw01.sin.example.net - primaryRouteServerIp: 10.1.1.1 - secondaryRouteServerIp: 10.1.1.2 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key12345 - prefixes: - - 203.0.113.0/24 - maxPrefixLimit: 300 - prependSelfEnabled: true - bgpIpv6: - customerPeerIp: 2001:db8:c59b::22 - domainName: gw01.sin.example.net - primaryRouteServerIp: 2001:db8:c59b::33 - secondaryRouteServerIp: 2001:db8:c59b::322 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key123456 - prefixes: - - 2001:DB8:123::/48 - maxPrefixLimit: 300 - prependSelfEnabled: true - routeCollector: - asn: 1238 - ipV4: 10.255.255.254 - ipV6: 2001:db8:85a3::8a2e:370:7334\ - order: - purchaseOrderNumber: 1-3456576 - orderNumber: 1-139105284200 - project: - projectId: e275485c-7072-439f-943a-c923548b2be5 - account: - accountNumber: 100179 - notifications: - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - changelog: - createdBy: "12345" - createdDateTime: 2025-08-30T07:21:39Z - additionalInfo: - errorCode: EQ-3058039 - errorMessage: Unable to activate Exchange Service Port. Please verify your configuration or contact support. - ExchangeService_400: - value: - - errorCode: EQ-3067103 - errorMessage: Invalid request. Please verify the request payload. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - details: Invalid request. Please verify the request payload. - ExchangeService_401: - value: - - errorCode: EQ-3067106 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - ExchangeService_403: - value: - - errorCode: EQ-3067102 - errorMessage: Operation not allowed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - details: Operation not allowed for current user - ExchangeService_404: - value: - - errorCode: EQ-3067101 - errorMessage: Internet Exchange Service not found. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - details: Internet Exchange Service not found. - ExchangeService_500: - value: - - errorCode: EQ-3067104 - errorMessage: Internal Server Error - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - details: Internal Server Error - ExchangeServiceDeleteResponse: - value: - href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 - uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 - type: IX - name: ix_exchange_service - bandwidth: 400000 - description: ix_exchange_service - state: DEPROVISIONING - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - publicPeeringConnection: - type: IX_VC - href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 - uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 - routingProtocol: - customerAsn: 5555 - macAddress: 00:11:22:33:44:55 - vlan: 99 - routeServerAsn: 24115 - bgpIpv4: - customerPeerIp: 12.1.1.1 - domainName: gw01.sin.example.net - primaryRouteServerIp: 10.1.1.1 - secondaryRouteServerIp: 10.1.1.2 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key12345 - prefixes: - - 203.0.113.0/24 - maxPrefixLimit: 300 - prependSelfEnabled: true - bgpIpv6: - customerPeerIp: 2001:db8:c59b::22 - domainName: gw01.sin.example.net - primaryRouteServerIp: 2001:db8:c59b::33 - secondaryRouteServerIp: 2001:db8:c59b::322 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key123456 - prefixes: - - 2001:DB8:123::/48 - maxPrefixLimit: 300 - prependSelfEnabled: true - routeCollector: - asn: 1238 - ipV4: 10.255.255.254 - ipV6: 2001:db8:85a3::8a2e:370:7334 - order: - purchaseOrderNumber: 1-3456576 - orderNumber: 1-139105284200 - project: - projectId: e275485c-7072-439f-943a-c923548b2be5 - account: - accountNumber: 100179 - notifications: - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - changelog: - updatedBy: "12345" - updatedDateTime: 2025-08-30T07:21:39Z - ExchangeServicePatchMacAddressRequest: - value: - - op: replace - path: /routingProtocol/macAddress - value: 00:1A:2B:3C:4D:5E - ExchangeServicePatchCustomerAsnRequest: - value: - - op: replace - path: /routingProtocol/customerAsn - value: 1232 - ExchangeServicePatchRoutingProtocolIPv4PrefixesRequest: - value: - - op: replace - path: /routingProtocol/bgpIpv4/prefixes - value: - - 10.10.10.0/24 - - 10.10.20.0/24 - ExchangeServicePatchRoutingProtocolIPv6PrefixesRequest: - value: - - op: replace - path: /routingProtocol/bgpIpv6/prefixes - value: - - 2001:db8:10::/48 - - 2001:db8:20::/48 - ExchangeServicePatchResponse: - value: - href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 - uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 - type: IX - name: ix_exchange_service - bandwidth: 400000 - description: ix_exchange_service - state: REPROVISIONING - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - publicPeeringConnection: - type: IX_VC - href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 - uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 - routingProtocol: - customerAsn: 5555 - macAddress: 00:11:22:33:44:55 - vlan: 99 - routeServerAsn: 24115 - bgpIpv4: - customerPeerIp: 12.1.1.1 - domainName: gw01.sin.example.net - primaryRouteServerIp: 10.1.1.1 - secondaryRouteServerIp: 10.1.1.2 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key12345 - prefixes: - - 203.0.113.0/24 - maxPrefixLimit: 300 - prependSelfEnabled: true - bgpIpv6: - customerPeerIp: 2001:db8:c59b::22 - domainName: gw01.sin.example.net - primaryRouteServerIp: 2001:db8:c59b::33 - secondaryRouteServerIp: 2001:db8:c59b::322 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key123456 - prefixes: - - 2001:DB8:123::/48 - maxPrefixLimit: 300 - prependSelfEnabled: true - routeCollector: - asn: 1238 - ipV4: 10.255.255.254 - ipV6: 2001:db8:85a3::8a2e:370:7334 - order: - purchaseOrderNumber: 1-3456576 - orderNumber: 1-139105284200 - project: - projectId: e275485c-7072-439f-943a-c923548b2be5 - account: - accountNumber: 100179 - notifications: - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - changelog: - updatedBy: "12345" - updatedDateTime: 2025-08-30T07:21:39Z - ExchangeServiceSearchProjectId: - value: - filter: - and: - - property: /project/projectId - operator: = - values: - - 30ad25e2-53dc-11ed-bdc3-0242ac120002 - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchMultipleProjectIds: - value: - filter: - and: - - property: /project/projectId - operator: IN - values: - - 30ad25e2-53dc-11ed-bdc3-0242ac120002 - - 30ad25e2-53dc-11ed-bdc3-0242ac120003 - - 30ad25e2-53dc-11ed-bdc3-0242ac120004 - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchState: - value: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONING - pagination: - limit: 10 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchMultipleState: - value: - filter: - and: - - property: /state - operator: IN - values: - - PROVISIONING - - REPROVISIONING - pagination: - limit: 10 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchMetroCode: - value: - filter: - and: - - property: /location/metroCode - operator: = - values: - - SV - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchMultipleMetroCode: - value: - filter: - and: - - property: /location/metroCode - operator: IN - values: - - SV - - NY - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchBandwidth: - value: - filter: - and: - - property: /bandwidth - operator: = - values: - - "500" - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchMultipleBandwidth: - value: - filter: - and: - - property: /bandwidth - operator: IN - values: - - "500" - - "1000" - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchResponse: - value: - pagination: - offset: 0 - limit: 10 - total: 1 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - data: - - href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 - uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 - type: IX - name: ix_exchange_service - bandwidth: 400000 - description: ix_exchange_service - state: PROVISIONING - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - publicPeeringConnection: - type: IX_VC - href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 - uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 - routingProtocol: - customerAsn: 5555 - macAddress: 00:11:22:33:44:55 - vlan: 99 - routeServerAsn: 24115 - bgpIpv4: - customerPeerIp: 12.1.1.1 - domainName: gw01.sin.example.net - primaryRouteServerIp: 10.1.1.1 - secondaryRouteServerIp: 10.1.1.2 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key12345 - prefixes: - - 203.0.113.0/24 - maxPrefixLimit: 300 - prependSelfEnabled: true - bgpIpv6: - customerPeerIp: 2001:db8:c59b::22 - domainName: gw01.sin.example.net - primaryRouteServerIp: 2001:db8:c59b::33 - secondaryRouteServerIp: 2001:db8:c59b::322 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key123456 - prefixes: - - 2001:DB8:123::/48 - maxPrefixLimit: 300 - prependSelfEnabled: true - routeCollector: - asn: 1238 - ipV4: 10.255.255.254 - ipV6: 2001:db8:85a3::8a2e:370:7334 - order: - purchaseOrderNumber: 1-3456576 - orderNumber: 1-139105284200 - project: - projectId: e275485c-7072-439f-943a-c923548b2be5 - account: - accountNumber: 100179 - notifications: - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - changelog: - updatedBy: "12345" - updatedDateTime: 2025-08-30T07:21:39Z - additionalInfo: - errorCode: EQ-3058039 - errorMessage: Unable to activate Exchange Service Port. Please verify your configuration or contact support. - EXCHANGE_SERVICE_ACTIVATE: - value: - type: EXCHANGE_SERVICE_ACTIVATE - EXCHANGE_SERVICE_VALIDATE: - value: - type: EXCHANGE_SERVICE_VALIDATE - EXCHANGE_SERVICE_RETRY_PROVISION: - value: - type: EXCHANGE_SERVICE_RETRY_PROVISION - ExchangeServiceActionResponse: - value: - href: https://api.equinix.com/fabric/v4/exchangeService/a8ba52de-faae-43b5-b0b1-6904d37ee011/actions/3a58dd05-f46d-4b1d-a154-2e85c396ea62 - type: EXCHANGE_SERVICE_ACTIVATE - uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 - state: SUCCEEDED - changelog: - createdDateTime: 2026-02-10T11:30:00Z - createdBy: Alice - InternetAccessCreate: - value: - type: SINGLE_IA - name: internet-access-primary - bandwidth: 1000 - routingProtocol: - type: BGP - exportPolicy: FULL - asn: - uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 - connections: - - uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 - customerRoutes: - - ipBlock: - uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - billing: - type: FIXED - project: - projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 - account: - accountNumber: "57689234" - order: - purchaseOrderNumber: PO-98765 - InternetAccessServiceAcceptedResponseExample: - value: - href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 - type: SINGLE_IA - uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 - name: internet-access-primary - state: PROVISIONING - change: - href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents - routingProtocol: - type: BGP - exportPolicy: FULL - asn: - href: https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1 - uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 - customerRoutes: - - ipBlock: - href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - connections: - - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 - uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 - billing: - type: FIXED - enabled: true - startDate: 2026-04-16T00:00:00Z - account: - accountNumber: "57689234" - href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 - project: - projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 - order: - href: https://api.equinix.com/colocations/v2/orders/100200300 - orderNumber: 100200300 - purchaseOrderNumber: PO-98765 - changeLog: - createdBy: api-user - createdDateTime: 2026-04-16T00:00:00Z - updatedBy: api-user - updatedDateTime: 2026-04-16T00:00:01Z - useCase: MAIN - InternetAccessSearchByProject: - value: - filter: - and: - - property: /project/projectId - operator: = - values: - - 44f4c4f8-2f39-494e-838c-d8e640591be5 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/updatedDateTime - InternetAccessServicesRetrievedResponseExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - sort: - - direction: DESC - property: /changeLog/updatedDateTime - data: - - href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 - type: SINGLE_IA - uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 - name: internet-access-primary - state: PROVISIONED - change: - href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents - routingProtocol: - type: BGP - customerRoutes: - - ipBlock: - href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - connections: - - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 - uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 - billing: - type: FIXED - account: - accountNumber: "57689234" - project: - projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 - order: - purchaseOrderNumber: PO-98765 - changeLog: - createdDateTime: 2026-04-16T00:00:00Z - useCase: MAIN - InternetAccessServiceRetrievedResponseExample: - value: - href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 - type: SINGLE_IA - uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 - name: internet-access-primary - state: PROVISIONED - bandwidth: 1000 - bandwidthCommit: 500 - change: - href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents - locations: - - metroHref: https://api.equinix.com/fabric/v4/metros/WA - metroCode: WA - region: AMER - ibx: WA1 - routingProtocol: - type: BGP - exportPolicy: FULL - asn: - href: https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1 - uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 - customerRoutes: - - ipBlock: - href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - connections: - - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 - uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 - billing: - type: FIXED - enabled: true - startDate: 2026-04-16T00:00:00Z - account: - accountNumber: "57689234" - href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 - project: - projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 - order: - href: https://api.equinix.com/colocations/v2/orders/100200300 - orderNumber: 100200300 - purchaseOrderNumber: PO-98765 - changeLog: - createdBy: api-user - createdDateTime: 2026-04-16T00:00:00Z - updatedBy: api-user - updatedDateTime: 2026-04-16T00:10:00Z - useCase: MAIN - InternetAccessPatchManageCustomerRoutes: - value: - - op: add - path: /routingProtocol/customerRoutes - value: - ipBlock: - uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - - op: remove - path: /routingProtocol/customerRoutes[@.ipBlock.uuid=ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91] - InternetAccessPatchUpdateServiceBandwidth: - value: - - op: replace - path: /bandwidth - value: 50 - - op: replace - path: /order/purchaseOrderNumber - value: PO-98765 - InternetAccessPatchUpdateName: - value: - - op: replace - path: /name - value: New Name - InterconnectCreate: - value: - type: XF_IC - name: test ic sv - description: test interconnect - location: - metroCode: SV - package: - type: IC_PACKAGE - code: BASIC - order: - termLength: 1 - account: - accountNumber: 456789 - project: - projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 - notifications: - - type: NOTIFICATIONS - emails: - - abc@test.com - InterconnectResponse: - value: - href: https://api.equinix.com/fabric/v4/interconnects/34085b91-2ea3-4578-bc1f-bbd526b57885 - uuid: 34085b91-2ea3-4578-bc1f-bbd526b57885 - type: XF_IC - name: test ic sv - description: test interconnect - state: PROVISIONING - location: - href: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - usedBandwidth: 0 - package: - href: https://api.equinix.com/fabric/v4/interconnectPackages/BASIC - type: IC_PACKAGE - code: BASIC - router: - href: https://api.equinix.com/fabric/v4/routers/24884a4e-bb47-403a-9426-a1b766305226 - type: IC_ROUTER - uuid: 24884a4e-bb47-403a-9426-a1b766305226 - order: - termLength: 1 - account: - accountNumber: 456789 - project: - projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 - notifications: - - type: NOTIFICATIONS - emails: - - test@test.com - - abc@test.com - changeLog: - createdBy: "1111" - createdDateTime: 2026-01-15T08:00:00Z - InterconnectDeleteResponse: - value: - href: https://api.equinix.com/fabric/v4/interconnects/34085b91-2ea3-4578-bc1f-bbd526b57885 - uuid: 34085b91-2ea3-4578-bc1f-bbd526b57885 - type: XF_IC - name: test ic sv - description: test interconnect - state: DEPROVISIONED - location: - href: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - usedBandwidth: 0 - package: - href: https://api.equinix.com/fabric/v4/interconnectPackages/BASIC - type: IC_PACKAGE - code: BASIC - router: - href: https://api.equinix.com/fabric/v4/routers/24884a4e-bb47-403a-9426-a1b766305226 - type: IC_ROUTER - uuid: 24884a4e-bb47-403a-9426-a1b766305226 - order: - termLength: 1 - account: - accountNumber: 456789 - project: - projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 - changeLog: - createdBy: johnsmith - createdDateTime: 2026-01-15T08:00:00Z - updatedBy: johnsmith - updatedDateTime: 2026-07-24T10:30:00Z - deletedBy: johndoe - deletedDateTime: 2026-07-24T10:30:00Z - InterconnectSearchRequest: - value: - filter: - and: - - property: /project/projectId - operator: IN - values: - - ae708bbb-d669-406a-845a-99b39ff65fd0 - - property: /state - operator: IN - values: - - PROVISIONED - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - InterconnectSearchResponse: - value: - pagination: - total: 1 - offset: 0 - limit: 20 - sort: - - property: /changeLog/createdDateTime - direction: DESC - data: - - href: https://api.equinix.com/fabric/v4/interconnects/34085b91-2ea3-4578-bc1f-bbd526b57885 - uuid: 34085b91-2ea3-4578-bc1f-bbd526b57885 - type: XF_IC - state: PROVISIONED - description: test interconnect - location: - href: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - usedBandwidth: 2000 - package: - href: https://api.equinix.com/fabric/v4/interconnectPackages/BASIC - type: IC_PACKAGE - code: BASIC - router: - href: https://api.equinix.com/fabric/v4/routers/24884a4e-bb47-403a-9426-a1b766305226 - uuid: 24884a4e-bb47-403a-9426-a1b766305226 - type: IC_ROUTER - order: - termLength: 1 - account: - accountNumber: 456789 - project: - projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 - notifications: - - type: NOTIFICATIONS - emails: - - test@test.com - changeLog: - createdBy: johnsmith - createdDateTime: 2026-01-15T08:00:00Z - interconnect-packages: - value: - data: - - href: https://api.equinix.com/fabric/v4/interconnectPackages/b3ceae25-fc42-4857-9aa8-bd72e0d063df - type: IC_PACKAGE - uuid: b3ceae25-fc42-4857-9aa8-bd72e0d063df - code: BASIC - description: string - routesMax: 1000 - bandwidthMax: 100000 - isRemote: true - state: ACTIVE - - href: https://api.equinix.com/fabric/v4/interconnectPackages/d89066ca-7861-457c-9dc1-63f131af4179 - type: IC_PACKAGE - uuid: d89066ca-7861-457c-9dc1-63f131af4179 - code: STANDARD - description: string - routesMax: 2000 - bandwidthMax: 200000 - isRemote: true - state: ACTIVE - - href: https://api.equinix.com/fabric/v4/interconnectPackages/ca1551cd-0364-4508-a969-6631c4bf9ea7 - type: IC_PACKAGE - uuid: ca1551cd-0364-4508-a969-6631c4bf9ea7 - code: PREMIUM - description: string - routesMax: 3000 - bandwidthMax: 400000 - isRemote: true - state: ACTIVE - IpBlockCreateEquinixApacRequest: - value: - prefixLength: 24 - location: - metroCode: SY - project: - projectId: 52cb19be-63c4-434d-bec8-5e94636291fc - type: IPV4_IP_BLOCK - regulations: - addressingPlans: - - purpose: SERVERS - size: 100 - - purpose: ROUTERS - size: 154 - questions: - privateSpaceConsidered: true - refusedPreviously: true - returningAddressSpace: false - account: - accountNumber: 2-57689234 - order: - purchaseOrderNumber: purchase-order123 - IpBlockCreateCustomerOwnedRequest: - value: - prefix: 128.112.4.0/24 - type: IPV4_IP_BLOCK - project: - projectId: 52cb19be-63c4-434d-bec8-5e94636291fc - IpBlockEquinixOwnershipAcceptedResponse: - value: - href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb - uuid: 31fbdb3f-8def-410d-868b-ef920878affb - state: PENDING - ownership: EQUINIX - location: - metroHref: https://api.equinix.com/fabric/v4/metros/WA - metroCode: SY - prefixLength: 24 - type: IPV4_IP_BLOCK - change: - href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents - order: - href: https://api.equinix.com/colocations/v2/orders/1-34834234 - orderNumber: 1-34834234 - account: - href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/2-57689234 - accountNumber: 2-57689234 - project: - href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc - projectId: 03ed2230-604a-494c-bca2-c042d38d80bc - regulations: - addressingPlans: - - purpose: SERVERS - size: 100 - - purpose: ROUTERS - size: 154 - questions: - privateSpaceConsidered: true - refusedPreviously: true - returningAddressSpace: false - changeLog: - createdDateTime: 2025-12-01T12:11:22.222351Z - assets: [] - IpBlockCustomerOwnershipAcceptedResponse: - value: - href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb - uuid: 31fbdb3f-8def-410d-868b-ef920878affb - state: ACTIVE - ownership: CUSTOMER - prefixLength: 24 - prefix: 128.112.4.0/24 - type: IPV4_IP_BLOCK - change: - href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents - project: - href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc - projectId: 03ed2230-604a-494c-bca2-c042d38d80bc - changeLog: - createdDateTime: 2025-12-01T12:11:22.222351Z - assets: [] - ConnectionSearchDirection: - value: - filter: - and: - - property: /direction - operator: = - values: - - OUTGOING - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ConnectionSearchIsremote: - value: - filter: - and: - - property: /isRemote - operator: = - values: - - "true" - pagination: - limit: 25 - offset: 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 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ConnectionSearchCustorg: - value: - filter: - and: - - property: /account/orgId - operator: = - values: - - "91997" - pagination: - limit: 25 - offset: 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 - 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: - 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: - 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: - 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: - limit: 25 - offset: 0 - ConnectionSearchAsideaccesspointtype: - value: - filter: - and: - - property: /aSide/accessPoint/type - operator: = - values: - - COLO - sort: - - direction: DESC - property: /changeLog/updatedDateTime - pagination: - 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: - 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: - 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: - limit: 25 - offset: 0 - ConnectionSearchChangestatus: - value: - filter: - and: - - property: /change/status - operator: = - values: - - APPROVED - pagination: - limit: 25 - offset: 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: - limit: 25 - offset: 0 - ConnectionSearchEquinixstatus: - value: - filter: - and: - - property: /operation/equinixStatus - operator: = - values: - - PROVISIONED - sort: - - direction: DESC - property: /changeLog/updatedDateTime - pagination: - limit: 25 - offset: 0 - ConnectionSearchProviderstatus: - value: - filter: - and: - - property: /operation/providerStatus - operator: = - values: - - AVAILABLE - sort: - - direction: DESC - property: /changeLog/updatedDateTime - pagination: - limit: 25 - offset: 0 - ConnectionSearchProjectidOPtional-CRH: - value: - filter: - and: - - property: /project/projectId - operator: = - values: - - 30ad25e2-53dc-11ed-bdc3-0242ac120002 - pagination: - limit: 25 - offset: 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: - limit: 25 - offset: 0 - ConnectionSearchRedundancypriority: - value: - filter: - and: - - operator: = - property: /redundancy/priority - values: - - PRIMARY - sort: - - direction: DESC - property: /changeLog/updatedDateTime - pagination: - 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: - 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: - 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: - 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: - limit: 25 - offset: 0 - ConnectionSearchZsideaccesspointtype: - value: - filter: - and: - - property: /zSide/accessPoint/type - operator: = - values: - - COLO - sort: - - direction: DESC - property: /changeLog/updatedDateTime - pagination: - 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: - 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: - 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: - 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: - 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: - 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 - ConnectionSearchByMaintenanceStatus: - value: - filter: - and: - - property: /operation/maintenanceStatus - operator: IN - values: - - SCHEDULED - - COMPLETED - - property: /operation/lockEnabled - operator: IN - values: - - "true" - 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" - VirtualConnectionProductColoToColoWithGeoScope: - 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 - - property: /connection/geoScope - operator: = - values: - - CONUS - 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" - VirtualPortProductUPP: - 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/package/code - operator: = - values: - - UNLIMITED_PLUS - - property: /port/serviceType - operator: = - values: - - EPL - - property: /port/connectivitySource/type - operator: = - values: - - COLO - - property: /port/lag/enabled - operator: = - values: - - "false" - VirtualPortProductIX: - value: - filter: - and: - - property: /type - operator: = - values: - - VIRTUAL_PORT_PRODUCT - - property: /port/location/ibx - operator: = - values: - - DA1 - - property: /port/type - operator: = - values: - - XF_PORT - - property: /port/bandwidth - operator: = - values: - - "1000" - - property: /port/serviceCode - operator: = - values: - - IX - - property: /port/connectivitySource/type - operator: = - values: - - COLO - 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 - OpticalConnectProduct: - value: - filter: - and: - - property: /type - operator: = - values: - - OPTICAL_CONNECT_PRODUCT - - property: /account/accountNumber - operator: = - values: - - "200551" - - property: /opticalConnect/type - operator: = - values: - - OC - - property: /opticalConnect/bandwidth - operator: = - values: - - "1000" - - property: /opticalConnect/pathType - operator: = - values: - - PROTECTED - - property: /opticalConnect/connectionDestinationType - operator: = - values: - - COLO - - property: /opticalConnect/aSide/location/ibxCode - operator: = - values: - - CH1 - - property: /opticalConnect/zSide/location/ibxCode - 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 - VirtualPortUPP: - 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 - package: - code: UNLIMITED_PLUS - VirtualPortIX: - value: - pagination: - offset: 0 - limit: 1 - total: 1 - data: - - type: VIRTUAL_PORT_PRODUCT - code: IX00008.PROD - name: Equinix Internet Exchange Port Product - description: Internet Exchange 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 - serviceCode: IX - 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 - OpticalConnect: - value: - pagination: - offset: 0 - limit: 1 - total: 1 - data: - - type: OPTICAL_CONNECT_PRODUCT - code: MC00007.PROD - name: Optical Connect Port Product - description: Optical Connect Port - account: - accountNumber: 200551 - orgId: 123 - charges: - - type: MONTHLY_RECURRING - price: 500 - - type: NON_RECURRING - price: 0 - currency: USD - opticalConnect: - type: OC - bandwidth: 1000 - pathType: PROTECTED - connectionDestinationType: COLO - aSide: - location: - ibxCode: CH1 - zSide: - location: - ibxCode: 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: http://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 - selectiveRedundancy: 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 - selectiveRedundancy: 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 - selectiveRedundancy: 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 - selectiveRedundancy: 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 - LmaasServiceProfileCreate: - value: - name: Last Mile Service Profile 1 - description: Sample Last Mile Service Profile - type: LMAAS_PROFILE - notifications: - - emails: - - someone@sample.com - type: QUOTE_NOTIFICATIONS - tags: [] - visibility: PUBLIC - customFields: [] - allowedEmails: [] - ports: - - type: XF_PORT - uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 - location: - metroCode: DC - crossConnectId: ECX.03.00000962 - lastMileConfig: - productCatalogs: - - id: sample-product-offering-id - name: Sample Product Offering - webUrl: https://www.example.com/lastmile - deliveryDate: - min: 10 - max: 30 - unit: DAYS - billingTerms: - - 1 - - 12 - - 24 - - 36 - - 48 - - 60 - offerings: - - bandwidth: 50 - price: - unit: USD - min: 100 - max: 500 - - bandwidth: 100 - price: - unit: USD - min: 200 - max: 500 - - bandwidth: 200 - price: - unit: USD - min: 300 - max: 500 - - bandwidth: 1000 - price: - unit: USD - min: 1000 - max: 2000 - accessPointTypeConfigs: - - type: COLO - linkProtocolConfig: - namedTags: [] - reuseVlanSTag: false - enableAutoGenerateServiceKey: false - apiConfig: - equinixManagedPort: false - equinixManagedVlan: false - allowOverSubscription: false - overSubscriptionLimit: 1 - apiAvailable: false - integrationId: "" - bandwidthFromApi: false - authenticationKey: - required: false - allowRemoteConnections: true - supportedBandwidths: - - 10 - - 50 - - 200 - - 500 - - 1000 - allowCustomBandwidth: false - connectionLabel: Connection - allowBandwidthAutoApproval: false - connectionRedundancyRequired: false - selectiveRedundancy: true - marketingInfo: - processSteps: [] - promotion: true - 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 - selectiveRedundancy: 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 - LmaasServiceProfileCreateResponse: - value: - href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 - uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 - name: Last Mile Service Profile 1 - description: Sample Last Mile Service Profile - type: LMAAS_PROFILE - notifications: - - emails: - - someone@sample.com - type: QUOTE_NOTIFICATIONS - tags: [] - visibility: PUBLIC - customFields: [] - allowedEmails: [] - ports: - - type: XF_PORT - uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 - location: - metroCode: DC - crossConnectId: ECX.03.00000962 - lastMileConfig: - apiIntegration: - siteValidationEnabled: false - dataCenterLocationEnabled: false - productOfferingEnabled: false - poqEnabled: false - quoteEnabled: false - placeOrderEnabled: false - quoteViaAggregatorEnabled: false - productCatalogs: - - id: sample-product-offering-id - name: Sample Product Offering - webUrl: https://www.example.com/lastmile - deliveryDate: - min: 10 - max: 30 - unit: DAYS - billingTerms: - - 1 - - 12 - - 24 - - 36 - - 48 - - 60 - offerings: - - bandwidth: 50 - price: - unit: USD - min: 100 - max: 500 - - bandwidth: 100 - price: - unit: USD - min: 200 - max: 500 - - bandwidth: 200 - price: - unit: USD - min: 300 - max: 500 - - bandwidth: 1000 - price: - unit: USD - min: 1000 - max: 2000 - accessPointTypeConfigs: - - type: COLO - linkProtocolConfig: - namedTags: [] - reuseVlanSTag: false - enableAutoGenerateServiceKey: false - apiConfig: - equinixManagedPort: false - equinixManagedVlan: false - allowOverSubscription: false - overSubscriptionLimit: 1 - apiAvailable: false - integrationId: "" - bandwidthFromApi: false - authenticationKey: - required: false - allowRemoteConnections: true - supportedBandwidths: - - 10 - - 50 - - 200 - - 500 - - 1000 - allowCustomBandwidth: false - connectionLabel: Connection - allowBandwidthAutoApproval: false - connectionRedundancyRequired: false - selectiveRedundancy: true - marketingInfo: - processSteps: [] - promotion: true - 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 - ServiceProfileSearchWithTypeAndMetro: - value: - filter: - and: - - property: /type - operator: = - values: - - L2_PROFILE - - property: /metros/code - operator: = - values: - - SG - 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 - selectiveRedundancy: 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 - selectiveRedundancy: 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 - LmaasServiceProfileResponse: - value: - state: ACTIVE - account: - orgId: 90925 - organizationName: Sample Organization - globalOrgId: 0017i000011X23ZAAS - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - changeLog: - createdBy: sampleuser - createdByFullName: Sample User - createdByEmail: someone@sample.com - createdDateTime: 2026-01-01T00:00:00.000Z - updatedBy: sampleuser - updatedByFullName: Sample User - updatedByEmail: someone@sample.com - updatedDateTime: 2026-01-01T00:00:00.000Z - href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 - uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 - type: LMAAS_PROFILE - name: Last Mile Service Profile 1 - description:

Sample Last Mile Service Profile

- notifications: - - type: QUOTE_NOTIFICATIONS - emails: - - someone@sample.com - visibility: PUBLIC - customFields: - - label: Account Id - description: Provider Portal User ID - required: true - dataType: NUMBER - captureInEmail: false - ports: - - type: XF_PORT - uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 - location: - metroCode: DC - crossConnectId: ECX.03.00000962 - metros: - - code: DC - name: Ashburn - ibxs: - - DC6 - - DC5 - displayName: Ashburn - accessPointTypeConfigs: - - uuid: d2d8105b-da0c-4b09-92d7-2584a85cbb33 - type: COLO - supportedBandwidths: - - 10 - - 50 - - 200 - - 500 - - 1000 - allowRemoteConnections: true - allowCustomBandwidth: false - allowBandwidthAutoApproval: false - linkProtocolConfig: - reuseVlanSTag: false - encapsulation: DOT1Q - enableAutoGenerateServiceKey: false - connectionRedundancyRequired: false - selectiveRedundancy: true - apiConfig: - apiAvailable: false - integrationId: "" - equinixManagedPort: false - equinixManagedVlan: false - allowOverSubscription: false - overSubscriptionLimit: 1 - bandwidthFromApi: false - connectionLabel: Connection - authenticationKey: - required: false - marketingInfo: - promotion: true - lastMileConfig: - apiIntegration: - siteValidationEnabled: false - dataCenterLocationEnabled: false - productOfferingEnabled: false - poqEnabled: false - quoteEnabled: false - placeOrderEnabled: false - quoteViaAggregatorEnabled: false - productCatalogs: - - id: Sample-product-offering-id - name: Sample Product Offering - webUrl: https://www.example.com/lastmile - deliveryDate: - unit: DAYS - min: 10 - max: 90 - billingTerms: - - 1 - - 12 - - 24 - - 36 - - 48 - - 60 - offerings: - - bandwidth: 50 - price: - unit: USD - min: 100 - max: 500 - - bandwidth: 100 - price: - unit: USD - min: 200 - max: 500 - - bandwidth: 500 - price: - unit: USD - min: 500 - max: 1000 - - bandwidth: 1000 - price: - unit: USD - min: 1000 - max: 2000 - 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 - selectiveRedundancy: 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 - selectiveRedundancy: 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 - selectiveRedundancy: 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 - ServiceProfilePatchRequestForVisibility: - value: - - op: replace - path: /visibility - value: PUBLIC - 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 - selectiveRedundancy: 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 - ServiceProfilePatchResponseForVisibility: - value: - state: ACTIVE - account: - orgId: 91785 - organizationName: testSeller-270010 - globalOrgId: 0016u000003JZ4tAAG - change: - type: PROFILE_UPDATE_ACCEPTANCE - uuid: 9b9f8a9b-4583-4649-9d91-a48494f822a7 - createdDateTime: 2026-02-17T17:23:35.543Z - 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: PRIVATE - 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 - selectiveRedundancy: 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 - ServiceProfileActionRequest: - value: - type: PROFILE_UPDATE_ACCEPTANCE - description: Approved to migrate to public - ServiceProfileActionRejectionRequest: - value: - type: PROFILE_UPDATE_REJECTION - description: Rejected the migration to public - ServiceProfileActionResponse: - value: - href: https://api.equinix.com/fabric/v4/serviceProfiles/f30a9de3-c79e-443e-b65d-0a0692c6f3e0/actions/ac2a3233-23d9-423c-b375-0e78717bd348 - type: PROFILE_UPDATE_ACCEPTANCE - uuid: ac2a3233-23d9-423c-b375-0e78717bd348 - comments: Approved to migrate to public - changeLog: - createdBy: adminuser - createdDateTime: 2026-03-04T10:30:00Z - updatedBy: adminuser - updatedDateTime: 2026-03-04T10:35:00Z - ServiceProfileEnvironmentsResponse: - value: - data: - - href: https://api.equinix.com/fabric/v4/serviceProfiles/23ad37d0-6b1c-4d1f-a4eb-9f3d68fbe4fd/environments/6ad498b5-d929-44ac-a199-ce9f0d31d9ac - uuid: 6ad498b5-d929-44ac-a199-ce9f0d31d9ac - type: IC_ENV - name: US West 1 – Production - description: Primary production environment - sellerRegion: us-west-1 - metros: - - code: CH - name: Chicago - displayName: Chicago - - code: DC - name: Ashburn - displayName: Ashburn - supportedBandwidths: - - 1000 - - 10000 - - 100000 - - href: https://api.equinix.com/fabric/v4/serviceProfiles/23ad37d0-6b1c-4d1f-a4eb-9f3d68fbe4fd/environments/1ad498b5-d929-44ac-a199-ce9f0d31d9ab - uuid: 1ad498b5-d929-44ac-a199-ce9f0d31d9ab - type: IC_ENV - name: US East 1 – Production - description: Primary production environment - sellerRegion: us-east-1 - metros: - - code: DC - name: Ashburn - displayName: Ashburn - supportedBandwidths: - - 1000 - - 10000 - - 100000 - pagination: - offset: 0 - limit: 2 - total: 2 - getServiceToken: - value: - href: http://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: http://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: http://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 - expirationDateTime: 2020-05-31T10:30:00Z - connection: - type: EVPL_VC - bandwidthLimit: 100 - allowRemoteConnection: false - allowCustomBandwidth: false - aSide: - accessPointSelectors: - - type: COLO - port: - href: http://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: http://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: http://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 - vni: 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 - vni: 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 - createZsideServiceTokenWithNetworkEvplan: - 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 - createZsideServiceTokenWithNetworkEplan: - value: - type: VC_TOKEN - name: zside_Network_token - description: Zside_Network_token - connection: - type: EPLAN_VC - allowRemoteConnection: true - supportedBandwidths: - - 10 - - 50 - - 200 - zSide: - accessPointSelectors: - - type: NETWORK - network: - type: EPLAN - 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 - createZsideServiceTokenWithNetworkEvptree: - value: - type: VC_TOKEN - name: zside_Network_token - description: Zside_Network_token - connection: - type: EVPTREE_VC - allowRemoteConnection: true - supportedBandwidths: - - 10 - - 50 - - 200 - zSide: - accessPointSelectors: - - type: NETWORK - network: - type: EVPTREE - 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 - createZsideServiceTokenWithNetworkEptree: - value: - type: VC_TOKEN - name: zside_Network_token - description: Zside_Network_token - connection: - type: EPTREE_VC - allowRemoteConnection: true - supportedBandwidths: - - 10 - - 50 - - 200 - zSide: - accessPointSelectors: - - type: NETWORK - network: - type: EPTREE - 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: http://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 - createZsideServiceTokenWithNetworkEvplan-Response: - value: - href: https://api.equinix.com/fabric/v4/serviceTokens/7cf92aa3-18b8-435c-b3fc-55e45b1ce964 - type: VC_TOKEN - uuid: 7cf92aa3-18b8-435c-b3fc-55e45b1ce964 - expirationDateTime: 2025-09-09T00:00:00Z - connection: - type: EVPLAN_VC - allowRemoteConnection: true - allowCustomBandwidth: false - supportedBandwidths: - - 10 - - 50 - - 200 - - 500 - zSide: - accessPointSelectors: - - type: NETWORK - network: - href: https://api.equinix.com/fabric/v4/networks/5e17244a-b3e6-4830-aea3-5269d61efd8c - uuid: 5e17244a-b3e6-4830-aea3-5269d61efd8c - type: EVPLAN - name: AUTO-EVPLAN-939087546 - scope: GLOBAL - state: INACTIVE - notifications: - - type: NOTIFICATION - emails: - - test@equinix.com - - user01@equinix.com - account: - orgId: 90837 - changelog: - createdBy: "890742" - createdDateTime: 2025-06-11T15:23:19.237Z - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee962 - createZsideServiceTokenWithNetworkEvptree-Response: - value: - href: https://api.equinix.com/fabric/v4/serviceTokens/543b869e-a9ba-4492-860b-44927ce619f9 - type: VC_TOKEN - uuid: 543b869e-a9ba-4492-860b-44927ce619f9 - expirationDateTime: 2025-09-09T00:00:00Z - connection: - type: EVPTREE_VC - allowRemoteConnection: true - allowCustomBandwidth: false - supportedBandwidths: - - 10 - - 50 - - 200 - - 500 - - 1000 - zSide: - accessPointSelectors: - - type: NETWORK - network: - href: https://api.equinix.com/fabric/v4/networks/a3536780-6118-4374-ab65-23b17fc4cbbb - uuid: a3536780-6118-4374-ab65-23b17fc4cbbb - type: EVPTREE - name: EVPTREE-AMER-01 - scope: REGIONAL - location: - region: AMER - state: INACTIVE - notifications: - - type: NOTIFICATION - emails: - - test@equinix.com - - user01@equinix.com - account: - orgId: 90837 - changelog: - createdBy: "890742" - createdDateTime: 2025-06-11T15:54:33.007Z - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee962 - Resend_Service_Token: - value: - type: RESEND_EMAIL_NOTIFICATION - postServiceTokenActionResponse: - value: - href: http://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: http://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 - ColoOpticalConnectCreate: - description: Both ends terminate on patch panels in colocation space you occupy, so no Letter of Authorization is needed. - value: - type: OC - bandwidth: 100000 - connectionDestinationType: COLO - pathType: UNPROTECTED - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "9" - patchPanelPortB: "10" - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: PP:Demarc:1259695 - patchPanelPortA: "20" - patchPanelPortB: "21" - connectorType: SC - order: - purchaseOrderNumber: "156576" - notifications: - - type: NOTIFICATION - emails: - - test@test.com - RemoteOpticalConnectCreate: - description: |- - The Z-side is identified by IBX code and the Letter of Authorization - issued by the destination customer. - value: - type: OC - bandwidth: 100000 - connectionDestinationType: REMOTE - pathType: UNPROTECTED - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - purchaseOrderNumber: "156576" - notifications: - - type: NOTIFICATION - emails: - - test@test.com - BMMROpticalConnectCreate: - description: The Z-side is identified by location and Letter of Authorization.
bmmrType declares who operates the meet-me room. - value: - type: OC - bandwidth: 100000 - connectionDestinationType: BMMR - pathType: UNPROTECTED - bmmrType: EQUINIX - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - purchaseOrderNumber: "156576" - notifications: - - type: NOTIFICATION - emails: - - test@test.com - ColoOpticalConnectResponseExample: - summary: COLO connection - value: - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-01 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: COLO - pathType: UNPROTECTED - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259690 - patchPanelPortA: "20" - patchPanelPortB: "21" - connectorType: SC - cageUniqueSpaceId: SV2:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV2 - order: - purchaseOrderNumber: "156576" - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - changeLog: - createdByEmail: abc@xyz.com - createdDateTime: 2025-07-24T06:50:46Z - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-07-24T06:51:46Z - RemoteOpticalConnectResponseExample: - summary: Remote connection - value: - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-01 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: REMOTE - pathType: UNPROTECTED - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - purchaseOrderNumber: "156576" - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - changeLog: - createdByEmail: abc@xyz.com - createdDateTime: 2025-07-24T06:50:46Z - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-07-24T06:51:46Z - BMMROpticalConnectResponseExample: - summary: BMMR connection - value: - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-01 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: BMMR - pathType: UNPROTECTED - bmmrType: EQUINIX - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - purchaseOrderNumber: "156576" - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - changeLog: - createdByEmail: abc@xyz.com - createdDateTime: 2025-07-24T06:50:46Z - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-07-24T06:51:46Z - OpticalConnect_400: - summary: Unknown or inaccessible connection. - value: - - errorCode: EQ-3057103 - errorMessage: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - details: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID - OpticalConnect_403: - summary: Operation not permitted - value: - - errorCode: EQ-3057102 - errorMessage: Operation not allowed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - details: Operation not allowed for current user - OpticalConnect_404: - summary: Optical connection not found - value: - - errorCode: EQ-3057101 - errorMessage: Optical Connect Service not found or already deleted - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - details: Optical Connect Service not found or already deleted - OpticalConnect_500: - summary: Unexpected server error - value: - - errorCode: EQ-3057104 - errorMessage: Internal Server Error - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - details: Internal Server Error - ColoOpticalConnectBulkCreate: - summary: COLO diverse pair - description: Two connections on separate patch panels. Equinix assigns the shared redundancy group and returns it on both connections. - value: - data: - - type: OC - bandwidth: 100000 - connectionDestinationType: COLO - pathType: DUAL_DIVERSE - redundancy: - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259690 - patchPanelPortA: "20" - patchPanelPortB: "21" - connectorType: SC - notifications: - - type: NOTIFICATION - emails: - - test@test.com - registeredUsers: - - test - - type: OC - bandwidth: 100000 - connectionDestinationType: COLO - pathType: DUAL_DIVERSE - redundancy: - priority: SECONDARY - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260385 - patchPanelPortA: "24" - patchPanelPortB: "25" - connectorType: SC - notifications: - - type: NOTIFICATION - emails: - - test@test.com - RemoteOpticalConnectBulkCreate: - value: - data: - - type: OC - bandwidth: 100000 - connectionDestinationType: REMOTE - pathType: DUAL_DIVERSE - redundancy: - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - account: - accountNumber: 270848 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - registeredUsers: - - test@test.com - - type: OC - bandwidth: 100000 - connectionDestinationType: REMOTE - pathType: DUAL_DIVERSE - redundancy: - priority: SECONDARY - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: SC - zSide: - location: - ibxCode: SV2 - loa: - uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 - account: - accountNumber: 270848 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - BMMROpticalConnectBulkCreate: - value: - data: - - type: OC - bandwidth: 100000 - connectionDestinationType: BMMR - pathType: DUAL_DIVERSE - bmmrType: EQUINIX - redundancy: - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - account: - accountNumber: 270848 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - registeredUsers: - - test@test.com - - type: OC - bandwidth: 100000 - connectionDestinationType: BMMR - pathType: DUAL_DIVERSE - bmmrType: EQUINIX - redundancy: - priority: SECONDARY - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: SC - zSide: - location: - ibxCode: SV2 - loa: - uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 - account: - accountNumber: 270848 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - ColoOpticalConnectBulkResponseExample: - value: - data: - - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-PRI-01 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: COLO - pathType: DUAL_DIVERSE - redundancy: - priority: PRIMARY - group: 22f8e668-4754-4564-825d-d1c7889c885a - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259690 - patchPanelPortA: "20" - patchPanelPortB: "21" - connectorType: SC - cageUniqueSpaceId: SV2:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV2 - order: - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - - href: https://api.equinix.com/fabric/v4/opticalConnects/a6f77b33-96c6-4eeb-8d79-76374d950603 - uuid: a6f77b33-96c6-4eeb-8d79-76374d950603 - type: OC - name: 270848-SV1-SV2-SEC-02 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: COLO - pathType: DUAL_DIVERSE - redundancy: - priority: SECONDARY - group: 22f8e668-4754-4564-825d-d1c7889c885a - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260385 - patchPanelPortA: "24" - patchPanelPortB: "25" - connectorType: SC - cageUniqueSpaceId: SV2:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV2 - order: - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - RemoteOpticalConnectBulkResponseExample: - value: - data: - - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-PRI-01 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: REMOTE - pathType: DUAL_DIVERSE - redundancy: - priority: PRIMARY - group: 22f8e668-4754-4564-825d-d1c7889c885a - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - - href: https://api.equinix.com/fabric/v4/opticalConnects/c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 - uuid: c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 - type: OC - name: 270848-SV1-SV2-SEC-02 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: REMOTE - pathType: DUAL_DIVERSE - redundancy: - priority: SECONDARY - group: 22f8e668-4754-4564-825d-d1c7889c885a - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 - order: - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - BMMROpticalConnectBulkResponseExample: - value: - data: - - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-PRI-01 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: BMMR - pathType: DUAL_DIVERSE - bmmrType: EQUINIX - redundancy: - priority: PRIMARY - group: 22f8e668-4754-4564-825d-d1c7889c885a - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - - href: https://api.equinix.com/fabric/v4/opticalConnects/c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 - uuid: c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 - type: OC - name: 270848-SV1-SV2-SEC-02 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: BMMR - pathType: DUAL_DIVERSE - bmmrType: EQUINIX - redundancy: - priority: SECONDARY - group: 22f8e668-4754-4564-825d-d1c7889c885a - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 - order: - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - ColoOpticalConnectResponseDeprovisioningExample: - value: - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-01 - state: DEPROVISIONING - bandwidth: 100000 - connectionDestinationType: COLO - pathType: UNPROTECTED - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259690 - patchPanelPortA: "20" - patchPanelPortB: "21" - connectorType: SC - cageUniqueSpaceId: SV2:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV2 - order: - purchaseOrderNumber: "156576" - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - changeLog: - createdByEmail: abc@xyz.com - createdDateTime: 2025-07-24T06:50:46Z - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-07-24T06:51:46Z - RemoteOpticalConnectResponseDeprovisioningExample: - value: - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-01 - state: DEPROVISIONING - bandwidth: 100000 - connectionDestinationType: REMOTE - pathType: UNPROTECTED - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - purchaseOrderNumber: "156576" - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - BMMROpticalConnectResponseDeprovisioningExample: - value: - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-01 - state: DEPROVISIONING - bandwidth: 100000 - connectionDestinationType: BMMR - pathType: UNPROTECTED - bmmrType: EQUINIX - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - purchaseOrderNumber: "156576" - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - changeLog: - createdByEmail: abc@xyz.com - createdDateTime: 2025-07-24T06:50:46Z - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-07-24T06:51:46Z - SearchOpticalConnectFilterByStatus: - summary: All provisioned connections - value: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONED - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/updatedDateTime - SearchOpticalConnectByName: - summary: A named connection of a given type - value: - filter: - and: - - property: /name - operator: = - values: - - 270848-SV1-SV2-01 - - property: /type - operator: = - values: - - OC - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/updatedDateTime - SearchOpticalConnectFilterOrAnd: - summary: Partial match on uuid or name - description: An OR group nested inside the top-level AND — matches circuits whose uuid starts with the given prefix, or whose name is like the value. - value: - filter: - and: - - or: - - property: /uuid - operator: LIKE - values: - - 676a0c3f-a785-4294-87bc-25fe9318a620% - - property: /name - operator: LIKE - values: - - 270848-SV1-SV2-01 - OpticalConnectSearchResponseExample: - summary: One matching connection. - 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/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-01-1 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: COLO - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259690 - patchPanelPortA: "20" - patchPanelPortB: "21" - cageUniqueSpaceId: SV2:01:002174 - cabinetUniqueSpaceId: Demarc - connectorType: SC - location: - ibxCode: SV2 - order: - purchaseOrderNumber: "156576" - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - changeLog: - createdByEmail: abc@xyz.com - createdDateTime: 2025-07-24T06:50:46Z - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-07-24T06:51:46Z - - href: https://api.equinix.com/fabric/v4/opticalConnects/07abb0e3-e67d-5090-9aff-fc5654abaae0 - uuid: 07abb0e3-e67d-5090-9aff-fc5654abaae0 - type: OC - name: 270848-SV1-SV2-01-2 - state: PROVISIONED - bandwidth: 100000 - connectionDestinationType: COLO - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1234685 - patchPanelPortA: "11" - patchPanelPortB: "12" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "22" - patchPanelPortB: "23" - connectorType: SC - cageUniqueSpaceId: SV2:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV2 - order: - purchaseOrderNumber: "126758" - orderNumber: 1-139105284200 - account: - accountNumber: 280845 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - changeLog: - createdByEmail: abc@xyz.com - createdDateTime: 2024-07-24T06:50:46Z - updatedByEmail: abc@xyz.com - updatedDateTime: 2024-07-24T06:51:46Z - OpticalConnect_400_invalid_sorting: - summary: Invalid sort direction. - value: - - errorCode: EQ-3057105 - errorMessage: Invalid value for sorting direction. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - OpticalConnect_401: - summary: Missing or invalid credentials - value: - - errorCode: EQ-3057106 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - 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 - services: - - type: ETHERNET_IP_SERVICE - - type: TIME_SERVICE - geoScopes: - - CANADA - - CONUS - - JAPAN - - UK - - AUSTRALIA - - BRAZIL - - SWITZERLAND - - EU - geoZones: - - code: EU - name: European Union - description: Note that Ireland and Italy are not currently included - 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 - services: - - type: ETHERNET_IP_SERVICE - - type: TIME_SERVICE - geoScopes: - - CANADA - - CONUS - - JAPAN - - UK - - AUSTRALIA - - BRAZIL - - SWITZERLAND - - EU - geoZones: - - code: EU - name: European Union - description: Note that Ireland and Italy are not currently included - 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 - services: - - type: ETHERNET_IP_SERVICE - - type: TIME_SERVICE - ports: - value: - pagination: - offset: 0 - limit: 1000 - total: 2 - data: - - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-02db-2dbc-ace0-30fa5c00ad04 - type: XF_PORT - uuid: c4d93b39-02db-2dbc-ace0-30fa5c00ad04 - name: gen-l2-qa-01-auto-TY4-L-Qinq-STD-SEC-10G-JUN-598 - physicalPortsSpeed: 10000 - physicalPortsType: 10GBASE_LR - connectivitySourceType: COLO - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - package: - code: STANDARD - state: REPROVISIONING - cvpId: "1616554" - operation: - connectionCount: 0 - evplVCCount: 0 - accessVCCount: 0 - account: - accountNumber: 200559 - accountName: gen-l2-qa-01-auto-200559 - orgId: 90946 - organizationName: gen-l2-qa-01-auto-200551. - ucmId: 500DFED2-EBDB-480d-896C-C7870E52D0D8 - globalCustId: 0017i000011X242AAC - changeLog: - createdBy: vvyugovskiy-IMPORT_JOB - createdDateTime: 2021-06-16T01:46:52Z - updatedBy: Order-to-activation - updatedDateTime: 2025-04-07T23:03:08.900Z - bandwidth: 10000 - availableBandwidth: 10000 - usedBandwidth: 0 - location: - metroHref: https://api.equinix.com/fabric/v4/metros/TY - region: APAC - metroName: Tokyo - metroCode: TY - ibx: TY4 - device: - name: sit-tb1-ty-a2.lab - redundancy: - priority: SECONDARY - demarcationPointIbx: TY4 - tetherIbx: TY4 - redundancy: - priority: SECONDARY - encapsulation: - type: QINQ - tagProtocolId: 37120 - lagEnabled: false - settings: - buyout: false - physicalPorts: - - type: XF_PHYSICAL_PORT - id: 1362185 - state: TO_BE_ADDED - uuid: 01892489-ce9b-7f25-b1f5-d32a5ac6a423 - tether: - crossConnectId: ECX.05.00001836 - cabinetNumber: Demarc - systemName: TY4:01:002181 - patchPanel: PP:1240:1089399 - patchPanelPortA: "7" - patchPanelPortB: "8" - ibx: TY4 - demarcationPoint: - patchPanel: PP:Demarc:00002181 - patchPanelName: PP:Demarc:00002181 - patchPanelPortA: "5" - patchPanelPortB: "6" - ibx: TY4 - operation: - operationalStatus: UP - - href: https://api.equinix.com/fabric/v4/ports/6f0f3015-2d51-4b6e-a98c-1defb4fe88f1 - type: XF_PORT - uuid: 6f0f3015-2d51-4b6e-a98c-1defb4fe88f1 - name: 200558-SY4-CX-PRI-02 - physicalPortsSpeed: 10000 - physicalPortsType: 10GBASE_LR - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - package: - code: STANDARD - state: ACTIVE - cvpId: "2000348" - operation: - connectionCount: 1 - evplVCCount: 1 - accessVCCount: 0 - maintenanceStatus: SCHEDULED - lockEnabled: true - account: - accountNumber: 200558 - accountName: Gen-L2-Qa-01-Auto-200558 - orgId: 90946 - organizationName: gen-l2-qa-01-auto-200551. - ucmId: 2D26D682-B62E-495d-AFDF-698EC3B353F8 - globalCustId: 0017i000011X242AAC - changeLog: - createdDateTime: 2025-05-06T17:29:30.800Z - updatedBy: API - updatedDateTime: 2025-05-06T17:29:40.300Z - bandwidth: 10000 - availableBandwidth: 9500 - usedBandwidth: 500 - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SY - region: APAC - metroName: Sydney - metroCode: SY - ibx: SY4 - device: - name: sit-tb1-sy-e1.lab - redundancy: - group: "1" - priority: PRIMARY - demarcationPointIbx: SY4 - tetherIbx: SY4 - redundancy: - priority: PRIMARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: true - settings: - buyout: false - physicalPorts: - - type: XF_PHYSICAL_PORT - id: 1362737 - state: ACTIVE - uuid: 01892489-ce07-7962-b676-b1a4d8091515 - tether: - crossConnectId: "22035616" - cabinetNumber: Demarc - systemName: SY4:01:002204 - patchPanel: PP:1240:1089399 - patchPanelPortA: "12" - patchPanelPortB: "14" - ibx: SY4 - demarcationPoint: - patchPanel: PP:Demarc:00002204 - patchPanelName: PP:Demarc:00002204 - patchPanelPortA: "17" - patchPanelPortB: "18" - ibx: SY4 - operation: - operationalStatus: UP - ports-500: - value: - - errorCode: EQ-3046030 - errorMessage: Internal error. - details: Internal system error - ports-500-user-failure: - value: - - errorCode: IC-USR-014-01 - errorMessage: Error in getting user's profile - 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 - connectivitySourceType: COLO - location: - metroCode: AT - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 16432 - project: - projectId: e275485c-7072-439f-943a-c923548b2be5 - package: - code: STANDARD - redundancy: - priority: PRIMARY - lagEnabled: true - physicalPorts: - - type: XF_PHYSICAL_PORT - demarcationPoint: - ibx: AT1 - cageUniqueSpaceId: AT1:02:FE50010 - cabinetUniqueSpaceId: "9999" - patchPanel: CD:9999:186947 - connectorType: SC - patchPanelPortA: "4" - patchPanelPortB: "5" - endCustomer: - isDisclosed: true - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - demarcationPointIbx: AT1 - notifications: - - type: TECHNICAL - registeredUsers: - - username - - type: NOTIFICATION - registeredUsers: - - user@equinix.com - coloUnlimitedPlusPortLag: - value: - type: XF_PORT - connectivitySourceType: COLO - location: - metroCode: GV - package: - code: UNLIMITED_PLUS - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 270848 - project: - projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 - redundancy: - priority: PRIMARY - lagEnabled: true - physicalPorts: - - type: XF_PHYSICAL_PORT - demarcationPoint: - ibx: GV1 - cageUniqueSpaceId: GV1:01:002174 - cabinetUniqueSpaceId: Demarc - patchPanel: CP:Demarc:1259684 - connectorType: SC - endCustomer: - isDisclosed: false - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - demarcationPointIbx: GV1 - notifications: - - type: TECHNICAL - registeredUsers: - - jaguarsuser-port-order - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - coloLagPortNewGroup: - value: - type: XF_PORT - connectivitySourceType: COLO - location: - metroCode: TR - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 96127367 - package: - code: UNLIMITED - project: - projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 - redundancy: - priority: PRIMARY - lagEnabled: true - physicalPorts: - - type: XF_PHYSICAL_PORT - demarcationPoint: - ibx: TR1 - cageUniqueSpaceId: TR1:01:JSIT001 - cabinetUniqueSpaceId: DEM - patchPanel: PP:DEM:1265410 - connectorType: LC - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - demarcationPointIbx: TR1 - order: - signature: - signatory: SELF - delegate: - email: jaguars-test-user-001@equinix.com - purchaseOrder: - type: EXEMPTION - notifications: - - type: TECHNICAL - registeredUsers: - - jaguars-test-user-001 - - type: NOTIFICATION - registeredUsers: - - jaguars-test-user-001 - coloAddSecondaryPort: - value: - type: XF_PORT - physicalPortsSpeed: 10000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: COLO - location: - metroCode: GV - demarcationPointIbx: GV1 - package: - code: STANDARD - 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 - cabinetUniqueSpaceId: AM1:02:032575:0105 - cageUniqueSpaceId: AM1:02:032575 - patchPanel: PP:0105:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: LC - COLOSinglePortNonLagCreateDryRun: - 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 - COLOSinglePortLagCreateDryRun: - 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 - remoteSinglePortNewGroupLagRequest: - value: - type: XF_PORT - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: REMOTE - 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 - bmmrSinglePortLag: - value: - type: XF_PORT - connectivitySourceType: BMMR - location: - metroCode: SE - package: - code: STANDARD - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 200551 - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - redundancy: - priority: PRIMARY - lagEnabled: true - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - demarcationPointIbx: SE2 - bmmrType: SELF - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - bmmrSinglePortNoLag: - value: - type: XF_PORT - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: BMMR - location: - metroCode: GV - demarcationPointIbx: GV1 - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - project: - projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 - package: - code: STANDARD - 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 - location: - metroCode: GV - demarcationPointIbx: GV1 - redundancy: - priority: SECONDARY - group: 1f6bdb37-f131-5925-c039-fe1785fad165 - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - project: - projectId: "567" - package: - code: STANDARD - 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 - createIXPublicPrivatePeeringPortRequest: - value: - type: XF_PORT - physicalPortsSpeed: 400000 - physicalPortsType: 400GBASE_LR4 - connectivitySourceType: COLO - location: - metroCode: GV - demarcationPointIbx: GV1 - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - project: - projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 - account: - accountNumber: 270848 - notifications: - - registeredUsers: - - jaguarsuser-port-order - type: TECHNICAL - physicalPorts: - - demarcationPoint: - ibx: GV1 - cabinetUniqueSpaceId: Demarc - cageUniqueSpaceId: GV1:01:002174 - patchPanel: CP:Demarc:1259684 - connectorType: SC - serviceCode: IX - createIXPublicPeeringPortRequest: - value: - type: XF_PORT - physicalPortsSpeed: 400000 - physicalPortsType: 400GBASE_LR4 - connectivitySourceType: COLO - location: - metroCode: GV - demarcationPointIbx: GV1 - lagEnabled: false - encapsulation: - type: UNTAGGED - project: - projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 - account: - accountNumber: 270848 - notifications: - - registeredUsers: - - jaguarsuser-port-order - type: TECHNICAL - physicalPorts: - - demarcationPoint: - ibx: GV1 - cabinetUniqueSpaceId: Demarc - cageUniqueSpaceId: GV1:01:002174 - patchPanel: CP:Demarc:1259684 - connectorType: SC - serviceCode: IX - PortCreateDryRunResponse: - value: - type: XF_PORT - physicalPortsType: 10GBASE_LR - physicalPortsSpeed: 10000 - physicalPortsCount: 1 - location: - metroCode: AM - demarcationPointIbx: AM1 - redundancy: - group: "1" - priority: PRIMARY - lagEnabled: true - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - package: - code: STANDARD - settings: - sharedPortType: false - project: - projectId: "567" - 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 - bmmrSinglePortCreateDryRunResponse: - value: - type: XF_PORT - connectivitySourceType: BMMR - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - location: - metroCode: AT - demarcationPointIbx: AT1 - redundancy: - priority: PRIMARY - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - package: - code: STANDARD - project: - projectId: b7c8d9e0-f1a2-4b3c-9d4e-5f6a7b8c9d0e - account: - accountNumber: 100001 - accountName: Test-Account - order: - purchaseOrder: - number: Fabric-PO-TEST-001 - amount: "1000" - startDate: 2025-01-01 - endDate: 2030-01-01 - type: EXISTING - signature: - signatory: SELF - delegate: - email: test-user@example.com - notifications: - - type: TECHNICAL - registeredUsers: - - test-technical-user - - type: NOTIFICATION - registeredUsers: - - test-notification-user - loas: - - uuid: a0b1c2d3-e4f5-4678-a6b7-c8d9e0f1a2b3 - remoteSinglePortCreateDryRunResponse: - value: - type: XF_PORT - connectivitySourceType: REMOTE - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - location: - metroCode: AT - demarcationPointIbx: AT1 - redundancy: - priority: PRIMARY - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - package: - code: STANDARD - project: - projectId: e3d4f5a6-7b8c-4d9e-a0b1-c2d3e4f56789 - account: - accountNumber: 100002 - accountName: Test-Account - order: - purchaseOrder: - number: Fabric-PO-TEST-002 - amount: "1000" - startDate: 2025-01-01 - endDate: 2030-01-01 - type: EXISTING - signature: - signatory: SELF - delegate: - email: test-user@example.com - notifications: - - type: TECHNICAL - registeredUsers: - - test-technical-user - - type: NOTIFICATION - registeredUsers: - - test-notification-user - loas: - - uuid: f1e2d3c4-b5a6-4978-8e0f-1a2b3c4d5e6f - coloSinglePortNonLagResponse: - value: - href: https://api.equinix.com/fabric/v4/ports/11abfba0-907f-460b-95ff-5a7bda4471ed - type: XF_PORT - uuid: 11abfba0-907f-460b-95ff-5a7bda4471ed - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - connectivitySourceType: COLO - project: - projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 - state: PENDING - order: - orderNumber: 1-233948565342 - uuid: d8ab29fe-e849-417d-b0a0-946e69dcd2ce - 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: - accountNumber: 96127367 - accountName: Jaguars_toronto__sig - ucmId: 86B71B7D-D0CC-4ee9-854D-A2C1AA7FA152 - changeLog: - createdBy: "923209" - createdDateTime: 2025-06-11T22:41:39.669Z - location: - metroCode: TR - demarcationPointIbx: TR1 - redundancy: - priority: PRIMARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: false - settings: - sharedPortType: false - package: - code: STANDARD - notifications: - - type: TECHNICAL - registeredUsers: - - jaguars-test-user-001 - - type: NOTIFICATION - registeredUsers: - - jaguars-test-user-001 - physicalPorts: - - demarcationPoint: - ibx: GV1 - cabinetUniqueSpaceId: Demarc - cageUniqueSpaceId: GV1:01:002174 - patchPanel: CP:Demarc:1259684 - connectorType: SC - bmmrSinglePortLagResponse: - value: - href: https://api.equinix.com/fabric/v4/ports/ed9d0b79-ff29-404a-b016-566435093afc - type: XF_PORT - uuid: ed9d0b79-ff29-404a-b016-566435093afc - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 0 - connectivitySourceType: BMMR - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - state: PENDING - order: - orderNumber: 1-289477804403 - uuid: b325f02c-69dd-41d2-838b-ea495c873e9d - account: - accountNumber: 200551 - accountName: gen-l2-qa-01-auto-200551 - ucmId: 83C58EBD-E231-4a8b-902E-0CFBE50E32C2 - changeLog: - createdBy: "1067822" - createdDateTime: 2025-06-21T00:15:48.414Z - location: - metroCode: SE - demarcationPointIbx: SE2 - redundancy: - priority: PRIMARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: true - package: - code: STANDARD - settings: - sharedPortType: false - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - additionalInfo: - - key: lagType - value: New - remoteSinglePortLagResponse: - value: - href: https://api.equinix.com/fabric/v4/ports/68adcd26-d66c-489d-9c72-8990b92a288e - type: XF_PORT - uuid: 68adcd26-d66c-489d-9c72-8990b92a288e - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - connectivitySourceType: REMOTE - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - state: PENDING - order: - orderNumber: 1-289477804403 - uuid: b325f02c-69dd-41d2-838b-ea495c873e9d - purchaseOrder: - type: EXEMPTION - account: - accountNumber: 200551 - accountName: gen-l2-qa-01-auto-200551 - ucmId: 83C58EBD-E231-4a8b-902E-0CFBE50E32C2 - changeLog: - createdBy: "1067822" - createdDateTime: 2025-06-21T00:15:48.414Z - location: - metroCode: SE - demarcationPointIbx: SE2 - redundancy: - priority: PRIMARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: true - package: - code: STANDARD - settings: - productCode: CX - sharedPortType: false - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - additionalInfo: - - key: lagType - value: New - remoteSinglePortLagWithPurchaseOrderExemption: - value: - type: XF_PORT - connectivitySourceType: REMOTE - location: - metroCode: AT - package: - code: STANDARD - settings: - sharedPortType: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 200551 - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - redundancy: - priority: PRIMARY - lagEnabled: true - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - demarcationPointIbx: AT1 - order: - purchaseOrder: - type: EXEMPTION - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - additionalInfo: - - key: lagType - value: New - loas: - - uuid: 2f78191c-0920-4f13-b1c7-2cef03d07570 - createIXPublicPrivatePeeringPortResponse: - value: - href: https://api.equinix.com/fabric/v4/ports/11abfba0-907f-460b-95ff-5a7bda4471ed - type: XF_PORT - uuid: 11abfba0-907f-460b-95ff-5a7bda4471ed - physicalPortsSpeed: 400000 - physicalPortsType: 400GBASE_LR4 - physicalPortsCount: 1 - connectivitySourceType: COLO - project: - projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 - state: PENDING - order: - orderNumber: 1-633948565342 - uuid: d8ab29fe-e849-417d-b0a0-946e69dcd2ce - account: - accountNumber: 270848 - accountName: Jaguars_toronto__sig - ucmId: 86B71B7D-D0CC-4ee9-854D-A2C1AA7FA152 - changeLog: - createdBy: "923209" - createdDateTime: 2025-06-11T22:41:39.669Z - location: - metroCode: GV - demarcationPointIbx: GV1 - redundancy: - priority: PRIMARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: false - settings: - sharedPortType: false - productCode: IX - notifications: - - type: TECHNICAL - registeredUsers: - - jaguars-test-user-001 - - type: NOTIFICATION - registeredUsers: - - jaguars-test-user-001 - physicalPorts: - - demarcationPoint: - ibx: GV1 - cabinetUniqueSpaceId: Demarc - cageUniqueSpaceId: GV1:01:002174 - patchPanel: CP:Demarc:1259684 - connectorType: SC - createIXPublicPeeringPortResponse: - value: - href: https://api.equinix.com/fabric/v4/ports/1babfba0-907f-460b-95ff-5a7bda4471ed - type: XF_PORT - uuid: 1babfba0-907f-460b-95ff-5a7bda4471ed - physicalPortsSpeed: 400000 - physicalPortsType: 400GBASE_LR4 - physicalPortsCount: 1 - connectivitySourceType: COLO - project: - projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 - state: PENDING - order: - orderNumber: 1-233948565342 - uuid: a8ab29fe-e849-417d-b0a0-946e69dcd2ce - account: - accountNumber: 270848 - accountName: Jaguars_toronto__sig - ucmId: 86B71B7D-D0CC-4ee9-854D-A2C1AA7FA152 - changeLog: - createdBy: "923209" - createdDateTime: 2025-06-11T22:41:39.669Z - location: - metroCode: GV - demarcationPointIbx: GV1 - redundancy: - priority: PRIMARY - encapsulation: - type: UNTAGGED - lagEnabled: false - settings: - sharedPortType: false - productCode: IX - notifications: - - type: TECHNICAL - registeredUsers: - - jaguars-test-user-001 - - type: NOTIFICATION - registeredUsers: - - jaguars-test-user-001 - physicalPorts: - - demarcationPoint: - ibx: GV1 - cabinetUniqueSpaceId: Demarc - cageUniqueSpaceId: GV1:01:002174 - patchPanel: CP:Demarc:1259684 - connectorType: SC - 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-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 - createPortBadRequest: - value: - - errorCode: EQ-3143004 - errorMessage: Json syntax error, please check request body - details: Unknown json property - correlationId: TEST - additionalInfo: - - property: encapsulation.type - reason: Unexpected value 'DOT1' - 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 - physicalPortsSpeed: 10000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: BMMR - package: - code: STANDARD - 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 - cabinetUniqueSpaceId: AM1:02:032575:0105 - cageUniqueSpaceId: AM1:02:032575 - patchPanel: PP:0105:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: LC - - type: XF_PORT - name: L2-DEV-USER01-CX-10G-SECONDARY - physicalPortsSpeed: 10000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: BMMR - location: - metroCode: AM - demarcationPointIbx: AM1 - package: - code: STANDARD - 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 - cabinetUniqueSpaceId: AM1:02:032575:0105 - cageUniqueSpaceId: AM1:02:032575 - patchPanel: PP:0105:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: LC - bmmrBulkPortRequest: - value: - data: - - type: XF_PORT - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: BMMR - redundancy: - priority: PRIMARY - location: - metroCode: SG - demarcationPointIbx: SG4 - settings: - sharedPortType: false - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 715013 - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - package: - code: STANDARD - loas: - - uuid: 96cb973f-0eea-4cf1-a93d-23a27f070a98 - additionalInfo: - - key: InterfaceReferenceId - value: "906234" - bmmrType: EQUINIX - order: - uuid: 3fefa958-7bb2-496b-8e9a-14dc92187e7e - - type: XF_PORT - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: BMMR - redundancy: - priority: SECONDARY - location: - metroCode: SG - demarcationPointIbx: SG4 - settings: - sharedPortType: false - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 715013 - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - package: - code: STANDARD - loas: - - uuid: 96cb973f-0eea-4cf1-a93d-23a27f070a98 - additionalInfo: - - key: InterfaceReferenceId - value: "906234" - bmmrType: EQUINIX - order: - uuid: 3fefa958-7bb2-496b-8e9a-14dc92187e7e - remoteBulkPortRequest: - value: - data: - - type: XF_PORT - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: REMOTE - redundancy: - priority: PRIMARY - location: - metroCode: SV - demarcationPointIbx: SV1 - settings: - sharedPortType: false - lagEnabled: false - package: - code: STANDARD - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 200551 - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - physicalPorts: - - type: XF_PHYSICAL_PORT - demarcationPoint: - ibx: SV1 - cabinetUniqueSpaceId: Demarc - cageUniqueSpaceId: SV1:01:002121 - patchPanel: PP:Demarc:00002121 - connectorType: SC - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - additionalInfo: - - key: InterfaceReferenceId - value: "261376" - order: - uuid: 3f3a8ac3-1fed-4355-8f81-8fe371dc9328 - - type: XF_PORT - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: REMOTE - redundancy: - priority: SECONDARY - location: - metroCode: SV - demarcationPointIbx: SV1 - package: - code: STANDARD - settings: - sharedPortType: false - sharedPortProduct: null - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 200551 - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - physicalPorts: - - type: XF_PHYSICAL_PORT - demarcationPoint: - ibx: SV1 - cabinetUniqueSpaceId: Demarc - cageUniqueSpaceId: SV1:01:002121 - patchPanel: PP:Demarc:00002121 - connectorType: SC - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - additionalInfo: - - key: InterfaceReferenceId - value: "261376" - order: - uuid: 3f3a8ac3-1fed-4355-8f81-8fe371dc9328 - 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 - settings: - sharedPortType: false - package: - code: STANDARD - 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 - package: - code: STANDARD - 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 - settings: - sharedPortType: false - notifications: - - type: TECHNICAL - registeredUsers: - - jaguarsuser-port-order - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - bmmrBulkPortResponse: - value: - data: - - href: https://api.equinix.com/fabric/v4/ports/136c412b-8c9d-429c-8030-de484c1371c4 - type: XF_PORT - uuid: 136c412b-8c9d-429c-8030-de484c1371c4 - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 0 - connectivitySourceType: BMMR - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - state: PENDING - order: - orderNumber: 1-293571904079 - uuid: 3fefa958-7bb2-496b-8e9a-14dc92187e7e - account: - accountNumber: 715013 - accountName: Equinix - ucmId: A5C6ED82-6DAE-4c3b-B524-67F8B51D65BE - changeLog: - createdBy: "1067822" - createdDateTime: 2025-06-23T20:04:15.549Z - location: - metroCode: SG - demarcationPointIbx: SG4 - redundancy: - group: 57eb2e60-d16a-40ad-8395-6e083ce0d631 - priority: PRIMARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: false - package: - code: STANDARD - settings: - sharedPortType: false - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - additionalInfo: - - key: InterfaceReferenceId - value: "906234" - - href: https://api.equinix.com/fabric/v4/ports/57eb2e60-d16a-40ad-8395-6e083ce0d631 - type: XF_PORT - uuid: 57eb2e60-d16a-40ad-8395-6e083ce0d631 - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 0 - connectivitySourceType: BMMR - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - state: PENDING - order: - orderNumber: 1-293571904079 - uuid: 3fefa958-7bb2-496b-8e9a-14dc92187e7e - account: - accountNumber: 715013 - accountName: Equinix - ucmId: A5C6ED82-6DAE-4c3b-B524-67F8B51D65BE - changeLog: - createdBy: "1067822" - createdDateTime: 2025-06-23T20:04:15.549Z - location: - metroCode: SG - demarcationPointIbx: SG4 - redundancy: - group: 136c412b-8c9d-429c-8030-de484c1371c4 - priority: SECONDARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: false - settings: - sharedPortType: false - package: - code: STANDARD - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - additionalInfo: - - key: InterfaceReferenceId - value: "906234" - remoteBulkPortResponse: - value: - data: - - href: https://api.equinix.com/fabric/v4/ports/9042c980-0a8d-4d53-b0fb-73388db92a3b - type: XF_PORT - uuid: 9042c980-0a8d-4d53-b0fb-73388db92a3b - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - connectivitySourceType: REMOTE - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - state: PENDING - order: - orderNumber: 1-293571904094 - uuid: 3f3a8ac3-1fed-4355-8f81-8fe371dc9328 - account: - accountNumber: 200551 - accountName: gen-l2-qa-01-auto-200551 - ucmId: 83C58EBD-E231-4a8b-902E-0CFBE50E32C2 - changeLog: - createdBy: "1067822" - createdDateTime: 2025-06-23T21:28:48.386Z - location: - metroCode: SV - demarcationPointIbx: SV1 - redundancy: - group: 44cea0ee-1a05-4347-a39b-c11dfde4b591 - priority: PRIMARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: false - package: - code: STANDARD - settings: - productCode: CX - sharedPortType: false - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - additionalInfo: - - key: InterfaceReferenceId - value: "261376" - - href: https://api.equinix.com/fabric/v4/ports/44cea0ee-1a05-4347-a39b-c11dfde4b591 - type: XF_PORT - uuid: 44cea0ee-1a05-4347-a39b-c11dfde4b591 - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - connectivitySourceType: REMOTE - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - state: PENDING - order: - orderNumber: 1-293571904094 - uuid: 3f3a8ac3-1fed-4355-8f81-8fe371dc9328 - account: - accountNumber: 200551 - accountName: gen-l2-qa-01-auto-200551 - ucmId: 83C58EBD-E231-4a8b-902E-0CFBE50E32C2 - changeLog: - createdBy: "1067822" - createdDateTime: 2025-06-23T21:28:48.386Z - location: - metroCode: SV - demarcationPointIbx: SV1 - redundancy: - group: 9042c980-0a8d-4d53-b0fb-73388db92a3b - priority: SECONDARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: false - package: - code: STANDARD - settings: - productCode: CX - sharedPortType: false - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - additionalInfo: - - key: InterfaceReferenceId - value: "261376" - 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 - uuid: bdfa360d-8ffb-4394-8905-56ea6ae3e87d - notifications: - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - - 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 - uuid: bdfa360d-8ffb-4394-8905-56ea6ae3e87d - notifications: - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - portByUUID: - value: - href: https://api.equinix.com/fabric/v4/ports/44c5712b-d704-4ca5-9b42-ee6be32ee06a - type: XF_PORT - uuid: 44c5712b-d704-4ca5-9b42-ee6be32ee06a - name: 270843-DA1-CX-PRI-33 - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - project: - projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 - package: - code: UNLIMITED - state: ACTIVE - cvpId: "2000833" - connectivitySourceType: COLO - operation: - operationalStatus: UP - connectionCount: 10 - evplVCCount: 10 - accessVCCount: 0 - account: - accountNumber: 270843 - accountName: ctr-sit-account1 - orgId: 93055 - organizationName: ctr-sit-account1-270843 - ucmId: 64726950-A62C-4749-98E2-5AA4CA44284F - globalCustId: 0016u000003JZ3XAAW - change: - uuid: ed41e367-e09d-4c2f-b6ab-30506de4437f - type: PORT_UPDATE - status: COMPLETED - data: - op: REPLACE - path: /encapsulation - value: - type: QINQ - tagProtocolId: 34984 - createdDateTime: 2025-05-29T20:38:45.630759Z - updatedDateTime: 2025-05-29T20:38:49.330822Z - changeLog: - createdBy: qa-automation - createdDateTime: 2025-05-21T18:12:18.300Z - updatedBy: qa-automation - updatedDateTime: 2025-05-29T20:38:48.900Z - bandwidth: 1000 - availableBandwidth: 500 - usedBandwidth: 500 - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DA - region: AMER - metroName: Dallas - metroCode: DA - ibx: DA1 - device: - name: qa3-da-a1.lab - redundancy: - priority: PRIMARY - demarcationPointIbx: DA1 - tetherIbx: DA1 - redundancy: - priority: PRIMARY - encapsulation: - type: QINQ - tagProtocolId: 34984 - lagEnabled: false - settings: - buyout: true - viewPortPermission: true - placeVcOrderPermission: true - physicalPorts: - - type: XF_PHYSICAL_PORT - id: 1426359 - state: ADDED - bandwidth: 0 - uuid: 0189244a-f3ac-7258-a8b4-3167af899305 - tether: - crossConnectId: "513213223" - ibx: DA1 - demarcationPoint: - ibx: DA1 - operation: - operationalStatus: UP - maintenanceScheduledPortByUUID: - value: - href: https://api.equinix.com/fabric/v4/ports/44c5712b-d704-4ca5-9b42-ee6be32ee06a - type: XF_PORT - uuid: 44c5712b-d704-4ca5-9b42-ee6be32ee06a - name: 270843-DA1-CX-PRI-33 - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - project: - projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 - package: - code: UNLIMITED - state: ACTIVE - connectivitySourceType: COLO - operation: - operationalStatus: UP - connectionCount: 10 - evplVCCount: 10 - accessVCCount: 0 - maintenanceStatus: SCHEDULED - lockEnabled: true - account: - accountNumber: 270843 - accountName: ctr-sit-account1 - orgId: 93055 - organizationName: ctr-sit-account1-270843 - ucmId: 64726950-A62C-4749-98E2-5AA4CA44284F - globalCustId: 0016u000003JZ3XAAW - changeLog: - createdBy: admin_user - createdDateTime: 2025-05-21T18:12:18.300Z - updatedBy: test_user - updatedDateTime: 2025-05-29T20:38:48.900Z - bandwidth: 1000 - availableBandwidth: 500 - usedBandwidth: 500 - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DA - region: AMER - metroName: Dallas - metroCode: DA - ibx: DA1 - demarcationPointIbx: DA1 - tetherIbx: DA1 - redundancy: - priority: PRIMARY - encapsulation: - type: QINQ - tagProtocolId: 34984 - lagEnabled: false - physicalPorts: - - type: XF_PHYSICAL_PORT - state: ADDED - bandwidth: 0 - uuid: 0189244a-f3ac-7258-a8b4-3167af899305 - tether: - crossConnectId: "513213223" - ibx: DA1 - demarcationPoint: - ibx: DA1 - operation: - operationalStatus: UP - portDryRunDelete: - value: - type: XF_PORT - uuid: e91484bb-4f65-4ab3-8f77-500dec2f855d - name: test-AT1-Dot1q-L-Secondary-108608 - physicalPortsType: 10GBASE_LR - physicalPortsSpeed: 10000 - physicalPortsCount: 1 - location: - metroCode: AM - demarcationPointIbx: AM1 - redundancy: - group: "1" - priority: PRIMARY - lagEnabled: true - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - package: - code: STANDARD - settings: - sharedPortType: false - project: - projectId: "567" - 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 - physicalPorts: - - 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" - 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 - portUpdateEncapsulationAndTagProtocolIdRequest: - value: - - op: replace - path: /encapsulation - value: - type: DOT1Q - tagProtocolId: 33024 - PortUpdateNameDryRunRequest: - value: - - op: replace - path: /name - value: 1234-ibx-port - portUpdateLagEnabledRequest: - value: - - op: replace - path: /lagEnabled - value: true - PortUpdateDryRunResponse: - 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 - physicalPortsSpeed: 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 - portPatchResponse202: - value: - href: https://api.equinix.com/fabric/v4/ports/44c5712b-d704-4ca5-9b42-ee6be32ee06a - type: XF_PORT - uuid: 08693250-e67f-431f-b1ac-d3204263876a - name: 290061-SV1-NE-Shared-CX-PRI-01 - physicalPortsSpeed: 10000 - physicalPortsType: 10GBASE_LR - physicalPortsCount: 1 - project: - projectId: "377533000114703" - state: REPROVISIONING - cvpId: "2001190" - account: - accountNumber: 290061 - ucmId: BD8EB6F3-F8EF-40dc-8AAF-032B85804920 - change: - type: PORT_UPDATE - status: REQUESTED - data: - op: REPLACE - path: /encapsulation - value: - type: DOT1Q - tagProtocolId: 33024 - bandwidth: 10000 - location: - metroName: Silicon Valley - metroCode: SV - device: - name: qa3-sv-em-e3.lab - redundancy: - priority: PRIMARY - configModel: UPF - demarcationPointIbx: SV5 - encapsulation: - type: QINQ - tagProtocolId: 37120 - lagEnabled: true - settings: - buyout: false - additionalInfo: - - key: crossConnectId - value: 21918108-A - package: - code: STANDARD - physicalPorts: - - tether: - crossConnectId: 21918108-A - patchPanel: CP:Demarc:1257694 - patchPanelPortA: "21" - patchPanelPortB: "22" - demarcationPoint: - patchPanelPortA: "18" - patchPanelPortB: "19" - ibx: SV1 - portPatchMultipleConnections400Response: - value: - - errorCode: EQ-3143253 - errorMessage: Port is used by one or more Connections, connectors, subscriptions and/or tokens - details: There are 9 Connections/ connectors/ subscriptions/ tokens associated to this port - correlationId: TEST - additionalInfo: - - property: /uuid - 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: - - property: /state - operator: = - values: - - ACTIVE - - REPROVISIONING - - property: /settings/productCode - operator: = - values: - - CX - - property: /project/projectId - operator: = - values: - - 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 - pagination: - limit: 1000 - offset: 0 - sort: - - property: /device/name - direction: DESC - portSearchByOptionalFilters: - value: - filter: - or: - - and: - - property: /device/name - operator: = - values: - - qa3-sv-em-e3.lab - - property: /physicalPorts/tether/crossConnectId - operator: = - values: - - 21918108-A - - property: /physicalPorts/interface/name - operator: = - values: - - et-0/0/0 - - property: /uuid - operator: = - values: - - 08693250-e67f-431f-b1ac-d3204263876a - - property: /name - operator: LIKE - values: - - port-name - - property: /account/orgId - operator: = - values: - - "94513" - - property: /account/accountNumber - operator: = - values: - - "290061" - - property: /location/metroCode - operator: IN - values: - - SV - pagination: - limit: 1000 - offset: 0 - sort: - - property: /device/name - direction: DESC - portSearchRangeOperators: - value: - filter: - or: - - and: - - property: /changeLog/createdDateTime - operator: BETWEEN - values: - - 2023-06-27T15:05:37Z - - 2023-07-27T15:05:37Z - - property: /badwidth - operator: ">=" - values: - - "1000" - pagination: - limit: 1000 - offset: 0 - sort: - - property: /changeLog/createdDateTime - direction: DESC - portSearchByMaintenanceStatus: - value: - filter: - and: - - property: /operation/maintenanceStatus - operator: IN - values: - - SCHEDULED - - COMPLETED - - property: /operation/lockEnabled - operator: IN - values: - - "true" - pagination: - limit: 25 - offset: 0 - portSearchInvalidProjectRequest: - value: - - errorCode: EQ-3046110 - errorMessage: ProjectID required. - details: ProjectId and ports are not found for the user - correlationId: TEST - additionalInfo: - - property: /project/projectId - reason: " before searching for ports, assign project and ports" - portSearchInvalidRequest: - value: - - errorCode: EQ-3046116 - errorMessage: JSON syntax error. - details: Unknown json property - correlationId: TEST - additionalInfo: - - property: filter.or.[0].and.[1].property - reason: Unexpected value '/settings/productCod' - portSearchInvalidSearchFieldProperty: - value: - - errorCode: EQ-3046116 - errorMessage: JSON syntax error. - details: Please refer the contracts for correct fields - correlationId: TEST - portSearchInvalidSearchFieldArgument: - value: - - errorCode: EQ-3046112 - errorMessage: Invalid argument value. - details: Please refer the contracts for correct fields - correlationId: TEST - port-packages: - value: - data: - - href: /fabric/v4/portPackages/XF_UNLIMITED_PLUS - type: PORT_PACKAGE - code: XF_UNLIMITED_PLUS - vcBandwidthMax: 100000 - vcRemoteSupported: true - supportedServiceTypes: - - MSP - supportedSourceTypes: - - COLO - supportedMetros: - - SV - - DA - - href: /fabric/v4/portPackages/XF_UNLIMITED - type: PORT_PACKAGE - code: XF_UNLIMITED - vcBandwidthMax: 100000 - vcRemoteSupported: false - supportedServiceTypes: - - MSP - supportedSourceTypes: - - REMOTE - - COLO - - href: /fabric/v4/portPackages/XF_STANDARD - type: PORT_PACKAGE - code: XF_STANDARD - vcBandwidthMax: 100000 - vcRemoteSupported: false - supportedServiceTypes: - - MSP - supportedSourceTypes: - - BMMR - - REMOTE - - COLO - port-packages-500: - value: - - errorCode: EQ-3143001 - errorMessage: Internal Error - details: Internal system error - correlationId: 80066c00-0f20-11f0-8367-d5075ee362a7 - 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_LR - physicalPortsSpeed: 10000 - physicalPortsAvailable: 8 - redundancy: - priority: PRIMARY - - demarcationPointIbx: AM2 - tetherIbx: AM1 - metroConnectUsed: true - lagEnabled: true - physicalPortsType: 10GBASE_LR - physicalPortsSpeed: 10000 - physicalPortsAvailable: 8 - redundancy: - priority: SECONDARY - ConnectionRouteAggregationsGetAll: - value: - pagination: - offset: 0 - limit: 20 - total: 4 - 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_IPv4_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_IPv4_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 - 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 - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: replace - path: /name - value: - type: BGP_IPv4_PREFIX_FILTER - name: My-route-filter-v4-updated - description: Test filter - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - 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 - SearchRouteFiltersAndRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_FILTER - - property: /state - operator: IN - values: - - PROVISIONED - - PROVISIONING - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteFiltersOrRequest: - value: - filter: - or: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_FILTER - - property: /name - operator: LIKE - values: - - "%Route_Filter_Demo%" - - property: /project/projectId - operator: IN - values: - - dadd3ab6-c0af-430c-8216-43d44f08c1c5 - - 4f08c1c6-c0af-430c-8216-43d44f08c1c5 - pagination: - offset: 1 - limit: 2 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteFiltersNestedRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_FILTER - - property: /changeLog/createdDateTime - operator: ">" - values: - - 2025-03-28T04:12:36.607Z - - or: - - property: /name - operator: LIKE - values: - - "%Demo%" - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteFiltersResponse: - value: - pagination: - offset: 1 - limit: 2 - total: 10 - next: /search?offset=3&limit=2 - previous: /search?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: BGP_IPv4_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: BGP_IPv4_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 - additionalInfo: - - property: prefixMatch - reason: Invalid argument value passed - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - name: Private-subnet-filter - description: Test rule - prefix: 192.168.0.0/25 - prefixMatch: exact - - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: replace - path: /prefixMatch - value: - name: Private-subnet-filter - description: Test rule - prefix: 192.168.0.0/25 - prefixMatch: orlonger - - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: replace - path: /prefixMatch - value: - name: Private-subnet-filter - description: Test rule - prefix: 192.168.0.0/25 - prefixMatch: exact - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - name: Private-subnet-filter - description: Test rule - prefix: 192.168.0.0/25 - prefixMatch: exact - 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: BGP_IPv4_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: BGP_IPv4_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 - SearchRouteFilterRulesAndRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_FILTER_RULE - - property: /state - operator: = - values: - - PROVISIONED - - or: - - property: /name - operator: LIKE - values: - - "%Demo%" - - property: /name - operator: LIKE - values: - - "%Production%" - - or: - - property: /state - operator: = - values: - - PROVISIONED - - and: - - property: /prefix - operator: = - values: - - 192.168.2.0/24 - - property: /prefixMatch - operator: = - values: - - exact - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteFilterRulesOrRequest: - value: - filter: - or: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_FILTER_RULE - - property: /state - operator: = - values: - - PROVISIONED - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteFilterRulesResponse: - value: - pagination: - offset: 1 - limit: 2 - total: 10 - next: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/search?offset=3&limit=2 - previous: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/search?offset=0&limit=2 - 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: Route_Filter_Rule_Demo1 - description: Test rule1 - prefixMatch: exact - action: PERMIT - prefix: 192.168.10.0/24 - state: PROVISIONED - 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: Route_Filter_Rule_Demo2 - description: Test rule2 - prefixMatch: orlonger - action: PERMIT - prefix: 192.168.20.0/24 - state: PROVISIONED - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: replace - path: /name - value: - type: BGP_IPv4_PREFIX_AGGREGATION - name: My-route-aggregations-v4-updated - description: Test Aggregation - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - 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 - SearchRouteAggregationsAndRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_AGGREGATION - - property: /state - operator: IN - values: - - PROVISIONED - - DEPROVISIONING - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteAggregationsOrRequest: - value: - filter: - or: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_AGGREGATION - - property: /name - operator: LIKE - values: - - "%Route_Aggregation_Demo%" - - property: /project/projectId - operator: IN - values: - - dadd3ab6-c0af-430c-8216-43d44f08c1c5 - - 8c1c5ab6-c0af-d44f-430c-43d44f08c1c5 - pagination: - offset: 1 - limit: 2 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteAggregationsNestedRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_AGGREGATION - - property: /changeLog/createdDateTime - operator: ">" - values: - - 2025-03-28T04:12:36.607Z - - or: - - property: /name - operator: LIKE - values: - - "%Demo%" - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteAggregationsResponse: - value: - pagination: - offset: 1 - limit: 2 - total: 10 - next: /search?offset=3&limit=2 - previous: /search?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: BGP_IPv4_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: BGP_IPv4_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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - 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: BGP_IPv4_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: BGP_IPv4_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 - SearchRouteAggregationRulesAndRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_AGGREGATION_RULE - - property: /state - operator: = - values: - - PROVISIONED - - or: - - property: /name - operator: LIKE - values: - - "%Demo%" - - property: /name - operator: LIKE - values: - - "%Production%" - - or: - - property: /prefix - operator: = - values: - - 192.168.2.0/24 - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteAggregationRulesOrRequest: - value: - filter: - or: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_AGGREGATION_RULE - - property: /state - operator: = - values: - - PROVISIONED - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteAggregationRulesResponse: - value: - pagination: - offset: 1 - limit: 2 - total: 10 - next: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/search?offset=3&limit=2 - previous: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/search?offset=0&limit=2 - 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: Route_Aggregation_Rule_Demo1 - description: Test rule1 - prefix: 192.168.10.0/24 - state: PROVISIONED - 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: Route_Aggregation_Rule_Demo2 - description: Test rule2 - prefix: 192.168.20.0/24 - state: PROVISIONED - 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. - 400_attached_to_gateway: - value: - - errorCode: EQ-3000039 - errorMessage: Gateway must be detached before deleting Fabric Cloud Router. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01586 - details: User must detach Gateway before deleting a Fabric Cloud Router. - 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 - UpdateTermLength: - value: - - op: replace - path: /order/termLength - value: 12 - UpdatePackageAndTermLength: - value: - - op: replace - path: /package/code - value: PREMIUM - - op: replace - path: /order/termLength - value: 12 - 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 - data: - - op: replace - path: /package/code - value: PREMIUM - - op: replace - path: /order/termLength - value: 12 - 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 - CloudRouterActionSearchResponse: - value: - pagination: - offset: 0 - limit: 1 - total: 2 - prev: null - next: null - data: - - href: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9 - uuid: 1e9414f1-763e-4c0a-86c6-0bc8336048d9 - type: RECEIVED_ROUTE_ENTRY_UPDATE - state: SUCCEEDED - connection: - href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 - uuid: 3066ab1d-af87-49d7-8a14-c9bdb57ac809 - type: IP_VC - operation: - bgpIpv4RoutesCount: 6 - bgpIpv6RoutesCount: 6 - distinctIpv4PrefixesCount: 4 - distinctIpv6PrefixesCount: 4 - changeLog: - createdDateTime: 2024-01-01T01:00:00Z - updatedDateTime: 2024-01-01T01:01:00Z - - href: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9 - uuid: 1e9414f1-763e-4c0a-86c6-0bc8336048d9 - type: ROUTE_TABLE_ENTRY_UPDATE - state: SUCCEEDED - router: - href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 - uuid: 3066ab1d-af87-49d7-8a14-c9bdb57ac809 - type: XF_ROUTER - operation: - bgpIpv4RoutesCount: 6 - bgpIpv6RoutesCount: 6 - distinctIpv4PrefixesCount: 4 - distinctIpv6PrefixesCount: 4 - changeLog: - createdDateTime: 2024-01-01T01:00:00Z - updatedDateTime: 2024-01-01T01:01:00Z - RouteEntriesStatusUpdate: - value: - type: ROUTE_TABLE_ENTRY_UPDATE - ReceivedRouteEntriesStatusUpdate: - value: - type: RECEIVED_ROUTE_ENTRY_UPDATE - connection: - uuid: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - AdvertisedRouteEntriesStatusUpdate: - value: - type: ADVERTISED_ROUTE_ENTRY_UPDATE - connection: - uuid: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - CloudRouterActionResponse: - value: - type: ROUTE_TABLE_ENTRY_UPDATE - uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 - state: PENDING - changeLog: - createdDateTime: 2020-05-21T10:30:00Z - 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 - 108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms - 108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms - 108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms - 108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms - --- 8.8.8.8 ping statistics --- - 4 packets transmitted, 4 packets received, 0.0% packet loss - round-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 - PostRequestTracerouteCommand: - value: - type: TRACEROUTE_COMMAND - name: traceroute-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 - probes: 3 - hopsMax: 20 - 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 - PostResponseTracerouteCommand: - value: - href: https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00 - type: TRACEROUTE_COMMAND - uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 - name: traceroute-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 - probes: 3 - hopsMax: 20 - 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 - 108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms - 108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms - 108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms - 108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms - --- 8.8.8.8 ping statistics --- - 4 packets transmitted, 4 packets received, 0.0% packet loss - round-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 - 108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms - 108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms - 108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms - 108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms - --- 8.8.8.8 ping statistics --- - 4 packets transmitted, 4 packets received, 0.0% packet loss - round-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 - GetResponseTracerouteCommandWithError: - value: - href: https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00 - type: TRACEROUTE_COMMAND - uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 - name: traceroute-test-1 - description: Testing FCR-SV-1 - state: FAILED - project: - projectId: b11d4cb5-978a-418a-8b13-bf19abb97938 - request: - destination: 8.8.8.8 - sourceConnection: - uuid: 1da3778c-6aa3-4e47-b2fe-83a0773dde18 - timeout: 2 - probes: 3 - hopsMax: 20 - response: - errors: - - errorCode: EQ-3041105 - errorMessage: Request timeout. - correlationId: 86c57a79-06fb-4ba3-b496-5387f3b45380 - details: Request timeout after 480 seconds. - additionalInfo: - - reason: Request timeout after 480 seconds. - 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: - - 10.10.10.5 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - SearchFilterByPrefix: - value: - filter: - and: - - property: /prefix - operator: = - values: - - 192.168.10.0/24 - 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 - CloudRouterActiveRoutesSearchResponse: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - type: IPv4_BGP_ROUTE - protocolType: BGP - state: ACTIVE - prefix: 192.168.10.0/24 - nextHop: 10.10.10.5 - asPath: - - "20001" - changeLog: - createdBy: johnsmith - createdByFullName: John Smith - createdByEmail: john.smith@example.com - createdDateTime: 2020-11-06T07:00:00Z - updatedBy: johnsmith - updatedByFullName: John Smith - updatedByEmail: john.smith@example.com - updatedDateTime: 2020-11-06T07:00:00Z - deletedBy: johnsmith - deletedByFullName: John Smith - deletedByEmail: john.smith@example.com - deletedDateTime: 2020-11-06T07:00:00Z - 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 - CloudRouterSearchRouteFiltersRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_FILTER - - property: /direction - operator: = - values: - - INBOUND - - property: /attachmentStatus - operator: = - values: - - ATTACHED - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - CloudRouterSearchRouteFiltersResponse: - value: - pagination: - offset: 0 - limit: 20 - total: 2 - next: /search?offset=3&limit=2 - previous: /search?offset=0&limit=2 - data: - - href: https://api.equinix.com/fabric/v4/connections/57f82f8c-d899-4a21-93ae-5cfe33c50556/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d - type: BGP_IPv4_PREFIX_FILTER - uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - direction: INBOUND - attachmentStatus: ATTACHED - changeLog: - createdBy: testuser - createdDateTime: 2020-05-21T10:30:00Z - - href: https://api.equinix.com/fabric/v4/connections/500589e0-4196-4839-8d43-a0c073b4d747/routeFilters/4ed45b37-2b26-49de-ab35-4ad039586c7a - type: BGP_IPv4_PREFIX_FILTER - uuid: 4ed45b37-2b26-49de-ab35-4ad039586c7a - direction: INBOUND - attachmentStatus: ATTACHED - changeLog: - createdBy: testuser - createdDateTime: 2020-05-21T10:30:00Z - CloudRouterSearchRouteAggregationsRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_AGGREGATION - - property: /attachmentStatus - operator: = - values: - - ATTACHED - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - CloudRouterSearchRouteAggregationsResponse: - value: - pagination: - offset: 1 - limit: 2 - total: 10 - next: /search?offset=3&limit=2 - previous: /search?offset=0&limit=2 - data: - - href: https://api.equinix.com/fabric/v4/connections/57f82f8c-d899-4a21-93ae-5cfe33c50556/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d - type: BGP_IPv4_PREFIX_AGGREGATION - uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - attachmentStatus: ATTACHED - changeLog: - createdBy: testuser - createdDateTime: 2020-05-21T10:30:00Z - - href: https://api.equinix.com/fabric/v4/connections/500589e0-4196-4839-8d43-a0c073b4d747/routeAggregations/4ed45b37-2b26-49de-ab35-4ad039586c7a - type: BGP_IPv4_PREFIX_AGGREGATION - uuid: 4ed45b37-2b26-49de-ab35-4ad039586c7a - attachmentStatus: ATTACHED - changeLog: - createdBy: testuser - createdDateTime: 2020-05-21T10:30:00Z - 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: https://api.equinix.com/fabric/v4/health - version: "4.4" - release: 2022.4.0 - 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 - 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: http://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: http://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 - createdDateTime: 2025-03-03T19:37:29.326Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-03T19:21:43.145Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-03T19:43:20.145Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-03T20:52:23.469Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-03T19:21:43.145Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-03T20:55:57.858Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-05T21:17:46.656Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-05T20:57:07.206Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-05T21:22:30.984Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-05T21:37:08.370Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-06T00:23:29.030Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-06T00:30:42.972Z - links: - - href: http://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 - updatedBy: testuser - updatedDateTime: 2020-05-21T10:30:00Z - 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 - updatedBy: testuser - updatedDateTime: 2020-05-21T10:30:00Z - 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 - updatedBy: testuser1 - updatedDateTime: 2020-05-21T10:30:00Z - deletedBy: testuser1 - deletedDateTime: 2020-05-21T10:30:00Z - 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 - updatedBy: testuser - updatedDateTime: 2020-05-21T10:30:00Z - 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 - updatedBy: testuser1 - updatedDateTime: 2020-05-21T10:30:00Z - 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: PTP - 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: PTP - 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= - - type: HEX - keyNumber: 65535 - key: YTFhMWExYTFhMWExYTE= - 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= - - type: HEX - keyNumber: 65535 - key: YTFhMWExYTFhMWExYTE= - 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: PTP - 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: PTP - 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 - operation: - operationalStatus: UP - 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 - operation: - operationalStatus: UP - 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 - operation: - operationalStatus: UP - 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 - operation: - operationalStatus: UP - 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 - operation: - operationalStatus: UP - 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= - - type: HEX - keyNumber: 65535 - key: YTFhMWExYTFhMWExYTE= - 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 - operation: - operationalStatus: UP - 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= - - type: HEX - keyNumber: 65535 - key: YTFhMWExYTFhMWExYTE= - 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 - operation: - operationalStatus: UP - 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= - - type: HEX - keyNumber: 65535 - key: YTFhMWExYTFhMWExYTE= - 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 - operation: - operationalStatus: UP - 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 - operation: - operationalStatus: UP - 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: PTP - 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= - - type: HEX - keyNumber: 65535 - key: YTFhMWExYTFhMWExYTE= - 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: PTP - 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 - operation: - operationalStatus: UP - 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= - - type: HEX - keyNumber: 65535 - key: YTFhMWExYTFhMWExYTE= - 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 - operation: - operationalStatus: UP - 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 - alertRulesCount: 3 - 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 - account: - accountNumber: 123456 - notifications: - - type: ALL - emails: - - johndoe@equinix.com - 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 - account: - accountNumber: 123456 - notifications: - - type: ALL - emails: - - johndoe@equinix.com - state: PROVISIONED - assetsCount: 1 - streamSubscriptionsCount: 2 - alertRulesCount: 3 - changeLog: - createdDateTime: 2024-05-06T16:21:18.545214Z - StreamSearchRequestExample: - value: - filter: - and: - - property: /project/projectId - operator: IN - values: - - 2f7f1a59-2dbf-43f8-b1a4-3c1f4e4b55b5 - - or: - - property: /uuid - operator: IN - values: - - 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 - - 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - - property: /state - operator: = - values: - - PROVISIONED - sort: - - direction: DESC - property: /changeLog/createdDateTime - pagination: - offset: 0 - limit: 20 - stream-search-all-example: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/streams/12f4d4a1-c7cb-4def-9f77-5ce93c19d999 - uuid: 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 - type: TELEMETRY_STREAM - name: stream-dev-01 - description: Observability stream for project assets - project: - projectId: 2f7f1a59-2dbf-43f8-b1a4-3c1f4e4b55b5 - state: PROVISIONED - assetsCount: 3 - streamSubscriptionsCount: 1 - alertRulesCount: 2 - changeLog: - createdDateTime: 2026-06-17T10:15:30Z - updatedDateTime: 2026-06-18T10:15:30Z - 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: /uuid - operator: IN - values: - - 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - - 9ac8ecfe-c7cb-4def-9f77-5ce93c19d83e - - property: /streamUuid - operator: = - values: - - 4719e319-65ae-4001-aabf-ca5f107b9b29 - - property: /attachmentStatus - operator: IN - values: - - ATTACHED - - ATTACHING - sort: - - direction: DESC - property: /uuid - pagination: - offset: 0 - limit: 20 - stream-asset-search-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 - streamUuid: e784aa26-8276-48b7-bb42-a6d9def0a424 - type: XF_PORT - metricsEnabled: false - attachmentStatus: ATTACHED - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - 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 - StreamDeviceAssetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d - uuid: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d - type: VIRTUAL_DEVICE - metricsEnabled: true - attachmentStatus: ATTACHED - interfaces: - - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3 - id: 3 - uuid: 1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b - type: DATA - state: ASSIGNED - attachmentStatus: ATTACHED - - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5 - id: 5 - uuid: 4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d - type: DATA - state: ASSIGNED - attachmentStatus: ATTACHED - StreamDevicePutRequestExample: - value: - metricsEnabled: true - interfaces: - - id: 3 - - id: 5 - StreamDeviceAssetAttachResponseExample: - value: - href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d - uuid: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d - type: VIRTUAL_DEVICE - metricsEnabled: true - attachmentStatus: ATTACHING - interfaces: - - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3 - id: 3 - uuid: 1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b - type: DATA - state: ASSIGNED - attachmentStatus: ATTACHING - - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5 - id: 5 - uuid: 4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d - type: DATA - state: ASSIGNED - attachmentStatus: ATTACHING - StreamDeviceAssetDetachResponseExample: - value: - href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d - uuid: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d - type: VIRTUAL_DEVICE - metricsEnabled: true - attachmentStatus: DETACHING - interfaces: - - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3 - id: 3 - uuid: 1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b - type: DATA - state: ASSIGNED - attachmentStatus: DETACHING - - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5 - id: 5 - uuid: 4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d - type: DATA - state: ASSIGNED - 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 - operation: - eventsDeliveredCount: 0 - metricsDeliveredCount: 0 - alertsDeliveredCount: 0 - errors: [] - changeLog: - createdDateTime: 2024-05-06T16:21:18.545214Z - StreamSubscriptionPostRequestExampleSimpleDefaultSplunk: - value: - type: STREAM_SUBSCRIPTION - name: splunk1 - description: subscription-1 - enabled: true - sink: - uri: https://http-inputs-.splunkcloud.com:/services/collector/event - 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://http-inputs-.splunkcloud.com:/services/collector/event - 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: https://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: https://.datadoghq.com - type: DATADOG - credential: - type: API_KEY - apiKey: my-api-key - settings: - source: Equinix - applicationKey: my-application-key - eventUri: https://.datadoghq.com/api/v1/events - metricUri: https://.datadoghq.com/api/v2/series - StreamSubscriptionPostRequestExampleDynatrace: - value: - type: STREAM_SUBSCRIPTION - name: dynatrace-subscription - description: subscription-1 - enabled: true - metricSelector: - include: - - equinix.fabric.connection.* - sink: - type: DYNATRACE - credential: - type: API_TOKEN - apiToken: - settings: - eventUri: https://.live.dynatrace.com/platform/ingest/v1/events - metricUri: https://.live.dynatrace.com/api/v2/metrics/ingest - 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 - StreamSubscriptionPostRequestExampleGenericWebhookNoAuth: - value: - type: STREAM_SUBSCRIPTION - name: webhook - description: subscription-1 - enabled: true - sink: - type: WEBHOOK - settings: - eventUri: https://xxxxxx - metricUri: https://xxxxxx - format: CLOUDEVENT - StreamSubscriptionPostRequestExampleGenericWebhookApiKey: - value: - type: STREAM_SUBSCRIPTION - name: webhook - description: subscription-1 - enabled: true - sink: - type: WEBHOOK - settings: - eventUri: https://xxxxxx - metricUri: https://xxxxxx - format: CLOUDEVENT - credential: - type: API_KEY - apiKey: - StreamSubscriptionPostRequestExampleGenericWebhookAccessToken: - value: - type: STREAM_SUBSCRIPTION - name: webhook - description: subscription-1 - enabled: true - sink: - type: WEBHOOK - settings: - eventUri: https://xxxxxx - metricUri: https://xxxxxx - format: CLOUDEVENT - credential: - type: ACCESS_TOKEN - accessToken: - StreamSubscriptionPostRequestExampleGenericWebhookUsernamePassword: - value: - type: STREAM_SUBSCRIPTION - name: webhook - description: subscription-1 - enabled: true - sink: - type: WEBHOOK - settings: - eventUri: https://xxxxxx - metricUri: https://xxxxxx - format: CLOUDEVENT - credential: - type: USERNAME_PASSWORD - username: - password: - StreamSubscriptionPostRequestExampleGrafanaWebhook: - value: - type: STREAM_SUBSCRIPTION - name: webhook - description: subscription-1 - enabled: true - metricSelector: - include: - - equinix.fabric.connection.* - sink: - type: WEBHOOK - settings: - eventUri: https:///otlp/v1/logs - metricUri: https:///otlp/v1/metrics - format: OPENTELEMETRY - credential: - type: API_KEY - apiKey: : - StreamSubscriptionPostRequestExampleGooglePubSub: - value: - type: STREAM_SUBSCRIPTION - name: gcp-pubsub - description: subscription-1 - enabled: true - metricSelector: - include: - - equinix.fabric.connection.* - sink: - type: GOOGLE_PUBSUB - uri: https://pubsub.googleapis.com/v1/projects//topics/:publish - credential: - type: ACCESS_TOKEN - accessToken: - 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://http-inputs-.splunkcloud.com:/services/collector/event - 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 - operation: - eventsDeliveredCount: 0 - metricsDeliveredCount: 0 - alertsDeliveredCount: 0 - errors: [] - changeLog: - createdDateTime: 2024-05-06T16:21:18.545214Z - StreamSubscriptionPutRequestExample: - 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: 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 - StreamSubscriptionSearchRequestExample: - value: - filter: - and: - - property: /streamUuid - operator: = - values: - - 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 - - or: - - property: /uuid - operator: = - values: - - 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - - property: /name - operator: ILIKE - values: - - demo% - sort: - - direction: DESC - property: /changeLog/createdDateTime - pagination: - offset: 0 - limit: 20 - stream-subscription-search-all-example: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/streams/12f4d4a1-c7cb-4def-9f77-5ce93c19d999/subscriptions/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - uuid: 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - type: STREAM_SUBSCRIPTION - name: demo-subscription - description: Subscription for demo stream events - state: PROVISIONED - enabled: true - metricSelector: - include: - - equinix.fabric.connection.* - eventSelector: - include: - - equinix.fabric.connection.* - sink: - uri: https://hooks.example.com/fabric - type: WEBHOOK - batchEnabled: false - batchSizeMax: 50 - batchWaitTimeMax: 5 - operation: - eventsDeliveredCount: 12 - metricsDeliveredCount: 4 - alertsDeliveredCount: 0 - errors: [] - changeLog: - createdDateTime: 2026-06-17T10:15:30Z - updatedDateTime: 2026-06-18T10:15:30Z - 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 - metricSelector: - include: - - equinix.fabric.connection.bandwidth_tx.usage - resourceSelector: - include: - - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b - detectionMethod: - type: THRESHOLD - windowSize: PT15M - operand: ABOVE - warningThreshold: "35000000" - criticalThreshold: "45000000" - changeLog: - createdBy: user - createdDateTime: 2024-05-06T16:21:18.545214Z - StreamAlertRulePostRequestExample: - value: - name: metric-alert-1 - type: METRIC_ALERT - description: metric-alert-1 - enabled: true - metricSelector: - include: - - equinix.fabric.connection.bandwidth_tx.usage - resourceSelector: - include: - - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b - detectionMethod: - type: THRESHOLD - windowSize: PT15M - warningThreshold: "35000000" - criticalThreshold: "45000000" - StreamSmartAlertRulePostRequestExample: - value: - name: metric-alert-1 - type: METRIC_ALERT - description: metric-alert-1 - enabled: true - metricSelector: - include: - - equinix.fabric.metro.sv_sy.latency - resourceSelector: - include: - - /fabric/v4/metros/SV - detectionMethod: - type: OUTLIER - 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 - metricSelector: - include: - - equinix.fabric.connection.bandwidth_tx.usage - resourceSelector: - include: - - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b - detectionMethod: - type: THRESHOLD - 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 - type: METRIC_ALERT - description: metric-alert-1 - enabled: true - metricSelector: - include: - - equinix.fabric.connection.bandwidth_tx.usage - resourceSelector: - include: - - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b - detectionMethod: - type: THRESHOLD - windowSize: PT15M - operand: ABOVE - 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 - metricSelector: - include: - - equinix.fabric.connection.bandwidth_tx.usage - resourceSelector: - include: - - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b - detectionMethod: - type: THRESHOLD - 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 - DeploymentCreate: - value: - type: TOPOLOGY_DEPLOYMENT - name: MCN-Deployment - description: FCR and AWS DGW Deployment in DC - topology: - uuid: 3d4cfd38-5f56-4f71-b3e4-5f44631f1b2a - providers: - - type: FABRIC_PROVIDER - resources: - - type: XF_ROUTER - name: router-1 - location: - metroCode: DC - package: - code: LAB - deploymentProperties: - elementId: 13fc5d30-036d-11f0-96a3-5336ee83f43f - - type: XF_ROUTER - uuid: 9e0f9cf0-6584-41d3-933b-e8d7c5b88450 - deploymentProperties: - elementId: f29757aa-ae8a-4170-9acf-7b2176bdbe49 - - type: IP_VC - bandwidth: 50 - name: My connection to router1 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: CLOUD_ROUTER - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - sellerRegion: us-east-1 - authenticationKey: 12345678923 - deploymentProperties: - elementId: adbad8be-10d7-42d5-ab85-066d1c8a8259 - dependsOn: - - 13fc5d30-036d-11f0-96a3-5336ee83f43f - - type: IP_VC - bandwidth: 50 - name: My connection to router2 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: CLOUD_ROUTER - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - sellerRegion: us-east-1 - authenticationKey: 12345678923 - deploymentProperties: - elementId: 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - f29757aa-ae8a-4170-9acf-7b2176bdbe49 - - type: BGP - bgpIpv4: - equinixip: 192.168.100.1/30 - customerip: 192.168.100.2 - enabled: true - bgpAuthKey: xxxxxxx - customerAsn: 65333 - asOverrideEnabled: true - deploymentProperties: - elementId: 3184e34a-69ba-4821-aa54-1e66a8a6672e - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - type: BGP - bgpIpv4: - equinixip: 192.168.100.5/30 - customerip: 192.168.100.6 - enabled: true - bgpAuthKey: xxxxxxx - customerAsn: 65334 - asOverrideEnabled: true - deploymentProperties: - elementId: 2194e34a-69ba-4821-aa54-1e66a8a6672e - dependsOn: - - 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - - type: IPWAN - name: ipwan-1 - scope: REGIONAL - location: - region: AMER - deploymentProperties: - elementId: 074fcae4-a679-4f0b-b6ba-cb00bd491048 - - type: IPWAN_VC - bandwidth: 50 - name: My connection from router1 to ipwan - deploymentProperties: - elementId: 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - 074fcae4-a679-4f0b-b6ba-cb00bd491048, 13fc5d30-036d-11f0-96a3-5336ee83f43f - - type: IPWAN_VC - bandwidth: 50 - name: My connection from router2 to ipwan - deploymentProperties: - elementId: 468cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - 074fcae4-a679-4f0b-b6ba-cb00bd491048, f29757aa-ae8a-4170-9acf-7b2176bdbe49 - - type: AWS_PROVIDER - resources: - - type: PERMISSION - roleArn: arn:aws:iam:::role/ - region: us-east-1 - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f48 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - type: DIRECT_CONNECT - uuid: c3af0941-b4e1-45d3-b961-8fc50768fcfb - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f46 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - c2a3d2ec-265a-41af-b72d-fded5a371f48 - - type: VIRTUAL_PRIVATE_GATEWAY - required: true/false - vpcId: c0c68cc5-6e7f-43d3-a322-afdac89038d7 - subnetId: c3af0941-b4e1-45d3-b961-8fc50768fcfb - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f45 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - c2a3d2ec-265a-41af-b72d-fded5a371f48 - project: - projectId: ad444dd7-1144-47db-bacc-bab4d313222d - account: - accountNumber: 346346456 - order: - purchaseOrderNumber: PO345346534563 - termLength: 12 - notifications: - - type: ALL - emails: - - test@test.com - DeploymentPostResponse: - value: - href: https://api.equinix.com/fabric/v4/deployments/8c9dfc8d-b32b-44a4-aa2e-e3dcc3c7fdac - type: TOPOLOGY_DEPLOYMENT - uuid: 8c9dfc8d-b32b-44a4-aa2e-e3dcc3c7fdac - name: MCN-Deployment - state: PENDING - description: FCR and AWS DGW Deployment in DC - topology: - uuid: 3d4cfd38-5f56-4f71-b3e4-5f44631f1b2a - providers: - - type: FABRIC_PROVIDER - resources: - - type: XF_ROUTER - deploymentProperties: - elementId: 13fc5d30-036d-11f0-96a3-5336ee83f43f - - href: https://api.equinix.com/fabric/v4/routers/9e0f9cf0-6584-41d3-933b-e8d7c5b88450 - type: XF_ROUTER - uuid: 9e0f9cf0-6584-41d3-933b-e8d7c5b88450 - deploymentProperties: - elementId: f29757aa-ae8a-4170-9acf-7b2176bdbe49 - dependsOn: [] - - type: IP_VC - bandwidth: 50 - state: PROVISIONING - name: My connection to router1 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: CLOUD_ROUTER - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - sellerRegion: us-east-1 - authenticationKey: 12345678923 - deploymentProperties: - elementId: adbad8be-10d7-42d5-ab85-066d1c8a8259 - dependsOn: - - 13fc5d30-036d-11f0-96a3-5336ee83f43f - - type: IP_VC - uuid: 31f5251c-8142-45b7-b566-76ae345d81ef - bandwidth: 50 - state: PROVISIONING - name: My connection to router2 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: CLOUD_ROUTER - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - sellerRegion: us-east-1 - authenticationKey: 12345678923 - deploymentProperties: - elementId: 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - f29757aa-ae8a-4170-9acf-7b2176bdbe49 - - type: BGP - bgpIpv4: - equinixip: 192.168.100.1/30 - customerip: 192.168.100.2 - enabled: true - bgpAuthKey: xxxxxxx - customerAsn: 65333 - asOverrideEnabled: true - deploymentProperties: - elementId: 3184e34a-69ba-4821-aa54-1e66a8a6672e - dependsOn: - - e40def8d-b067-4a94-8a67-e6caa5fa41b3 - - type: BGP - bgpIpv4: - equinixip: 192.168.100.5/30 - customerip: 192.168.100.6 - enabled: true - bgpAuthKey: xxxxxxx - customerAsn: 65334 - asOverrideEnabled: true - deploymentProperties: - elementId: 2194e34a-69ba-4821-aa54-1e66a8a6672e - dependsOn: - - 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - - href: https://api.equinix.com/fabric/v4/networks/6658cc3b-18e0-437c-b972-62b51a419a1e - type: IPWAN - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - name: ipwan-1 - scope: REGIONAL - state: PROVISIONING - location: - region: AMER - deploymentProperties: - elementId: 074fcae4-a679-4f0b-b6ba-cb00bd491048 - - href: https://api.equinix.com/fabric/v4/connections/8548cc3b-18e0-437c-b972-62b51a419a11 - type: IPWAN_VC - uuid: 8548cc3b-18e0-437c-b972-62b51a419a11 - bandwidth: 50 - name: My connection from router1 to ipwan - state: PROVISIONING - deploymentProperties: - elementId: 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - 074fcae4-a679-4f0b-b6ba-cb00bd491048 - - 13fc5d30-036d-11f0-96a3-5336ee83f43f - - href: https://api.equinix.com/fabric/v4/connections/2348cc3b-18e0-437c-b972-62b51a419a1f - type: IPWAN_VC - uuid: 2348cc3b-18e0-437c-b972-62b51a419a1f - bandwidth: 50 - name: My connection from router2 to ipwan - state: PROVISIONING - deploymentProperties: - elementId: 468cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - 074fcae4-a679-4f0b-b6ba-cb00bd491048 - - f29757aa-ae8a-4170-9acf-7b2176bdbe49 - - type: AWS_PROVIDER - resources: - - type: PERMISSION - roleArn: arn:aws:iam:::role/ - region: us-east-1 - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f48 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - type: DIRECT_CONNECT - uuid: c3af0941-b4e1-45d3-b961-8fc50768fcfb - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f46 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - c2a3d2ec-265a-41af-b72d-fded5a371f48 - - type: VIRTUAL_PRIVATE_GATEWAY - required: true - vpcId: c0c68cc5-6e7f-43d3-a322-afdac89038d7 - subnetId: c3af0941-b4e1-45d3-b961-8fc50768fcfb - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f45 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - c2a3d2ec-265a-41af-b72d-fded5a371f48 - project: - projectId: ad444dd7-1144-47db-bacc-bab4d313222d - account: - accountNumber: 346346456 - order: - purchaseNumber: PO345346534563 - termLength: 12 - notifications: - - type: ALL - emails: - - test@test.com - Orchestrator_400_InvalidName: - value: - - errorCode: EQ-8020022 - errorMessage: Name is minimum 0 and up to 50 characters in length - correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e - details: Name is minimum 0 and up to 50 characters in length - additionalInfo: - - property: /name - reason: Name is minimum 0 and up to 50 characters in length - Orchestrator_401: - value: - - errorCode: EQ-8020001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - Orchestrator_403: - value: - - errorCode: EQ-8020002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - Orchestrator_404: - value: - - errorCode: EQ-8020020 - errorMessage: Deployement not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: Deployement not found or already deleted - Orchestrator_500: - value: - - errorCode: EQ-8020030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - DeploymentGet: - value: - href: https://api.equinix.com/fabric/v4/deployments/8c9dfc8d-b32b-44a4-aa2e-e3dcc3c7fdac - type: TOPOLOGY_DEPLOYMENT - uuid: 8c9dfc8d-b32b-44a4-aa2e-e3dcc3c7fdac - name: MCN-Deployment - state: PROVISIONED - description: FCR and AWS DGW Deployment in DC - providers: - - type: FABRIC_PROVIDER - resources: - - href: https://api.equinix.com/fabric/v4/routers/1479d681-a7f5-4ea9-9495-9f54c4ca2ec4 - type: XF_ROUTER - uuid: 1479d681-a7f5-4ea9-9495-9f54c4ca2ec4 - deploymentProperties: - elementId: 13fc5d30-036d-11f0-96a3-5336ee83f43f - dependsOn: [] - - href: https://api.equinix.com/fabric/v4/routers/9e0f9cf0-6584-41d3-933b-e8d7c5b88450 - type: XF_ROUTER - uuid: 9e0f9cf0-6584-41d3-933b-e8d7c5b88450 - deploymentProperties: - elementId: f29757aa-ae8a-4170-9acf-7b2176bdbe49 - dependsOn: [] - - href: https://api.equinix.com/fabric/v4/connections/21d5251c-8142-45b7-b566-76ae345d81ee - type: IP_VC - uuid: 21d5251c-8142-45b7-b566-76ae345d81ee - bandwidth: 50 - state: PROVISIONING - name: My connection to router1 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: CLOUD_ROUTER - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - sellerRegion: us-east-1 - authenticationKey: 12345678923 - deploymentProperties: - elementId: adbad8be-10d7-42d5-ab85-066d1c8a8259 - dependsOn: - - 13fc5d30-036d-11f0-96a3-5336ee83f43f - - href: https://api.equinix.com/fabric/v4/connections/31f5251c-8142-45b7-b566-76ae345d81ef - type: IP_VC - uuid: 31f5251c-8142-45b7-b566-76ae345d81ef - bandwidth: 50 - state: PROVISIONING - name: My connection to router2 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: CLOUD_ROUTER - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - sellerRegion: us-east-1 - authenticationKey: 12345678923 - deploymentProperties: - elementId: 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - f29757aa-ae8a-4170-9acf-7b2176bdbe49 - - type: BGP - bgpIpv4: - equinixip: 192.168.100.1/30 - customerip: 192.168.100.2 - enabled: true - bgpAuthKey: xxxxxxx - customerAsn: 65333 - asOverrideEnabled: true - deploymentProperties: - elementId: 3184e34a-69ba-4821-aa54-1e66a8a6672e - dependsOn: - - e40def8d-b067-4a94-8a67-e6caa5fa41b3 - - type: BGP - bgpIpv4: - equinixip: 192.168.100.5/30 - customerip: 192.168.100.6 - enabled: true - bgpAuthKey: xxxxxxx - customerAsn: 65334 - asOverrideEnabled: true - deploymentProperties: - elementId: 2194e34a-69ba-4821-aa54-1e66a8a6672e - dependsOn: - - 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - - href: https://api.equinix.com/fabric/v4/networks/6658cc3b-18e0-437c-b972-62b51a419a1e - type: IPWAN - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - name: ipwan-1 - scope: REGIONAL - state: PROVISIONING - location: - region: AMER - deploymentProperties: - elementId: 074fcae4-a679-4f0b-b6ba-cb00bd491048 - - href: https://api.equinix.com/fabric/v4/connections/8548cc3b-18e0-437c-b972-62b51a419a11 - type: IPWAN_VC - uuid: 8548cc3b-18e0-437c-b972-62b51a419a11 - bandwidth: 50 - name: My connection from router1 to ipwan - state: PROVISIONING - deploymentProperties: - elementId: 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - 074fcae4-a679-4f0b-b6ba-cb00bd491048 - - 13fc5d30-036d-11f0-96a3-5336ee83f43f - - href: https://api.equinix.com/fabric/v4/connections/2348cc3b-18e0-437c-b972-62b51a419a1f - type: IPWAN_VC - uuid: 2348cc3b-18e0-437c-b972-62b51a419a1f - bandwidth: 50 - name: My connection from router2 to ipwan - state: PROVISIONING - deploymentProperties: - elementId: 468cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - 074fcae4-a679-4f0b-b6ba-cb00bd491048 - - f29757aa-ae8a-4170-9acf-7b2176bdbe49 - - type: AWS_PROVIDER - resources: - - type: PERMISSION - roleArn: arn:aws:iam:::role/ - region: us-east-1 - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f48 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - type: DIRECT_CONNECT - uuid: c3af0941-b4e1-45d3-b961-8fc50768fcfb - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f46 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - c2a3d2ec-265a-41af-b72d-fded5a371f48 - - type: VIRTUAL_PRIVATE_GATEWAY - required: true - vpcId: c0c68cc5-6e7f-43d3-a322-afdac89038d7 - subnetId: c3af0941-b4e1-45d3-b961-8fc50768fcfb - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f45 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - c2a3d2ec-265a-41af-b72d-fded5a371f48 - project: - projectId: ad444dd7-1144-47db-bacc-bab4d313222d - account: - accountNumber: 346346456 - order: - purchaseNumber: PO345346534563 - termLength: 12 - notifications: - - type: ALL - emails: - - test@test.com - Orchestrator_400_InvalidState: - value: - - errorCode: EQ-8020030 - errorMessage: Cannot delete Deployment in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete Deployment in transient state. - DeploymentActions: - value: - type: DEPLOY - data: - - type: PERMISSION - roleArn: arn:aws:iam:::role/ - region: us-east-1 - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f48 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - ProviderResourcesSearch: - value: - filter: - and: - - property: /providers/type - operator: = - values: - - AWS_PROVIDER - - property: /providers/oidcCredentials/roleArn - operator: = - values: - - arn:aws:iam:::role/ - - property: /providers/oidcCredentials/region - operator: = - values: - - us-east-1 - - property: /providers/resources/type - operator: = - values: - - DIRECT_CONNECT - - VPC - - SUBNET - IssueLoaOnCageWithCageId: - value: - type: CAGE_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - expirationDateTime: 2026-12-31T23:59:59Z - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - demarcationPoint: - cageUniqueSpaceId: AM7:0G:0202 - IssueLoaOnPatchPanelPort: - value: - type: PATCH_PANEL_PORT_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for patch panel port access to Equinix at SV1 - authorizedProductType: XC - expirationDateTime: 2026-12-31T23:59:59Z - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 23 - patchPanelPortB: 24 - connectorType: SC - IssueLoaOnPatchPanel: - value: - type: PATCH_PANEL_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for patch panel access to Equinix at SV1 - authorizedProductType: XC - expirationDateTime: 2026-12-31T23:59:59Z - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - RequestLoaOnCage: - value: - type: CAGE_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for patch panel port access to Equinix at SV1 - authorizedProductType: XC - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - location: - ibxCode: SV11 - RequestLoaOnPatchPanel: - value: - type: PATCH_PANEL_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for patch panel port access to Equinix at SV1 - authorizedProductType: XC - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - location: - ibxCode: SV11 - RequestLoaOnPatchPanelPort: - value: - type: PATCH_PANEL_PORT_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for patch panel port access to Equinix at SV1 - authorizedProductType: XC - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - location: - ibxCode: SV11 - LoaCreateResponseByRequestor: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: PATCH_PANEL_PORT_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - state: PENDING_AUTHORIZATION - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - location: - ibxCode: SV1 - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org1.com - LoaCreateResponseByIssuerWithCageType: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: CAGE_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - state: PENDING_ACCEPTANCE - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - demarcationPoint: - cageUniqueSpaceId: SV1:01:10:200 - location: - ibxCode: SV1 - changeLog: - createdDateTime: 2025-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - LoaCreateResponseByIssuerWithPatchPanelPortType: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: PATCH_PANEL_PORT_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - state: PENDING_ACCEPTANCE - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 23 - patchPanelPortB: 23 - connectorType: SC - location: - ibxCode: SV1 - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - LoaCreateResponseByIssuerWithPatchPanelType: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: PATCH_PANEL_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - state: PENDING_ACCEPTANCE - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - location: - ibxCode: SV1 - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - Loa_400: - value: - - errorCode: EQ-3070103 - errorMessage: Loa does not exist. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - additionalInfo: - - property: uuid - reason: Loa does not exist. Please check Loa UUID - Loa_401: - value: - - errorCode: EQ-3070106 - errorMessage: User not found in request or invalid. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - Loa_403: - value: - - errorCode: EQ-3070102 - errorMessage: Operation not allowed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: Operation not allowed for current user - Loa_404: - value: - - errorCode: EQ-3070101 - errorMessage: Loa not found - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: uuid - reason: Loa does not exist. Please check Loa UUID - Loa_500: - value: - - errorCode: EQ-3070104 - errorMessage: Internal Server Error - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: An unexpected error occurred while processing the request - LoaResponse: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: PATCH_PANEL_PORT_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - state: INACTIVE - expirationDateTime: 2024-12-31T23:59:59Z - operation: - consumersCount: 10 - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - demarcationPoint: - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0105 - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 23 - patchPanelPortB: 23 - connectorType: SC - location: - ibxCode: SV1 - changeLog: - createdDateTime: 2025-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - LoaPatchRequest: - value: - - op: replace - path: /demarcationPoint/patchPanelId - value: CP:Demarc:1259685 - LoaPatchResponse: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: PATCH_PANEL_PORT_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - state: INACTIVE - operation: - consumersCount: 1 - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 23 - patchPanelPortB: 23 - connectorType: SC - location: - ibxCode: SV1 - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - AuthorizeLoaActionRequest: - value: - type: LOA_ISSUER_AUTHORIZATION - data: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 23 - patchPanelPortB: 23 - connectorType: SC - expirationDateTime: 2026-08-07T07:00:00Z - AcceptLoaActionRequest: - value: - type: LOA_REQUESTOR_ACCEPTANCE - CopyLoaActionRequest: - value: - type: LOA_COPY_LINK - SendLoaActionRequest: - value: - type: LOA_SEND_EMAIL_NOTIFICATION - CancelLoaActionRequest: - value: - type: LOA_CANCEL - AuthorizeLoaActionResponse: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: LOA_ISSUER_AUTHORIZATION - state: COMPLETED - data: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 23 - patchPanelPortB: 23 - connectorType: SC - expirationDateTime: 2026-08-07T07:00:00Z - changeLog: - createdDateTime: 2026-06-24T06:50:46Z - createdBy: user - createdByEmail: user@org1.com - AcceptLoaActionResponse: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: LOA_REQUESTOR_ACCEPTANCE - state: COMPLETED - changeLog: - createdDateTime: 2025-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - SendLoaActionResponse: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: LOA_SEND_EMAIL_NOTIFICATION - state: COMPLETED - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - CopyLoaActionResponse: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: LOA_COPY_LINK - state: COMPLETED - data: - portalUrl: https://portal.equinix.com/fabric/loa/inventory/issuer/29cc7878-54e3-4e1a-8651-87a61354bac2/authorize - changeLog: - createdDateTime: 2026-06-24T06:50:46Z - createdBy: user - createdByEmail: user@org1.com - Loa_Action_400: - value: - - errorCode: EQ-3070107 - errorMessage: Loa Action does not exist. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - additionalInfo: - - property: uuid - reason: Loa Action does not exist. Please check Loa UUID - Loa_Action_404: - value: - - errorCode: EQ-3070101 - errorMessage: Loa Action not found - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: uuid - reason: Loa 3070101 does not exist. Please check Loa UUID - LoaSearchByNameWithType: - summary: A named loa of a given type - value: - filter: - and: - - property: /name - operator: ILIKE - values: - - LOA-Equinix-SV1 - - property: /type - operator: = - values: - - PATCH_PANEL_PORT_LOA - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - LoaSearchStateWithPartnerOrIbx: - summary: Partial match on state with partner name or with ibx code - value: - filter: - and: - - property: /state - operator: = - values: - - PENDING_ACCEPTANCE - - or: - - property: /requestor/orgName - operator: ILIKE - values: - - abc - - property: /location/ibxCode - operator: ILIKE - values: - - MB - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - LoaSearchResponse: - value: - pagination: - offset: 0 - limit: 25 - total: 1 - sort: - - property: /changeLog/createdDateTime - direction: DESC - data: - - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: PATCH_PANEL_PORT_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - state: INACTIVE - expirationDateTime: 2026-12-31T23:59:59Z - operation: - consumersCount: 1 - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - demarcationPoint: - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0105 - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 23 - patchPanelPortB: 23 - connectorType: SC - location: - ibxCode: SV1 - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - LoaActionSearchByActionType: - value: - filter: - and: - - property: /type - operator: = - values: - - LOA_REQUESTOR_ACCEPTANCE - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/createdDateTime - direction: DESC - LoaSearchActionResponse: - value: - pagination: - offset: 0 - limit: 25 - total: 1 - sort: - - property: /changeLog/createdDateTime - direction: DESC - data: - - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: LOA_ISSUER_AUTHORIZATION - state: COMPLETED - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - LoaConsumersResponse: - value: - pagination: - offset: 0 - limit: 25 - total: 2 - data: - - href: https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: XF_PORT - changeLog: - createdDateTime: 2025-07-24T06:50:46Z - - href: https://api.equinix.com/fabric/v4/ports/b7e14c2d-93f8-4a61-8d5b-c29f71e4a306 - uuid: b7e14c2d-93f8-4a61-8d5b-c29f71e4a306 - type: XF_PORT - changeLog: - createdDateTime: 2025-07-26T06:50:46Z - LoaNotesResponse: - value: - data: - - type: ISSUER - href: https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - comments: test note from issuer - createdDateTime: 2026-07-24T06:50:46Z - - type: REQUESTOR - href: https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/a41f485e-3094-42de-8797-0ef19a51df81 - uuid: a41f485e-3094-42de-8797-0ef19a51df81 - comments: test note from requestor - createdDateTime: 2026-07-25T06:50:46Z - LoaNoteRequest: - value: - comments: LOA under review by our team. Expected response within 2 business days. - CreateLoaNoteResponse: - value: - type: ISSUER - href: https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - comments: LOA under review by our team. Expected response within 2 business days. - createdDateTime: 2026-06-24T06:50:46Z - StandardCrossConnectRequest: - summary: Standard Cross Connect - description: Minimal Cross Connect request with only the required fields. - value: - type: XC - name: My-CC-service - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 12 - patchPanelPortB: 24 - connectorType: SC - schedule: - code: STANDARD - requestedDateTime: 2026-02-27T07:21:39Z - StandardCCWithServicesRequest: - summary: Standard Cross Connect With Services - description: Standard Cross Connect with additional services - link light verification and patch equipment. - value: - type: XC - name: My-CC-service - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 12 - patchPanelPortB: 24 - connectorType: SC - schedule: - code: STANDARD - requestedDateTime: 2026-02-27T07:21:39Z - services: - - type: XC_LINK_LIGHT_VERIFICATION - - type: XC_PATCH_EQUIPMENT - device: - cabinetUniqueSpaceId: SV2:00:000000:0100 - port: 32 - connectorType: SC - description: device description - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - customerReferenceId: "12345" - StandardCCByPatchPanelRequest: - summary: Standard Cross Connect By Patch Panel - description: Standard Cross Connect using patch panel demarcation points on both sides. - value: - type: XC - name: My-CC-service - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 12 - patchPanelPortB: 24 - connectorType: SC - schedule: - code: STANDARD - requestedDateTime: 2026-02-27T07:21:39Z - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - purchaseOrder: - number: "1233" - amount: "10000" - startDate: 2026-02-26 - endDate: 2027-02-26 - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - type: NEW - customerReferenceId: "12345" - notes: - - comments: test note - attachments: - - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - StandardCCByLoaRequest: - summary: Standard Cross Connect By LOA - description: Standard Cross Connect where the z-side is specified via a Letter of Authorization. - value: - type: XC - name: My-CC-service - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - zSide: - loa: - uuid: c61f485e-3094-42de-8797-0ef19a51df79 - schedule: - code: STANDARD - requestedDateTime: 2026-02-27T07:21:39Z - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - customerReferenceId: "12345" - notes: - - comments: test note - attachments: - - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - ExtendedCCEquinixManagedRequest: - summary: Extended Cross Connect Equinix Managed - description: "Extended Cross Connect with Equinix-managed meet-me room (bmmrType: EQUINIX)." - value: - type: XC - name: My-CC-service - bmmrType: EQUINIX - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - zSide: - location: - ibxCode: SV11 - loa: - uuid: c61f485e-3094-42de-8797-0ef19a51df79 - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - customerReferenceId: "12345" - notes: - - comments: test note - attachments: - - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - ExtendedCCSelfManagedRequest: - summary: Extended Cross Connect Self Managed - description: "Extended Cross Connect with self-managed meet-me room (bmmrType: SELF)." - value: - type: XC - name: My-CC-service - bmmrType: SELF - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - zSide: - location: - ibxCode: SV11 - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - customerReferenceId: "12345" - notes: - - comments: test note - attachments: - - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - DiverseWithExistingCCRequest: - summary: Diverse with Existing Cross Connect - description: Add a SECONDARY Cross Connect to an existing PRIMARY by providing the PRIMARY's redundancy group identifier, or its serial number, as the redundancy group. - value: - type: XC - name: My-CC-service-SEC - redundancy: - priority: SECONDARY - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 14 - patchPanelPortB: 15 - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 22 - patchPanelPortB: 23 - connectorType: SC - schedule: - code: STANDARD - requestedDateTime: 2026-02-27T07:21:39Z - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - customerReferenceId: "12345" - StandardCCByPatchPanelResponse: - summary: Standard Cross Connect By Patch Panel - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - name: My-CC-service - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - state: PROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 45 - patchPanelPortB: 32 - connectorType: SC - cageUniqueSpaceId: SV2:00:000000 - cabinetUniqueSpaceId: SV2:00:000000:0100 - location: - ibxCode: SV1 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - StandardCCByLoaResponse: - summary: Standard Cross Connect By LOA - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - name: My-CC-service - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - state: PROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - loa: - href: https://api.equinix.com/fabric/v4/loas/b51f485e-3094-42de-8797-0ef19a51df79 - uuid: c61f485e-3094-42de-8797-0ef19a51df79 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - ExtendedCCEquinixManagedResponse: - summary: Extended Cross Connect Equinix Managed - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - name: My-CC-service - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - bmmrType: EQUINIX - state: PROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV11 - loa: - href: https://api.equinix.com/fabric/v4/loas/c61f485e-3094-42de-8797-0ef19a51df79 - uuid: c61f485e-3094-42de-8797-0ef19a51df79 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - ExtendedCCSelfManagedResponse: - summary: Extended Cross Connect Self Managed - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - name: My-CC-service - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - bmmrType: SELF - state: PROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV11 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - DiverseWithExistingCCResponse: - summary: Diverse with Existing Cross Connect - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - name: My-CC-service-SEC - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - state: PROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: SECONDARY - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 14 - patchPanelPortB: 15 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 22 - patchPanelPortB: 23 - connectorType: SC - cageUniqueSpaceId: SV2:00:000000 - cabinetUniqueSpaceId: SV2:00:000000:0100 - location: - ibxCode: SV1 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - CrossConnect_400: - value: - - errorCode: EQ-3071100 - errorMessage: Bad request. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - additionalInfo: - - property: type - reason: Cross Connect type is required. - CrossConnect_401: - value: - - errorCode: EQ-3071101 - errorMessage: User not found in request or invalid. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - CrossConnect_403: - value: - - errorCode: EQ-3071102 - errorMessage: Operation not allowed. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - additionalInfo: - - property: projectId - reason: User does not have access to the specified project. - CrossConnect_404: - value: - - errorCode: EQ-3071103 - errorMessage: Cross Connect does not exist. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - additionalInfo: - - property: uuid - reason: Cross Connect does not exist. Please check Cross Connect UUID. - CrossConnect_500: - value: - - errorCode: EQ-3071199 - errorMessage: Internal server error. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - DiverseCCPairRequest: - summary: Diverse pair - description: Two Cross Connects placed at the same time on separate patch panels - one PRIMARY and one SECONDARY. - value: - data: - - type: XC - name: My-CC-service-PRI - redundancy: - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 12 - patchPanelPortB: 24 - connectorType: SC - schedule: - code: STANDARD - requestedDateTime: 2026-02-27T07:21:39Z - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - customerReferenceId: "12345" - - type: XC - name: My-CC-service-SEC - redundancy: - priority: SECONDARY - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 14 - patchPanelPortB: 15 - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 22 - patchPanelPortB: 23 - connectorType: SC - schedule: - code: STANDARD - requestedDateTime: 2026-02-27T07:21:39Z - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - customerReferenceId: "12345" - DiverseCCPairResponse: - summary: Diverse Cross Connect Pair - value: - data: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - name: My-CC-service-PRI - state: PROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 12 - patchPanelPortB: 24 - connectorType: SC - cageUniqueSpaceId: SV2:00:000000 - cabinetUniqueSpaceId: SV2:00:000000:0100 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603 - type: XC - uuid: a6f77b33-96c6-4eeb-8d79-76374d950603 - name: My-CC-service-SEC - state: PROVISIONING - serialNumber: "234567891" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: SECONDARY - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 14 - patchPanelPortB: 15 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 22 - patchPanelPortB: 23 - connectorType: SC - cageUniqueSpaceId: SV2:00:000000 - cabinetUniqueSpaceId: SV2:00:000000:0100 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567891 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - CrossConnect_400_diverse: - summary: Invalid diverse pair - value: - - errorCode: EQ-3071106 - errorMessage: Invalid diverse Cross Connect request - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - details: A diverse pair order must contain exactly two Cross Connects, one PRIMARY and one SECONDARY. - additionalInfo: - - property: /data - reason: Expected two entries with complementary redundancy priorities. - CrossConnectSearchByNameWithState: - value: - filter: - and: - - property: /name - operator: LIKE - values: - - My-CC-service - - property: /state - operator: IN - values: - - PENDING - - PENDING_ACTION - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - CrossConnectSearchByIbxWithType: - value: - filter: - and: - - property: /type - operator: = - values: - - XC - - or: - - property: /aSide/location/ibxCode - operator: = - values: - - SV1 - - property: /zSide/location/ibxCode - operator: = - values: - - SV1 - pagination: - limit: 25 - offset: 0 - sort: - - property: /name - direction: ASC - CrossConnectSearchResponse: - value: - pagination: - offset: 0 - limit: 25 - total: 1 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - data: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - name: My-CC-service - state: PROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - loa: - href: https://api.equinix.com/fabric/v4/loas/b51f485e-3094-42de-8797-0ef19a51df79 - uuid: c61f485e-3094-42de-8797-0ef19a51df79 - location: - ibxCode: SV1 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-26T07:21:39Z - createdBy: testuser - updatedDateTime: 2026-02-28T07:21:39Z - updatedBy: "1234" - CCDeleteRequest: - summary: Delete a Cross Connect - description: The notification contacts are appended to the ones already held on the Cross Connect, while the purchase order and the customer reference identifier replace the existing ones. - value: - schedule: - code: STANDARD - requestedDateTime: 2021-06-14T17:21:25.586Z - deinstallationDateTime: 2021-06-14T17:21:25.586Z - notifications: - - type: TECHNICAL - emails: - - abc@test.com - order: - purchaseOrder: - number: "1233" - amount: "23" - startDate: 2026-02-26 - endDate: 2027-02-26 - customerReferenceId: "12345" - CCDeleteResponse: - summary: Delete a Cross Connect - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - name: My-CC-service-PRI - state: DEPROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: PRIMARY - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - CrossConnect_400_bulk_delete: - summary: Invalid bulk delete request - value: - - errorCode: EQ-3071100 - errorMessage: Invalid bulk Cross Connect delete request - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - details: One or more Cross Connects in the request cannot be deleted. - additionalInfo: - - property: /data/0/uuid - reason: Cross Connect is not in a state that allows deletion. - CrossConnectSchedulesResponse: - value: - data: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - type: XC_INSTALL_SCHEDULE - code: EXPEDITE - state: COMPLETED - autoConvertToStandard: true - readinessDateTime: 2026-08-23T07:21:39Z - requestedDateTime: 2026-08-24T07:21:39Z - equinixProposedDateTime: 2026-08-25T07:21:39Z - installationDateTime: 2026-08-25T09:21:39Z - changeLog: - createdBy: testuser - createdDateTime: 2026-08-22T07:21:39Z - updatedBy: "124" - updatedDateTime: 2026-08-25T09:21:39Z - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/a11f485e-3094-42de-8797-0ef19a51df79 - uuid: a11f485e-3094-42de-8797-0ef19a51df79 - type: XC_DEINSTALL_SCHEDULE - code: STANDARD - state: PENDING - requestedDateTime: 2026-09-14T17:21:25.586Z - deinstallationDateTime: 2026-09-16T17:21:25.586Z - changeLog: - createdBy: testuser - createdDateTime: 2026-09-12T07:21:39Z - CrossConnectServicesResponse: - value: - data: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - type: XC_LINK_LIGHT_VERIFICATION - state: PENDING - changeLog: - createdBy: testuser - createdDateTime: 2026-02-28T07:21:39Z - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/a11f485e-3094-42de-8797-0ef19a51df79 - uuid: a11f485e-3094-42de-8797-0ef19a51df79 - type: XC_PATCH_EQUIPMENT - state: PENDING - device: - cabinetUniqueSpaceId: SV2:00:000000:0100 - port: 32 - connectorType: SC - description: additional notes for patch equipment - changeLog: - createdBy: testuser - createdDateTime: 2026-02-28T07:21:39Z - CrossConnectAttachmentsResponse: - summary: Cross Connect attachments - value: - data: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - type: ATTACHMENT - source: CUSTOMER - attachmentId: a11f485e-3094-42de-8797-0ef19a51df79 - downloadHref: https://api.equinix.com/ecp/attachments/a11f485e-3094-42de-8797-0ef19a51df79 - changeLog: - createdBy: "123" - createdDateTime: 2026-02-28T07:21:39Z - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/a41f485e-3094-42de-8797-0ef19a51df81 - uuid: a41f485e-3094-42de-8797-0ef19a51df81 - type: ATTACHMENT - source: EQUINIX - attachmentId: b21f485e-3094-42de-8797-0ef19a51df80 - downloadHref: https://api.equinix.com/ecp/attachments/b21f485e-3094-42de-8797-0ef19a51df80 - changeLog: - createdBy: EQUINIX - createdDateTime: 2026-02-27T07:21:39Z - CreateAttachmentRequest: - value: - attachmentId: a11f485e-3094-42de-8797-0ef19a51df79 - CreateAttachmentResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - type: ATTACHMENT - source: CUSTOMER - attachmentId: a11f485e-3094-42de-8797-0ef19a51df79 - downloadHref: https://api.equinix.com/ecp/attachments/a11f485e-3094-42de-8797-0ef19a51df79 - changeLog: - createdBy: "123" - createdDateTime: 2026-02-28T07:21:39Z - CrossConnectNotesResponse: - summary: Cross Connect notes - value: - pagination: - offset: 0 - limit: 10 - total: 2 - data: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - type: NOTE - source: CUSTOMER - comments: Additional note to EQUINIX technician. - changeLog: - createdBy: "124" - createdDateTime: 2026-02-28T07:21:39Z - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79 - uuid: a11f485e-3094-42de-8797-0ef19a51df79 - type: NOTE - source: EQUINIX - comments: Please confirm the patch panel port before the scheduled installation. - changeLog: - createdBy: SYSTEM - createdDateTime: 2026-02-27T07:21:39Z - CreateNoteRequest: - value: - comments: test note - CreateNoteResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - type: NOTE - source: CUSTOMER - comments: test note - changeLog: - createdBy: "124" - createdDateTime: 2026-02-28T07:21:39Z - SendSignatureQuoteActionRequest: - value: - type: XC_SIGNATURE_SUBMISSION - AcceptProposedDateTimeActionRequest: - value: - type: XC_PROPOSED_DATE_TIME_ACCEPTANCE - RejectProposedDateTimeActionRequest: - value: - type: XC_PROPOSED_DATE_TIME_REJECTION - CancelCrossConnectActionRequest: - value: - type: XC_CANCEL - DeinstallCrossConnectActionRequest: - summary: Deinstall a Cross Connect - description: Removal of a provisioned Cross Connect, along with the patch equipment. The notification contacts are appended to the ones already held on the Cross Connect, while the purchase order and the customer reference identifier replace the existing ones. - value: - type: XC_DEINSTALL - data: - schedule: - code: STANDARD - requestedDateTime: 2026-06-14T17:21:25.586Z - deinstallationDateTime: 2026-06-16T17:21:25.586Z - liveTrafficConsentProvided: true - services: - - type: XC_PATCH_EQUIPMENT - device: - cabinetUniqueSpaceId: SV2:00:000000:0100 - port: 32 - connectorType: SC - description: device description - notifications: - - type: TECHNICAL - emails: - - abc@test.com - attachments: - - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - order: - purchaseOrder: - number: "1233" - amount: "23" - startDate: 2026-02-26 - endDate: 2027-02-26 - customerReferenceId: "12345" - UpdateInformationActionRequest: - value: - type: XC_INFORMATION_UPDATE - data: - notes: - - parentNote: - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - comments: Please proceed - attachments: - - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - SendSignatureQuoteActionResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: XC_SIGNATURE_SUBMISSION - state: COMPLETED - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - AcceptProposedDateTimeActionResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/41dd8989-65f4-4f2b-9762-98b72465cbe5 - uuid: 41dd8989-65f4-4f2b-9762-98b72465cbe5 - type: XC_PROPOSED_DATE_TIME_ACCEPTANCE - state: COMPLETED - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - RejectProposedDateTimeActionResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/52ee9090-76a5-4a3c-a873-a9c83576dcf6 - uuid: 52ee9090-76a5-4a3c-a873-a9c83576dcf6 - type: XC_PROPOSED_DATE_TIME_REJECTION - state: COMPLETED - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - CancelCrossConnectActionResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/63ffa1a1-87b6-4b4d-b984-bad94687edf7 - uuid: 63ffa1a1-87b6-4b4d-b984-bad94687edf7 - type: XC_CANCEL - state: PENDING - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - DeinstallCrossConnectActionResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/74ffa1a1-87b6-4b4d-b984-bad94687edf8 - uuid: 74ffa1a1-87b6-4b4d-b984-bad94687edf8 - type: XC_DEINSTALL - state: PENDING - data: - attachments: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 - uuid: b41f485e-3094-42de-8797-0ef19a51df82 - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - schedule: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/c51f485e-3094-42de-8797-0ef19a51df83 - uuid: c51f485e-3094-42de-8797-0ef19a51df83 - type: XC_DEINSTALL_SCHEDULE - code: STANDARD - state: PENDING - requestedDateTime: 2026-06-14T17:21:25.586Z - deinstallationDateTime: 2026-06-16T17:21:25.586Z - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - liveTrafficConsentProvided: true - services: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/d61f485e-3094-42de-8797-0ef19a51df84 - uuid: d61f485e-3094-42de-8797-0ef19a51df84 - type: XC_PATCH_EQUIPMENT - state: PENDING - device: - cabinetUniqueSpaceId: SV2:00:000000:0100 - port: 32 - connectorType: SC - description: device description - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - UpdateInformationActionResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/7400b2b2-98c7-4c5e-ca95-cbea5798fe08 - uuid: 7400b2b2-98c7-4c5e-ca95-cbea5798fe08 - type: XC_INFORMATION_UPDATE - state: COMPLETED - data: - notes: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - parentNote: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79 - uuid: a11f485e-3094-42de-8797-0ef19a51df79 - comments: Please proceed - attachments: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 - uuid: b41f485e-3094-42de-8797-0ef19a51df82 - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - CrossConnect_Action_400: - value: - - errorCode: EQ-3071104 - errorMessage: Bad request. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - additionalInfo: - - property: type - reason: Cross Connect Action type is not one of the allowedActions of the Cross Connect. - CrossConnect_Action_404: - value: - - errorCode: EQ-3071105 - errorMessage: Cross Connect Action does not exist. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - additionalInfo: - - property: uuid - reason: Cross Connect Action does not exist. Please check the Action UUID. - CrossConnectActionSearchByActionType: - value: - filter: - and: - - property: /type - operator: = - values: - - XC_INFORMATION_UPDATE - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/createdDateTime - direction: DESC - CrossConnectActionSearchResponse: - value: - pagination: - offset: 0 - limit: 25 - total: 1 - sort: - - property: /changeLog/createdDateTime - direction: DESC - data: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/7400b2b2-98c7-4c5e-ca95-cbea5798fe08 - uuid: 7400b2b2-98c7-4c5e-ca95-cbea5798fe08 - type: XC_INFORMATION_UPDATE - state: COMPLETED - data: - notes: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - parentNote: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79 - uuid: a11f485e-3094-42de-8797-0ef19a51df79 - comments: Please proceed - attachments: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 - uuid: b41f485e-3094-42de-8797-0ef19a51df82 - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - SearchInstallSchedulesRequest: - summary: Installation schedule windows - value: - filter: - and: - - property: /type - operator: = - values: - - XC_INSTALL_SCHEDULE - - property: /code - operator: IN - values: - - EXPEDITE - - FLEXIBLE - - STANDARD - - property: /aSide/location/ibxCode - operator: = - values: - - SV11 - - property: /zSide/location/ibxCode - operator: = - values: - - SV11 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /startDateTime - SearchInstallSchedulesResponse: - summary: Installation schedule windows - value: - pagination: - offset: 0 - limit: 20 - total: 3 - data: - - href: https://api.equinix.com/fabric/v4/crossConnectSchedules/EXPEDITE - type: XC_INSTALL_SCHEDULE - code: EXPEDITE - aSide: - location: - ibxCode: SV11 - zSide: - location: - ibxCode: SV11 - startDateTime: 2026-03-05T17:00:00Z - endDateTime: 2026-03-10T17:24:00Z - unavailableDates: - - 2026-03-07 - - 2026-03-08 - - href: https://api.equinix.com/fabric/v4/crossConnectSchedules/STANDARD - type: XC_INSTALL_SCHEDULE - code: STANDARD - aSide: - location: - ibxCode: SV11 - zSide: - location: - ibxCode: SV11 - startDateTime: 2026-03-10T18:00:00Z - endDateTime: 2026-04-10T17:24:00Z - unavailableDates: - - 2026-03-27 - - 2026-03-28 - - 2026-03-29 - - href: https://api.equinix.com/fabric/v4/crossConnectSchedules/FLEXIBLE - type: XC_INSTALL_SCHEDULE - code: FLEXIBLE - aSide: - location: - ibxCode: SV11 - zSide: - location: - ibxCode: SV11 - startDateTime: 2026-04-10T18:00:00Z - endDateTime: 2026-06-10T17:24:00Z - unavailableDates: - - 2026-04-17 - - 2026-04-18 - - 2026-04-19 - AppDomainCreate: - value: - type: APP_DOMAIN - name: atlassian.net - description: Atlassian Domain - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppDomainPostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - description: Atlassian Domain - state: PENDING_VERIFICATION - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - AppDomain_400_InvalidName: - value: - - errorCode: EQ-3810022 - errorMessage: Domain name is invalid - correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e - details: Domain name is invalid - additionalInfo: - - property: /name - reason: Domain name is invalid - AppDomain_401: - value: - - errorCode: EQ-3810001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - AppDomain_403: - value: - - errorCode: EQ-3810002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - AppDomain_415: - value: - - errorCode: EQ-3810016 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - AppDomain_500: - value: - - errorCode: EQ-3810030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - AppDomainGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - description: Atlassian Domain - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppDomain_404: - value: - - errorCode: EQ-3810020 - errorMessage: App Domain not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: App Domain not found or already deleted - AppDomainDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - description: Atlassian Domain - state: DEPROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - deletedBy: test - deletedDateTime: 2026-06-29T04:20:55.471Z - AppDomain_400_InvalidState: - value: - - errorCode: EQ-3810030 - errorMessage: Cannot delete App Domain in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete App Domain in transient state. - AppDomainUpdateDescription: - value: - - op: replace - path: /description - value: Updated Atlassian Domain - AppDomainPatchResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - description: Updated Atlassian Domain - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - change: - uuid: 531c4ab5-43b0-4352-8975-ee9045325841 - type: APP_DOMAIN_UPDATE - status: REQUESTED - createdDateTime: 2026-06-27T04:20:55.471Z - updatedDateTime: 2026-06-28T04:20:55.471Z - data: - - op: replace - path: /description - value: Updated Atlassian Domain - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppDomain_400_InvalidOperation: - value: - - errorCode: EQ-3810022 - errorMessage: Invalid Argument passed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - AppDomainSearchFilterByStatus: - value: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONED - - property: /project/projectId - operator: IN - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppDomainSearchFilterByName: - value: - filter: - and: - - property: /name - operator: = - values: - - test- - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppDomainSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /name - operator: LIKE - values: - - abc% - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppDomainSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - description: Atlassian Domain - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppDomain_400_InvalidSorting: - value: - - errorCode: EQ-3810039 - errorMessage: Invalid value for sorting direction. - correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - AppDomainAttachedAppLinksGetResponseExample: - value: - pagination: - limit: 20 - offset: 0 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - type: APP_LINK - uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: Atlassian App Link - description: Atlassian App Link in SV - state: PROVISIONED - router: - href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - type: XF_ROUTER - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - bandwidth: 1000 - ipv4Subnet: 192.168.10.0/29 - ipv4Address: 192.168.10.3 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppLinkCreate: - value: - type: APP_LINK - name: Atlassian App Link - description: Atlassian App Link in SV - router: - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - ipv4Subnet: 192.168.10.0/29 - bandwidth: 1000 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppLinkPostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - type: APP_LINK - name: Atlassian App Link - description: Atlassian App Link in SV - state: PROVISIONING - router: - href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - type: XF_ROUTER - ipv4Subnet: 192.168.10.0/29 - ipv4Address: 192.168.10.3 - bandwidth: 1000 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - AppLink_400_InvalidName: - value: - - errorCode: EQ-3820022 - errorMessage: Name is minimum 0 and up to 50 characters in length - correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e - details: Name is minimum 0 and up to 50 characters in length - additionalInfo: - - property: /name - reason: Name is minimum 0 and up to 50 characters in length - AppLink_401: - value: - - errorCode: EQ-3820001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - AppLink_403: - value: - - errorCode: EQ-3820002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - AppLink_415: - value: - - errorCode: EQ-3820016 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - AppLink_500: - value: - - errorCode: EQ-3820030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - AppLinkGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - type: APP_LINK - name: Atlassian App Link - description: Atlassian App Link in SV - state: PROVISIONED - router: - href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - type: XF_ROUTER - ipv4Subnet: 192.168.10.0/29 - ipv4Address: 192.168.10.3 - bandwidth: 1000 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLink_404: - value: - - errorCode: EQ-3820020 - errorMessage: AppLink not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: AppLink not found or already deleted - AppLinkDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - type: APP_LINK - name: Atlassian App Link - description: Atlassian App Link in SV - state: DEPROVISIONING - router: - href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - type: XF_ROUTER - ipv4Subnet: 192.168.10.0/29 - ipv4Address: 192.168.10.3 - bandwidth: 1000 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - deletedBy: test - deletedDateTime: 2026-06-29T04:20:55.471Z - AppLink_400_InvalidState: - value: - - errorCode: EQ-3820030 - errorMessage: Cannot delete App Link in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete App Link in transient state. - AppLinkUpdateName: - value: - - op: replace - path: /name - value: Updated Atlassian App Link - AppLinkPatchResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - type: APP_LINK - name: Updated Atlassian App Link - description: Atlassian App Link in SV - state: REPROVISIONING - router: - href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - type: XF_ROUTER - ipv4Subnet: 192.168.10.0/29 - ipv4Address: 192.168.10.3 - bandwidth: 1000 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - change: - uuid: 531c4ab5-43b0-4352-8975-ee9045325841 - type: APP_LINK_UPDATE - status: REQUESTED - createdDateTime: 2026-06-27T04:20:55.471Z - updatedDateTime: 2026-06-28T04:20:55.471Z - data: - - op: replace - path: /name - value: Updated Atlassian App Link - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLink_400_InvalidOperation: - value: - - errorCode: EQ-3040054 - errorMessage: Invalid Argument passed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - AppLinkSearchFilterByStatus: - value: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONED - - property: /project/projectId - operator: IN - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppLinkSearchFilterByName: - value: - filter: - and: - - property: /name - operator: = - values: - - test- - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppLinkSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /name - operator: LIKE - values: - - abc% - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppLinkSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - type: APP_LINK - name: Atlassian App Link - description: Atlassian App Link in SV - state: PROVISIONED - router: - href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - type: XF_ROUTER - ipv4Subnet: 192.168.10.0/29 - ipv4Address: 192.168.10.3 - bandwidth: 1000 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppLink_400_InvalidSorting: - value: - - errorCode: EQ-3820039 - errorMessage: Invalid value for sorting direction. - correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - AppLinkAttachDomainResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - attachmentStatus: ATTACHED - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachDomainAttachResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - attachmentStatus: ATTACHING - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-27T04:20:55.471Z - AppLink_400_InvalidAttachState: - value: - - errorCode: EQ-3820030 - errorMessage: Cannot perform attach or detach operation in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot perform attach or detach operation in transient state. - AppLinkAttachDomainDetachResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - attachmentStatus: DETACHING - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachDomainSearchFilterByStatus: - value: - filter: - and: - - property: /attachmentStatus - operator: = - values: - - ATTACHED - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppLinkAttachDomainSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /uuid - operator: = - values: - - 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - AppLinkAttachDomainSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - attachmentStatus: ATTACHED - AppLinkAttachDomainGetExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - description: Atlassian Domain - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - attachmentStatus: ATTACHED - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachServiceResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - geoScope: GLOBAL - destinationIp: 10.10.1.110 - attachmentStatus: ATTACHED - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachService: - value: - geoScope: GLOBAL - destinationIp: 10.10.1.110 - AppLinkAttachServiceAttachResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - geoScope: GLOBAL - destinationIp: 10.10.1.110 - attachmentStatus: ATTACHING - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-27T04:20:55.471Z - AppLinkAttachServiceDetachResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - geoScope: GLOBAL - destinationIp: 10.10.1.110 - attachmentStatus: DETACHING - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachServicePatchDestinationIp: - value: - - op: replace - path: /destinationIp - value: 10.10.1.120 - AppLinkAttachServicePatchResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - geoScope: GLOBAL - destinationIp: 10.10.1.120 - attachmentStatus: ATTACHING - change: - uuid: 531c4ab5-43b0-4352-8975-ee9045325841 - type: APP_SERVICE_UPDATE - status: REQUESTED - createdDateTime: 2026-06-27T04:20:55.471Z - updatedDateTime: 2026-06-27T04:20:55.471Z - data: - - op: replace - path: /destinationIp - value: 10.10.1.120 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-27T04:20:55.471Z - AppLinkAttachServiceSearchFilterByStatus: - value: - filter: - and: - - property: /attachmentStatus - operator: = - values: - - ATTACHED - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppLinkAttachServiceSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /uuid - operator: = - values: - - 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - AppLinkAttachServiceSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - geoScope: GLOBAL - destinationIp: 10.10.1.110 - attachmentStatus: ATTACHED - AppLinkAttachServiceGetExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - name: Atlassian App Service - description: Atlassian App Service in SV - state: PROVISIONED - endpoint: equinixjira.atlassian.net - sourceDomains: - - equinix.com - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - geoScope: GLOBAL - destinationIp: 10.10.1.110 - attachmentStatus: ATTACHED - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachProcessorGetResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - uuid: 90ee425c-9988-454c-96d9-1128bc16350f - type: APP_PROCESSOR - config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... - endpoint: 123456.privateai.link - attachmentStatus: ATTACHED - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachProcessor: - value: - config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... - AppLinkAttachProcessorAttachResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - uuid: 90ee425c-9988-454c-96d9-1128bc16350f - type: APP_PROCESSOR - config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... - endpoint: 123456.privateai.link - attachmentStatus: ATTACHING - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-27T04:20:55.471Z - AppLinkAttachProcessorDetachResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - uuid: 90ee425c-9988-454c-96d9-1128bc16350f - type: APP_PROCESSOR - config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... - endpoint: 123456.privateai.link - attachmentStatus: DETACHING - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachProcessorSearchFilterByStatus: - value: - filter: - and: - - property: /attachmentStatus - operator: = - values: - - ATTACHED - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppLinkAttachProcessorSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - uuid: 90ee425c-9988-454c-96d9-1128bc16350f - type: APP_PROCESSOR - config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... - endpoint: 123456.privateai.link - attachmentStatus: ATTACHED - AppLinkAttachProcessorListExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /appProcessors?offset=1&limit=20 - previous: /appProcessors?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - uuid: 90ee425c-9988-454c-96d9-1128bc16350f - type: APP_PROCESSOR - attachmentStatus: ATTACHED - config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... - endpoint: 123456.privateai.link - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppProcessorGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - uuid: 90ee425c-9988-454c-96d9-1128bc16350f - type: APP_PROCESSOR - name: agent-gateway - description: llm-routing, a2a-routing, mcp-routing - registryId: agentgateway/agentgateway:1.3.0 - marketplace: - visibility: PUBLIC - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-09-08T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-09-08T04:20:55.471Z - AppProcessor_401: - value: - - errorCode: EQ-3850001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - AppProcessor_403: - value: - - errorCode: EQ-3850002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - AppProcessor_404: - value: - - errorCode: EQ-3850020 - errorMessage: AppProcessor not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: AppProcessor not found or already deleted - AppProcessor_500: - value: - - errorCode: EQ-3850030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - AppProcessorSearchFilterByStatus: - value: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONED - - property: /project/projectId - operator: IN - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppProcessorSearchFilterByName: - value: - filter: - and: - - property: /name - operator: = - values: - - agent- - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppProcessorSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /name - operator: LIKE - values: - - agent% - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppProcessorSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - uuid: 90ee425c-9988-454c-96d9-1128bc16350f - type: APP_PROCESSOR - name: agent-gateway - description: llm-routing, a2a-routing, mcp-routing - registryId: agentgateway/agentgateway:1.3.0 - marketplace: - visibility: PUBLIC - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppProcessor_400_InvalidSorting: - value: - - errorCode: EQ-3850039 - errorMessage: Invalid value for sorting direction. - correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - AppProcessor_415: - value: - - errorCode: EQ-3850016 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - AppServiceCreate: - value: - type: APP_SERVICE - name: Atlassian App Service - description: Atlassian App Service in SV - endpoint: equinixjira.atlassian.net - sourceDomains: - - equinix.com - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppServicePostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - name: Atlassian App Service - description: Atlassian App Service in SV - state: PROVISIONING - endpoint: equinixjira.atlassian.net - sourceDomains: - - equinix.com - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - AppService_400_InvalidName: - value: - - errorCode: EQ-3830022 - errorMessage: Name is minimum 0 and up to 50 characters in length - correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e - details: Name is minimum 0 and up to 50 characters in length - additionalInfo: - - property: /name - reason: Name is minimum 0 and up to 50 characters in length - AppService_401: - value: - - errorCode: EQ-3830001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - AppService_403: - value: - - errorCode: EQ-3830002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - AppService_415: - value: - - errorCode: EQ-3830016 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - AppService_500: - value: - - errorCode: EQ-3830030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - AppServiceGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - name: Atlassian App Service - description: Atlassian App Service in SV - state: PROVISIONED - endpoint: equinixjira.atlassian.net - sourceDomains: - - equinix.com - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - account: - organizationName: atlassian - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppService_404: - value: - - errorCode: EQ-3830020 - errorMessage: App Service not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: App Service not found or already deleted - AppServiceDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - name: Atlassian App Service - description: Atlassian App Service in SV - state: DEPROVISIONING - endpoint: equinixjira.atlassian.net - sourceDomains: - - equinix.com - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - deletedBy: test - deletedDateTime: 2026-06-29T04:20:55.471Z - AppService_400_InvalidState: - value: - - errorCode: EQ-3830030 - errorMessage: Cannot delete App Service in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete App Service in transient state. - AppServiceUpdateName: - value: - - op: replace - path: /name - value: Updated Atlassian App Service - AppServicePatchResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - name: Updated Atlassian App Service - description: Atlassian App Service in SV - state: REPROVISIONING - endpoint: equinixjira.atlassian.net - sourceDomains: - - equinix.com - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - change: - uuid: 531c4ab5-43b0-4352-8975-ee9045325841 - type: APP_SERVICE_UPDATE - status: REQUESTED - createdDateTime: 2026-06-27T04:20:55.471Z - updatedDateTime: 2026-06-28T04:20:55.471Z - data: - - op: replace - path: /name - value: Updated Atlassian App Service - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppService_400_InvalidOperation: - value: - - errorCode: EQ-3040054 - errorMessage: Invalid Argument passed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - AppServiceSearchFilterByStatus: - value: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONED - - property: /project/projectId - operator: IN - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppServiceSearchFilterByName: - value: - filter: - and: - - property: /name - operator: = - values: - - test- - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppServiceSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /name - operator: LIKE - values: - - abc% - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppServiceSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - name: Atlassian App Service - description: Atlassian App Service in SV - state: PROVISIONED - endpoint: equinixjira.atlassian.net - sourceDomains: - - equinix.com - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - account: - organizationName: atlassian - AppService_400_InvalidSorting: - value: - - errorCode: EQ-3830039 - errorMessage: Invalid value for sorting direction. - correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - AppServiceAttachedAppLinksGetResponseExample: - value: - pagination: - limit: 20 - offset: 0 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - type: APP_LINK - uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: Atlassian App Link - description: Atlassian App Link in SV - state: PROVISIONED - router: - href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - type: XF_ROUTER - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - bandwidth: 1000 - ipv4Subnet: 192.168.10.0/29 - ipv4Address: 192.168.10.3 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppServiceAttachedAppSubscriptionsGetResponseExample: - value: - pagination: - limit: 20 - offset: 0 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_SUBSCRIPTION - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - state: PROVISIONED - account: - organizationName: equinix - AppServiceAttachedAppSubscriptionSearchExample: - value: - pagination: - limit: 20 - offset: 0 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_SUBSCRIPTION - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - state: PROVISIONED - account: - organizationName: equinix - AppSubscriptionCreate: - value: - type: APP_SUBSCRIPTION - source: - appLink: - uuid: e32c9c7a-0149-4582-8345-192b82aef972 - ipSubnets: - - 192.168.100.0/24 - target: - appService: - uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d - geoScope: GLOBAL - prioritization: LATENCY - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppSubscriptionPostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_SUBSCRIPTION - source: - appLink: - uuid: e32c9c7a-0149-4582-8345-192b82aef972 - ipSubnets: - - 192.168.100.0/24 - target: - appService: - uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d - geoScope: GLOBAL - prioritization: LATENCY - state: PROVISIONING - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - AppSubscription_401: - value: - - errorCode: EQ-3840001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - AppSubscription_403: - value: - - errorCode: EQ-3840002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - AppSubscription_415: - value: - - errorCode: EQ-3840016 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - AppSubscription_500: - value: - - errorCode: EQ-3840030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - AppSubscriptionGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_SUBSCRIPTION - source: - appLink: - uuid: e32c9c7a-0149-4582-8345-192b82aef972 - ipSubnets: - - 192.168.100.0/24 - target: - appService: - uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d - geoScope: GLOBAL - prioritization: LATENCY - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppSubscription_404: - value: - - errorCode: EQ-3840020 - errorMessage: App Subscription not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: App Subscription not found or already deleted - AppSubscriptionDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_SUBSCRIPTION - source: - appLink: - uuid: e32c9c7a-0149-4582-8345-192b82aef972 - ipSubnets: - - 192.168.100.0/24 - target: - appService: - uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d - geoScope: GLOBAL - prioritization: LATENCY - state: DEPROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - deletedBy: test - deletedDateTime: 2026-06-29T04:20:55.471Z - AppSubscription_400_InvalidState: - value: - - errorCode: EQ-3840030 - errorMessage: Cannot delete App Subscription in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete App Subscription in transient state. - AppSubscriptionUpdateSourceIpSubnets: - value: - - op: add - path: /source/ipSubnets - value: - - 192.168.200.0/24 - AppSubscriptionPatchResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_SUBSCRIPTION - source: - appLink: - uuid: e32c9c7a-0149-4582-8345-192b82aef972 - ipSubnets: - - 192.168.100.0/24 - - 192.168.200.0/24 - target: - appService: - uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d - geoScope: GLOBAL - prioritization: LATENCY - state: PROVISIONING - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - change: - uuid: 531c4ab5-43b0-4352-8975-ee9045325841 - type: APP_SUBSCRIPTION_UPDATE - status: REQUESTED - createdDateTime: 2026-06-27T04:20:55.471Z - updatedDateTime: 2026-06-28T04:20:55.471Z - data: - - op: add - path: /source/ipSubnets - value: - - 192.168.200.0/24 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppSubscription_400_InvalidOperation: - value: - - errorCode: EQ-3040054 - errorMessage: Invalid Argument passed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - AppSubscriptionSearchFilterByStatus: - value: - filter: - and: - - property: /state - operator: IN - values: - - PROVISIONED - - property: /project/projectId - operator: IN - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppSubscriptionSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /uuid - operator: = - values: - - 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppSubscriptionSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_SUBSCRIPTION - source: - appLink: - uuid: e32c9c7a-0149-4582-8345-192b82aef972 - ipSubnets: - - 192.168.100.0/24 - target: - appService: - uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d - geoScope: GLOBAL - prioritization: LATENCY - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppSubscription_400_InvalidSorting: - value: - - errorCode: EQ-3840039 - errorMessage: Invalid value for sorting direction. - correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - thumbs-up-response: - value: - response_id: resp_69f6f816-799f-4aa2-8e63-77fec55524d1 - reaction: thumbs_up - category: other - comment: Looking good - submitted_at: 2024-11-21T10:30:00Z - user: test-user-123 - thumbs-down-response: - value: - response_id: resp_69f6f816-799f-4aa2-8e63-77fec55524d1 - reaction: thumbs_down - category: accuracy - comment: Is that true? - submitted_at: 2024-11-21T10:30:00Z - user: test-user-123 - 400-missing-required-header: - value: - - errorCode: EQ-3222001 - errorMessage: Missing X-AUTH-USERNAME header - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 400-invalid-auth-format: - value: - - errorCode: EQ-3222003 - errorMessage: Invalid Authorization header format - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 400-missing-token: - value: - - errorCode: EQ-3222004 - errorMessage: Authorization header is missing the token - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 401-missing-auth-header: - value: - - errorCode: EQ-3222001 - errorMessage: Missing Authorization header - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 401-empty-auth: - value: - - errorCode: EQ-3222003 - errorMessage: Missing or empty Authorization header - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 401-malformed-jwt: - value: - - errorCode: EQ-3222005 - errorMessage: Malformed JWT token - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 401-invalid-jwt: - value: - - errorCode: EQ-3222006 - errorMessage: Invalid JWT token - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 403-feature-disabled: - value: - - errorCode: EQ-3222002 - errorMessage: ENA is disabled for this user and/or user's organization - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 500-reactions-internal-server-error: - value: - - errorCode: EQ-3222100 - errorMessage: Failed to store reaction - correlationId: 123e4567-e89b-12d3-a456-426614174000 - standard-request: - value: - input: - - content: - - text: Which of my connections are at risk of exceeding their bandwidth limits? - type: input_text - role: user - type: message - string-input: - value: - input: Which of my connections are at risk of exceeding their bandwidth limits? - standard-streaming-request: - value: - input: - - content: - - text: Use the equinix_intelligence_search_docs tool to answer my questions about What is VPN - type: input_text - role: user - type: message - stream: true - response-chaining: - value: - input: - - content: - - text: Which of my connections are at risk of exceeding their bandwidth limits? - type: input_text - role: user - type: message - previous_response_id: resp_08b22a5f-63c6-4892-8cd6-2a4b1ef591c0 - related-prompts-request: - value: - input: - - content: - - text: Use the equinix_intelligence_search_docs tool to answer my questions about What is VPN - type: input_text - role: user - type: message - metadata: - prompt_source: user/related_prompt - include_related_prompts: "true" - structured-output: - value: - input: Can you show me metrics for port bb1ad009-4dcc-445 - text: - format: - name: final_output - schema: - $schema: https://json-schema.org/draft/2020-12/schema - type: object - properties: - component: - type: string - const: observability_chart - asset_type: - type: string - const: port - asset_id: - type: string - const: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - asset_name: - type: string - const: Equinix-SV-CX-port-L-Dot1q-100G-PRI - title: - type: string - indexKey: - type: string - const: time - data: - type: array - items: - type: object - properties: - time: - type: string - format: date-time - pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - bandwidth_rx: - type: number - description: Mbps - bandwidth_tx: - type: number - description: Mbps - required: - - time - - bandwidth_rx - - bandwidth_tx - additionalProperties: false - series: - minItems: 2 - type: array - items: - type: object - properties: - dataKey: - type: string - name: - type: string - color: - type: string - required: - - dataKey - - name - - color - additionalProperties: false - required: - - component - - asset_type - - asset_id - - asset_name - - title - - indexKey - - data - - series - additionalProperties: false - type: json_schema - response_created: - summary: response.created - value: - response: - id: resp_4542cc2f-7e4c-4694-a5fb-7797a150d0e0 - created_at: 1765358850.078279 - model: fsa-agent - object: response - output: - - id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - content: - - annotations: [] - text: "" - type: output_text - role: assistant - status: in_progress - type: message - parallel_tool_calls: false - tool_choice: none - tools: [] - status: in_progress - sequence_number: 0 - type: response.created - response_in_progress: - summary: response.in_progress - value: - response: - id: resp_4542cc2f-7e4c-4694-a5fb-7797a150d0e0 - created_at: 1765358850.078279 - model: fsa-agent - object: response - output: - - id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - content: - - annotations: [] - text: "" - type: output_text - role: assistant - status: in_progress - type: message - parallel_tool_calls: false - tool_choice: none - tools: [] - status: in_progress - sequence_number: 1 - type: response.in_progress - response_output_item_added: - summary: response.output_item.added - value: - item: - id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - content: - - annotations: [] - text: "" - type: output_text - role: assistant - status: in_progress - type: message - output_index: 0 - sequence_number: 2 - type: response.output_item.added - response_content_part_added: - summary: response.content_part.added - value: - content_index: 0 - item_id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - output_index: 0 - part: - annotations: [] - text: "" - type: output_text - sequence_number: 3 - type: response.content_part.added - response_output_text_delta: - summary: response.output_text.delta - value: - content_index: 0 - delta: I can retrieve that — I just need one - item_id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - logprobs: [] - output_index: 0 - sequence_number: 5 - type: response.output_text.delta - response_output_text_done: - summary: response.output_text.done - value: - content_index: 0 - item_id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - logprobs: [] - output_index: 0 - sequence_number: 24 - text: |- - I can retrieve that — I just need one detail from you. - - What I need - - Provide the stream UUID (preferred) — e.g., the stream's unique ID. - - Or, if you don't have the UUID, tell me the stream name (or confirm you want me to list your streams so you can pick one). - - Options I can perform for you - - If you give a stream UUID → I'll fetch the stream details and return the stream state and project ID. - - If you give a stream name → I can search/list streams matching that name (you may need to pick the correct one) and then fetch details. - - If you ask me to list streams now → I can return a paged list of your streams so you can choose which to inspect. - - Tell me which option you prefer and, if available, paste the stream UUID (or stream name). - type: response.output_text.done - response_content_part_done: - summary: response.content_part.done - value: - content_index: 0 - item_id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - output_index: 0 - part: - annotations: [] - text: |- - I can retrieve that — I just need one detail from you. - - What I need - - Provide the stream UUID (preferred) — e.g., the stream's unique ID. - - Or, if you don't have the UUID, tell me the stream name (or confirm you want me to list your streams so you can pick one). - - Options I can perform for you - - If you give a stream UUID → I'll fetch the stream details and return the stream state and project ID. - - If you give a stream name → I can search/list streams matching that name (you may need to pick the correct one) and then fetch details. - - If you ask me to list streams now → I can return a paged list of your streams so you can choose which to inspect. - - Tell me which option you prefer and, if available, paste the stream UUID (or stream name). - type: output_text - sequence_number: 25 - type: response.content_part.done - response_output_item_done: - summary: response.output_item.done - value: - item: - id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - content: - - annotations: [] - text: |- - I can retrieve that — I just need one detail from you. - - What I need - - Provide the stream UUID (preferred) — e.g., the stream's unique ID. - - Or, if you don't have the UUID, tell me the stream name (or confirm you want me to list your streams so you can pick one). - - Options I can perform for you - - If you give a stream UUID → I'll fetch the stream details and return the stream state and project ID. - - If you give a stream name → I can search/list streams matching that name (you may need to pick the correct one) and then fetch details. - - If you ask me to list streams now → I can return a paged list of your streams so you can choose which to inspect. - - Tell me which option you prefer and, if available, paste the stream UUID (or stream name). - type: output_text - role: assistant - status: completed - type: message - output_index: 0 - sequence_number: 26 - type: response.output_item.done - response_completed: - summary: response.completed - value: - response: - id: resp_4542cc2f-7e4c-4694-a5fb-7797a150d0e0 - created_at: 1765358850.078279 - metadata: - related_prompt_1: List streams - related_prompt_2: Get stream stream state & project - related_prompt_3: Search streams by name '' stream - model: fsa-agent - object: response - output: - - id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - content: - - annotations: [] - text: |- - I can retrieve that — I just need one detail from you. - - What I need - - Provide the stream UUID (preferred) — e.g., the stream's unique ID. - - Or, if you don't have the UUID, tell me the stream name (or confirm you want me to list your streams so you can pick one). - - Options I can perform for you - - If you give a stream UUID → I'll fetch the stream details and return the stream state and project ID. - - If you give a stream name → I can search/list streams matching that name (you may need to pick the correct one) and then fetch details. - - If you ask me to list streams now → I can return a paged list of your streams so you can choose which to inspect. - - Tell me which option you prefer and, if available, paste the stream UUID (or stream name). - type: output_text - role: assistant - status: completed - type: message - parallel_tool_calls: false - tool_choice: none - tools: [] - status: completed - sequence_number: 27 - type: response.completed - standard-response: - value: - id: resp_08b22a5f-63c6-4892-8cd6-2a4b1ef591c0 - created_at: 1765339923 - model: fsa-agent - object: response - output: - - id: msg_14af23c6-15ea-4f11-8fa6-0cc80ffba850 - content: - - annotations: [] - text: Output data from Equinix Networking Assistant in response to prompt - type: output_text - role: assistant - status: completed - type: message - parallel_tool_calls: false - tool_choice: none - tools: [] - safety_identifier: - status: completed - text: - format: - type: text - usage: - input_tokens: 86146 - input_tokens_details: - cached_tokens: 0 - output_tokens: 1803 - output_tokens_details: - reasoning_tokens: 960 - total_tokens: 87949 - user: - response-with-related-prompt: - value: - id: resp_08b22a5f-63c6-4892-8cd6-2a4b1ef591c0 - created_at: 1765339923 - metadata: - related_prompt_1: Get Network Edge service IPsec/IKE example - related_prompt_2: Pair Network Edge service VPN with FCR router BGP config - related_prompt_3: Compare Equinix Fabric service vs VPN for metro SV (cost/latency/SLAs) - model: fsa-agent - object: response - output: - - id: msg_14af23c6-15ea-4f11-8fa6-0cc80ffba850 - content: - - annotations: [] - text: Output data from Equinix Networking Assistant in response to prompt - type: output_text - role: assistant - status: completed - type: message - parallel_tool_calls: false - tool_choice: none - tools: [] - safety_identifier: - status: completed - text: - format: - type: text - usage: - input_tokens: 86146 - input_tokens_details: - cached_tokens: 0 - output_tokens: 1803 - output_tokens_details: - reasoning_tokens: 960 - total_tokens: 87949 - user: - response-with-annotations: - value: - id: resp_08b22a5f-63c6-4892-8cd6-2a4b1ef591c0 - created_at: 1765339923 - model: fsa-agent - object: response - output: - - id: msg_14af23c6-15ea-4f11-8fa6-0cc80ffba850 - content: - - annotations: - - start_index: 0 - end_index: 0 - type: url_citation - title: "" - url: https://docs.equinix.com/managed-solutions/regional/united-kingdom/gms-uk-ips-infrastructure-platform-service - - start_index: 0 - end_index: 0 - type: url_citation - title: "" - url: https://docs.equinix.com/connecting-to-service-provider/fabric-connect-akamai - text: Output data from Equinix Networking Assistant in response to prompt - type: output_text - role: assistant - status: completed - type: message - parallel_tool_calls: false - tool_choice: none - tools: [] - safety_identifier: - status: completed - text: - format: - type: text - usage: - input_tokens: 86146 - input_tokens_details: - cached_tokens: 0 - output_tokens: 1803 - output_tokens_details: - reasoning_tokens: 960 - total_tokens: 87949 - user: - structured-output-response: - value: - id: resp_03490546-ddd4-4082-897d-c4b25076100f - created_at: 1778016085 - model: fsa-agent - object: response - output: - - id: msg_0beaa595b63725bd0069fa5f57871c819493aaf9bf91a686c3 - content: - - annotations: [] - text: |- - { - "component": "observability_chart", - "asset_type": "port", - "asset_id": "757400f8-d360-11e9-bb65-2a2ae2dbcce6", - "asset_name": "Equinix-SV-CX-port-L-Dot1q-100G-PRI", - "title": "Port metrics", - "indexKey": "time", - "error": { - "type": "ResourceNotFound", - "message": "I couldn't find a port with UUID bb1ad009-4dcc-4459-88b1-02df653d3004, so I can't return metrics for it." - }, - "data": [], - "series": [ - { - "dataKey": "bandwidth_rx", - "name": "Inbound bandwidth", - "color": "#1f77b4" - }, - { - "dataKey": "bandwidth_tx", - "name": "Outbound bandwidth", - "color": "#ff7f0e" - }, - { - "dataKey": "drops_erred", - "name": "Dropped/erred packets", - "color": "#d62728" - } - ] - } - type: output_text - logprobs: [] - role: assistant - status: completed - type: message - parallel_tool_calls: false - tool_choice: none - tools: [] - 500-responses-internal-server-error: - value: - - errorCode: EQ-3222201 - errorMessage: | - I'm so sorry, we were unable to process your prompt due to a system level issue. Equinix Networking Assistant needs some tender, loving care. Please report this error to maintainers with error code EQ-3222201. - correlationId: 123e4567-e89b-12d3-a456-426614174000 - response-deleted: - value: - id: resp_08b22a5f-63c6-4892-8cd6-2a4b1ef591c0 - deleted: true - object: response - input-items: - summary: Standard input items response - value: - data: - - id: msg_16fb930e-c71a-4cfc-9b5d-4871c6a98aef - content: - - annotations: [] - text: |- - Results — connections in DC with Fabric Cloud Router (FCR), active (limit 20) - ..... - type: output_text - role: assistant - status: completed - type: message - - id: msg_3920f72c-5172-42d1-8f5b-7eafd490411e - content: - text: Show connections in DC with FCRs; active, either side, limit 20 - type: input_text - role: user - first_id: msg_16fb930e-c71a-4cfc-9b5d-4871c6a98aef - has_more: false - last_id: msg_3920f72c-5172-42d1-8f5b-7eafd490411e - object: list - GatewayCreate: - value: - type: VPN_GW - name: My-VPN-Gateway - description: my test gateway - package: - code: LAB - haEnabled: true - localAsn: 65432 - router: - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - type: XF_ROUTER - project: - projectId: b1baecec-b7e7-453b-89fc-b35757bfcdbf - account: - accountNumber: 12345678 - order: - purchaseOrderNumber: 1-129105284100 - notifications: - - type: ALL - emails: - - test@test.com - GatewayPostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/gateways/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - uuid: c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - type: VPN_GW - name: My-VPN-Gateway - description: my test gateway - state: PROVISIONING - package: - code: LAB - router: - href: https://api.equinix.com/fabric/v4/routers/6658cc3b-18e0-437c-b972-62b51a419a1e - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - type: XF_ROUTER - localAsn: 65432 - ipv4: - primaryIp: 192.168.127.12/30 - secondaryIp: 192.168.127.13/30 - project: - projectId: b1baecec-b7e7-453b-89fc-b35757bfcdbf - account: - accountNumber: 12345678 - order: - purchaseOrderNumber: 1-129105284100 - notifications: - - type: ALL - emails: - - test@test.com - changeLog: - createdBy: abc@xyz.com - createdByEmail: abc@xyz.com - createdDateTime: 2025-04-21T01:11:11.117Z - updatedBy: abc@xyz.com - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-04-22T02:22:22.227Z - Gateway_400_InvalidName: - value: - - errorCode: EQ-8010022 - errorMessage: Name is minimum 3 and up to 24 characters in length - correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e - 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 - Gateway_401: - value: - - errorCode: EQ-8010001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - Gateway_403: - value: - - errorCode: EQ-8010002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - Gateway_415: - value: - - errorCode: EQ-8010016 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - Gateway_500: - value: - - errorCode: EQ-8010030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - GatewaySearchFilterByStatus: - value: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONED - - property: /project/projectId - operator: IN - values: - - b1baecec-b7e7-453b-89fc-b35757bfcdbf - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - GatewaySearchFilterByName: - value: - filter: - and: - - property: /name - operator: = - values: - - test- - - property: /project/projectId - operator: = - values: - - 6658cc3b-18e0-437c-b972-62b51a419a1e - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - GatewaySearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /name - operator: LIKE - values: - - abc% - - property: /name - operator: = - values: - - test-vpn - - property: /project/projectId - operator: = - values: - - b1baecec-b7e7-453b-89fc-b35757bfcdbf - GatewaySearchExample: - value: - pagination: - offset: 20 - limit: 20 - total: 1 - next: /search?offset=40&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/gateways/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - uuid: c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - type: VPN_GW - name: My-VPN-Gateway - description: my test gateway - state: PROVISIONED - package: - code: LAB - router: - href: https://api.equinix.com/fabric/v4/routers/6658cc3b-18e0-437c-b972-62b51a419a1e - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - type: XF_ROUTER - localAsn: 65432 - ipv4: - primaryIp: 192.168.127.12/30 - secondaryIp: 192.168.127.13/30 - project: - projectId: b1baecec-b7e7-453b-89fc-b35757bfcdbf - account: - accountNumber: 12345678 - notifications: - - type: ALL - emails: - - test@test.com - changeLog: - createdBy: abc@xyz.com - createdByEmail: abc@xyz.com - createdDateTime: 2025-04-21T01:11:11.117Z - updatedBy: abc@xyz.com - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-04-22T02:22:22.227Z - Gateway_400_InvalidSorting: - value: - - errorCode: EQ-8010039 - errorMessage: Invalid value for sorting direction. - correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - GatewayGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/gateways/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - uuid: c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - type: VPN_GW - name: My-VPN-Gateway - description: my test gateway - state: PROVISIONED - package: - code: LAB - router: - href: https://api.equinix.com/fabric/v4/routers/6658cc3b-18e0-437c-b972-62b51a419a1e - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - type: XF_ROUTER - localAsn: 65432 - ipv4: - primaryIp: 192.168.127.12/30 - secondaryIp: 192.168.127.13/30 - project: - projectId: b1baecec-b7e7-453b-89fc-b35757bfcdbf - account: - accountNumber: 12345678 - notifications: - - type: ALL - emails: - - test@test.com - changeLog: - createdBy: abc@xyz.com - createdByEmail: abc@xyz.com - createdDateTime: 2025-04-21T01:11:11.117Z - updatedBy: abc@xyz.com - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-04-22T02:22:22.227Z - Gateway_404: - value: - - errorCode: EQ-8010020 - errorMessage: Gateway not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: Gateway not found or already deleted - GatewayDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/gateways/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - uuid: c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - type: VPN_GW - name: My-VPN-Gateway - description: my test gateway - state: DEPROVISIONING - package: - code: LAB - router: - href: https://api.equinix.com/fabric/v4/routers/6658cc3b-18e0-437c-b972-62b51a419a1e - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - type: XF_ROUTER - localAsn: 65432 - ipv4: - primaryIp: 192.168.127.12/30 - secondaryIp: 192.168.127.13/30 - project: - projectId: b1baecec-b7e7-453b-89fc-b35757bfcdbf - account: - accountNumber: 12345678 - notifications: - - type: ALL - emails: - - test@test.com - changeLog: - createdBy: abc@xyz.com - createdByEmail: abc@xyz.com - createdDateTime: 2025-04-21T01:11:11.117Z - updatedBy: abc@xyz.com - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-04-22T02:22:22.227Z - deletedBy: abc@xyz.com - deletedByEmail: abc@xyz.com - deletedDateTime: 2025-04-23T03:33:33.337Z - Gateway_400_InvalidState: - value: - - errorCode: EQ-8010030 - errorMessage: Cannot delete Gateway in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete Gateway in transient state. - GatewayUpdateNameRequest: - value: - - op: replace - path: /name - value: Gw-Name-2 - GatewayUpdatePackageRequest: - value: - - op: replace - path: /package/code - value: LAB - GatewayUpdateResponseExample: - value: - href: https://api.equinix.com/fabric/v4/gateways/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - uuid: c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - type: VPN_GW - name: Gw-Name-2 - description: my test gateway - state: REPROVISIONING - package: - code: LAB - router: - href: https://api.equinix.com/fabric/v4/routers/6658cc3b-18e0-437c-b972-62b51a419a1e - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - type: XF_ROUTER - localAsn: 65432 - ipv4: - primaryIp: 192.168.127.12/30 - secondaryIp: 192.168.127.13/30 - project: - projectId: b1baecec-b7e7-453b-89fc-b35757bfcdbf - account: - accountNumber: 12345678 - notifications: - - type: ALL - emails: - - test@test.com - changeLog: - createdBy: abc@xyz.com - createdByEmail: abc@xyz.com - createdDateTime: 2025-04-21T01:11:11.117Z - updatedBy: abc@xyz.com - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-04-22T02:22:22.227Z - ListGatewayPackagesResponse: - value: - pagination: - offset: 0 - limit: 2 - total: 2 - data: - - href: https://api.equinix.com/fabric/v4/gatewayPackages/LAB - type: GW_PACKAGE - code: LAB - description: string - totalIPv4RoutesMax: 50 - totalIPv6RoutesMax: 50 - totalTunnelsMax: 4 - bandwidth: 50 - - href: https://api.equinix.com/fabric/v4/gatewayPackages/STANDARD - type: GW_PACKAGE - code: STANDARD - description: string - totalIPv4RoutesMax: 250 - totalIPv6RoutesMax: 250 - totalTunnelsMax: 10 - bandwidth: 1000 - GetGatewayPackageResponse: - value: - href: https://api.equinix.com/fabric/v4/gatewayPackages/LAB - type: GW_PACKAGE - code: LAB - description: string - totalIPv4RoutesMax: 50 - totalIPv6RoutesMax: 50 - totalTunnelsMax: 4 - bandwidth: 50 - TunnelRoutingProtocolGetAllResponseExample: - value: - pagination: - offset: 0 - limit: 10 - total: 1 - previous: "" - next: "" - data: - - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656/routingProtocols/80932bb5-1d3e-457a-b067-0ace6a3a0268 - uuid: 80932bb5-1d3e-457a-b067-0ace6a3a0268 - type: BGP - name: testBgpPeer1 - state: PROVISIONED - ipv4: - enabled: true - localPeerIp: 192.168.1.1 - remotePeerIp: 192.168.1.2 - localAsn: 65432 - remoteAsn: 65219 - authentication: - type: MD5 - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - TunnelRoutingProtocol_401: - value: - - errorCode: EQ-3047304 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - TunnelRoutingProtocol_403: - value: - - errorCode: EQ-3047305 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - TunnelRoutingProtocol_404: - value: - - errorCode: EQ-3047306 - errorMessage: Tunnel Routing Protocol not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: Tunnel Routing Protocol not found or already deleted - TunnelRoutingProtocol_500: - value: - - errorCode: EQ-3047308 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - TunnelRoutingProtocolCreate: - value: - type: BGP - name: testBgpPeer1 - ipv4: - enabled: true - authentication: - type: MD5 - key: 8a9d5f3ca2b4a5fd7e8b6d8a9c5f3e2b1a7 - remoteAsn: 65219 - TunnelRoutingProtocolPostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656/routingProtocols/80932bb5-1d3e-457a-b067-0ace6a3a0268 - uuid: 80932bb5-1d3e-457a-b067-0ace6a3a0268 - type: BGP - name: My-BgpPeer - ipv4: - enabled: true - localPeerIp: 192.168.1.1 - remotePeerIp: 192.168.1.2 - localAsn: 65432 - remoteAsn: 65219 - authentication: - type: MD5 - state: PROVISIONED - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - TunnelRoutingProtocol_400_InvalidName: - value: - - errorCode: EQ-3047301 - errorMessage: Name is minimum 0 and up to 50 characters in length - correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e - details: Name is minimum 0 and up to 50 characters in length - additionalInfo: - - property: /name - reason: Name is minimum 0 and up to 50 characters in length - TunnelRoutingProtocol_415: - value: - - errorCode: EQ-3047307 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - TunnelRoutingProtocolGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656/routingProtocols/80932bb5-1d3e-457a-b067-0ace6a3a0268 - uuid: 80932bb5-1d3e-457a-b067-0ace6a3a0268 - type: BGP - name: My-BgpPeer - ipv4: - enabled: true - localPeerIp: 192.168.1.1 - remotePeerIp: 192.168.1.2 - localAsn: 65432 - remoteAsn: 65219 - authentication: - type: MD5 - state: PROVISIONED - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-03-10T05:00:00Z - TunnelRoutingProtocolDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656/routingProtocols/80932bb5-1d3e-457a-b067-0ace6a3a0268 - uuid: 80932bb5-1d3e-457a-b067-0ace6a3a0268 - type: BGP - name: My-BgpPeer - ipv4: - enabled: true - localPeerIp: 192.168.1.1 - remotePeerIp: 192.168.1.2 - localAsn: 65432 - remoteAsn: 65219 - authentication: - type: MD5 - state: DEPROVISIONING - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-03-10T05:00:00Z - deletedBy: testBuyer - deletedDateTime: 2025-03-15T12:20:06Z - TunnelRoutingProtocol_400_InvalidState: - value: - - errorCode: EQ-3047303 - errorMessage: Cannot delete Tunnel Routing Protocol in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete Tunnel Routing Protocol in transient state. - TunnelRoutingProtocolUpdateNameRequest: - value: - - op: replace - path: /name - value: testBgpPeer1-new-name - TunnelRoutingProtocolUpdateEnabledRequest: - value: - - op: replace - path: /ipv4/enabled - value: false - TunnelRoutingProtocolUpdateResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656/routingProtocols/80932bb5-1d3e-457a-b067-0ace6a3a0268 - uuid: 80932bb5-1d3e-457a-b067-0ace6a3a0268 - type: BGP - name: testBgpPeer1-new-name - state: REPROVISIONING - ipv4: - enabled: true - localPeerIp: 192.168.1.1 - remotePeerIp: 192.168.1.2 - localAsn: 65432 - remoteAsn: 65219 - authentication: - type: MD5 - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-04-28T04:12:36.607Z - GatewayTunnelCreate: - value: - type: IPSEC_TUNNEL - name: My-Tunnel - description: My IPSec tunnel - gateway: - uuid: 01e1218a-8ed4-493e-a5e9-8e54806894b9 - ipv4: - tunnelRemoteIp: 192.168.1.1/30 - tunnelLocalIp: 192.168.1.2/30 - mtu: 1500 - enabled: true - remoteBranchIp: 1.2.3.43 - authentication: - type: PSK - ikeVersion: IKEV2 - preSharedKey: my_secret_key_123456 - phase1DhGroup: "14" - phase1EncryptAlgorithm: AES128_GCM16 - phase1IntegrityAlgorithm: SHA256 - phase2DhGroup: "14" - phase2EncryptAlgorithm: AES128_GCM16 - phase2IntegrityAlgorithm: SHA256 - ikeLifetime: 28800 - espLifetime: 3600 - GatewayTunnelPostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656 - uuid: aee72df9-dec8-4c89-8f18-c4d0ef203656 - type: IPSEC_TUNNEL - name: My-Tunnel - description: My IPSec tunnel - state: PROVISIONING - gateway: - href: https://api.equinix.com/fabric/v4/gateways/01e1218a-8ed4-493e-a5e9-8e54806894b9 - type: VPN_GW - uuid: 01e1218a-8ed4-493e-a5e9-8e54806894b9 - ipv4: - tunnelRemoteIp: 192.168.1.1/30 - tunnelLocalIp: 192.168.1.2/30 - mtu: 1500 - enabled: true - remoteBranchIp: 1.2.3.43 - authentication: - type: PSK - ikeVersion: IKEV2 - preSharedKey: "********" - phase1DhGroup: "14" - phase1EncryptAlgorithm: AES128_GCM16 - phase1IntegrityAlgorithm: SHA256 - phase2DhGroup: "14" - phase2EncryptAlgorithm: AES128_GCM16 - phase2IntegrityAlgorithm: SHA256 - ikeLifetime: 28800 - espLifetime: 3600 - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-03-29T05:00:00.000Z - GatewayTunnel_400_InvalidName: - value: - - errorCode: EQ-8030022 - errorMessage: Name is minimum 0 and up to 50 characters in length - correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e - details: Name is minimum 0 and up to 50 characters in length - additionalInfo: - - property: /name - reason: Name is minimum 0 and up to 50 characters in length - GatewayTunnel_401: - value: - - errorCode: EQ-8030001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - GatewayTunnel_403: - value: - - errorCode: EQ-8030002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - GatewayTunnel_415: - value: - - errorCode: EQ-8030016 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - GatewayTunnel_500: - value: - - errorCode: EQ-8030030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - GatewayTunnelGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656 - uuid: aee72df9-dec8-4c89-8f18-c4d0ef203656 - type: IPSEC_TUNNEL - name: My-Tunnel - description: My IPSec tunnel - state: PROVISIONED - gateway: - href: https://api.equinix.com/fabric/v4/gateways/01e1218a-8ed4-493e-a5e9-8e54806894b9 - type: VPN_GW - uuid: 01e1218a-8ed4-493e-a5e9-8e54806894b9 - ipv4: - tunnelRemoteIp: 192.168.1.1/30 - tunnelLocalIp: 192.168.1.2/30 - mtu: 1500 - enabled: true - remoteBranchIp: 1.2.3.43 - authentication: - type: PSK - ikeVersion: IKEV2 - preSharedKey: "********" - phase1DhGroup: "14" - phase1EncryptAlgorithm: AES128_GCM16 - phase1IntegrityAlgorithm: SHA256 - phase2DhGroup: "14" - phase2EncryptAlgorithm: AES128_GCM16 - phase2IntegrityAlgorithm: SHA256 - ikeLifetime: 28800 - espLifetime: 3600 - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-03-10T05:00:00Z - GatewayTunnel_404: - value: - - errorCode: EQ-8030020 - errorMessage: Gateway Tunnel not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: Gateway Tunnel not found or already deleted - GatewayTunnelDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656 - uuid: aee72df9-dec8-4c89-8f18-c4d0ef203656 - type: IPSEC_TUNNEL - name: My-Tunnel - description: My IPSec tunnel - state: DEPROVISIONING - gateway: - href: https://api.equinix.com/fabric/v4/gateways/01e1218a-8ed4-493e-a5e9-8e54806894b9 - type: VPN_GW - uuid: 01e1218a-8ed4-493e-a5e9-8e54806894b9 - ipv4: - tunnelRemoteIp: 192.168.1.1/30 - tunnelLocalIp: 192.168.1.2/30 - mtu: 1500 - enabled: true - remoteBranchIp: 1.2.3.43 - authentication: - type: PSK - ikeVersion: IKEV2 - preSharedKey: "********" - phase1DhGroup: "14" - phase1EncryptAlgorithm: AES128_GCM16 - phase1IntegrityAlgorithm: SHA256 - phase2DhGroup: "14" - phase2EncryptAlgorithm: AES128_GCM16 - phase2IntegrityAlgorithm: SHA256 - ikeLifetime: 28800 - espLifetime: 3600 - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-03-10T05:00:00Z - deletedBy: testBuyer - deletedDateTime: 2025-03-15T12:20:06Z - GatewayTunnel_400_InvalidState: - value: - - errorCode: EQ-8030030 - errorMessage: Cannot delete Gateway Tunnel in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete Gateway Tunnel in transient state. - GatewayTunnelUpdateEnabled: - value: - - op: replace - path: /enabled - value: true - GatewayTunnelUpdateName: - value: - - op: replace - path: /name - value: updated-tunnel - GatewayTunnelUpdateDescription: - value: - - op: replace - path: /description - value: updated tunnel description - GatewayTunnelUpdatePreSharedKey: - value: - - op: replace - path: /authentication/preSharedKey - value: my_new_secret_key_123456 - GatewayTunnelUpdateLifetimes: - value: - - op: replace - path: /authentication/ikeLifetime - value: 14400 - - op: replace - path: /authentication/espLifetime - value: 1800 - GatewayTunnelUpdateResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656 - uuid: aee72df9-dec8-4c89-8f18-c4d0ef203656 - type: IPSEC_TUNNEL - name: My-Tunnel - description: My IPSec tunnel - state: REPROVISIONING - gateway: - href: https://api.equinix.com/fabric/v4/gateways/01e1218a-8ed4-493e-a5e9-8e54806894b9 - type: VPN_GW - uuid: 01e1218a-8ed4-493e-a5e9-8e54806894b9 - ipv4: - tunnelRemoteIp: 192.168.1.1/30 - tunnelLocalIp: 192.168.1.2/30 - mtu: 1500 - enabled: true - remoteBranchIp: 1.2.3.43 - authentication: - type: PSK - ikeVersion: IKEV2 - preSharedKey: "********" - phase1DhGroup: "14" - phase1EncryptAlgorithm: AES128_GCM16 - phase1IntegrityAlgorithm: SHA256 - phase2DhGroup: "14" - phase2EncryptAlgorithm: AES128_GCM16 - phase2IntegrityAlgorithm: SHA256 - ikeLifetime: 28800 - espLifetime: 3600 - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-03-29T05:00:00.000Z - GatewayTunnelSearchFilterByStatus: - value: - filter: - and: - - property: /state - operator: IN - values: - - PROVISIONED - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - GatewayTunnelSearchFilterByName: - value: - filter: - and: - - property: /name - operator: = - values: - - test- - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - GatewayTunnelSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /name - operator: LIKE - values: - - abc% - - property: /state - operator: = - values: - - PROVISIONED - GatewayTunnelSearchExample: - 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/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656 - uuid: aee72df9-dec8-4c89-8f18-c4d0ef203656 - type: IPSEC_TUNNEL - name: My-Tunnel - description: My IPSec tunnel - state: PROVISIONED - gateway: - href: https://api.equinix.com/fabric/v4/gateways/01e1218a-8ed4-493e-a5e9-8e54806894b9 - type: VPN_GW - uuid: 01e1218a-8ed4-493e-a5e9-8e54806894b9 - ipv4: - tunnelRemoteIp: 192.168.1.1/30 - tunnelLocalIp: 192.168.1.2/30 - mtu: 1500 - enabled: true - remoteBranchIp: 1.2.3.43 - authentication: - type: PSK - ikeVersion: IKEV2 - preSharedKey: "********" - phase1DhGroup: "14" - phase1EncryptAlgorithm: AES128_GCM16 - phase1IntegrityAlgorithm: SHA256 - phase2DhGroup: "14" - phase2EncryptAlgorithm: AES128_GCM16 - phase2IntegrityAlgorithm: SHA256 - ikeLifetime: 28800 - espLifetime: 3600 - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-03-10T05:00:00Z - GatewayTunnel_400_InvalidSorting: - value: - - errorCode: EQ-8030039 - errorMessage: Invalid value for sorting direction. - correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - TermPostFCRRequestExample: - value: - accountNumber: ACCT-123456 - product: CLOUD_ROUTER_PRODUCT - type: BCD_FIXED_TERM - delayDuration: P30D - startDateTime: 2026-09-24T06:59:46Z - quantityEntitled: 1 - name: Q3 FCR Trial — Advanced & Premium - comSolCaseId: CS-98765 - notes: text1 - selector: - and: - - property: /router/package/code - operator: IN - values: - - ADVANCED - - PREMIUM - TermPostVCRequestExample: - value: - accountNumber: ACCT-654321 - product: VIRTUAL_CONNECTION_PRODUCT - type: BCD_FIXED_TERM - delayDuration: P60D - startDateTime: 2026-07-01T00:00:00Z - quantityEntitled: 1 - name: Q3 VC Trial — Up to 1G - comSolCaseId: CS-98766 - selector: - and: - - property: /connection/bandwidth - operator: <= - values: - - "1000" - TermPostFCRResponseExample: - value: - href: https://api.equinix.com/fabric/v4/terms/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - accountNumber: ACCT-123456 - type: BCD_FIXED_TERM - product: CLOUD_ROUTER_PRODUCT - state: ACTIVE - startDateTime: 2026-09-24T06:59:46Z - delayDuration: P30D - commencementDateTime: 2026-12-24T06:59:46Z - quantityEntitled: 1 - name: Q3 FCR Trial — Advanced & Premium - comSolCaseId: CS-98765 - notes: text1 - selector: - and: - - property: /router/package/code - operator: IN - values: - - ADVANCED - - PREMIUM - changeLog: - createdId: 1222 - createdDateTime: 2026-06-15T10:00:00Z - TermPostVCResponseExample: - value: - href: https://api.equinix.com/fabric/v4/terms/b2c3d4e5-f6a7-8901-bcde-f12345678901 - uuid: b2c3d4e5-f6a7-8901-bcde-f12345678901 - accountNumber: ACCT-654321 - type: BCD_FIXED_TERM - product: VIRTUAL_CONNECTION_PRODUCT - state: ACTIVE - startDateTime: 2026-07-01T00:00:00Z - delayDuration: P60D - commencementDateTime: 2026-08-30T00:00:00Z - quantityEntitled: 1 - name: Q3 VC Trial — Up to 1G - comSolCaseId: CS-98766 - selector: - and: - - property: /connection/bandwidth - operator: <= - values: - - "1000" - changeLog: - createdId: 1223 - createdDateTime: 2026-06-15T10:05:00Z - Terms_400: - value: - - errorCode: EQ-3073002 - errorMessage: Invalid argument - correlationId: req-abc-123 - details: accountNumber is required - additionalInfo: - - property: accountNumber - reason: required - Terms_400_TermStartDateInPast: - value: - - errorCode: EQ-3073010 - errorMessage: startDateTime cannot be in the past - correlationId: req-abc-123 - details: startDateTime cannot be in the past - additionalInfo: - - property: startDateTime - reason: must be today or a future date - Terms_500: - value: - - errorCode: EQ-3073001 - errorMessage: Internal error - correlationId: req-abc-123 - details: Internal system error - TermGetByIdFCRResponseExample: - value: - href: https://api.equinix.com/fabric/v4/terms/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - accountNumber: ACCT-123456 - type: BCD_FIXED_TERM - product: CLOUD_ROUTER_PRODUCT - state: ACTIVE - startDateTime: 2026-09-24T06:59:46Z - delayDuration: P30D - commencementDateTime: 2026-12-24T06:59:46Z - quantityEntitled: 1 - name: Q3 FCR Trial — Advanced & Premium - comSolCaseId: CS-98765 - notes: text1 - selector: - and: - - property: /router/package/code - operator: IN - values: - - ADVANCED - - PREMIUM - changeLog: - createdId: 1222 - createdDateTime: 2026-06-15T10:00:00Z - TermGetByIdVCResponseExample: - value: - href: https://api.equinix.com/fabric/v4/terms/b2c3d4e5-f6a7-8901-bcde-f12345678901 - uuid: b2c3d4e5-f6a7-8901-bcde-f12345678901 - accountNumber: ACCT-654321 - type: BCD_FIXED_TERM - product: VIRTUAL_CONNECTION_PRODUCT - state: ACTIVE - startDateTime: 2026-07-01T00:00:00Z - delayDuration: P60D - commencementDateTime: 2026-08-30T00:00:00Z - quantityEntitled: 1 - name: Q3 VC Trial — Up to 1G - comSolCaseId: CS-98766 - selector: - and: - - property: /connection/bandwidth - operator: <= - values: - - "1000" - changeLog: - createdId: 1223 - createdDateTime: 2026-06-15T10:05:00Z - Terms_404: - value: - - errorCode: EQ-3073004 - errorMessage: Resource not found - correlationId: req-abc-123 - details: "Term not found: a1b2c3d4-e5f6-7890-abcd-ef1234567890" - TermDeleteFCRResponseExample: - value: - href: https://api.equinix.com/fabric/v4/terms/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - accountNumber: ACCT-123456 - type: BCD_FIXED_TERM - product: CLOUD_ROUTER_PRODUCT - state: DELETED - startDateTime: 2026-09-24T06:59:46Z - delayDuration: P30D - commencementDateTime: 2026-12-24T06:59:46Z - quantityEntitled: 1 - name: Q3 FCR Trial — Advanced & Premium - comSolCaseId: CS-98765 - notes: text1 - selector: - and: - - property: /router/package/code - operator: IN - values: - - ADVANCED - - PREMIUM - changeLog: - createdId: 1222 - createdDateTime: 2026-06-15T10:00:00Z - deletedId: 1222 - deletedDateTime: 2026-07-29T09:00:00Z - TermDeleteVCResponseExample: - value: - href: https://api.equinix.com/fabric/v4/terms/b2c3d4e5-f6a7-8901-bcde-f12345678901 - uuid: b2c3d4e5-f6a7-8901-bcde-f12345678901 - accountNumber: ACCT-654321 - type: BCD_FIXED_TERM - product: VIRTUAL_CONNECTION_PRODUCT - state: DELETED - startDateTime: 2026-07-01T00:00:00Z - delayDuration: P60D - commencementDateTime: 2026-08-30T00:00:00Z - quantityEntitled: 1 - name: Q3 VC Trial — Up to 1G - comSolCaseId: CS-98766 - selector: - and: - - property: /connection/bandwidth - operator: <= - values: - - "1000" - changeLog: - createdId: 1223 - createdDateTime: 2026-06-15T10:05:00Z - deletedId: 1223 - deletedDateTime: 2026-07-29T09:05:00Z - Terms_409: - value: - - errorCode: EQ-3073005 - errorMessage: Resource already deleted - correlationId: req-abc-123 - details: "Term already deleted: a1b2c3d4-e5f6-7890-abcd-ef1234567890" - TermSearchFCRRequestExample: - value: - filter: - and: - - property: accountNumber - operator: = - values: - - ACCT-123456 - - property: product - operator: = - values: - - CLOUD_ROUTER_PRODUCT - - property: state - operator: = - values: - - ACTIVE - sort: - - field: changeLog.createdDateTime - direction: DESC - pagination: - offset: 0 - limit: 20 - TermSearchVCRequestExample: - value: - filter: - and: - - property: accountNumber - operator: = - values: - - ACCT-654321 - - property: product - operator: = - values: - - VIRTUAL_CONNECTION_PRODUCT - - property: state - operator: IN - values: - - ACTIVE - - INACTIVE - sort: - - field: startDateTime - direction: ASC - pagination: - offset: 0 - limit: 20 - TermSearchResponseExample: - value: - data: - - uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - href: https://api.equinix.com/fabric/v4/terms/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - accountNumber: ACCT-123456 - type: BCD_FIXED_TERM - product: CLOUD_ROUTER_PRODUCT - state: ACTIVE - startDateTime: 2026-09-24T06:59:46Z - delayDuration: P30D - commencementDateTime: 2026-12-24T06:59:46Z - quantityEntitled: 1 - name: Q3 FCR Trial — Advanced & Premium - comSolCaseId: CS-98765 - changeLog: - createdId: 1222 - createdDateTime: 2026-06-15T10:00:00Z - pagination: - offset: 0 - limit: 20 - total: 1 + $ref: '#/components/schemas/AppSubscription' headers: ETag: description: response header - identifier for a specific version of a resource. schema: type: string - securitySchemes: - BearerAuth: - type: http - scheme: bearer - bearerFormat: JWT x-tagGroups: - name: Core Connectivity tags: diff --git a/spec/services/fabricv4/oas3.patched/openapi.yaml b/spec/services/fabricv4/oas3.patched/openapi.yaml index 4149119d..e965fb66 100644 --- a/spec/services/fabricv4/oas3.patched/openapi.yaml +++ b/spec/services/fabricv4/oas3.patched/openapi.yaml @@ -1,5 +1,6 @@ openapi: 3.0.3 info: + version: 4.34.0 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 @@ -9,10 +10,6 @@ info: license: name: Equinix Inc url: https://developer.equinix.com/agreement - version: "4.34.0" -externalDocs: - description: Find more information on Equinix Developer Portal - url: https://developer.equinix.com servers: - url: https://api.equinix.com description: Equinix Inc @@ -99,7 +96,633 @@ tags: description: Streams - name: Tags description: Tags Beta +externalDocs: + url: https://developer.equinix.com + description: Find more information on Equinix Developer Portal paths: + /fabric/v4/asns: + post: + tags: + - ASNs + summary: Create ASN + description: Create a new Public or Private ASN record + operationId: createAsn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAsnRequest' + examples: + CreatePublicAsn: + summary: Create a public ASN + value: + type: PUBLIC_ASN + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + number: 64497 + rirRegion: RIPE_NCC + ownershipChallengeDetails: + type: RPKI + CreatePrivateAsn: + summary: Create a private ASN + value: + type: PRIVATE_ASN + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + location: + metroCode: SV + range: 16_BIT + required: true + responses: + '202': + description: ASN request accepted + content: + application/json: + schema: + $ref: '#/components/schemas/Asn' + examples: + PublicAsnCreated: + summary: Public ASN creation response + value: + href: fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43 + uuid: 6db706f8-2a37-4546-a3ed-1df113a84d43 + type: PUBLIC_ASN + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + state: PENDING + number: 64497 + rirRegion: RIPE_NCC + ownershipChallengeDetails: + type: RPKI + message: eqx-rpki-challenge-2026-04-21T11:20:00Z-64497 + signature: null + assets: [] + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + PrivateAsnCreated: + summary: Private ASN creation response + value: + href: fabric/v4/asns/3b37813d-f8bf-4152-bf8f-43d661860ba3 + uuid: 3b37813d-f8bf-4152-bf8f-43d661860ba3 + type: PRIVATE_ASN + state: PROVISIONING + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + location: + metroCode: SV + number: null + range: 16_BIT + assets: [] + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH + /fabric/v4/asns/search: + post: + tags: + - ASNs + summary: Search ASNs + description: Search for ASN records based on criteria + operationId: searchAsns + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AsnSearchRequestBody' + examples: + SearchByProject: + summary: Search ASNs by project + value: + pagination: + offset: 0 + limit: 25 + filter: + and: + - property: /project/projectId + operator: '=' + values: + - 03ed2230-604a-494c-bca2-c042d38d80bc + sort: + - direction: DESC + property: /changeLog/createdDateTime + required: true + responses: + '200': + description: ASN records found successfully + content: + application/json: + schema: + $ref: '#/components/schemas/AsnSearchResponseBody' + examples: + SearchAsnsByProject: + summary: Search results for an ASN project + value: + pagination: + total: 1 + sort: + - direction: DESC + property: /changeLog/createdDateTime + data: + - href: fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43 + uuid: 6db706f8-2a37-4546-a3ed-1df113a84d43 + type: PUBLIC_ASN + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + state: PROVISIONING + number: 64497 + rirRegion: RIPE_NCC + ownershipChallengeDetails: + type: RPKI + message: eqx-rpki-challenge-2026-04-21T11:20:00Z-64497 + signature: MEUCIQCrExampleBase64SignatureValue7h4Yg== + assets: + - service: + href: https://api.equinix.com/fabric/v4/internetAccessService/52fbdb3f-8def-410d-868b-ef920878bff8 + type: IA + uuid: 52fbdb3f-8def-410d-868b-ef920878bff8 + announcingMetro: LD + ipBlocks: + - href: https://api.equinix.com/fabric/v4/ipBlocks/129afa61-f706-41cb-a03a-69a276bdb0b4 + type: IPV4_IP_BLOCK + uuid: 129afa61-f706-41cb-a03a-69a276bdb0b4 + - href: https://api.equinix.com/fabric/v4/ipBlocks/72fc7c32-67c8-4ae4-b43f-d4d656961f04 + type: IPV6_IP_BLOCK + uuid: 72fc7c32-67c8-4ae4-b43f-d4d656961f04 + changeLog: + createdDateTime: '2025-12-01T12:11:22.222Z' + updatedDateTime: '2025-12-01T13:11:22.222Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH + /fabric/v4/asns/{asnId}: + get: + tags: + - ASNs + summary: Get ASN + description: Retrieve ASN record by UUID + operationId: getAsnById + parameters: + - name: asnId + in: path + description: UUID of the ASN record + required: true + schema: + type: string + format: uuid + responses: + '200': + description: ASN retrieved successfully + content: + application/json: + schema: + $ref: '#/components/schemas/Asn' + examples: + PublicAsnRetrieved: + summary: Public ASN after ownership signature update + value: + href: fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43 + uuid: 6db706f8-2a37-4546-a3ed-1df113a84d43 + type: PUBLIC_ASN + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + state: PROVISIONING + number: 64497 + rirRegion: RIPE_NCC + ownershipChallengeDetails: + type: RPKI + message: eqx-rpki-challenge-2026-04-21T11:20:00Z-64497 + signature: MEUCIQCrExampleBase64SignatureValue7h4Yg== + assets: + - service: + href: https://api.equinix.com/fabric/v4/internetAccessService/52fbdb3f-8def-410d-868b-ef920878bff8 + type: IA + uuid: 52fbdb3f-8def-410d-868b-ef920878bff8 + announcingMetro: LD + ipBlocks: + - href: https://api.equinix.com/fabric/v4/ipBlocks/129afa61-f706-41cb-a03a-69a276bdb0b4 + type: IPV4_IP_BLOCK + uuid: 129afa61-f706-41cb-a03a-69a276bdb0b4 + - href: https://api.equinix.com/fabric/v4/ipBlocks/72fc7c32-67c8-4ae4-b43f-d4d656961f04 + type: IPV6_IP_BLOCK + uuid: 72fc7c32-67c8-4ae4-b43f-d4d656961f04 + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + updatedDateTime: '2025-12-01T13:11:22.222351Z' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH + patch: + tags: + - ASNs + summary: Update ASN + description: Update ASN record + operationId: patchAsnById + parameters: + - name: asnId + in: path + description: UUID of the ASN record + required: true + schema: + type: string + format: uuid + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AsnPatchRequest' + examples: + AddOwnershipSignature: + summary: Add the ownership challenge signature + value: + - op: replace + path: /ownershipChallengeDetails/signature + value: MEUCIQCrExampleBase64SignatureValue7h4Yg== + required: true + responses: + '202': + description: ASN request accepted + content: + application/json: + schema: + $ref: '#/components/schemas/Asn' + examples: + PublicAsnCreated: + summary: Public ASN creation response + value: + href: fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43 + uuid: 6db706f8-2a37-4546-a3ed-1df113a84d43 + type: PUBLIC_ASN + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + state: PENDING + number: 64497 + rirRegion: RIPE_NCC + ownershipChallengeDetails: + type: RPKI + message: eqx-rpki-challenge-2026-04-21T11:20:00Z-64497 + signature: null + assets: [] + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + PrivateAsnCreated: + summary: Private ASN creation response + value: + href: fabric/v4/asns/3b37813d-f8bf-4152-bf8f-43d661860ba3 + uuid: 3b37813d-f8bf-4152-bf8f-43d661860ba3 + type: PRIVATE_ASN + state: PROVISIONING + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + location: + metroCode: SV + number: null + range: 16_BIT + assets: [] + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH + delete: + tags: + - ASNs + summary: Delete ASN + description: Deprovision ASN record by UUID + operationId: deleteAsnById + parameters: + - name: asnId + in: path + description: UUID of the ASN record + required: true + schema: + type: string + format: uuid + responses: + '202': + description: ASN request accepted + content: + application/json: + schema: + $ref: '#/components/schemas/Asn' + examples: + PublicAsnCreated: + summary: Public ASN creation response + value: + href: fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43 + uuid: 6db706f8-2a37-4546-a3ed-1df113a84d43 + type: PUBLIC_ASN + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + state: PENDING + number: 64497 + rirRegion: RIPE_NCC + ownershipChallengeDetails: + type: RPKI + message: eqx-rpki-challenge-2026-04-21T11:20:00Z-64497 + signature: null + assets: [] + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + PrivateAsnCreated: + summary: Private ASN creation response + value: + href: fabric/v4/asns/3b37813d-f8bf-4152-bf8f-43d661860ba3 + uuid: 3b37813d-f8bf-4152-bf8f-43d661860ba3 + type: PRIVATE_ASN + state: PROVISIONING + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + location: + metroCode: SV + number: null + range: 16_BIT + assets: [] + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/{asset}/{assetId}/cloudevents: get: tags: @@ -107,90 +730,189 @@ paths: summary: Get Cloud Events by Asset Id (Deprecated) description: This API provides capability to retrieve cloud events of an asset id operationId: getCloudEventByAssetId + deprecated: true parameters: - name: asset in: path description: asset required: true schema: - $ref: "#/components/schemas/CloudEventAssetType" + $ref: '#/components/schemas/CloudEventAssetType' - name: assetId in: path description: asset UUID required: true schema: - $ref: "#/components/schemas/AssetId" + description: Asset UUID + type: string + format: uuid + example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - name: fromDateTime in: query description: Start date and time required: false schema: - $ref: "#/components/schemas/StartDateTime" + $ref: '#/components/schemas/StartDateTime' - name: toDateTime in: query description: End date and time required: false schema: - $ref: "#/components/schemas/EndDateTime" + $ref: '#/components/schemas/EndDateTime' - name: offset in: query description: offset required: false schema: - $ref: "#/components/schemas/Offset" + $ref: '#/components/schemas/Offset' - name: limit in: query description: limit required: false schema: - $ref: "#/components/schemas/Limit" + $ref: '#/components/schemas/Limit' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetCloudEventsByAssetResponse" + $ref: '#/components/schemas/GetCloudEventsByAssetResponse' examples: Example: - $ref: "#/components/examples/get-cloud-events-by-asset-id" - "401": + 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 + traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, + tracestate: 71a60705518f,81a607055181 + data: + message: Neighbor 100.100.100.102 address session state changed to Connect + auth: + authtype: system + authid: 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' + traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, + tracestate: 71a60705518f,81a607055181 + data: + message: Connection named TEST-CONNECTION state changed to provisioning + resource: + href: http://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: + authtype: user + authid: '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 + traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, + tracestate: 71a60705518f,81a607055181 + data: + message: Connection named TEST-CONNECTION state changed to provisioned + resource: + href: http://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: + authtype: system + authid: equinix + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: uuid not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: uuid not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - deprecated: true + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/cloudevents/{cloudEventId}: get: tags: @@ -204,53 +926,99 @@ paths: description: Cloud Event UUID required: true schema: - $ref: "#/components/schemas/CloudEventId" + description: Cloud Event UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Cloud Event object content: application/json: schema: - $ref: "#/components/schemas/CloudEvent" + $ref: '#/components/schemas/CloudEvent' examples: CloudEventResponseExample: - $ref: "#/components/examples/get-cloud-event" - "401": + 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' + traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, + tracestate: 71a60705518f,81a607055181 + data: + message: Connection named TEST-CONNECTION state changed to provisioning + resource: + href: http://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: + authtype: user + authid: '123456' + name: test user + email: testuser@test.com + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: uuid not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: uuid not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/cloudevents/search: post: tags: @@ -258,62 +1026,183 @@ paths: 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" + $ref: '#/components/schemas/CloudEventSearchRequest' examples: CloudEventSearchRequestExample: - $ref: "#/components/examples/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: /equinixorganization + operator: '=' + values: + - '526698000597331' + - property: /equinixproject + operator: '=' + values: + - dadd3ab6-c0af-430c-8216-43d44f08c1c5 + - property: /time + operator: '>' + values: + - '2018-04-05T17:31:00.000Z' + pagination: + offset: 0 + limit: 20 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetCloudEventsByAssetResponse" + $ref: '#/components/schemas/GetCloudEventsByAssetResponse' examples: Example: - $ref: "#/components/examples/get-cloud-events-by-asset-id" - "401": + 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 + traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, + tracestate: 71a60705518f,81a607055181 + data: + message: Neighbor 100.100.100.102 address session state changed to Connect + auth: + authtype: system + authid: 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' + traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, + tracestate: 71a60705518f,81a607055181 + data: + message: Connection named TEST-CONNECTION state changed to provisioning + resource: + href: http://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: + authtype: user + authid: '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 + traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, + tracestate: 71a60705518f,81a607055181 + data: + message: Connection named TEST-CONNECTION state changed to provisioned + resource: + href: http://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: + authtype: system + authid: equinix + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: uuid not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: uuid not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/liveEvents/search: post: tags: @@ -321,62 +1210,111 @@ paths: summary: Search last Operational Cloud Events description: This API provides capability to search last operational cloud events from a filtered query operationId: searchLastOpEvents - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/LiveEventSearchRequest" + $ref: '#/components/schemas/LiveEventSearchRequest' examples: LiveEventSearchRequestExample: - $ref: "#/components/examples/search-live-events" + value: + filter: + and: + - property: /subject + operator: IN + values: + - /fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + pagination: + offset: 0 + limit: 2 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/SearchLiveEventResponse" + $ref: '#/components/schemas/SearchLiveEventResponse' examples: Example: - $ref: "#/components/examples/search-live-events-response" - "401": + value: + pagination: + offset: 0 + limit: 2 + total: 1 + data: + - specversion: '1.0' + source: https://api.equinix.com/fabric/v4/cloudevents + id: 6c573287-9914-4202-8b6d-2d15e7da04b8 + type: equinix.fabric.port.status.down + subject: /fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + time: '2018-04-05T17:31:00.000Z' + dataschema: https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json + datacontenttype: application/json + severitynumber: '21' + severitytext: FATAL + equinixalert: raise/AABBcCCDDeEfFf123, + equinixproject: project-123 + data: + message: Virtual port 'port-name' status changed to DOWN + resource: + href: https://api.equinix.com//fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + uuid: 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + type: XF_PORT + state: PROVISIONED + operation: + operationalStatus: DOWN + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: uuid not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: uuid not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/{asset}/{assetId}/metrics: get: tags: @@ -384,19 +1322,23 @@ paths: summary: Get Metrics by Asset Id (Deprecated) description: This API provides capability to retrieve Metrics of an asset id operationId: getMetricByAssetId + deprecated: true parameters: - name: asset in: path description: asset required: true schema: - $ref: "#/components/schemas/MetricAssetType" + $ref: '#/components/schemas/MetricAssetType' - name: assetId in: path description: asset UUID required: true schema: - $ref: "#/components/schemas/AssetId" + description: Asset UUID + type: string + format: uuid + example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - name: name in: query description: | @@ -421,8 +1363,8 @@ paths: - `equinix.fabric.metro.{SOURCE_METRO_CODE}_{DESTINATION_METRO_CODE}.jitter_avg` required: true schema: - pattern: ^equinix\.fabric\.(connection|port|metro)\..+ type: string + pattern: ^equinix\.fabric\.(connection|port|metro)\..+ examples: connectionRxUsageExample: value: equinix.fabric.connection.bandwidth_rx.usage @@ -465,72 +1407,170 @@ paths: description: Start date and time required: false schema: - $ref: "#/components/schemas/StartDateTime" + $ref: '#/components/schemas/StartDateTime' - name: toDateTime in: query description: End date and time required: false schema: - $ref: "#/components/schemas/EndDateTime" + $ref: '#/components/schemas/EndDateTime' - name: offset in: query description: offset required: false schema: - $ref: "#/components/schemas/Offset" + $ref: '#/components/schemas/Offset' - name: limit in: query description: limit required: false schema: - $ref: "#/components/schemas/Limit_1" + $ref: '#/components/schemas/Limit-2' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetMetricsByAssetResponse" + $ref: '#/components/schemas/GetMetricsByAssetResponse' examples: Example: - $ref: "#/components/examples/get-metrics-by-asset-id" - "401": + value: + pagination: + offset: 0 + limit: 10 + total: 2 + next: null + previous: null + data: + - type: GAUGE + name: equinix.fabric.port.bandwidth_rx.usage + unit: bit/s + interval: PT5M + resource: + href: https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72 + uuid: 0689734d-25c6-40d1-a9ff-3e4edea07a72 + type: XF_PORT + state: PROVISIONED + name: my-port-name + summary: + mean: 102.15384615384616 + max: 107 + datapoints: + - endDateTime: '2025-05-14T13:57:56.000Z' + value: 107 + - endDateTime: '2025-05-14T14:02:48.000Z' + value: 97 + - endDateTime: '2025-05-14T14:07:58.000Z' + value: 105 + - endDateTime: '2025-05-14T14:12:36.000Z' + value: 102 + - endDateTime: '2025-05-14T14:18:00.000Z' + value: 96 + - endDateTime: '2025-05-14T14:23:03.000Z' + value: 106 + - endDateTime: '2025-05-14T14:27:59.000Z' + value: 104 + - endDateTime: '2025-05-14T14:32:56.000Z' + value: 104 + - endDateTime: '2025-05-14T14:37:51.000Z' + value: 103 + - endDateTime: '2025-05-14T14:42:59.000Z' + value: 100 + - endDateTime: '2025-05-14T14:47:58.000Z' + value: 105 + - endDateTime: '2025-05-14T14:53:08.000Z' + value: 94 + - endDateTime: '2025-05-14T14:57:46.000Z' + value: 105 + - type: GAUGE + name: equinix.fabric.port.bandwidth_tx.usage + unit: bit/s + interval: PT5M + resource: + href: https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72 + uuid: 0689734d-25c6-40d1-a9ff-3e4edea07a72 + summary: + mean: 255.92307692307693 + max: 295 + datapoints: + - endDateTime: '2025-05-14T13:57:56.000Z' + value: 259 + - endDateTime: '2025-05-14T14:02:48.000Z' + value: 234 + - endDateTime: '2025-05-14T14:07:58.000Z' + value: 242 + - endDateTime: '2025-05-14T14:12:36.000Z' + value: 280 + - endDateTime: '2025-05-14T14:18:00.000Z' + value: 243 + - endDateTime: '2025-05-14T14:23:03.000Z' + value: 262 + - endDateTime: '2025-05-14T14:27:59.000Z' + value: 247 + - endDateTime: '2025-05-14T14:32:56.000Z' + value: 295 + - endDateTime: '2025-05-14T14:37:51.000Z' + value: 284 + - endDateTime: '2025-05-14T14:42:59.000Z' + value: 227 + - endDateTime: '2025-05-14T14:47:58.000Z' + value: 260 + - endDateTime: '2025-05-14T14:53:08.000Z' + value: 251 + - endDateTime: '2025-05-14T14:57:46.000Z' + value: 243 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: uuid not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: uuid not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - deprecated: true + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/metrics: get: tags: @@ -547,8 +1587,8 @@ paths: - `equinix.fabric.metro.*.jitter_avg` required: true schema: - pattern: ^equinix\.fabric\.metro\.\*\..+ type: string + pattern: ^equinix\.fabric\.metro\.\*\..+ examples: metroLatencyExample: value: equinix.fabric.metro.*.latency @@ -559,65 +1599,115 @@ paths: description: value required: true schema: - $ref: "#/components/schemas/Value" + $ref: '#/components/schemas/Value' - name: offset in: query description: offset required: false schema: - $ref: "#/components/schemas/Offset" + $ref: '#/components/schemas/Offset' - name: limit in: query description: limit required: false schema: - $ref: "#/components/schemas/Limit_1" + $ref: '#/components/schemas/Limit-2' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetMetricsByNameResponse" + $ref: '#/components/schemas/GetMetricsByNameResponse' examples: Example: - $ref: "#/components/examples/get-metrics-by-name" - "401": + value: + pagination: + offset: 0 + limit: 5000 + total: 3 + data: + - type: GAUGE + name: equinix.fabric.metro.at_am.latency + unit: ms + resource: + href: https://uatapi.equinix.com/fabric/v4/metros/AT + type: XF_METRO + description: Atlanta to Amsterdam intermetro latency, average in milliseconds + datapoints: + - endDateTime: '2026-02-03T23:05:04Z' + value: 94.8 + - type: GAUGE + name: equinix.fabric.metro.at_ba.latency + unit: ms + resource: + href: https://uatapi.equinix.com/fabric/v4/metros/AT + type: XF_METRO + description: Atlanta to Barcelona intermetro latency, average in milliseconds + datapoints: + - endDateTime: '2026-02-03T23:05:04Z' + value: 111 + - type: GAUGE + name: equinix.fabric.metro.at_bg.latency + unit: ms + resource: + href: https://uatapi.equinix.com/fabric/v4/metros/AT + type: XF_METRO + description: Atlanta to Bogota intermetro latency, average in milliseconds + datapoints: + - endDateTime: '2026-02-03T23:05:04Z' + value: 69.8 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: uuid not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: uuid not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/metrics/search: post: tags: @@ -625,62 +1715,181 @@ paths: summary: Search Metrics description: This API provides capability to search metrics from a filtered query operationId: searchMetrics - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/MetricsSearchRequest" + $ref: '#/components/schemas/MetricsSearchRequest' examples: MetricSearchRequestExample: - $ref: "#/components/examples/search-metrics" + value: + filter: + and: + - property: /subject + operator: '=' + values: + - /fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + - property: /name + operator: IN + values: + - equinix.fabric.port.bandwidth_rx.usage + - equinix.fabric.port.bandwidth_tx.usage + - equinix.fabric.port.packets_dropped_rx.count + - equinix.fabric.port.packets_dropped_tx.count + - property: /dataPoints/endDateTime + operator: BETWEEN + values: + - '2025-09-01T19:19:50Z' + - '2025-09-03T19:19:50Z' + pagination: + offset: 0 + limit: 10 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetMetricsByAssetResponse" + $ref: '#/components/schemas/GetMetricsByAssetResponse' examples: Example: - $ref: "#/components/examples/get-metrics-by-asset-id" - "401": + value: + pagination: + offset: 0 + limit: 10 + total: 2 + next: null + previous: null + data: + - type: GAUGE + name: equinix.fabric.port.bandwidth_rx.usage + unit: bit/s + interval: PT5M + resource: + href: https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72 + uuid: 0689734d-25c6-40d1-a9ff-3e4edea07a72 + type: XF_PORT + state: PROVISIONED + name: my-port-name + summary: + mean: 102.15384615384616 + max: 107 + datapoints: + - endDateTime: '2025-05-14T13:57:56.000Z' + value: 107 + - endDateTime: '2025-05-14T14:02:48.000Z' + value: 97 + - endDateTime: '2025-05-14T14:07:58.000Z' + value: 105 + - endDateTime: '2025-05-14T14:12:36.000Z' + value: 102 + - endDateTime: '2025-05-14T14:18:00.000Z' + value: 96 + - endDateTime: '2025-05-14T14:23:03.000Z' + value: 106 + - endDateTime: '2025-05-14T14:27:59.000Z' + value: 104 + - endDateTime: '2025-05-14T14:32:56.000Z' + value: 104 + - endDateTime: '2025-05-14T14:37:51.000Z' + value: 103 + - endDateTime: '2025-05-14T14:42:59.000Z' + value: 100 + - endDateTime: '2025-05-14T14:47:58.000Z' + value: 105 + - endDateTime: '2025-05-14T14:53:08.000Z' + value: 94 + - endDateTime: '2025-05-14T14:57:46.000Z' + value: 105 + - type: GAUGE + name: equinix.fabric.port.bandwidth_tx.usage + unit: bit/s + interval: PT5M + resource: + href: https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72 + uuid: 0689734d-25c6-40d1-a9ff-3e4edea07a72 + summary: + mean: 255.92307692307693 + max: 295 + datapoints: + - endDateTime: '2025-05-14T13:57:56.000Z' + value: 259 + - endDateTime: '2025-05-14T14:02:48.000Z' + value: 234 + - endDateTime: '2025-05-14T14:07:58.000Z' + value: 242 + - endDateTime: '2025-05-14T14:12:36.000Z' + value: 280 + - endDateTime: '2025-05-14T14:18:00.000Z' + value: 243 + - endDateTime: '2025-05-14T14:23:03.000Z' + value: 262 + - endDateTime: '2025-05-14T14:27:59.000Z' + value: 247 + - endDateTime: '2025-05-14T14:32:56.000Z' + value: 295 + - endDateTime: '2025-05-14T14:37:51.000Z' + value: 284 + - endDateTime: '2025-05-14T14:42:59.000Z' + value: 227 + - endDateTime: '2025-05-14T14:47:58.000Z' + value: 260 + - endDateTime: '2025-05-14T14:53:08.000Z' + value: 251 + - endDateTime: '2025-05-14T14:57:46.000Z' + value: 243 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: uuid not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: uuid not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/connections: post: tags: @@ -700,336 +1909,5234 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ConnectionPostRequest" + $ref: '#/components/schemas/ConnectionPostRequest' examples: Colo2Colo-Dot1q2Dot1q: - $ref: "#/components/examples/COLO2COLO-Dot1q2Dot1q" + value: + type: EVPL_VC + name: My-Port-2-Port-Connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a8ba52de-faae-43b5-b0b1-6904d37ee063 + linkProtocol: + type: DOT1Q + vlanTag: 1001 + zSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Colo-Dot1q2Dot1q-WithTerms: - $ref: "#/components/examples/COLO2COLO-Dot1q2Dot1q-withTerms" + value: + type: EVPL_VC + name: My-Port-2-Port-Connection-1 + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 24 + aSide: + accessPoint: + type: COLO + port: + uuid: a8ba52de-faae-43b5-b0b1-6904d37ee063 + linkProtocol: + type: DOT1Q + vlanTag: 1001 + zSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Colo-Dot1q2Dot1q-WithGeoScope: - $ref: "#/components/examples/COLO2COLO-Dot1q2Dot1q-withGeoScope" + value: + type: EVPL_VC + name: My-Port-2-Port-Connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a867f685-41b0-1b07-6de0-320a5c00abdd + linkProtocol: + type: DOT1Q + vlanTag: 1001 + zSide: + accessPoint: + type: COLO + port: + uuid: b067f685-49b0-1a09-6fe0-360a5d00afdd + linkProtocol: + type: DOT1Q + vlanTag: 1001 + geoScope: CONUS + project: + projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 + notifications: + - type: ALL + emails: + - test@test.com Colo2Colo-Dot1q2Qinq: - $ref: "#/components/examples/COLO2COLO-Dot1Q2QinQ" + value: + type: EVPL_VC + name: My-Port-2-Port-Connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + zSide: + accessPoint: + type: COLO + port: + uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c + linkProtocol: + type: QINQ + vlanSTag: 1001 + vlanCTag: 1002 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Colo-Qinq2Qinq: - $ref: "#/components/examples/COLO2COLO-Qinq2Qinq" + value: + type: EVPL_VC + name: My-Port-2-Port-Connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: QINQ + vlanSTag: 12 + zSide: + accessPoint: + type: COLO + port: + uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c + linkProtocol: + type: QINQ + vlanSTag: 13 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Colo-Qinq2Dot1q: - $ref: "#/components/examples/COLO2COLO-Qinq2Dot1q" + value: + type: EVPL_VC + name: My-Port-2-Port-Connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: QINQ + vlanSTag: 1001 + vlanCTag: 1125 + zSide: + accessPoint: + type: COLO + port: + uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c + linkProtocol: + type: DOT1Q + vlanTag: 1001 + notifications: + - type: ALL + emails: + - test@test.com Colo2Colo-AsResellerForSubCustomer: - $ref: "#/components/examples/COLO2COLO-AsReseller" + value: + type: EVPL_VC + name: Conn-1 + order: + purchaseOrderNumber: 1-129105284100 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Colo2Colo-MetroConnect: - $ref: "#/components/examples/COLO2COLO-MetroConnect" + value: + type: MC_VC + name: metro-connect-P2P + bandwidth: 1000 + 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: - $ref: "#/components/examples/COLO2COLO-EPL" + value: + type: EPL_VC + name: My-Port-2-Port-Connection-1 + order: + purchaseOrderNumber: po1234 + termLength: 1 + bandwidth: 100 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + zSide: + accessPoint: + type: COLO + port: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Colo2Colo-AccessEpl: - $ref: "#/components/examples/COLO2COLO-AccessEpl" + value: + type: ACCESS_EPL_VC + name: My-Port-2-Port-Connection-1 + order: + purchaseOrderNumber: 1-129105284100 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Colo2Sp-Generic: - $ref: "#/components/examples/COLO2SPwithDot1q" + value: + type: EVPL_VC + name: My-Layer2-Connection-3 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c + location: + metroCode: DC + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Sp-Generic-WithGeoScope: - $ref: "#/components/examples/COLO2SPwithGeoScope" + value: + type: EVPL_VC + name: My-Port-2-GenSP-Conn-1 + bandwidth: 50 + redundancy: + priority: PRIMARY + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: c4d93b39-034e-34ec-ace0-30fa5c00ad01 + linkProtocol: + type: DOT1Q + vlanTag: 23 + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: 5a76497a-ff00-4a89-a605-b0680799c6aa + location: + metroCode: DC + geoScope: CONUS + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric_user@equinix.com Colo2Sp-NetworkEdgeGeneric: - $ref: "#/components/examples/COLO2SPwithDot1q" + value: + type: EVPL_VC + name: My-Layer2-Connection-3 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c + location: + metroCode: DC + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Sp-Non-Generic-WithGeoScope: - $ref: "#/components/examples/COLO2SPNonGenwithGeoScope" + value: + type: EVPL_VC + name: My-Port-2-NonGenSP-Conn-1 + bandwidth: 100 + redundancy: + priority: PRIMARY + order: + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: c4d93b39-0341-341c-ace0-30fa5c00ad01 + linkProtocol: + type: QINQ + vlanSTag: 23 + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: bfb74121-7e2c-4f74-99b3-69cdafb03b41 + location: + metroCode: SV + authenticationKey: xxxx-xxx-xxxx + geoScope: CONUS + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric_user@equinix.com Colo2Sp-Alibaba: - $ref: "#/components/examples/COLO2AlibabaSPwithDot1q" + value: + type: EVPL_VC + name: port2alibaba-connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Sp-Aws-Primary: - $ref: "#/components/examples/COLO2AWSSPwithDot1q-Primary" + value: + type: EVPL_VC + name: Primary-Aws + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + redundancy: + priority: PRIMARY + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Sp-Azure-Primary: - $ref: "#/components/examples/COLO2AzureSP-Primary" + value: + type: EVPL_VC + name: port2azure-connection-1 + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: d166b9ce-79ed-4ea6-8f8b-785fd69f3dcc + linkProtocol: + type: DOT1Q + vlanTag: 123 + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: a1390b22-abe0-4e93-ad37-85beef9d254a + location: + metroCode: DC + peeringType: PRIVATE + authenticationKey: xxx-xxx-xxx + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2Sp-LMaaS-Primary: - $ref: "#/components/examples/COLO2LMaaSSP" + value: + type: EVPL_VC + name: Last Mile Connection 1 + bandwidth: 10 + redundancy: + priority: PRIMARY + order: + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: d4db1048-ef3d-f3d6-49e0-306a5c00a341 + linkProtocol: + type: QINQ + vlanSTag: 121 + vlanCTag: 145 + zSide: + accessPoint: + type: SP + profile: + uuid: 8236fbb9-51e5-428f-86bf-6b67e1223ac1 + location: + metroCode: DC + productOffering: + id: sample-product-offering-id + name: Sample product offering 1 + billingTerm: 12 + bandwidthCommit: 50 + address: + id: lmaas-addr-sample-id + streetNr: '1234' + streetName: Main St + city: San Jose + stateOrProvince: CA + postCode: '95101' + country: United States + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - someone@sample.com + - type: ORDERING + emails: + - someone@sample.com + phone: + - type: OFFICE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: MOBILE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: TECHNICAL + emails: + - someone@sample.com + phone: + - type: OFFICE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: MOBILE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME Colo2Sp-Google: - $ref: "#/components/examples/COLO2GoogleSPwithDot1q" + value: + type: EVPL_VC + name: My-Layer2-Connection-3 + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@test.com Colo2Sp-Ibm_1.0: - $ref: "#/components/examples/COLO2IBM_1" + value: + type: EVPL_VC + name: My-Layer2-Connection-3 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com + additionalInfo: + - key: ASN + value: '1234' + - key: Global + value: 'false' Colo2Sp-Ibm_2.0: - $ref: "#/components/examples/COLO2IBM_2" + value: + type: EVPL_VC + name: My-Layer2-Connection-3 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + 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 Colo2Sp-Oracle: - $ref: "#/components/examples/COLO2OracleSPwithDot1q" + value: + type: EVPL_VC + name: My-Layer2-Connection-3 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + linkProtocol: + type: DOT1Q + vlanTag: 1001 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Colo2ServiceToken: - $ref: "#/components/examples/COLO2ServiceToken" + value: + type: EVPL_VC + name: Conn-1 + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + location: + metroCode: SV + zSide: + serviceToken: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Colo2Network-EVPLAN_VC: - $ref: "#/components/examples/COLO2NETWORKwithDot1q" + value: + type: EVPLAN_VC + name: colo2network-evplan-vc + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Colo2Network-EPLAN_VC: - $ref: "#/components/examples/COLO2NETWORKwithEPL" + value: + type: EPLAN_VC + name: colo2network-eplan-vc + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 + zSide: + accessPoint: + type: NETWORK + network: + uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Colo2Network-EVPTREE_VC: - $ref: "#/components/examples/COLO2NETWORK_EVPTREE_withDot1q" + value: + type: EVPTREE_VC + name: colo2network-evptree-vc + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + role: LEAF + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Colo2Network-EPTREE_VC: - $ref: "#/components/examples/COLO2NETWORK_EPTREE_withEPL" + value: + type: EPTREE_VC + name: colo2network-eptree-vc + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: COLO + port: + uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 + zSide: + accessPoint: + type: NETWORK + network: + uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 + role: LEAF + project: + projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 + notifications: + - type: ALL + emails: + - fabric@equinix.com Vd2Network: - $ref: "#/components/examples/Vd2NETWORK" + value: + type: EVPLAN_VC + name: MY-EVPLAN-CONNECTION-1 + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: VD + virtualDevice: + type: EDGE + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + type: NETWORK + id: 3 + zSide: + accessPoint: + type: NETWORK + network: + uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 + project: + projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Vd2Sp-Aws: - $ref: "#/components/examples/Vd2AwsSP" + value: + type: EVPL_VC + name: vd2aws-connection-1 + bandwidth: 50 + order: + purchaseOrderNumber: 1-1234567890 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Vd2Sp-Azure: - $ref: "#/components/examples/Vd2AzureSP" + value: + type: EVPL_VC + name: vd2azure-connection-1 + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Vd2Sp-Oracle: - $ref: "#/components/examples/Vd2OracleSP" + value: + type: EVPL_VC + name: vd2oracle-connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 24 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Vd2Sp-IBM_1.0: - $ref: "#/components/examples/Vd2Ibm_1" + value: + type: EVPL_VC + name: vd2ibm10-connection-1 + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Vd2Sp-IBM_2.0: - $ref: "#/components/examples/Vd2Ibm_2" + value: + type: EVPL_VC + name: vd2ibm20-connection-1 + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Vd2Sp-Alibaba: - $ref: "#/components/examples/Vd2AlibabaSP" + value: + type: EVPL_VC + name: vd2alibaba-connection-1 + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - fabric@equinix.com Vd2Sp-Google: - $ref: "#/components/examples/Vd2GoogleSP" + value: + type: EVPL_VC + name: vd2googleSp-connection-1 + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 24 + 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 + notifications: + - type: ALL + emails: + - fabric@equinx.com Vd2Sp-Primary: - $ref: "#/components/examples/Vd2Sp-Primary" + value: + type: EVPL_VC + name: Network Device to SP + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + redundancy: + priority: PRIMARY + aSide: + accessPoint: + type: VD + virtualDevice: + type: EDGE + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + type: NETWORK + id: 3 + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 + authenticationKey: xx-xx-xx + sellerRegion: us-west-1 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Vd2Sp-Secondary: - $ref: "#/components/examples/Vd2Sp-Secondary" + value: + type: EVPL_VC + name: Network Device to SP + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: 3 + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 + authenticationKey: xx-xx-xx + sellerRegion: us-west-1 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Vd2Colo: - $ref: "#/components/examples/Vd2Colo" + value: + type: EVPL_VC + name: vd to COLO + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 24 + aSide: + accessPoint: + type: VD + virtualDevice: + type: EDGE + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + type: NETWORK + id: 3 + zSide: + accessPoint: + type: COLO + port: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + linkProtocol: + type: DOT1Q + vlanTag: 300 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Vd2Colo-WithGeoScope: - $ref: "#/components/examples/VD2COLO-Dot1q-withGeoScope" + value: + type: EVPL_VC + name: My-VD-2-COLO-Connection-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: VD + virtualDevice: + uuid: a867f685-41b0-1b07-6de0-320a5c00abdd + interface: + type: NETWORK + id: 1 + location: + metroCode: FR + zSide: + accessPoint: + type: COLO + port: + uuid: b067f685-49b0-1a09-6fe0-360a5d00afd0 + linkProtocol: + type: DOT1Q + vlanTag: 1001 + location: + metroCode: AM + geoScope: EU + project: + projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 + notifications: + - type: ALL + emails: + - test@test.com Vd2Colo-vlanTag: - $ref: "#/components/examples/Vd2Colo-VlanTag" + value: + type: EVPL_VC + name: vd to COLO + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: VD + virtualDevice: + type: EDGE + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + type: NETWORK + id: 3 + zSide: + accessPoint: + type: COLO + port: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + linkProtocol: + type: DOT1Q + vlanTagMin: 300 + vlanTagMax: 1099 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Vd2Colo-vlanCTag: - $ref: "#/components/examples/Vd2Colo-VlanCTag" + value: + type: EVPL_VC + name: vd to COLO + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: VD + virtualDevice: + type: EDGE + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + type: NETWORK + id: 3 + zSide: + accessPoint: + type: COLO + port: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + linkProtocol: + type: QINQ + vlanCTag: 300 + vlanSTag: 301 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Vd2ColoUntagged: - $ref: "#/components/examples/Vd2ColoUntagged" + value: + type: EVPL_VC + name: vd to SP + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: VD + virtualDevice: + type: EDGE + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + type: NETWORK + id: 3 + zSide: + accessPoint: + type: COLO + port: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + linkProtocol: + type: UNTAGGED + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Vd2ServiceToken: - $ref: "#/components/examples/Vd2ServiceToken" + value: + type: EVPL_VC + name: vd2token-conn-1 + order: + purchaseOrderNumber: po1234 + termLength: 1 + bandwidth: 10 + redundancy: + priority: PRIMARY + aSide: + accessPoint: + type: VD + virtualDevice: + type: EDGE + uuid: 207667ba-3211-452c-b0a8-8b9046e122a2 + zSide: + serviceToken: + uuid: 557411a5-16a6-4aef-beea-7f622e94f1e0 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcda Fcr2Colo: - $ref: "#/components/examples/Fcr2Colo" + value: + type: IP_VC + name: My-FCR-Connection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Google: - $ref: "#/components/examples/Fcr2Sp-Google" + value: + type: IP_VC + name: My-FCR-GCPConnection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Azure: - $ref: "#/components/examples/Fcr2Sp-Azure" + value: + type: IP_VC + name: My-FCR-AzureConnection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-IBM: - $ref: "#/components/examples/Fcr2Sp-IBM" + value: + type: IP_VC + name: My-FCR-IBMConnection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: CLOUD_ROUTER + router: + uuid: 66a21614-1c4a-11ec-9621-0242ac130002 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com + additionalInfo: + - key: Global + value: 'false' + - key: IBM IPv4 CIDR + value: 172.16.0.18/30 + - key: CER IPv4 CIDR + value: 172.16.0.19/30 Fcr2Sp-Generic: - $ref: "#/components/examples/Fcr2Sp-Generic" + value: + type: IP_VC + name: My-FCR-GenericConnection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Generic-Redundant-Primary: - $ref: "#/components/examples/Fcr2Sp-Generic" + value: + type: IP_VC + name: My-FCR-GenericConnection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Generic-Redundant-Secondary: - $ref: "#/components/examples/Fcr2Sp-Generic-Redundant-Secondary" + value: + type: IP_VC + name: FCR_to_RedSP_Secondary + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Generic-Redundant-Primary-re-add: - $ref: "#/components/examples/Fcr2Sp-Generic-Redundant-Primary" + value: + type: IP_VC + name: FCR_to_RedSP_Primary-Re-add + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Aws: - $ref: "#/components/examples/Fcr2Sp-Aws" + value: + type: IP_VC + name: My-FCR-AWSConnection + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Oracle: - $ref: "#/components/examples/Fcr2Sp-Oracle" + value: + type: IP_VC + name: My-FCR-OracleConnection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com Fcr2Sp-Alibaba: - $ref: "#/components/examples/Fcr2Sp-Alibaba" + value: + type: IP_VC + name: My-FCR-AlibabaConnection + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + authenticationKey: xx-xx-xx + sellerRegion: us-west-1 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Vd: - $ref: "#/components/examples/Fcr2Vd" + value: + type: IP_VC + name: My-GW-VDConnection + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: 3 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Vd-Redundant-Secondary: - $ref: "#/components/examples/Fcr2Vd-Redundant-Secondary" + value: + type: IP_VC + name: My-GW-VDConnection-Secondary + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: 3 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2IpWan: - $ref: "#/components/examples/Fcr2IpWan" + value: + type: IPWAN_VC + name: MY-IPWAN-CONNECTION-1 + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: CLOUD_ROUTER + router: + uuid: 66a21614-1c4a-11ec-9621-0242ac130002 + zSide: + accessPoint: + type: NETWORK + network: + uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Sp-Aws-Marketplace-subscription: - $ref: "#/components/examples/Fcr2Sp-Aws-marketplaceSubscription" + value: + type: IP_VC + name: My-FCR-AWSConnection + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 Fcr2MetalNetwork: - $ref: "#/components/examples/Fcr2Metal-Network" + value: + type: IP_VC + name: My-FCR-MetalNetwork-Connection + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2ServiceToken: - $ref: "#/components/examples/Fcr2ServiceToken" + value: + type: IP_VC + name: My-FCR-Connection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: CLOUD_ROUTER + router: + uuid: 66a21614-1c4a-11ec-9621-0242ac130002 + location: + metroCode: SV + zSide: + serviceToken: + uuid: 4cc30499-d472-4edb-9114-1381ed17e356 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com AsideServiceToken2ColoWithDot1q: - $ref: "#/components/examples/AsideServiceToken2PortWithDot1q" + value: + type: EVPL_VC + name: Aside-token + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com AsideServiceToken2ColoWithQinq: - $ref: "#/components/examples/AsideServiceToken2PortWithQinq" + value: + type: EVPL_VC + name: Aside-Token + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com AsideServiceToken2PrivateSP-NE: - $ref: "#/components/examples/AsideServiceToken2PrivateSP-NE" + value: + type: EVPL_VC + name: Token2PrivateSP-NE + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + serviceToken: + uuid: 41a9e1ef-18bb-485b-a9b3-99801ac03684 + zSide: + accessPoint: + type: SP + profile: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 + location: + metroCode: SV + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com AsideServiceToken2ZsideServiceToken: - $ref: "#/components/examples/AsideServiceToken2ZsideServiceToken" + value: + type: EVPL_VC + name: Aside to zside token connection + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + serviceToken: + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + zSide: + serviceToken: + uuid: 4f9c5438-90eb-4295-b109-7754119a1e8d + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Metal2Sp-Aws: - $ref: "#/components/examples/Metal2Sp-Aws" + value: + type: EVPL_VC + name: My-Metal-sp-connection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com Metal2Sp-Azure: - $ref: "#/components/examples/Metal2Sp-Azure" + value: + type: EVPL_VC + name: Metal2Azure Connection + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: 16799d66-ef43-445c-ba29-d17522d8a137 + notifications: + - type: ALL + emails: + - eqxfabricamcrh@gmail.com Metal2Sp-GCP: - $ref: "#/components/examples/Metal2Sp-GCP" + value: + type: EVPL_VC + name: Metal2GCP-Connection + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com Metal2Sp-Oracle: - $ref: "#/components/examples/Metal2Sp-Oracle" + value: + type: EVPL_VC + name: Metal2Oracle-Connection + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: 16799d66-ef43-445c-ba29-d17522d8a137 + notifications: + - type: ALL + emails: + - test@gmail.com Metal2Sp-IBM: - $ref: "#/components/examples/Metal2Sp-IBM" + value: + type: EVPL_VC + name: Metal2IBM-Connection + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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' + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com Metal2Port-Dot1Q: - $ref: "#/components/examples/Metal2Port-Dot1q" + value: + type: EVPL_VC + name: Metal2Port-dot1q + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: METAL_NETWORK + authenticationKey: xxxxxxxxx + zSide: + accessPoint: + type: COLO + port: + uuid: 6c73d02c-87e1-4642-8e18-01eb4b87e243 + linkProtocol: + type: DOT1Q + vlanTag: 128 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com Metal2Port-QinQ: - $ref: "#/components/examples/Metal2Port-Qinq" + value: + type: EVPL_VC + name: Metal2Port-qinq + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com Metal2Port-ZsideServiceToken: - $ref: "#/components/examples/Metal2ServiceToken" + value: + type: EVPL_VC + name: Metal2ServiceToken + bandwidth: 100 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: METAL_NETWORK + authenticationKey: xxxxxxxxx + zSide: + serviceToken: + uuid: bc1383be-579a-4d75-ae19-b0d487bbff90 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com Metal2Sp-Generic: - $ref: "#/components/examples/Metal2Sp-Generic" + value: + type: EVPL_VC + name: Metal2Generic + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: METAL_NETWORK + authenticationKey: xxxxxxxxx + zSide: + accessPoint: + type: SP + profile: + type: L2_PROFILE + uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c + location: + metroCode: DC + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@test.com Vd2IASp: - $ref: "#/components/examples/Vd2IAProfile-Request" + value: + type: IA_VC + name: Network Device to IA SP + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Fcr2Metal-Network: - $ref: "#/components/examples/Fcr2Metal-Network" + value: + type: IP_VC + name: My-FCR-MetalNetwork-Connection + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Connection-Colo2Sp-GenericDryRunCreate: - $ref: "#/components/examples/CreateConnectionDryRunRequest" + value: + type: EVPL_VC + name: My-EVPL-Connection + bandwidth: 500 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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 + notifications: + - type: ALL + emails: + - test@test.com IX2Sp-PublicPeering_VC: - $ref: "#/components/examples/IXDedicatedPublicPeeringConnection" + value: + type: IX_VC + name: Virtual-Connection-1 + bandwidth: 1000 + aSide: + accessPoint: + type: COLO + port: + uuid: 99e83e59-fd26-4134-b1b3-4c5dea6924d6 + zSide: + accessPoint: + type: SP + profile: + uuid: 0f6bdb36-e130-4924-b038-ee1785fad166 + notifications: + - type: ALL + emails: + - test@test.com + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Connection" + $ref: '#/components/schemas/Connection' examples: ConnectionDryRun-Colo2AWS: - $ref: "#/components/examples/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 ConnectionDryRun-Colo2Azure: - $ref: "#/components/examples/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 ConnectionDryRun-Colo2Google: - $ref: "#/components/examples/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 ConnectionDryRun-Colo2IBM: - $ref: "#/components/examples/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 ConnectionDryRun-Colo2Network-EPLAN_VC: - $ref: "#/components/examples/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 ConnectionDryRun-Colo2Network-EVPLAN_VC: - $ref: "#/components/examples/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 ConnectionDryRun-Colo2Sp-Generic: - $ref: "#/components/examples/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 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: + 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 + ConnectionDryRun-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 + ConnectionDryRun-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 + ConnectionDryRun-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 + '201': + description: Accept Connection Request + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' + examples: Colo2Colo-withTerms: - $ref: "#/components/examples/COLO2COLO-Dot1q2Dot1q-withTerms-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/6c157170-f84d-424a-9396-b5d6ee723296 + type: EVPL_VC + uuid: 6c157170-f84d-424a-9396-b5d6ee723296 + name: My-Port-2-Port-Connection-1 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: po1234 + billingTier: Up to 100 MB + termLength: 24 + contractedBandwidth: 100 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + changeLog: + createdBy: fabric_user + createdDateTime: '2026-04-11T19:26:58.847Z' + updatedBy: fabric_user + updatedDateTime: '2026-04-11T19:26:58.847Z' + bandwidth: 10 + redundancy: + group: d630b469-2322-481b-9c32-d04a35ca7a60 + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033a-33ac-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033a-33ac-ace0-30fa5c00ad01 + name: port-001-NK-709 + linkProtocol: + type: DOT1Q + vlanTag: 23 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DA + metroCode: DA + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-0348-348c-ace0-30fa5c00ad04 + type: XF_PORT + uuid: c4d93b39-0348-348c-ace0-30fa5c00ad09 + name: port-001-NK-710 + linkProtocol: + type: DOT1Q + vlanTag: 24 Colo2Colo-withGeoScope: - $ref: "#/components/examples/COLO2COLO-Dot1q2Dot1q-withGeoScope-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/3656347c-4ed2-4d13-8907-f4238b8a057a + type: EVPL_VC + uuid: 3656347c-4ed2-4d13-8907-f4238b8a057a + name: My-Port-2-Port-Connection-1 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + changeLog: + createdBy: fabric_user + createdDateTime: '2026-04-11T19:42:50.774Z' + updatedBy: fabric_user + updatedDateTime: '2026-04-11T19:42:50.774Z' + bandwidth: 50 + geoScope: CONUS + redundancy: + group: 6e26930e-9fbb-449e-b9eb-cd98c97725er + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033b-33bc-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033b-33bc-ace0-30fa5c00ad01 + name: reg-001-CH2-JUN-698 + linkProtocol: + type: DOT1Q + vlanTag: 39 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033a-33ac-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033a-33ac-ace0-30fa5c00ad01 + name: reg-001-CH2-JUN-694 + linkProtocol: + type: DOT1Q + vlanTag: 40 Colo2Sp: - $ref: "#/components/examples/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' Colo2Sp-Generic-withGeoScope: - $ref: "#/components/examples/COLO2SPwithGeoScope-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/0bbd1d06-35df-47b7-b358-2f435cecb198 + type: EVPL_VC + uuid: 0bbd1d06-35df-47b7-b358-2f435cecb198 + name: My-Port-2-GenSP-Conn-1 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PENDING_APPROVAL + order: + billingTier: Up to 10 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + changeLog: + createdBy: fabric_user + createdDateTime: '2026-05-11T20:23:48.480Z' + updatedBy: fabric_user + updatedDateTime: '2026-05-11T20:23:48.480Z' + bandwidth: 10 + geoScope: CONUS + redundancy: + group: b19a678b-bcf7-428f-963b-55ea07eb1ef7 + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033a-83ac-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033a-83ac-ace0-30fa5c00ad01 + name: reg-001-JUN-691 + linkProtocol: + type: DOT1Q + vlanTag: 37 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + metroCode: DC + profile: + href: https://api.equinix.com/fabric/v4/serviceProfiles/5a76497a-ff00-4a89-a605-b0680799c6aa + type: L2_PROFILE + name: Fabric_L2_SP + uuid: 5a76497a-ff00-4a89-a605-b0680799c6aa Colo2Sp-Non-Generic-withGeoScope: - $ref: "#/components/examples/COLO2SPNonGenwithGeoScope-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/360a076f-0d2f-454c-b227-c5e6f48920ea + type: EVPL_VC + uuid: 360a076f-0d2f-454c-b227-c5e6f48920ea + name: My-Port-2-NonGenSP-Conn-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + billingTier: Up to 1G + termLength: 1 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + changeLog: + createdBy: fabric_user + createdDateTime: '2026-04-11T20:07:16.611Z' + updatedBy: fabric_user + updatedDateTime: '2026-04-11T20:07:16.611Z' + bandwidth: 1000 + geoScope: CONUS + redundancy: + group: 27d24507-3222-4654-9b97-ce16c8313b01 + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-0341-341c-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-0341-341c-ace0-30fa5c00ad01 + name: reg-001-JUN-703 + linkProtocol: + type: QINQ + vlanSTag: 23 + vlanCTag: 24 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SV + metroCode: SV + profile: + href: https://api.equinix.com/fabric/v4/serviceProfiles/bfb74121-7e2c-4f74-99b3-69cdafb03b41 + type: L2_PROFILE + name: Azure Express Route + uuid: bfb74121-7e2c-4f74-99b3-69cdafb03b12 + authenticationKey: xxxx-xxx-xxxx Colo2Colo-MetroConnect: - $ref: "#/components/examples/COLO2COLO-MetroConnect-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 + type: MC_VC + uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 + name: metro-connect-P2P + bandwidth: 1000 + 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: UNTAGGED + location: + metroCode: ME + zSide: + accessPoint: + type: COLO + port: + href: https://api.equinix.com/fabric/v4/ports/20d32a80-0d61-4333-bc03-707b591ae2f4 + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + linkProtocol: + type: UNTAGGED + location: + metroCode: ME + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + changeLog: + createdDateTime: '2020-05-21T10:30:00Z' + project: + projectId: 37c8212c-c393-465c-8267-09d28c49774c Colo2Sp-Azure-Primary: - $ref: "#/components/examples/COLO2AzureSP-Primary-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/5901c429-cd23-4149-b1cc-5f1b10cc5041 + type: EVPL_VC + uuid: 5901c429-cd23-4149-b1cc-5f1b10cc5041 + name: port2azure-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabricuser + createdDateTime: '2026-03-10T02:26:31.546Z' + updatedBy: fabricuser + updatedDateTime: '2026-03-10T02:26:31.546Z' + bandwidth: 100 + redundancy: + group: ce76ec16-5857-4472-9067-2fa3d7a9f52q + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DA + metroCode: DA + port: + href: https://api.equinix.com/fabric/v4/ports/d966b9ce-79ed-4ea6-8f8a-785fd69f3dcb + type: XF_PORT + uuid: d966b9ce-79ed-4ea6-8f8a-785fd69f3dcb + name: 1-DA1-CX-PRI-012345 + linkProtocol: + type: DOT1Q + vlanTag: 123 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + metroCode: DC + profile: + href: https://api.equinix.com/fabric/v4/serviceProfiles/a1390b22-bbe0-4e93-ad37-85beef9d254a + type: L2_PROFILE + name: Azure ExpressRoute + uuid: a1390b22-bbe0-4e93-ad37-85beef9d254a + authenticationKey: xxxx-xxx-xxxx Colo2Sp-LMaaS-Primary: - $ref: "#/components/examples/COLO2LMaaSSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/8236fbb9-51e5-428f-86bf-6b67e1223ac1 + uuid: 8236fbb9-51e5-428f-86bf-6b67e1223ac1 + type: EVPL_VC + name: Last Mile Connection 1 + bandwidth: 10 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PENDING_APPROVAL + redundancy: + group: d4db1048-ef3d-f3d6-49e0-306a5c00a341 + priority: PRIMARY + order: + billingTier: Up to 10 MB + termLength: 1 + aSide: + accessPoint: + location: + metroCode: DC + port: + href: https://api.equinix.com/fabric/v4/ports/c4d9350e-780f-80fd-1ce0-306a5c00a600 + type: XF_PORT + uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 + name: Sample Port DC + linkProtocol: + type: QINQ + vlanSTag: 121 + vlanCTag: 145 + zSide: + accessPoint: + location: + metroCode: DC + profile: + href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 + uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 + type: LMAAS_PROFILE + name: Last Mile Service Profile 1 + productOffering: + id: sample-product-offering-id + name: Sample product offering 1 + billingTerm: 12 + bandwidthCommit: 50 + address: + id: lmaas-addr-sample-id + streetNr: '1234' + streetName: Main St + city: San Jose + stateOrProvince: CA + postCode: '95101' + country: United States + notifications: + - type: ALL + emails: + - someone@sample.com + - type: ORDERING + emails: + - someone@sample.com + phone: + - type: OFFICE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: MOBILE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: TECHNICAL + emails: + - someone@sample.com + phone: + - type: OFFICE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: MOBILE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + changeLog: + createdBy: sampleuser + createdByFullName: Sample User + createdByEmail: someone@sample.com + createdDateTime: '2026-01-01T00:00:00.000Z' + updatedBy: sampleuser + updatedByFullName: Sample User + updatedByEmail: someone@sample.com + updatedDateTime: '2026-01-01T00:00:00.000Z' Colo2Sp-Google: - $ref: "#/components/examples/COLO2GoogleSPwithDot1q-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/f662d4c4-fcd8-40ba-b95b-64fc7e0a61fb + type: EVPL_VC + uuid: f662d4c4-fcd8-40ba-b95b-64fc7e0a61fb + name: My-Layer2-Connection-3 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: po1234 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-25T14:25:30.509Z' + updatedBy: fabric + updatedDateTime: '2024-04-25T14:25:30.509Z' + bandwidth: 50 + redundancy: + group: 2673c07d-9bd3-43c2-9827-91e940d01a54 + priority: PRIMARY + aSide: + accessPoint: + location: + metroCode: DA + port: + href: https://api.equinix.com/fabric/v4/ports/33353aa1-18f2-4b32-94d6-59a12500f7e2 + type: XF_PORT + 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 Colo2Sp-Alibaba: - $ref: "#/components/examples/COLO2AlibabaSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/2c7bb68e-f560-41ac-9950-e62c87be191e + type: EVPL_VC + uuid: 2c7bb68e-f560-41ac-9950-e62c87be191e + name: port2alibaba-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + billingTier: Up to 50 MB + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-05-02T20:07:38.626Z' + updatedBy: fabric + updatedDateTime: '2024-05-02T20:07:38.626Z' + bandwidth: 50 + redundancy: + group: 6aafb605-f3e4-4380-a9c0-1eddf829bca0 + priority: PRIMARY + aSide: + accessPoint: + location: + metroCode: SV + port: + href: https://api.equinix.com/fabric/v4/ports/b54d71a6-aecb-40cc-b458-8a4103f5cdba + type: XF_PORT + 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 Colo2Sp-IBM_1.0: - $ref: "#/components/examples/COLO2IBM_1" + value: + href: https://api.equinix.com/fabric/v4/connections/eda6cc39-7e4c-4504-a715-3cdb8861cd6b + type: EVPL_VC + uuid: eda6cc39-7e4c-4504-a715-3cdb8861cd6b + name: port2ibm1-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-05-02T20:16:05.955Z' + updatedBy: fabric + updatedDateTime: '2024-05-02T20:16:05.955Z' + bandwidth: 50 + redundancy: + group: 7c730560-122b-4467-bcc3-54df733e4172 + priority: PRIMARY + aSide: + accessPoint: + location: + metroCode: SV + port: + href: https://api.equinix.com/fabric/v4/ports/b54d71a6-aecb-40cc-b458-8a4103f5cdba + type: XF_PORT + uuid: b54d71a6-aecb-40cc-b458-8a4103f5cdba + name: 641728-SV5-1 + linkProtocol: + type: DOT1Q + vlanTag: 1019 + zSide: + accessPoint: + location: + metroCode: DC + profile: + href: https://api.equinix.com/fabric/v4/serviceProfiles/45b446fa-d3b6-417a-b871-a5ee0efdc459 + type: L2_PROFILE + name: IBM Cloud Direct Link Exchange + uuid: 45b446fa-d3b6-417a-b871-a5ee0efdc459 + sellerRegion: Washington 2 + authenticationKey: xxxx-xxx-xxxx Colo2Sp-IBM_2.0: - $ref: "#/components/examples/COLO2IBM_2" + value: + href: https://api.equinix.com/fabric/v4/connections/3f394b6f-c8e3-4b9b-9b9b-2971a90add2e + type: EVPL_VC + uuid: 3f394b6f-c8e3-4b9b-9b9b-2971a90add2e + name: port2ibm2-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-05-02T20:18:47.194Z' + updatedBy: fabric + updatedDateTime: '2024-05-02T20:18:47.194Z' + bandwidth: 50 + redundancy: + group: c11ddf35-6e63-4b2f-a5e0-248ea56a7665 + priority: PRIMARY + aSide: + accessPoint: + location: + metroCode: SV + port: + href: https://api.equinix.com/fabric/v4/ports/b54d71a6-aecb-40cc-b458-8a4103f5cdba + type: XF_PORT + uuid: b54d71a6-aecb-40cc-b458-8a4103f5cdba + name: 641728-SV5-1 + linkProtocol: + type: DOT1Q + vlanTag: 1020 + zSide: + accessPoint: + location: + metroCode: SV + 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: San Jose 2 + authenticationKey: xxxx-xxx-xxxx Colo2Sp-Oracle: - $ref: "#/components/examples/COLO2OracleSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/6c157170-f84d-424a-9396-b5d6ee723296 + type: EVPL_VC + uuid: 6c157170-f84d-424a-9396-b5d6ee723296 + name: vd2oracle-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 1G + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-05-02T20:25:09.841Z' + updatedBy: fabric + updatedDateTime: '2024-05-02T20:25:09.841Z' + bandwidth: 1000 + redundancy: + group: e8400059-34e1-47f1-9914-cb5907ee7913 + priority: PRIMARY + aSide: + accessPoint: + location: + metroCode: SV + port: + href: https://api.equinix.com/fabric/v4/ports/b54d71a6-aecb-40cc-b458-8a4103f5cdba + type: XF_PORT + 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: - $ref: "#/components/examples/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 + termLength: 1 + 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' Vd2Token: - $ref: "#/components/examples/Vd2ServiceToken-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/e3bf3fa5-2b8f-4437-8171-688175240a1a + type: EVPL_VC + uuid: e3bf3fa5-2b8f-4437-8171-688175240a1a + name: vd2token-conn-1 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: po1234 + billingTier: Up to 10 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + changeLog: + createdBy: fabric_user + createdDateTime: '2026-04-11T20:49:02.630Z' + updatedBy: fabric_user + updatedDateTime: '2026-04-11T20:49:02.630Z' + bandwidth: 10 + redundancy: + group: 7c2b584c-f184-43ab-9626-52533a2cdb2a + priority: PRIMARY + aSide: + accessPoint: + interface: + uuid: 09918b27-0fb6-428e-a9c5-c26334e825ca + id: 10 + type: CLOUD + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + metroCode: DC + linkProtocol: + type: DOT1Q + vlanTag: 788 + virtualDevice: + uuid: 207667ba-3211-452c-b0a8-8b9046e122a1 + type: EDGE + zSide: + serviceToken: + href: https://api.equinix.com/fabric/v4/serviceTokens/557411a5-16a6-4aef-beea-7f622e94f1e1 + uuid: 557411a5-16a6-4aef-beea-7f622e94f1e1 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee965 + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DA + metroCode: DA + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-0348-348c-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-0348-348c-ace0-30fa5c00ad01 + name: reg-NK-710 + linkProtocol: + type: DOT1Q + vlanTag: 101 Vd2Colo: - $ref: "#/components/examples/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 + termLength: 1 + 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 + linkProtocol: + type: DOT1Q + vlanTag: 1522 + 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-WithGeoScope: - $ref: "#/components/examples/VD2COLO-Dot1q-withGeoScope-response" + value: + href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f3e9-4f84-8c8f-1505b43df5e2 + uuid: 3a58dd05-f3e9-4f84-8c8f-1505b43df5e2 + type: EVPL_VC + name: My-VD-2-COLO-Connection-1 + state: ACTIVE + bandwidth: 1000 + order: + purchaseOrderNumber: po1234 + termLength: 1 + aSide: + accessPoint: + type: VD + virtualDevice: + uuid: a867f685-41b0-1b07-6de0-320a5c00abdd + name: my-virtual-device + interface: + type: NETWORK + id: 1 + location: + metroHref: https://api.equinix.com/fabric/v4/metros/FR + metroCode: FR + zSide: + accessPoint: + type: COLO + port: + uuid: b067f685-49b0-1a09-6fe0-360a5d00afd9 + name: my-port + linkProtocol: + type: DOT1Q + vlanTag: 1001 + location: + metroCode: AM + geoScope: EU + project: + projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 + notifications: + - type: ALL + emails: + - test@test.com + operation: + providerStatus: AVAILABLE + equinixStatus: PROVISIONED + changeLog: + createdDateTime: '2023-01-15T10:00:00Z' + updatedDateTime: '2023-01-15T10:05:00Z' Vd2Colo-tag: - $ref: "#/components/examples/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 + termLength: 1 + 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-27T16:25:37.229Z' + aSide: + accessPoint: + virtualDevice: + type: EDGE + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f8 + 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: - $ref: "#/components/examples/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 + termLength: 1 + 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: - $ref: "#/components/examples/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 + termLength: 1 + 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 + createdDateTime: '2022-05-12T17:53:45.401Z' Fcr2Colo: - $ref: "#/components/examples/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 + createdDateTime: '2022-05-12T17:53:45.401Z' Fcr2IpWan: - $ref: "#/components/examples/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: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + 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 + createdDateTime: '2022-05-12T17:53:45.401Z' Fcr2Sp-Marketplace-subscription: - $ref: "#/components/examples/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 + termLength: 1 + 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 + createdDateTime: '2022-05-12T17:53:45.401Z' ServiceToken2PortResponseDot1Q: - $ref: "#/components/examples/AsideServiceToken2PortResponseWithDot1q" + value: + href: https://api.equinix.com/fabric/v4/connections/e972bd9b-5726-4062-b046-7086fe9921ab + type: EVPL_VC + uuid: e972bd9b-5726-4062-b046-7086fe9921ab + name: token2port-conn-1 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + billingTier: Up to 10 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + changeLog: + createdBy: fabric_user + createdDateTime: '2026-05-11T21:03:02.631Z' + updatedBy: fabric_user + updatedDateTime: '2026-05-11T21:03:02.631Z' + bandwidth: 10 + redundancy: + group: 48852efe-f68a-4f0d-8449-36abd43a4afa + priority: PRIMARY + aSide: + serviceToken: + href: https://api.equinix.com/fabric/v4/serviceTokens/f10d177b-4afb-461a-bb23-b65b021af367 + type: VC_TOKEN + uuid: f10d177b-4afb-461a-bb23-b65b021af367 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee96a + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033f-33fc-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033f-33fc-ace0-30fa5c00ad01 + name: reg-JUN-701 + linkProtocol: + type: DOT1Q + vlanTag: 45 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033e-33ec-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033e-33ec-ace0-30fa5c00ad01 + name: reg-JUN-700 + linkProtocol: + type: DOT1Q + vlanTag: 34 ServiceToken2PortResponseQinQ: - $ref: "#/components/examples/AsideServiceToken2PortResponseWithQinq" + value: + href: https://api.equinix.com/fabric/v4/connections/e972bd9b-5726-4062-b046-7086fe9921ab + type: EVPL_VC + uuid: e972bd9b-5726-4062-b046-7086fe9921ab + name: token2port-conn-1 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + billingTier: Up to 10 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric_user@equinix.com + changeLog: + createdBy: fabric_user + createdDateTime: '2026-05-11T21:03:02.631Z' + updatedBy: fabric_user + updatedDateTime: '2026-05-11T21:03:02.631Z' + bandwidth: 10 + redundancy: + group: 48852efe-f68a-4f0d-8449-36abd43a4afa + priority: PRIMARY + aSide: + serviceToken: + href: https://api.equinix.com/fabric/v4/serviceTokens/f10d177b-4afb-461a-bb23-b65b021af367 + type: VC_TOKEN + uuid: f10d177b-4afb-461a-bb23-b65b021af367 + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee96a + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033f-33fc-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033f-33fc-ace0-30fa5c00ad01 + name: reg-JUN-701 + linkProtocol: + type: QINQ + vlanSTag: 45 + vlanCTag: 46 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033e-33ec-ace0-30fa5c00ad01 + type: XF_PORT + uuid: c4d93b39-033e-33ec-ace0-30fa5c00ad01 + name: reg-JUN-700 + linkProtocol: + type: QINQ + vlanSTag: 34 + vlanCTag: 35 Metal2Sp-Aws: - $ref: "#/components/examples/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 + redundancy: + group: 3cbd354d-d147-4552-bfd0-78c559b4cc91 + priority: PRIMARY + aSide: + accessPoint: + type: METAL_NETWORK + virtualNetwork: + href: https://api.equinix.com/metal/v1/virtual-networks/a867f685-41b0-1b07-6de0-320a5c00abd0 + uuid: a867f685-41b0-1b07-6de0-320a5c00abd0 + 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: + accountNumber: 123213 + notifications: + - type: ALL + emails: + - fabric@gmail.com + - fabric1@gmail.com + changeLog: + createdBy: fabric + createdDateTime: '2020-05-21T10:30:00Z' Metal2Sp-Azure: - $ref: "#/components/examples/Metal2Sp-Azure-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/d3b69c6b-3b23-4ac0-a1bb-8db16460714d + type: EVPL_VC + 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 + createdDateTime: '2024-03-21T20:14:04.072Z' + updatedBy: fabric + 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: - $ref: "#/components/examples/Metal2Sp-GCP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/d3b69c6b-3b23-4ac0-a1bb-8db16460714d + type: EVPL_VC + 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 + createdDateTime: '2024-03-21T20:14:04.072Z' + updatedBy: fabric + 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: - $ref: "#/components/examples/Metal2Sp-Oracle-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/7a21d5d8-f153-45f8-ad76-f92babf3f103 + type: EVPL_VC + 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 + createdDateTime: '2024-03-19T23:09:15.547Z' + updatedBy: fabric + 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: - $ref: "#/components/examples/Metal2Sp-IBM-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/f0e56501-d92f-4ca3-b047-f95628d4a32a + type: EVPL_VC + 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 + createdDateTime: '2024-03-06T17:20:41.574Z' + updatedBy: fabric + 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: - $ref: "#/components/examples/Metal2Port-Dot1q-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/02b7b7d4-1726-4451-9598-e28091c096cd + type: EVPL_VC + 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 + createdDateTime: '2024-03-20T00:39:07.648Z' + updatedBy: fabric + 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: - $ref: "#/components/examples/Metal2Port-Qinq-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/d87489aa-c32d-4756-a81a-6f557afb871d + type: EVPL_VC + 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 + createdDateTime: '2024-03-21T23:44:22.347Z' + updatedBy: fabric + 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 Metal2Port-ZsideServiceToken: - $ref: "#/components/examples/Metal2ServiceToken-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/f712745e-ccf9-4a0d-9e4d-83c1bb5b9028 + type: EVPL_VC + 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 + createdDateTime: '2024-03-20T20:12:08.595Z' + updatedBy: fabric + 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: - $ref: "#/components/examples/Metal2Sp-Generic-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/1a9ffa8f-d4d4-44ab-9733-362c9a36ec94 + type: EVPL_VC + 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 + createdDateTime: '2024-03-22T00:42:35.386Z' + updatedBy: fabric + 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 Fcr2Metal-Network: - $ref: "#/components/examples/Fcr2Metal-Network" + value: + type: IP_VC + name: My-FCR-MetalNetwork-Connection + bandwidth: 50 + order: + purchaseOrderNumber: po1234 + termLength: 1 + 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + notifications: + - type: ALL + emails: + - test@equinix.com + - test1@equinix.com Colo2Network-EVPLAN_VC: - $ref: "#/components/examples/COLO2NETWORKwithDot1q-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/f3dd7395-7196-45f4-9b6f-54094aa75f53 + type: EVPLAN_VC + 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: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-23T02:51:07.675Z' + updatedBy: fabric + updatedDateTime: '2024-04-23T02:51:07.675Z' + bandwidth: 50 + redundancy: + group: ecebee55-975b-4017-857c-74617f821b87 + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DA + metroCode: DA + port: + href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 + type: XF_PORT + 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 Colo2Network-EPLAN_VC: - $ref: "#/components/examples/COLO2NETWORKwithEPL-Response" - Colo2Network-EVPTREE_VC: - $ref: "#/components/examples/COLO2NETWORK_EVPTREE_withDot1q-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/cce170c5-a496-4928-8426-507e00818887 + type: EPLAN_VC + 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: 1 + notifications: + - type: ALL + emails: + - fabric@test.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-23T03:07:17.587Z' + updatedBy: fabric + updatedDateTime: '2024-04-23T03:07:17.587Z' + bandwidth: 50 + redundancy: + group: dbab0e00-db97-4abf-aebe-76c7a40a371e + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SP + metroCode: SP + port: + href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 + type: XF_PORT + 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 + Colo2Network-EVPTREE_VC: + value: + href: https://api.equinix.com/fabric/v4/connections/f3dd7395-7196-45f4-9b6f-54094aa75f53 + type: EVPTREE_VC + uuid: f3dd7395-7196-45f4-9b6f-54094aa75f53 + name: colo2network-evptree-vc + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-23T02:51:07.675Z' + updatedBy: fabric + updatedDateTime: '2024-04-23T02:51:07.675Z' + bandwidth: 50 + redundancy: + group: ecebee55-975b-4017-857c-74617f821b87 + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DA + metroCode: DA + port: + href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 + type: XF_PORT + 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: EVPTREE-GLOBAL + platformUuid: afe28606-8021-4161-802c-b80d4bc22f20 + state: ACTIVE + type: EVPTREE + scope: GLOBAL + role: LEAF Colo2Network-EPTREE_VC: - $ref: "#/components/examples/COLO2NETWORK_EPTREE_withEPL-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/cce170c5-a496-4928-8426-507e00818887 + type: EPTREE_VC + uuid: cce170c5-a496-4928-8426-507e00818887 + name: colo2network-eptree-vc + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@test.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-23T03:07:17.587Z' + updatedBy: fabric + updatedDateTime: '2024-04-23T03:07:17.587Z' + bandwidth: 50 + redundancy: + group: dbab0e00-db97-4abf-aebe-76c7a40a371e + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SP + metroCode: SP + port: + href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 + type: XF_PORT + 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: EPTREE-GLOBAL + platformUuid: 47aedd04-64dc-4e86-8da3-f88a9755a214 + state: ACTIVE + type: EPTREE + scope: GLOBAL + role: LEAF Vd2IASp: - $ref: "#/components/examples/Vd2IAProfile-Response" + value: + href: https://uatapi.npclouda.equinix.com/fabric/v4/connections/ce42ca81-538d-4f38-b020-d45fb48d20c7 + type: IA_VC + uuid: ce42ca81-538d-4f38-b020-d45fb48d20c7 + name: vd2eia-connection-1 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-30T20:19:44.279Z' + updatedBy: fabric + 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: + metroHref: https://api.equinix.com/fabric/v4/metros/SY + 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: - $ref: "#/components/examples/Vd2NETWORK-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/e1f165fd-29bb-4c15-8ec7-56242677e6fc + type: EVPLAN_VC + uuid: e1f165fd-29bb-4c15-8ec7-56242677e6fc + name: vd2network-connection + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-1234567890 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-23T02:12:20.334Z' + updatedBy: fabric + 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: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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 Vd2Sp-Aws: - $ref: "#/components/examples/Vd2AwsSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/f0a954e7-bdc5-4727-90cc-869f990e289f + type: EVPL_VC + uuid: f0a954e7-bdc5-4727-90cc-869f990e289f + name: vd2aws-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-1234567890 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-27T00:32:21.879Z' + updatedBy: fabric + 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: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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 Vd2Sp-Azure: - $ref: "#/components/examples/Vd2AzureSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/3da14bba-d81c-4497-93c3-3f4a3cb0bc40 + type: EVPL_VC + uuid: 3da14bba-d81c-4497-93c3-3f4a3cb0bc40 + name: vd2azure-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-1234567890 + billingTier: Up to 200 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-25T20:30:24.632Z' + updatedBy: fabric + 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: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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 Vd2Sp-Oracle: - $ref: "#/components/examples/Vd2OracleSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/53c89f1a-0be7-44a1-9c03-28059632a72d + type: EVPL_VC + uuid: 53c89f1a-0be7-44a1-9c03-28059632a72d + name: vd2oracle-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 1G + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-25T20:40:40.676Z' + updatedBy: fabric + 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: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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 Vd2Sp-IBM_1.0: - $ref: "#/components/examples/Vd2Ibm_1" + value: + href: https://api.equinix.com/fabric/v4/connections/d99408ca-7143-4ff7-b66c-93909d3ed893 + type: EVPL_VC + uuid: d99408ca-7143-4ff7-b66c-93909d3ed893 + name: vd2ibm10-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-27T00:56:19.807Z' + updatedBy: fabric + updatedDateTime: '2024-04-27T00:56:19.807Z' + bandwidth: 50 + redundancy: + group: dc80b3b0-f5b8-4e80-bb91-34a536ea52e8 + priority: PRIMARY + aSide: + accessPoint: + interface: + uuid: b3313274-d03d-42ef-a221-ab03d31b6b67 + id: 7 + type: CLOUD + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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/45b446fa-d3b6-417a-b871-a5ee0efdc459 + type: L2_PROFILE + name: IBM Cloud Direct Link Exchange + uuid: 45b446fa-d3b6-417a-b871-a5ee0efdc459 + sellerRegion: Washington 2 + authenticationKey: xxxx-xxx-xxx Vd2Sp-IBM_2.0: - $ref: "#/components/examples/Vd2Ibm_2" + value: + href: https://api.equinix.com/fabric/v4/connections/0175e136-8be7-4b04-8d57-c33c20555501 + type: EVPL_VC + uuid: 0175e136-8be7-4b04-8d57-c33c20555501 + name: vd2ibm20-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-129105284100 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-25T20:41:37.805Z' + updatedBy: fabric + updatedDateTime: '2024-04-25T20:41:37.805Z' + bandwidth: 50 + redundancy: + group: d1f11356-91ca-4550-8488-ba434a771e09 + priority: PRIMARY + aSide: + accessPoint: + interface: + uuid: 1be460db-5125-49e8-92b4-124e75aab35f + id: 8 + type: CLOUD + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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/e092ed47-63d2-4f4a-87a0-82e3b08eefe5 + type: L2_PROFILE + name: IBM Cloud Direct Link 2 + uuid: e092ed47-63d2-4f4a-87a0-82e3b08eefe5 + sellerRegion: San Jose 2 + authenticationKey: xxxx-xxx-xxx Vd2Sp-Alibaba: - $ref: "#/components/examples/Vd2AlibabaSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/66ed4e8a-584c-4027-9788-748fecb5ce35 + type: EVPL_VC + uuid: 66ed4e8a-584c-4027-9788-748fecb5ce35 + name: vd2alibaba-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: po1234 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinix.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-25T20:43:43.199Z' + updatedBy: fabric + 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: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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 Vd2Sp-Google: - $ref: "#/components/examples/Vd2GoogleSP-Response" + value: + href: https://api.equinix.com/fabric/v4/connections/50ae793c-b466-4d71-9724-c32b5e402bbe + type: EVPL_VC + uuid: 50ae793c-b466-4d71-9724-c32b5e402bbe + name: vd2googleSp-connection-1 + operation: + providerStatus: PROVISIONING + equinixStatus: PROVISIONING + order: + purchaseOrderNumber: 1-1234567890 + billingTier: Up to 50 MB + termLength: 1 + notifications: + - type: ALL + emails: + - fabric@equinx.com + changeLog: + createdBy: fabric + createdDateTime: '2024-04-25T14:06:48.933Z' + updatedBy: fabric + 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: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + 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 IX2Sp-PublicPeering_VC: - $ref: "#/components/examples/IXDedicatedPublicPeeringConnectionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/connections/a8ba52de-faae-43b5-b0b1-6904d37ee011 + uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 + type: IX_VC + name: Virtual-Connection-1 + bandwidth: 1000 + operation: + providerStatus: NOT_AVAILABLE + equinixStatus: PROVISIONING + aSide: + accessPoint: + type: COLO + port: + href: https://api.equinix.com/fabric/v4/ports/99e83e59-fd26-4134-b1b3-4c5dea6924d6 + uuid: 99e83e59-fd26-4134-b1b3-4c5dea6924d6 + type: XF_PORT + name: A-IX-Port + linkProtocol: + type: DOT1Q + vlanTag: 99 + zSide: + accessPoint: + type: SP + profile: + href: https://api.equinix.com/fabric/v4/serviceProfiles/0f6bdb36-e130-4924-b038-ee1785fad166 + uuid: 0f6bdb36-e130-4924-b038-ee1785fad166 + type: IX_PROFILE + name: Equinix Internet Exchange Peering Profile + project: + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + notifications: + - type: ALL + emails: + - test@test.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "403": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "405": + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' + '405': description: Method not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/405" + value: + - errorCode: EQ-3142569 + errorMessage: Method not supported, Please check the URL passed + details: Method:PATCH + correlationId: f48687b0-d088-46d1-b06c-00c0688fbca9 /fabric/v4/connections/{connectionId}: get: tags: @@ -1043,124 +7150,346 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: direction in: query description: Connection Direction required: false schema: - $ref: "#/components/schemas/ConnectionDirection" + $ref: '#/components/schemas/ConnectionDirection' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Connection" + $ref: '#/components/schemas/Connection' examples: nonGenericConnectionResponse: - $ref: "#/components/examples/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 genericConnectionResponse: - $ref: "#/components/examples/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: ACTIVE + 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 coloToColoWithMaintenanceResponse: - $ref: "#/components/examples/ColoToColoWithMaintenanceResponseExample" + 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-ColoToColo-280122023234849 + state: ACTIVE + operation: + providerStatus: AVAILABLE + equinixStatus: PROVISIONED + maintenanceStatus: SCHEDULED + lockEnabled: true + order: + purchaseOrderNumber: PO754587184643 + notifications: + - type: ALL + emails: + - fake@mail.com + account: + accountNumber: 270001 + orgId: 91997 + globalOrgId: 0016u000003JZ4sAAG + changeLog: + createdBy: admin_user + createdDateTime: '2022-01-28T02:32:36.402Z' + updatedBy: test_user + updatedDateTime: '2022-01-29T02: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 + type: XF_PORT + uuid: c791f8cb-5a41-a410-8ce0-306a5c00a4ee + name: testBuyer-DA1-L-Dot1q-STD-PRI-10G-NK-329 + linkProtocol: + type: DOT1Q + vlanTag: 1043 + zSide: + 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-5a49-a490-8ce0-306a5c00a4ee + type: XF_PORT + uuid: c791f8cb-5a49-a490-8ce0-306a5c00a4ee + name: testBuyer-DA1-L-Dot1q-STD-SEC-10G-NK-337 + linkProtocol: + type: DOT1Q + vlanTag: 3322 Colo2Sp-LMaaS: - $ref: "#/components/examples/LMaaSConnectionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/connections/8236fbb9-51e5-428f-86bf-6b67e1223ac1 + uuid: 8236fbb9-51e5-428f-86bf-6b67e1223ac1 + type: EVPL_VC + name: Last Mile Connection 1 + state: ACTIVE + operation: + providerStatus: AVAILABLE + equinixStatus: PROVISIONED + order: + billingTier: Up to 10 MB + termLength: 1 + bandwidth: 10 + redundancy: + group: d4db1048-ef3d-f3d6-49e0-306a5c00a341 + priority: PRIMARY + isRemote: false + direction: INCOMING + account: + accountNumber: 201257 + orgId: 91955 + globalOrgId: '' + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + changeLog: + createdBy: sampleuser + createdDateTime: '2026-01-01T00:00:00.000Z' + updatedBy: sampleuser + updatedDateTime: '2026-01-01T00:00:00.000Z' + notifications: + - type: ALL + emails: + - someone@sample.com + - type: ORDERING + emails: + - someone@sample.com + phone: + - type: OFFICE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: MOBILE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: TECHNICAL + emails: + - someone@sample.com + phone: + - type: OFFICE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + - type: MOBILE + number: '+11234567890' + contactPreference: + timezone: America/Los_Angeles + availability: ANYTIME + aSide: + accessPoint: + type: COLO + account: + accountNumber: 201257 + organizationName: Sample Organization + location: + region: AMER + metroName: Ashburn + metroCode: DC + ibx: DC11 + port: + href: https://api.equinix.com/fabric/v4/ports/c4d9350e-780f-80fd-1ce0-306a5c00a600 + uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 + name: Sample Port DC + redundancy: + priority: SECONDARY + linkProtocol: + type: QINQ + vlanSTag: 121 + vlanCTag: 145 + zSide: + accessPoint: + type: SP + account: + organizationName: Sample Provider Organization + location: + region: AMER + metroName: Ashburn + metroCode: DC + ibx: DC11 + profile: + href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 + type: LMAAS_PROFILE + name: Last Mile Service Profile 1 + uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 + productOffering: + id: sample-product-offering-id + name: Sample product offering 1 + billingTerm: 12 + bandwidthCommit: 50 + address: + id: lmaas-addr-sample-id + streetNr: '1234' + streetName: Main St + city: San Jose + stateOrProvince: CA + postCode: '95101' + country: United States + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_Invalid_id" - "403": + 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 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' example: - errorCode: EQ-3000005 errorMessage: You don't have permissions to perform READ operation. Please contact your master administrator to get the right permissions through Equinix Customer Portal or contact Equinix Support (support@equinix.com). - "404": - description: Not Found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/404" - delete: - tags: - - Connections - summary: Delete Connection 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": + '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" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/405" + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' patch: tags: - Connections @@ -1173,7 +7502,9 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: dryRun in: query description: option to verify that API calls will succeed @@ -1185,88 +7516,571 @@ paths: content: application/json-patch+json: schema: - $ref: "#/components/schemas/ConnectionUpdateRequest" + $ref: '#/components/schemas/ConnectionUpdateRequest' examples: ConnectionUpdateNameRequest: - $ref: "#/components/examples/ConnectionUpdateNameRequest" + value: + - op: replace + path: /name + value: Conn-Name-2 ConnectionUpdateBandwidthRequest: - $ref: "#/components/examples/ConnectionUpdateBandwidthRequest" + value: + - op: replace + path: /bandwidth + value: 1000 ConnectionUpdateTermLengthRequest: - $ref: "#/components/examples/ConnectionUpdateTermLengthRequest" + value: + - op: replace + path: /order/termLength + value: 12 ConnectionAddAccessAndSecretKeyAWSRequest: - $ref: "#/components/examples/ConnectionAddAccessAndSecretKeyAWSRequest" + value: + - op: add + path: '' + value: + additionalInfo: + - key: accessKey + value: nTTgtgoQbTQCRHTbynll + - key: secretKey + value: NwPcpbWgFEPofydsZEQGwjtHqJOYrUmBbrcxtOzP ConnectionMigrationAsideRequest: - $ref: "#/components/examples/ConnectionMigrationAsideRequest" + value: + - op: replace + path: /aSide/accessPoint/port/uuid + value: 5e7fd31d-f1e8-46fe-b6ad-6f5f2306cfd8 ConnectionUpdateNotificationEmailRequest: - $ref: "#/components/examples/ConnectionUpdateNotificationEmailRequest" + value: + - op: replace + path: /notifications + value: + - type: ALL + emails: + - testEmail1@equinix.com + - testEmail2@equinix.com ConnectionMigrationAsideRequestForVirtualDevice: - $ref: "#/components/examples/ConnectionMigrationAsideVirtualDeviceRequest" + value: + - op: replace + path: /aSide/accessPoint + value: + virtualDevice: + type: EDGE + uuid: 207667ba-3211-452c-b0a8-8b9046e122a5 + interface: + type: CLOUD + id: 4 ConnectionUpdateBandwidthRequestDryRun: - $ref: "#/components/examples/ConnectionUpdateBandwidthRequest" + value: + - op: replace + path: /bandwidth + value: 1000 ConnectionPriorityMigrationAsideRequestForVirtualDevice: - $ref: "#/components/examples/ConnectionPriorityMigrationAsideVirtualDeviceRequest" + value: + - op: replace + path: /aSide/accessPoint/fabricEdgePriority + value: PRIMARY required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Connection" + $ref: '#/components/schemas/Connection' examples: connectionPatchExampleDryRun: - $ref: "#/components/examples/ConnectionPatchResponseDryRun" - "202": + 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 + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Connection" + $ref: '#/components/schemas/Connection' examples: connectionPatchExample: - $ref: "#/components/examples/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 connectionUpdateTermLength: - $ref: "#/components/examples/ConnectionUpdateTermLengthResponse" + value: + href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 + type: EVPL_VC + uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 + name: dha_p2p_CH_1m + change: + uuid: 9b9f8a9b-4583-4649-9d91-a48494f822a7 + type: CONNECTION_UPDATE + createdDateTime: '2025-09-10T12:33:42.916Z' + data: + op: replace + path: /order/termLength + value: 12 + operation: + providerStatus: AVAILABLE + equinixStatus: PROVISIONED + order: + billingTier: Up to 200 MB + termLength: 12 + notifications: + - type: ALL + emails: + - testuser@equinix.com + changeLog: + createdBy: testuser + createdDateTime: '2025-09-10T12:26:12.344Z' + updatedBy: testuser + updatedDateTime: '2025-09-10T12:33:42.996Z' + bandwidth: 200 + redundancy: + group: 561082c7-d979-4beb-9536-520cc5b9d0ac + priority: PRIMARY + aSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DC + metroCode: DC + port: + href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d + type: XF_PORT + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + name: gen-l2-qa-01-auto-DC5-NL-Dot1q-STD-PRI-1G-JUN-51 + linkProtocol: + type: DOT1Q + vlanTag: 1246 + zSide: + accessPoint: + location: + metroHref: https://api.equinix.com/fabric/v4/metros/CH + metroCode: CH + port: + href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d + type: XF_PORT + uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d + name: gen-l2-qa-01-auto-CH1-L-Dot1q-BO-PRI-10G-JUN-189 + linkProtocol: + type: DOT1Q + vlanTag: 1247 links: Get Connection Details: operationId: getConnectionByUuid parameters: connectionId: $response.body#/uuid - "400": + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + dryRun: + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '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/400" - dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' + delete: + tags: + - Connections + summary: Delete Connection by ID + description: Delete Connection by ID + operationId: deleteConnectionByUuid + parameters: + - name: connectionId + in: path + description: Connection UUID + required: true + schema: + description: Virtual Circuit UUID + type: string + responses: + '200': + description: Delete Connection Request + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' + examples: + connectionExample: + 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': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142510 + errorMessage: Connection is in transient state + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142401 + errorMessage: Your account isn't authorized to perform this task. Contact your administrator for assistance. + correlationId: 12312y7127tges + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' + '405': + description: Method not allowed + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3142569 + errorMessage: Method not supported, Please check the URL passed + details: Method:PATCH + correlationId: f48687b0-d088-46d1-b06c-00c0688fbca9 /fabric/v4/connections/{connectionId}/actions: post: tags: @@ -1280,81 +8094,293 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ConnectionActionRequest" + $ref: '#/components/schemas/ConnectionActionRequest' examples: ApproveGenericConnection: - $ref: "#/components/examples/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 RejectGenericConnection: - $ref: "#/components/examples/Connection_Creation_Rejection" + value: + type: CONNECTION_CREATION_REJECTION + description: Invalid connection request ApproveBandwidthUpdate: - $ref: "#/components/examples/Connection_Update_Acceptance" + value: + type: CONNECTION_UPDATE_ACCEPTANCE RejectBandwidthUpdate: - $ref: "#/components/examples/Connection_Update_Rejection" + value: + type: CONNECTION_UPDATE_REJECTION + description: Invalid connection update request AcceptDeleteConnection: - $ref: "#/components/examples/Connection_Deletion_Acceptance" + value: + type: CONNECTION_DELETION_ACCEPTANCE VcMigrationZSide: - $ref: "#/components/examples/Connection_Update_Request_VC_Migration" + value: + type: CONNECTION_UPDATE_REQUEST + data: + zSide: + accessPoint: + type: COLO + port: + uuid: c791f8cb-5a47-a470-8ce0-306a5c00a4ee BGPSync: - $ref: "#/components/examples/Connection_Provider_Status_Request" + value: + type: CONNECTION_PROVIDER_STATUS_REQUEST GetProviderBandwidth: - $ref: "#/components/examples/Connection_Provider_Bandwidth_Request" + value: + type: CONNECTION_PROVIDER_BANDWIDTH_REQUEST AcceptZSide-NetworkEdge: - $ref: "#/components/examples/AcceptZSide_NetworkEdge_Request" + value: + type: CONNECTION_CREATION_ACCEPTANCE + data: + zSide: + accessPoint: + virtualDevice: + uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 + interface: + type: CLOUD + id: 8 ProviderStatusUpdate: - $ref: "#/components/examples/Connection_Provider_Status_Update" + value: + type: CONNECTION_PROVIDER_STATUS_UPDATE_REQUEST + data: + operation: + providerStatus: QUOTING required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionAction" + $ref: '#/components/schemas/ConnectionAction' examples: connectionActionExample: - $ref: "#/components/examples/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' GetProviderBandwidth: - $ref: "#/components/examples/Connection_Provider_Bandwidth_Response" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' /fabric/v4/connections/{connectionId}/advertisedRoutes/search: post: tags: @@ -1368,71 +8394,336 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteSearchRequest" + $ref: '#/components/schemas/ConnectionRouteSearchRequest' examples: ConnectionRoutesSearchType: - $ref: "#/components/examples/ConnectionRoutesSearchByType" + value: + filter: + and: + - property: /type + operator: '=' + values: + - IPv4_BGP_ROUTE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime ConnectionRoutesSearchByState: - $ref: "#/components/examples/ConnectionRoutesSearchByState" + value: + filter: + and: + - property: /state + operator: '=' + values: + - ACTIVE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime ConnectionRoutesSearchByPrefix: - $ref: "#/components/examples/ConnectionRoutesSearchByPrefix" + value: + filter: + and: + - property: /prefix + operator: '=' + values: + - 192.168.10.0/24 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime ConnectionRoutesSearchByNextHop: - $ref: "#/components/examples/ConnectionRoutesSearchByNextHop" + value: + filter: + and: + - property: /nextHop + operator: '=' + values: + - 10.10.10.5 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime ConnectionRoutesSearchByMed: - $ref: "#/components/examples/ConnectionRoutesSearchByMed" + value: + filter: + and: + - property: /med + operator: '=' + values: + - '200' + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteTableEntrySearchResponse" + $ref: '#/components/schemas/ConnectionRouteTableEntrySearchResponse' examples: advertisedRoutes: - $ref: "#/components/examples/CloudRouterAdvertisedRoutesSearchResponse" + value: + pagination: + offset: 0 + limit: 20 + total: 1 + data: + - type: IPv4_BGP_ROUTE + protocolType: BGP + state: ACTIVE + prefix: 192.168.10.0/24 + nextHop: 10.10.10.5 + MED: 5 + asPath: + - '20001' + connection: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 81331c52-04c0-4656-a4a7-18c52669348f + name: connection_1 + changeLog: + createdBy: johnsmith + createdByFullName: John Smith + createdByEmail: john.smith@example.com + createdDateTime: '2020-11-06T07:00:00Z' + updatedBy: johnsmith + updatedByFullName: John Smith + updatedByEmail: john.smith@example.com + updatedDateTime: '2020-11-06T07:00:00Z' + deletedBy: johnsmith + deletedByFullName: John Smith + deletedByEmail: john.smith@example.com + deletedDateTime: '2020-11-06T07:00:00Z' receivedRoutes: - $ref: "#/components/examples/CloudRouterReceivedRoutesSearchResponse" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + data: + - type: IPv4_BGP_ROUTE + protocolType: BGP + state: ACTIVE + prefix: 192.168.10.0/24 + nextHop: 10.10.10.5 + MED: 5 + asPath: + - '20001' + connection: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 81331c52-04c0-4656-a4a7-18c52669348f + name: connection_1 + changeLog: + createdBy: johnsmith + createdByFullName: John Smith + createdByEmail: john.smith@example.com + createdDateTime: '2020-11-06T07:00:00Z' + updatedBy: johnsmith + updatedByFullName: John Smith + updatedByEmail: john.smith@example.com + updatedDateTime: '2020-11-06T07:00:00Z' + deletedBy: johnsmith + deletedByFullName: John Smith + deletedByEmail: john.smith@example.com + deletedDateTime: '2020-11-06T07:00:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' /fabric/v4/connections/{connectionId}/receivedRoutes/search: post: tags: @@ -1446,67 +8737,308 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteSearchRequest" + $ref: '#/components/schemas/ConnectionRouteSearchRequest' examples: ConnectionRoutesSearchType: - $ref: "#/components/examples/ConnectionRoutesSearchByType" + value: + filter: + and: + - property: /type + operator: '=' + values: + - IPv4_BGP_ROUTE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime ConnectionRoutesSearchByState: - $ref: "#/components/examples/ConnectionRoutesSearchByState" + value: + filter: + and: + - property: /state + operator: '=' + values: + - ACTIVE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime ConnectionRoutesSearchByMed: - $ref: "#/components/examples/ConnectionRoutesSearchByMed" + value: + filter: + and: + - property: /med + operator: '=' + values: + - '200' + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteTableEntrySearchResponse" + $ref: '#/components/schemas/ConnectionRouteTableEntrySearchResponse' examples: advertisedRoutes: - $ref: "#/components/examples/CloudRouterAdvertisedRoutesSearchResponse" + value: + pagination: + offset: 0 + limit: 20 + total: 1 + data: + - type: IPv4_BGP_ROUTE + protocolType: BGP + state: ACTIVE + prefix: 192.168.10.0/24 + nextHop: 10.10.10.5 + MED: 5 + asPath: + - '20001' + connection: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 81331c52-04c0-4656-a4a7-18c52669348f + name: connection_1 + changeLog: + createdBy: johnsmith + createdByFullName: John Smith + createdByEmail: john.smith@example.com + createdDateTime: '2020-11-06T07:00:00Z' + updatedBy: johnsmith + updatedByFullName: John Smith + updatedByEmail: john.smith@example.com + updatedDateTime: '2020-11-06T07:00:00Z' + deletedBy: johnsmith + deletedByFullName: John Smith + deletedByEmail: john.smith@example.com + deletedDateTime: '2020-11-06T07:00:00Z' receivedRoutes: - $ref: "#/components/examples/CloudRouterReceivedRoutesSearchResponse" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + data: + - type: IPv4_BGP_ROUTE + protocolType: BGP + state: ACTIVE + prefix: 192.168.10.0/24 + nextHop: 10.10.10.5 + MED: 5 + asPath: + - '20001' + connection: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 81331c52-04c0-4656-a4a7-18c52669348f + name: connection_1 + changeLog: + createdBy: johnsmith + createdByFullName: John Smith + createdByEmail: john.smith@example.com + createdDateTime: '2020-11-06T07:00:00Z' + updatedBy: johnsmith + updatedByFullName: John Smith + updatedByEmail: john.smith@example.com + updatedDateTime: '2020-11-06T07:00:00Z' + deletedBy: johnsmith + deletedByFullName: John Smith + deletedByEmail: john.smith@example.com + deletedDateTime: '2020-11-06T07:00:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' /fabric/v4/connections/{connectionId}/routingProtocols: get: tags: @@ -1534,64 +9066,262 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetResponse" + $ref: '#/components/schemas/GetResponse' examples: getAllRoutingProtocols: - $ref: "#/components/examples/RoutingProtocolGetAll" - "400": + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + updatedDateTime: '2021-10-30T07:21:39Z' + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 post: tags: - Routing Protocols @@ -1604,90 +9334,318 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolBase" + $ref: '#/components/schemas/RoutingProtocolBase' examples: Fcr2ColoDirectRoutingOnly: - $ref: "#/components/examples/Fcr2ColoCreateDirect" + value: + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + directIpv6: + equinixIfaceIp: 2001:7a9::34f4:0:f3dd:1/126 Fcr2ColoBGPRoutingOnly: - $ref: "#/components/examples/Fcr2ColoCreateBGP" + value: + type: BGP + bgpIpv4: + enabled: true + customerPeerIp: 10.1.1.2 + equinixPeerIp: 192.168.100.1 + bgpIpv6: + enabled: true + customerPeerIp: 2001:db8:c59b::1 + equinixPeerIp: 2001:db8:c59b::1 + outboundASPrependCount: 3 + customerAsn: 100 + bfd: + enabled: true + interval: '100' Fcr2GcpDirectRoutingOnly: - $ref: "#/components/examples/Fcr2GcpCreateDirect" + value: + type: DIRECT + directIpv4: + equinixIfaceIp: 169.254.100.1/30 Fcr2GcpBGPRoutingOnly: - $ref: "#/components/examples/Fcr2GcpCreateBGP" + value: + type: BGP + bgpIpv4: + enabled: true + customerPeerIp: 169.254.100.2 + equinixPeerIp: 169.254.100.1 + outboundASPrependCount: 3 + customerAsn: 100 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolData" + $ref: '#/components/schemas/RoutingProtocolData' examples: bgpCreateResponse: - $ref: "#/components/examples/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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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 directCreateResponse: - $ref: "#/components/examples/RoutingProtocolCreateDirectResponse" - "400": + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + updatedDateTime: '2021-10-30T07:21:39Z' + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/connections/{connectionId}/routingProtocols/bulk: post: tags: @@ -1701,84 +9659,253 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ConnectionRoutingProtocolPostRequest" + $ref: '#/components/schemas/ConnectionRoutingProtocolPostRequest' examples: DirectRoutingOnly: - $ref: "#/components/examples/CreateRoutingWithDirectOnly" + value: + data: + - type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + directIpv6: + equinixIfaceIp: 2001:7a9::34f4:0:f3dd:1/126 BGPRoutingOnly: - $ref: "#/components/examples/CreateRoutingWithBGPOnly" + value: + data: + - type: BGP + bgpIpv4: + enabled: true + customerPeerIp: 10.1.1.2 + equinixPeerIp: 192.168.100.1 + outboundASPrependCount: 3 + inboundMED: 1000 + outboundMED: 2000 + bgpIpv6: + enabled: true + customerPeerIp: 2001:db8:c59b::2 + equinixPeerIp: 2001:db8:c59b::1 + outboundASPrependCount: 3 + inboundMED: 1000 + outboundMED: 2000 + customerAsn: 0 + asOverrideEnabled: true + bgpAuthKey: string + bfd: + enabled: true + interval: '100' DirectAndBGPRouting: - $ref: "#/components/examples/CreateRoutingWithDirectAndBGP" + value: + data: + - type: BGP + bgpIpv4: + enabled: true + customerPeerIp: 192.168.100.2 + equinixPeerIp: 192.168.100.1 + outboundASPrependCount: 3 + inboundMED: 1000 + outboundMED: 2000 + bgpIpv6: + enabled: true + customerPeerIp: 2001:db8:c59b::2 + equinixPeerIp: 2001:db8:c59b::1 + outboundASPrependCount: 3 + inboundMED: 1000 + outboundMED: 2000 + customerAsn: 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 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetResponse" + $ref: '#/components/schemas/GetResponse' examples: getAllRoutingProtocols: - $ref: "#/components/examples/RoutingProtocolGetAll" - "400": + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + updatedDateTime: '2021-10-30T07:21:39Z' + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400_routing_protocol" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}: get: tags: @@ -1792,266 +9919,899 @@ paths: description: Routing Protocol Id required: true schema: - $ref: "#/components/schemas/RoutingProtocolId" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolData" + $ref: '#/components/schemas/RoutingProtocolData' examples: bgpCreateResponse: - $ref: "#/components/examples/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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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 directCreateResponse: - $ref: "#/components/examples/RoutingProtocolCreateDirectResponse" - "400": + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + updatedDateTime: '2021-10-30T07:21:39Z' + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" - put: + 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 + delete: tags: - Routing Protocols - summary: Replace Protocol - description: This API provides capability to replace complete Routing Protocols on a virtual connection - operationId: replaceConnectionRoutingProtocolByUuid + 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" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - 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 + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolData" + $ref: '#/components/schemas/RoutingProtocolData' examples: - bgpReplaceResponse: - $ref: "#/components/examples/RoutingProtocolReplaceBGPResponse" - directReplaceResponse: - $ref: "#/components/examples/RoutingProtocolReplaceDirectResponse" - "400": + directDeleteResponse: + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + updatedDateTime: '2021-10-30T07:21:39Z' + deletedBy: fabric + deletedDateTime: '2021-10-30T07:21:39Z' + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + bgpDeleteResponse: + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" - delete: + 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 + put: tags: - Routing Protocols - summary: Delete Protocol - description: This API provides capability to delete Routing Protocols on virtual connection - operationId: deleteConnectionRoutingProtocolByUuid + 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" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingProtocolBase' + examples: + DirectRoutingReplaceExample: + value: + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + directIpv6: + equinixIfaceIp: 2001:7a9::34f4:0:f3dd:1/126 + BGPRoutingReplaceExample: + value: + type: BGP + bgpIpv4: + enabled: true + customerPeerIp: 192.168.100.2 + equinixPeerIp: 192.168.100.1 + outboundASPrependCount: 3 + inboundMED: 1000 + outboundMED: 2000 + bgpIpv6: + enabled: true + customerPeerIp: 2001:db8:c59b::2 + equinixPeerIp: 2001:db8:c59b::1 + outboundASPrependCount: 3 + customerAsn: 0 + bgpAuthKey: string + asOverrideEnabled: true + bfd: + enabled: true + interval: '100' + required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolData" + $ref: '#/components/schemas/RoutingProtocolData' examples: - directDeleteResponse: - $ref: "#/components/examples/RoutingProtocolDeleteDirectResponse" - bgpDeleteResponse: - $ref: "#/components/examples/RoutingProtocolDeleteBGPResponse" - "400": + bgpReplaceResponse: + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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 + directReplaceResponse: + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + updatedDateTime: '2021-10-30T07:21:39Z' + type: DIRECT + directIpv4: + equinixIfaceIp: 192.168.100.1/30 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 patch: tags: - Routing Protocols @@ -2064,322 +10824,953 @@ paths: description: Routing Protocol Id required: true schema: - $ref: "#/components/schemas/RoutingProtocolId" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ConnectionRoutingProtocolPatchRequest" + $ref: '#/components/schemas/ConnectionRoutingProtocolPatchRequest' examples: EnableIPv4PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolEnableIPv4" + value: + - op: replace + path: /bgpIpv4/enabled + value: true EnableIPv6PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolEnableIPv6" + value: + - op: replace + path: /bgpIpv6/enabled + value: true DisableIPv4PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolDisableIPv4" + value: + - op: replace + path: /bgpIpv4/enabled + value: false DisableIPv6PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolDisableIPv6" + value: + - op: replace + path: /bgpIpv6/enabled + value: false application/json-patch+json: schema: - $ref: "#/components/schemas/ConnectionRoutingProtocolPatchRequest" + $ref: '#/components/schemas/ConnectionRoutingProtocolPatchRequest' examples: EnableIPv4PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolEnableIPv4" + value: + - op: replace + path: /bgpIpv4/enabled + value: true EnableIPv6PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolEnableIPv6" + value: + - op: replace + path: /bgpIpv6/enabled + value: true DisableIPv4PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolDisableIPv4" + value: + - op: replace + path: /bgpIpv4/enabled + value: false DisableIPv6PatchExample: - $ref: "#/components/examples/PatchRoutingProtocolDisableIPv6" + value: + - op: replace + path: /bgpIpv6/enabled + value: false required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolData" + $ref: '#/components/schemas/RoutingProtocolData' examples: EnableBGPResponse: - $ref: "#/components/examples/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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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 DisableBGPResponse: - $ref: "#/components/examples/RoutingProtocolDisableBGPResponse" - "400": + 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: fabric + createdDateTime: '2021-10-30T07:21:39Z' + updatedBy: fabric + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/actions: - get: + post: tags: - Routing Protocols - summary: Get BGP Actions - description: This API provides capability to get all BGP actions status - operationId: getConnectionRoutingProtocolAllBgpActions + 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" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - 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 + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BGPActionRequest' + examples: + 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 + required: true responses: - "200": - description: Fabric BGP Action object + '202': + description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/BGPActionsBulkData" + $ref: '#/components/schemas/BGPActionData' examples: - BGPActionsAllResponse: - $ref: "#/components/examples/BGPActionsBulkDataResponseExample" - "400": + BGPActionHardResetIpV4: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + BGPActionHardResetIpV6: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + BGPActionSoftClearInAndOutIpV4: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + BGPActionSoftClearInAndOutIpV6: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + BGPActionSoftClearInIpV4: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + BGPActionSoftClearInIpV6: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" - post: + 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 + get: tags: - Routing Protocols - summary: Clear/Reset BGP - description: This API provides capability to clear/reset Routing Protocols BGP session - operationId: postConnectionRoutingProtocolBgpActionByUuid + 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" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - 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 + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + - 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: - "202": - description: Successful operation + '200': + description: Fabric BGP Action object content: application/json: schema: - $ref: "#/components/schemas/BGPActionData" + $ref: '#/components/schemas/BGPActionsBulkData' 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": + BGPActionsAllResponse: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: 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 + createdDateTime: '2020-05-21T10:20:00Z' + updatedBy: testuser + updatedDateTime: '2020-05-21T10:25:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 dryRun: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3142411 + errorMessage: Dry run is not supported for this connection type + correlationId: 1012536-0000-108258589231-api + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/actions/{actionId}: get: tags: @@ -2393,74 +11784,110 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: - $ref: "#/components/schemas/RoutingProtocolId" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: actionId in: path description: BGP Action UUID required: true schema: - $ref: "#/components/schemas/ActionId" + description: BGP Action UUID + type: string + format: uuid + example: 86534014-34b4-53f6-45d6-4b94a92d8623 responses: - "200": + '200': description: Fabric BGP Action object content: application/json: schema: - $ref: "#/components/schemas/BGPActionData" + $ref: '#/components/schemas/BGPActionData' examples: BGPActionResponse: - $ref: "#/components/examples/BGPActionDataResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: adminuser + updatedDateTime: '2020-05-21T10:35:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_Invalid_id" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/changes/{changeId}: get: tags: @@ -2474,74 +11901,140 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: - $ref: "#/components/schemas/RoutingProtocolId" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: changeId in: path description: Routing Protocol Change UUID required: true schema: - $ref: "#/components/schemas/ChangeId" + description: Routing Protocol Change UUID + type: string + format: uuid + example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: - "200": + '200': description: Fabric Routing Protocol Change object content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolChangeData" + $ref: '#/components/schemas/RoutingProtocolChangeData' examples: RoutingProtocolChangeResponse: - $ref: "#/components/examples/RoutingProtocolGetChangeResponseExample" - "400": + 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: + enabled: true + 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: + enabled: true + 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 + asOverrideEnabled: true + bgpAuthKey: string + bfd: + enabled: true + interval: '100' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_Invalid_id" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/changes: get: tags: @@ -2555,13 +12048,18 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: - $ref: "#/components/schemas/RoutingProtocolId" + description: Routing Protocol UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: offset in: query description: offset @@ -2577,60 +12075,154 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Fabric Routing Protocol Change object content: application/json: schema: - $ref: "#/components/schemas/RoutingProtocolChangeDataResponse" + $ref: '#/components/schemas/RoutingProtocolChangeDataResponse' examples: RoutingProtocolChangesResponse: - $ref: "#/components/examples/RoutingProtocolGetAllChangesResponseExample" - "400": + 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: + enabled: true + 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: + enabled: true + 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 + 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: + enabled: true + customerPeerIp: 10.1.1.3 + equinixPeerIp: 10.1.1.4 + operation: + operationalStatus: UP + opStatusChangedAt: '2021-10-30T07:21:39Z' + bgpIpv6: + enabled: true + customerPeerIp: 2001:db8:c59b::1 + equinixPeerIp: 2001:db8:c59b::1 + operation: + operationalStatus: UP + opStatusChangedAt: '2021-10-30T07:21:39Z' + customerAsn: 0 + bgpAuthKey: string + bfd: + enabled: true + interval: '100' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_Invalid_id" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Connection ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3041120 + errorMessage: The connection ID was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/exchangeServices: post: tags: @@ -2638,71 +12230,185 @@ paths: summary: Create Internet Exchange Service description: This API provides capability to create Internet Exchange Service operationId: createExchangeService - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceCreateRequest" + $ref: '#/components/schemas/ExchangeServiceCreateRequest' examples: ExchangeServiceCreateRequest: - $ref: "#/components/examples/ExchangeServiceCreateRequest" + value: + type: IX + name: ix_exchange_service + publicPeeringConnection: + uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 + description: ix_exchange_service + routingProtocol: + customerAsn: 5555 + macAddress: '00:11:22:33:44:55' + bgpIpv4: + domainName: gw01.sin.example.net + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5KEY12345 + prefixes: + - 203.0.113.0/24 + bgpIpv6: + domainName: gw01.sin.example.net + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5KEY123456 + prefixes: + - 2001:DB8:123::/48 + order: + purchaseOrderNumber: 1-3456576 + notifications: + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order + project: + projectId: e275485c-7072-439f-943a-c923548b2be5 + account: + accountNumber: 100179 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceResponse" + $ref: '#/components/schemas/ExchangeServiceResponse' examples: CreateExchangeServiceResponse: - $ref: "#/components/examples/ExchangeServiceResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 + uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 + type: IX + name: ix_exchange_service + bandwidth: 400000 + description: ix_exchange_service + state: PROVISIONING + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SV + metroCode: SV + publicPeeringConnection: + type: IX_VC + href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 + uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 + routingProtocol: + customerAsn: 5555 + macAddress: '00:11:22:33:44:55' + vlan: 99 + routeServerAsn: 24115 + bgpIpv4: + customerPeerIp: 12.1.1.1 + domainName: gw01.sin.example.net + primaryRouteServerIp: 10.1.1.1 + secondaryRouteServerIp: 10.1.1.2 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key12345 + prefixes: + - 203.0.113.0/24 + maxPrefixLimit: 300 + prependSelfEnabled: true + bgpIpv6: + customerPeerIp: 2001:db8:c59b::22 + domainName: gw01.sin.example.net + primaryRouteServerIp: 2001:db8:c59b::33 + secondaryRouteServerIp: 2001:db8:c59b::322 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key123456 + prefixes: + - 2001:DB8:123::/48 + maxPrefixLimit: 300 + prependSelfEnabled: true + routeCollector: + asn: 1238 + ipV4: 10.255.255.254 + ipV6: 2001:db8:85a3::8a2e:370:7334\ + order: + purchaseOrderNumber: 1-3456576 + orderNumber: 1-139105284200 + project: + projectId: e275485c-7072-439f-943a-c923548b2be5 + account: + accountNumber: 100179 + notifications: + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order + changelog: + createdBy: '12345' + createdDateTime: '2025-08-30T07:21:39Z' + additionalInfo: + errorCode: EQ-3058039 + errorMessage: Unable to activate Exchange Service Port. Please verify your configuration or contact support. + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_400" - "401": + value: + - errorCode: EQ-3067103 + errorMessage: Invalid request. Please verify the request payload. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid request. Please verify the request payload. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_401" - "403": + value: + - errorCode: EQ-3067106 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_403" - "404": + value: + - errorCode: EQ-3067102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_404" - "500": + value: + - errorCode: EQ-3067101 + errorMessage: Internet Exchange Service not found. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internet Exchange Service not found. + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_500" + value: + - errorCode: EQ-3067104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/exchangeServices/{exchangeServiceId}: get: tags: @@ -2716,62 +12422,148 @@ paths: description: Internet Exchange Service Id required: true schema: - $ref: "#/components/schemas/ExchangeServiceId" + description: Internet Exchange Service UUID + type: string + format: uuid + example: a8ba52de-faae-43b5-b0b1-6904d37ee011 responses: - "200": + '200': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceResponse" + $ref: '#/components/schemas/ExchangeServiceResponse' examples: GetExchangeServiceResponse: - $ref: "#/components/examples/ExchangeServiceResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 + uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 + type: IX + name: ix_exchange_service + bandwidth: 400000 + description: ix_exchange_service + state: PROVISIONING + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SV + metroCode: SV + publicPeeringConnection: + type: IX_VC + href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 + uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 + routingProtocol: + customerAsn: 5555 + macAddress: '00:11:22:33:44:55' + vlan: 99 + routeServerAsn: 24115 + bgpIpv4: + customerPeerIp: 12.1.1.1 + domainName: gw01.sin.example.net + primaryRouteServerIp: 10.1.1.1 + secondaryRouteServerIp: 10.1.1.2 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key12345 + prefixes: + - 203.0.113.0/24 + maxPrefixLimit: 300 + prependSelfEnabled: true + bgpIpv6: + customerPeerIp: 2001:db8:c59b::22 + domainName: gw01.sin.example.net + primaryRouteServerIp: 2001:db8:c59b::33 + secondaryRouteServerIp: 2001:db8:c59b::322 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key123456 + prefixes: + - 2001:DB8:123::/48 + maxPrefixLimit: 300 + prependSelfEnabled: true + routeCollector: + asn: 1238 + ipV4: 10.255.255.254 + ipV6: 2001:db8:85a3::8a2e:370:7334\ + order: + purchaseOrderNumber: 1-3456576 + orderNumber: 1-139105284200 + project: + projectId: e275485c-7072-439f-943a-c923548b2be5 + account: + accountNumber: 100179 + notifications: + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order + changelog: + createdBy: '12345' + createdDateTime: '2025-08-30T07:21:39Z' + additionalInfo: + errorCode: EQ-3058039 + errorMessage: Unable to activate Exchange Service Port. Please verify your configuration or contact support. + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_400" - "401": + value: + - errorCode: EQ-3067103 + errorMessage: Invalid request. Please verify the request payload. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid request. Please verify the request payload. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_401" - "403": + value: + - errorCode: EQ-3067106 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_403" - "404": + value: + - errorCode: EQ-3067102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_404" - "500": + value: + - errorCode: EQ-3067101 + errorMessage: Internet Exchange Service not found. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internet Exchange Service not found. + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_500" + value: + - errorCode: EQ-3067104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error patch: tags: - Internet Exchange Services @@ -2784,68 +12576,164 @@ paths: description: Internet Exchange Service Id required: true schema: - $ref: "#/components/schemas/ExchangeServiceId" + description: Internet Exchange Service UUID + type: string + format: uuid + example: a8ba52de-faae-43b5-b0b1-6904d37ee011 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/JsonPatch" + $ref: '#/components/schemas/JsonPatch' examples: ExchangeServicePatchMacAddressRequest: - $ref: "#/components/examples/ExchangeServicePatchMacAddressRequest" + value: + - op: replace + path: /routingProtocol/macAddress + value: 00:1A:2B:3C:4D:5E ExchangeServicePatchCustomerAsnRequest: - $ref: "#/components/examples/ExchangeServicePatchCustomerAsnRequest" + value: + - op: replace + path: /routingProtocol/customerAsn + value: 1232 ExchangeServicePatchRoutingProtocolIPv4PrefixesRequest: - $ref: "#/components/examples/ExchangeServicePatchRoutingProtocolIPv4PrefixesRequest" + value: + - op: replace + path: /routingProtocol/bgpIpv4/prefixes + value: + - 10.10.10.0/24 + - 10.10.20.0/24 ExchangeServicePatchRoutingProtocolIPv6PrefixesRequest: - $ref: "#/components/examples/ExchangeServicePatchRoutingProtocolIPv6PrefixesRequest" + value: + - op: replace + path: /routingProtocol/bgpIpv6/prefixes + value: + - 2001:db8:10::/48 + - 2001:db8:20::/48 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceResponse" + $ref: '#/components/schemas/ExchangeServiceResponse' examples: PatchExchangeServiceResponse: - $ref: "#/components/examples/ExchangeServicePatchResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 + uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 + type: IX + name: ix_exchange_service + bandwidth: 400000 + description: ix_exchange_service + state: REPROVISIONING + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SV + metroCode: SV + publicPeeringConnection: + type: IX_VC + href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 + uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 + routingProtocol: + customerAsn: 5555 + macAddress: '00:11:22:33:44:55' + vlan: 99 + routeServerAsn: 24115 + bgpIpv4: + customerPeerIp: 12.1.1.1 + domainName: gw01.sin.example.net + primaryRouteServerIp: 10.1.1.1 + secondaryRouteServerIp: 10.1.1.2 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key12345 + prefixes: + - 203.0.113.0/24 + maxPrefixLimit: 300 + prependSelfEnabled: true + bgpIpv6: + customerPeerIp: 2001:db8:c59b::22 + domainName: gw01.sin.example.net + primaryRouteServerIp: 2001:db8:c59b::33 + secondaryRouteServerIp: 2001:db8:c59b::322 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key123456 + prefixes: + - 2001:DB8:123::/48 + maxPrefixLimit: 300 + prependSelfEnabled: true + routeCollector: + asn: 1238 + ipV4: 10.255.255.254 + ipV6: 2001:db8:85a3::8a2e:370:7334 + order: + purchaseOrderNumber: 1-3456576 + orderNumber: 1-139105284200 + project: + projectId: e275485c-7072-439f-943a-c923548b2be5 + account: + accountNumber: 100179 + notifications: + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order + changelog: + updatedBy: '12345' + updatedDateTime: '2025-08-30T07:21:39Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_400" - "403": + value: + - errorCode: EQ-3067103 + errorMessage: Invalid request. Please verify the request payload. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid request. Please verify the request payload. + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_403" - "404": + value: + - errorCode: EQ-3067102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_404" - "500": + value: + - errorCode: EQ-3067101 + errorMessage: Internet Exchange Service not found. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internet Exchange Service not found. + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_500" + value: + - errorCode: EQ-3067104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/exchangeServices/search: post: tags: @@ -2853,76 +12741,255 @@ paths: summary: Search Internet Exchange Services description: The API provides capability to get list of user's Internet Exchange Service using search criteria, including optional filtering, pagination and sorting operationId: searchExchangeService - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceSearchRequest" + $ref: '#/components/schemas/ExchangeServiceSearchRequest' examples: ExchangeServiceSearchProjectId: - $ref: "#/components/examples/ExchangeServiceSearchProjectId" + value: + filter: + and: + - property: /project/projectId + operator: '=' + values: + - 30ad25e2-53dc-11ed-bdc3-0242ac120002 + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ExchangeServiceMultiProjectIdSearch: - $ref: "#/components/examples/ExchangeServiceSearchMultipleProjectIds" + value: + filter: + and: + - property: /project/projectId + operator: IN + values: + - 30ad25e2-53dc-11ed-bdc3-0242ac120002 + - 30ad25e2-53dc-11ed-bdc3-0242ac120003 + - 30ad25e2-53dc-11ed-bdc3-0242ac120004 + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ExchangeServiceStateSearch: - $ref: "#/components/examples/ExchangeServiceSearchState" + value: + filter: + and: + - property: /state + operator: '=' + values: + - PROVISIONING + pagination: + limit: 10 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ExchangeServiceMultiStateSearch: - $ref: "#/components/examples/ExchangeServiceSearchMultipleState" + value: + filter: + and: + - property: /state + operator: IN + values: + - PROVISIONING + - REPROVISIONING + pagination: + limit: 10 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ExchangeServiceMetroCodeSearch: - $ref: "#/components/examples/ExchangeServiceSearchMetroCode" + value: + filter: + and: + - property: /location/metroCode + operator: '=' + values: + - SV + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ExchangeServiceMultiMetroCodeSearch: - $ref: "#/components/examples/ExchangeServiceSearchMultipleMetroCode" + value: + filter: + and: + - property: /location/metroCode + operator: IN + values: + - SV + - NY + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ExchangeServiceBandwidthSearch: - $ref: "#/components/examples/ExchangeServiceSearchBandwidth" + value: + filter: + and: + - property: /bandwidth + operator: '=' + values: + - '500' + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ExchangeServiceMultiBandwidthSearch: - $ref: "#/components/examples/ExchangeServiceSearchMultipleBandwidth" + value: + filter: + and: + - property: /bandwidth + operator: IN + values: + - '500' + - '1000' + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceSearchResponse" + $ref: '#/components/schemas/ExchangeServiceSearchResponse' examples: example: - $ref: "#/components/examples/ExchangeServiceSearchResponse" - "400": + value: + pagination: + offset: 0 + limit: 10 + total: 1 + sort: + - property: /changeLog/updatedDateTime + direction: DESC + data: + - href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 + uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 + type: IX + name: ix_exchange_service + bandwidth: 400000 + description: ix_exchange_service + state: PROVISIONING + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SV + metroCode: SV + publicPeeringConnection: + type: IX_VC + href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 + uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 + routingProtocol: + customerAsn: 5555 + macAddress: '00:11:22:33:44:55' + vlan: 99 + routeServerAsn: 24115 + bgpIpv4: + customerPeerIp: 12.1.1.1 + domainName: gw01.sin.example.net + primaryRouteServerIp: 10.1.1.1 + secondaryRouteServerIp: 10.1.1.2 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key12345 + prefixes: + - 203.0.113.0/24 + maxPrefixLimit: 300 + prependSelfEnabled: true + bgpIpv6: + customerPeerIp: 2001:db8:c59b::22 + domainName: gw01.sin.example.net + primaryRouteServerIp: 2001:db8:c59b::33 + secondaryRouteServerIp: 2001:db8:c59b::322 + asSet: AS-EC-SV + mlpeEnabled: true + md5AuthKey: TESTMD5Key123456 + prefixes: + - 2001:DB8:123::/48 + maxPrefixLimit: 300 + prependSelfEnabled: true + routeCollector: + asn: 1238 + ipV4: 10.255.255.254 + ipV6: 2001:db8:85a3::8a2e:370:7334 + order: + purchaseOrderNumber: 1-3456576 + orderNumber: 1-139105284200 + project: + projectId: e275485c-7072-439f-943a-c923548b2be5 + account: + accountNumber: 100179 + notifications: + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order + changelog: + updatedBy: '12345' + updatedDateTime: '2025-08-30T07:21:39Z' + additionalInfo: + errorCode: EQ-3058039 + errorMessage: Unable to activate Exchange Service Port. Please verify your configuration or contact support. + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' example: - errorCode: EQ-3000035 errorMessage: Invalid request body - "401": + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_401" - "403": + value: + - errorCode: EQ-3067106 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' example: - errorCode: EQ-3000197 errorMessage: User not authorized to perform given action - "500": + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_500" + value: + - errorCode: EQ-3067104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/exchangeServices/{exchangeServiceId}/actions: post: tags: @@ -2936,75 +13003,107 @@ paths: description: Internet Exchange Service Id required: true schema: - $ref: "#/components/schemas/ExchangeServiceId" + description: Internet Exchange Service UUID + type: string + format: uuid + example: a8ba52de-faae-43b5-b0b1-6904d37ee011 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceActionRequest" + $ref: '#/components/schemas/ExchangeServiceActionRequest' examples: ActivateExchangeServiceRequest: - $ref: "#/components/examples/EXCHANGE_SERVICE_ACTIVATE" + value: + type: EXCHANGE_SERVICE_ACTIVATE ValidateExchangeServiceRequest: - $ref: "#/components/examples/EXCHANGE_SERVICE_VALIDATE" + value: + type: EXCHANGE_SERVICE_VALIDATE RetryExchangeServiceRequest: - $ref: "#/components/examples/EXCHANGE_SERVICE_RETRY_PROVISION" + value: + type: EXCHANGE_SERVICE_RETRY_PROVISION required: true responses: - "202": + '202': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/ExchangeServiceActionResponse" + $ref: '#/components/schemas/ExchangeServiceActionResponse' examples: example: - $ref: "#/components/examples/ExchangeServiceActionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/exchangeService/a8ba52de-faae-43b5-b0b1-6904d37ee011/actions/3a58dd05-f46d-4b1d-a154-2e85c396ea62 + type: EXCHANGE_SERVICE_ACTIVATE + uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 + state: SUCCEEDED + changelog: + createdDateTime: '2026-02-10T11:30:00Z' + createdBy: Alice + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_400" - "401": + value: + - errorCode: EQ-3067103 + errorMessage: Invalid request. Please verify the request payload. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid request. Please verify the request payload. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_401" - "403": + value: + - errorCode: EQ-3067106 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_403" - "404": + value: + - errorCode: EQ-3067102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_404" - "500": + value: + - errorCode: EQ-3067101 + errorMessage: Internet Exchange Service not found. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internet Exchange Service not found. + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/ExchangeService_500" + value: + - errorCode: EQ-3067104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/internetAccessServices: post: tags: @@ -3012,44 +13111,103 @@ paths: summary: Create Internet Access Service description: Creates Internet Access Service operationId: createEiaService - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/InternetAccessPostRequest" + $ref: '#/components/schemas/InternetAccessPostRequest' examples: CreateInternetAccess: - $ref: "#/components/examples/InternetAccessCreate" + value: + type: SINGLE_IA + name: internet-access-primary + bandwidth: 1000 + routingProtocol: + type: BGP + exportPolicy: FULL + asn: + uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 + connections: + - uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + customerRoutes: + - ipBlock: + uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + billing: + type: FIXED + project: + projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 + account: + accountNumber: '57689234' + order: + purchaseOrderNumber: PO-98765 required: true responses: - "202": + '202': description: EIA Service creation or update accepted content: application/json: schema: - $ref: "#/components/schemas/InternetAccessService" + $ref: '#/components/schemas/InternetAccessService' examples: internetAccessServiceAccepted: - $ref: "#/components/examples/InternetAccessServiceAcceptedResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 + type: SINGLE_IA + uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 + name: internet-access-primary + state: PROVISIONING + change: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents + routingProtocol: + type: BGP + exportPolicy: FULL + asn: + href: https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1 + uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 + customerRoutes: + - ipBlock: + href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + connections: + - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + billing: + type: FIXED + enabled: true + startDate: '2026-04-16T00:00:00Z' + account: + accountNumber: '57689234' + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 + project: + projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 + order: + href: https://api.equinix.com/colocations/v2/orders/100200300 + orderNumber: 100200300 + purchaseOrderNumber: PO-98765 + changeLog: + createdBy: api-user + createdDateTime: '2026-04-16T00:00:00Z' + updatedBy: api-user + updatedDateTime: '2026-04-16T00:00:01Z' + useCase: MAIN + '400': description: Invalid input parameter content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/internetAccessServices/search: post: tags: @@ -3057,44 +13215,90 @@ paths: summary: Search Internet Access Services description: Search for Internet Access Services operationId: searchEiaServices - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/InternetAccessSearchRequest" + $ref: '#/components/schemas/InternetAccessSearchRequest' examples: SearchByProject: - $ref: "#/components/examples/InternetAccessSearchByProject" + value: + filter: + and: + - property: /project/projectId + operator: '=' + values: + - 44f4c4f8-2f39-494e-838c-d8e640591be5 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime required: true responses: - "200": + '200': description: EIA Services retrieved successfully content: application/json: schema: - $ref: "#/components/schemas/InternetAccessServices" + $ref: '#/components/schemas/InternetAccessServices' examples: internetAccessServicesRetrieved: - $ref: "#/components/examples/InternetAccessServicesRetrievedResponseExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + data: + - href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 + type: SINGLE_IA + uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 + name: internet-access-primary + state: PROVISIONED + change: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents + routingProtocol: + type: BGP + customerRoutes: + - ipBlock: + href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + connections: + - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + billing: + type: FIXED + account: + accountNumber: '57689234' + project: + projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 + order: + purchaseOrderNumber: PO-98765 + changeLog: + createdDateTime: '2026-04-16T00:00:00Z' + useCase: MAIN + '400': description: Invalid input parameter content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/internetAccessServices/{uuid}: get: tags: @@ -3111,27 +13315,73 @@ paths: type: string format: uuid responses: - "200": + '200': description: EIA Service retrieved successfully content: application/json: schema: - $ref: "#/components/schemas/InternetAccessService" + $ref: '#/components/schemas/InternetAccessService' examples: internetAccessServiceRetrieved: - $ref: "#/components/examples/InternetAccessServiceRetrievedResponseExample" - "404": + value: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 + type: SINGLE_IA + uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 + name: internet-access-primary + state: PROVISIONED + bandwidth: 1000 + bandwidthCommit: 500 + change: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents + locations: + - metroHref: https://api.equinix.com/fabric/v4/metros/WA + metroCode: WA + region: AMER + ibx: WA1 + routingProtocol: + type: BGP + exportPolicy: FULL + asn: + href: https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1 + uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 + customerRoutes: + - ipBlock: + href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + connections: + - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + billing: + type: FIXED + enabled: true + startDate: '2026-04-16T00:00:00Z' + account: + accountNumber: '57689234' + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 + project: + projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 + order: + href: https://api.equinix.com/colocations/v2/orders/100200300 + orderNumber: 100200300 + purchaseOrderNumber: PO-98765 + changeLog: + createdBy: api-user + createdDateTime: '2026-04-16T00:00:00Z' + updatedBy: api-user + updatedDateTime: '2026-04-16T00:10:00Z' + useCase: MAIN + '404': description: EIA Service not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - delete: + $ref: '#/components/schemas/ErrorList' + patch: tags: - Internet Access Services - summary: Delete Internet Access Service by ID - description: Delete Internet Access Service by UUID - operationId: deleteEiaService + summary: Update Internet Access Service by ID + description: Patch Internet Access Service by UUID + operationId: patchEiaService parameters: - name: uuid in: path @@ -3140,34 +13390,96 @@ paths: schema: type: string format: uuid + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InternetAccessPatchRequest' + examples: + Add and remove IP Blocks in a single request: + value: + - op: add + path: /routingProtocol/customerRoutes + value: + ipBlock: + uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + - op: remove + path: /routingProtocol/customerRoutes[@.ipBlock.uuid=ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91] + Update bandwidth with purchase order number: + value: + - op: replace + path: /bandwidth + value: 50 + - op: replace + path: /order/purchaseOrderNumber + value: PO-98765 + Update name: + value: + - op: replace + path: /name + value: New Name + required: true responses: - "202": + '202': description: EIA Service creation or update accepted content: application/json: schema: - $ref: "#/components/schemas/InternetAccessService" + $ref: '#/components/schemas/InternetAccessService' examples: internetAccessServiceAccepted: - $ref: "#/components/examples/InternetAccessServiceAcceptedResponseExample" - "404": + value: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 + type: SINGLE_IA + uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 + name: internet-access-primary + state: PROVISIONING + change: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents + routingProtocol: + type: BGP + exportPolicy: FULL + asn: + href: https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1 + uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 + customerRoutes: + - ipBlock: + href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + connections: + - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + billing: + type: FIXED + enabled: true + startDate: '2026-04-16T00:00:00Z' + account: + accountNumber: '57689234' + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 + project: + projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 + order: + href: https://api.equinix.com/colocations/v2/orders/100200300 + orderNumber: 100200300 + purchaseOrderNumber: PO-98765 + changeLog: + createdBy: api-user + createdDateTime: '2026-04-16T00:00:00Z' + updatedBy: api-user + updatedDateTime: '2026-04-16T00:00:01Z' + useCase: MAIN + '404': description: EIA Service not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "409": - description: EIA Service cannot be deleted due to active products - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - patch: + $ref: '#/components/schemas/ErrorList' + delete: tags: - Internet Access Services - summary: Update Internet Access Service by ID - description: Patch Internet Access Service by UUID - operationId: patchEiaService + summary: Delete Internet Access Service by ID + description: Delete Internet Access Service by UUID + operationId: deleteEiaService parameters: - name: uuid in: path @@ -3176,35 +13488,67 @@ paths: schema: type: string format: uuid - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/InternetAccessPatchRequest" - examples: - Add and remove IP Blocks in a single request: - $ref: "#/components/examples/InternetAccessPatchManageCustomerRoutes" - Update bandwidth with purchase order number: - $ref: "#/components/examples/InternetAccessPatchUpdateServiceBandwidth" - Update name: - $ref: "#/components/examples/InternetAccessPatchUpdateName" - required: true responses: - "202": + '202': description: EIA Service creation or update accepted content: application/json: schema: - $ref: "#/components/schemas/InternetAccessService" + $ref: '#/components/schemas/InternetAccessService' examples: internetAccessServiceAccepted: - $ref: "#/components/examples/InternetAccessServiceAcceptedResponseExample" - "404": + value: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 + type: SINGLE_IA + uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 + name: internet-access-primary + state: PROVISIONING + change: + href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents + routingProtocol: + type: BGP + exportPolicy: FULL + asn: + href: https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1 + uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 + customerRoutes: + - ipBlock: + href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + connections: + - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 + billing: + type: FIXED + enabled: true + startDate: '2026-04-16T00:00:00Z' + account: + accountNumber: '57689234' + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 + project: + projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 + order: + href: https://api.equinix.com/colocations/v2/orders/100200300 + orderNumber: 100200300 + purchaseOrderNumber: PO-98765 + changeLog: + createdBy: api-user + createdDateTime: '2026-04-16T00:00:00Z' + updatedBy: api-user + updatedDateTime: '2026-04-16T00:00:01Z' + useCase: MAIN + '404': description: EIA Service not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' + '409': + description: EIA Service cannot be deleted due to active products + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' /fabric/v4/ipBlocks: post: tags: @@ -3212,48 +13556,119 @@ paths: summary: Create IP Block description: Submits new Equinix owned or customer owned IP Block request operationId: submitIpBlock - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/SubmitIpBlockRequestBody" + $ref: '#/components/schemas/SubmitIpBlockRequestBody' examples: EquinixOwnedApacWithRegulations: - $ref: "#/components/examples/IpBlockCreateEquinixApacRequest" + value: + prefixLength: 24 + location: + metroCode: SY + project: + projectId: 52cb19be-63c4-434d-bec8-5e94636291fc + type: IPV4_IP_BLOCK + regulations: + addressingPlans: + - purpose: SERVERS + size: 100 + - purpose: ROUTERS + size: 154 + questions: + privateSpaceConsidered: true + refusedPreviously: true + returningAddressSpace: false + account: + accountNumber: 2-57689234 + order: + purchaseOrderNumber: purchase-order123 CustomerOwned: - $ref: "#/components/examples/IpBlockCreateCustomerOwnedRequest" + value: + prefix: 128.112.4.0/24 + type: IPV4_IP_BLOCK + project: + projectId: 52cb19be-63c4-434d-bec8-5e94636291fc required: true responses: - "202": + '202': description: IP Block submitted, patched, or deletion accepted content: application/json: schema: - $ref: "#/components/schemas/IpBlock" + $ref: '#/components/schemas/IpBlock' examples: EquinixOwnedAccepted: - $ref: "#/components/examples/IpBlockEquinixOwnershipAcceptedResponse" + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: PENDING + ownership: EQUINIX + location: + metroHref: https://api.equinix.com/fabric/v4/metros/WA + metroCode: SY + prefixLength: 24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + order: + href: https://api.equinix.com/colocations/v2/orders/1-34834234 + orderNumber: 1-34834234 + account: + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/2-57689234 + accountNumber: 2-57689234 + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + regulations: + addressingPlans: + - purpose: SERVERS + size: 100 + - purpose: ROUTERS + size: 154 + questions: + privateSpaceConsidered: true + refusedPreviously: true + returningAddressSpace: false + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] CustomerOwnedAccepted: - $ref: "#/components/examples/IpBlockCustomerOwnershipAcceptedResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: ACTIVE + ownership: CUSTOMER + prefixLength: 24 + prefix: 128.112.4.0/24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] + '400': description: Invalid input parameter content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/ipBlocks/{uuid}: get: tags: @@ -3270,35 +13685,83 @@ paths: type: string format: uuid responses: - "200": + '200': description: IP Block retrieved successfully content: application/json: schema: - $ref: "#/components/schemas/IpBlock" + $ref: '#/components/schemas/IpBlock' examples: EquinixOwnedRetrieved: - $ref: "#/components/examples/IpBlockEquinixOwnershipAcceptedResponse" + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: PENDING + ownership: EQUINIX + location: + metroHref: https://api.equinix.com/fabric/v4/metros/WA + metroCode: SY + prefixLength: 24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + order: + href: https://api.equinix.com/colocations/v2/orders/1-34834234 + orderNumber: 1-34834234 + account: + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/2-57689234 + accountNumber: 2-57689234 + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + regulations: + addressingPlans: + - purpose: SERVERS + size: 100 + - purpose: ROUTERS + size: 154 + questions: + privateSpaceConsidered: true + refusedPreviously: true + returningAddressSpace: false + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] CustomerOwnedRetrieved: - $ref: "#/components/examples/IpBlockCustomerOwnershipAcceptedResponse" - "403": + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: ACTIVE + ownership: CUSTOMER + prefixLength: 24 + prefix: 128.112.4.0/24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: IP Block not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' delete: tags: - IP Blocks @@ -3314,47 +13777,95 @@ paths: type: string format: uuid responses: - "202": + '202': description: IP Block submitted, patched, or deletion accepted content: application/json: schema: - $ref: "#/components/schemas/IpBlock" + $ref: '#/components/schemas/IpBlock' examples: EquinixOwnedAccepted: - $ref: "#/components/examples/IpBlockEquinixOwnershipAcceptedResponse" + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: PENDING + ownership: EQUINIX + location: + metroHref: https://api.equinix.com/fabric/v4/metros/WA + metroCode: SY + prefixLength: 24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + order: + href: https://api.equinix.com/colocations/v2/orders/1-34834234 + orderNumber: 1-34834234 + account: + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/2-57689234 + accountNumber: 2-57689234 + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + regulations: + addressingPlans: + - purpose: SERVERS + size: 100 + - purpose: ROUTERS + size: 154 + questions: + privateSpaceConsidered: true + refusedPreviously: true + returningAddressSpace: false + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] CustomerOwnedAccepted: - $ref: "#/components/examples/IpBlockCustomerOwnershipAcceptedResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: ACTIVE + ownership: CUSTOMER + prefixLength: 24 + prefix: 128.112.4.0/24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] + '400': description: Invalid input parameter content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: IP Block not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "409": + $ref: '#/components/schemas/ErrorList' + '409': description: IP Block cannot be deleted due to active products content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' patch: tags: - IP Blocks @@ -3373,32 +13884,80 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/PatchIpBlockRequestBody" + $ref: '#/components/schemas/PatchIpBlockRequestBody' required: true responses: - "202": + '202': description: IP Block submitted, patched, or deletion accepted content: application/json: schema: - $ref: "#/components/schemas/IpBlock" + $ref: '#/components/schemas/IpBlock' examples: EquinixOwnedAccepted: - $ref: "#/components/examples/IpBlockEquinixOwnershipAcceptedResponse" + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: PENDING + ownership: EQUINIX + location: + metroHref: https://api.equinix.com/fabric/v4/metros/WA + metroCode: SY + prefixLength: 24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + order: + href: https://api.equinix.com/colocations/v2/orders/1-34834234 + orderNumber: 1-34834234 + account: + href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/2-57689234 + accountNumber: 2-57689234 + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + regulations: + addressingPlans: + - purpose: SERVERS + size: 100 + - purpose: ROUTERS + size: 154 + questions: + privateSpaceConsidered: true + refusedPreviously: true + returningAddressSpace: false + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] CustomerOwnedAccepted: - $ref: "#/components/examples/IpBlockCustomerOwnershipAcceptedResponse" - "404": + value: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + uuid: 31fbdb3f-8def-410d-868b-ef920878affb + state: ACTIVE + ownership: CUSTOMER + prefixLength: 24 + prefix: 128.112.4.0/24 + type: IPV4_IP_BLOCK + change: + href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents + project: + href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc + projectId: 03ed2230-604a-494c-bca2-c042d38d80bc + changeLog: + createdDateTime: '2025-12-01T12:11:22.222351Z' + assets: [] + '404': description: IP Block not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/ipBlocks/search: post: tags: @@ -3406,32 +13965,31 @@ paths: summary: Search IP Blocks description: Search for IP Blocks based on criteria operationId: searchIpBlocks - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/IpBlocksSearchRequestBody" + $ref: '#/components/schemas/IpBlocksSearchRequestBody' required: true responses: - "200": + '200': description: IP Blocks found successfully content: application/json: schema: - $ref: "#/components/schemas/IpBlockSearchResponseBody" - "400": + $ref: '#/components/schemas/IpBlockSearchResponseBody' + '400': description: Invalid input parameter content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/connections/search: post: tags: @@ -3439,95 +13997,691 @@ paths: 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" + $ref: '#/components/schemas/SearchRequest' examples: ConnectionSearchDirection: - $ref: "#/components/examples/ConnectionSearchDirection" + value: + filter: + and: + - property: /direction + operator: '=' + values: + - OUTGOING + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchIsremote: - $ref: "#/components/examples/ConnectionSearchIsremote" + value: + filter: + and: + - property: /isRemote + operator: '=' + values: + - 'true' + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchName: - $ref: "#/components/examples/ConnectionSearchName" + value: + filter: + and: + - property: /name + operator: '=' + values: + - AWS-Dot1Q-AWSRemote + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchUuid: - $ref: "#/components/examples/ConnectionSearchUuid" + value: + filter: + and: + - property: /uuid + operator: '=' + values: + - 3736df8d-a903-42fd-bd06-06c9a76b238e + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchCustorg: - $ref: "#/components/examples/ConnectionSearchCustorg" + value: + filter: + and: + - property: /account/orgId + operator: '=' + values: + - '91997' + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchAccountname: - $ref: "#/components/examples/ConnectionSearchAccountname" + value: + filter: + and: + - property: /aSide/accessPoint/account/accountName + operator: '=' + values: + - testBuyer-270001 + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchCloudRouteruuid: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: + limit: 25 + offset: 0 ConnectionSearchAsidemetrocodemetroname: - $ref: "#/components/examples/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: + limit: 25 + offset: 0 ConnectionSearchAsideaccesspointname: - $ref: "#/components/examples/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: + limit: 25 + offset: 0 ConnectionSearchAsideaccesspointuuid: - $ref: "#/components/examples/ConnectionSearchAsideaccesspointuuid" + value: + filter: + and: + - property: /aSide/accessPoint/port/uuid + operator: '=' + values: + - c791f8cb-5941-9410-8ce0-306a5c00a4ee + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchAsideaccesspointtype: - $ref: "#/components/examples/ConnectionSearchAsideaccesspointtype" + value: + filter: + and: + - property: /aSide/accessPoint/type + operator: '=' + values: + - COLO + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchAsidevirtualdevicename: - $ref: "#/components/examples/ConnectionSearchAsidevirtualdevicename" + value: + filter: + and: + - property: /aSide/accessPoint/virtualDevice/name + operator: '=' + values: + - E2E-NE-Device-Aut-170122034210108 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchAsidevirtualdeviceuuid: - $ref: "#/components/examples/ConnectionSearchAsidevirtualdeviceuuid" + value: + filter: + and: + - property: /aSide/accessPoint/virtualDevice/uuid + operator: '=' + values: + - c6b96cec-cf70-4700-9c1e-2f73724d2fa5 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchAsideservicetokenuuid: - $ref: "#/components/examples/ConnectionSearchAsideservicetokenuuid" + value: + filter: + and: + - property: /aSide/serviceToken/uuid + operator: '=' + values: + - 30225621-c1ad-4614-b6a5-d9c70cad61cb + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchChangestatus: - $ref: "#/components/examples/ConnectionSearchChangestatus" + value: + filter: + and: + - property: /change/status + operator: '=' + values: + - APPROVED + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchUpdatedatetime: - $ref: "#/components/examples/ConnectionSearchUpdatedatetime" + value: + filter: + and: + - property: /changeLog/updatedDateTime + operator: '=' + values: + - '2021-01-02T00:00:00Z' + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchEquinixstatus: - $ref: "#/components/examples/ConnectionSearchEquinixstatus" + value: + filter: + and: + - property: /operation/equinixStatus + operator: '=' + values: + - PROVISIONED + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchProviderstatus: - $ref: "#/components/examples/ConnectionSearchProviderstatus" + value: + filter: + and: + - property: /operation/providerStatus + operator: '=' + values: + - AVAILABLE + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchProjectid: - $ref: "#/components/examples/ConnectionSearchProjectidOPtional-CRH" + value: + filter: + and: + - property: /project/projectId + operator: '=' + values: + - 30ad25e2-53dc-11ed-bdc3-0242ac120002 + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC ConnectionSearchRedundancygroup: - $ref: "#/components/examples/ConnectionSearchRedundancygroup" + value: + filter: + and: + - operator: '=' + property: /redundancy/group + values: + - 3f7ab592-0db3-41b8-bb9a-ecc05d5d5732 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchRedundancypriority: - $ref: "#/components/examples/ConnectionSearchRedundancypriority" + value: + filter: + and: + - operator: '=' + property: /redundancy/priority + values: + - PRIMARY + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchZsidevlanstagctag: - $ref: "#/components/examples/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: + limit: 25 + offset: 0 ConnectionSearchZsidemetrocodemetroname: - $ref: "#/components/examples/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: + limit: 25 + offset: 0 ConnectionSearchZsideaccesspointname: - $ref: "#/components/examples/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: + limit: 25 + offset: 0 ConnectionSearchZsideaccesspointuuid: - $ref: "#/components/examples/ConnectionSearchZsideaccesspointuuid" + value: + filter: + and: + - property: /zSide/accessPoint/port/uuid + operator: '=' + values: + - c791f8cb-5941-9410-8ce0-306a5c00a4ee + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchZsideaccesspointtype: - $ref: "#/components/examples/ConnectionSearchZsideaccesspointtype" + value: + filter: + and: + - property: /zSide/accessPoint/type + operator: '=' + values: + - COLO + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchZsidevirtualdevicename: - $ref: "#/components/examples/ConnectionSearchZsidevirtualdevicename" + value: + filter: + and: + - property: /zSide/accessPoint/virtualDevice/name + operator: '=' + values: + - E2E-NE-Device-Aut-170122034210108 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchZsidevirtualdeviceuuid: - $ref: "#/components/examples/ConnectionSearchZsidevirtualdeviceuuid" + value: + filter: + and: + - property: /zSide/accessPoint/virtualDevice/uuid + operator: '=' + values: + - c6b96cec-cf70-4700-9c1e-2f73724d2fa5 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchZsideservicetokenuuid: - $ref: "#/components/examples/ConnectionSearchZsideservicetokenuuid" + value: + filter: + and: + - property: /zSide/serviceToken/uuid + operator: '=' + values: + - 019eab69-8293-4abf-ac8c-e6269d5a3e92 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchZsideprofileuuid: - $ref: "#/components/examples/ConnectionSearchZsideprofileuuid" + value: + filter: + and: + - property: /zSide/accessPoint/profile/uuid + operator: '=' + values: + - c6b96cec-cf70-4700-9c1e-2f73724d2fa5 + sort: + - direction: DESC + property: /changeLog/updatedDateTime + pagination: + limit: 25 + offset: 0 ConnectionSearchANDwithNestedOR-LIKE: - $ref: "#/components/examples/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: + limit: 25 + offset: 0 ConnectionSearchORwithNestedAND: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 ConnectionSearchByMaintenanceStatus: - $ref: "#/components/examples/ConnectionSearchByMaintenanceStatus" + value: + filter: + and: + - property: /operation/maintenanceStatus + operator: IN + values: + - SCHEDULED + - COMPLETED + - property: /operation/lockEnabled + operator: IN + values: + - 'true' + pagination: + limit: 25 + offset: 0 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionSearchResponse" + $ref: '#/components/schemas/ConnectionSearchResponse' example: pagination: offset: 0 @@ -3583,43 +14737,47 @@ paths: maintenanceStatus: SCHEDULED lockEnabled: true changeLog: - createdDateTime: 2020-05-21T10:30:00Z - updatedDateTime: 2020-05-21T10:30:00Z + createdDateTime: '2020-05-21T10:30:00Z' + updatedDateTime: '2020-05-21T10:30:00Z' project: projectId: 2c10d60e-29c1-4721-ad1a-b531f4e04717 - "400": + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' example: - errorCode: EQ-3000035 errorMessage: Invalid request body - "401": + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' example: - errorCode: EQ-3000197 errorMessage: User not authorized to perform given action - "404": + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' /fabric/v4/prices/search: post: tags: @@ -3627,104 +14785,962 @@ paths: summary: Search Prices description: Search prices by search criteria operationId: searchPrices - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/FilterBody" + $ref: '#/components/schemas/FilterBody' examples: virtualConnectionProductEvplVcTypeFromColoToColo: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 virtualConnectionProductFcrVcTypeFromGWToSP: - $ref: "#/components/examples/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 virtualConnectionProductFcrVcTypeFromGWToColo: - $ref: "#/components/examples/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 virtualConnectionProductFcrVcTypeFromVDToColo: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 virtualConnectionProductOfflineEvpLanVcTypeFromColoToNetwork: - $ref: "#/components/examples/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' virtualConnectionProductColoToColoWithGeoScope: - $ref: "#/components/examples/VirtualConnectionProductColoToColoWithGeoScope" + 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 + - property: /connection/geoScope + operator: '=' + values: + - CONUS cloudRouterProduct: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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' virtualPortProductUPP: - $ref: "#/components/examples/VirtualPortProductUPP" + 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/package/code + operator: '=' + values: + - UNLIMITED_PLUS + - property: /port/serviceType + operator: '=' + values: + - EPL + - property: /port/connectivitySource/type + operator: '=' + values: + - COLO + - property: /port/lag/enabled + operator: '=' + values: + - 'false' virtualPortProductIX: - $ref: "#/components/examples/VirtualPortProductIX" + value: + filter: + and: + - property: /type + operator: '=' + values: + - VIRTUAL_PORT_PRODUCT + - property: /port/location/ibx + operator: '=' + values: + - DA1 + - property: /port/type + operator: '=' + values: + - XF_PORT + - property: /port/bandwidth + operator: '=' + values: + - '1000' + - property: /port/serviceCode + operator: '=' + values: + - IX + - property: /port/connectivitySource/type + operator: '=' + values: + - COLO precisionTimeProductNtpStandardPackageCode: - $ref: "#/components/examples/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 precisionTimeProductNtpEnterprisePackageCode: - $ref: "#/components/examples/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 precisionTimeProductPtpStandardPackageCode: - $ref: "#/components/examples/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 precisionTimeProductPtpEnterprisePackageCode: - $ref: "#/components/examples/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 opticalConnectProduct: - $ref: "#/components/examples/OpticalConnectProduct" + value: + filter: + and: + - property: /type + operator: '=' + values: + - OPTICAL_CONNECT_PRODUCT + - property: /account/accountNumber + operator: '=' + values: + - '200551' + - property: /opticalConnect/type + operator: '=' + values: + - OC + - property: /opticalConnect/bandwidth + operator: '=' + values: + - '1000' + - property: /opticalConnect/pathType + operator: '=' + values: + - PROTECTED + - property: /opticalConnect/connectionDestinationType + operator: '=' + values: + - COLO + - property: /opticalConnect/aSide/location/ibxCode + operator: '=' + values: + - CH1 + - property: /opticalConnect/zSide/location/ibxCode + operator: '=' + values: + - CH3 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/PriceSearchResponse" + $ref: '#/components/schemas/PriceSearchResponse' examples: virtualConnection: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 cloudRouter: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 virtualPortUPP: - $ref: "#/components/examples/VirtualPortUPP" + 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 + package: + code: UNLIMITED_PLUS virtualPortIX: - $ref: "#/components/examples/VirtualPortIX" + value: + pagination: + offset: 0 + limit: 1 + total: 1 + data: + - type: VIRTUAL_PORT_PRODUCT + code: IX00008.PROD + name: Equinix Internet Exchange Port Product + description: Internet Exchange 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 + serviceCode: IX precisionTimeService: - $ref: "#/components/examples/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 opticalConnect: - $ref: "#/components/examples/OpticalConnect" - "400": + value: + pagination: + offset: 0 + limit: 1 + total: 1 + data: + - type: OPTICAL_CONNECT_PRODUCT + code: MC00007.PROD + name: Optical Connect Port Product + description: Optical Connect Port + account: + accountNumber: 200551 + orgId: 123 + charges: + - type: MONTHLY_RECURRING + price: 500 + - type: NON_RECURRING + price: 0 + currency: USD + opticalConnect: + type: OC + bandwidth: 1000 + pathType: PROTECTED + connectionDestinationType: COLO + aSide: + location: + ibxCode: CH1 + zSide: + location: + ibxCode: CH3 + '400': description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/PriceErrorList" + $ref: '#/components/schemas/PriceErrorList' examples: example: - $ref: "#/components/examples/400_prices" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/PriceErrorList" + $ref: '#/components/schemas/PriceErrorList' examples: example: - $ref: "#/components/examples/500_prices" + value: + - errorCode: EQ-3038030 + errorMessage: Internal Server Error + details: We couldn't process you request /fabric/v4/ports/{portId}/stats: get: tags: - Statistics summary: Get Stats by ID (DEPRECATED) 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.**(DEPRECATED)** + deprecated: true operationId: getPortStatsByPortUuid parameters: - name: portId @@ -3732,65 +15748,105 @@ paths: description: Port UUID required: true schema: - $ref: "#/components/schemas/PortUUID" + description: Port UUID + type: string + format: uuid - name: startDateTime in: query description: startDateTime required: true schema: - $ref: "#/components/schemas/StartDateTime" - example: 2020-11-06T07:00:00Z + $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 + $ref: '#/components/schemas/endDateTime' + example: '2020-11-10T07:00:00Z' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Statistics" + $ref: '#/components/schemas/Statistics' examples: statsExample: - $ref: "#/components/examples/200_port" - "401": + value: + href: http://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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "500": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - deprecated: true + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/connections/{connectionId}/stats: get: tags: - Statistics summary: Get Stats by ID (DEPRECATED) 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 **(DEPRECATED)** + deprecated: true operationId: getConnectionStatsByPortUuid parameters: - name: connectionId @@ -3798,57 +15854,108 @@ paths: description: Connection UUID required: true schema: - $ref: "#/components/schemas/VirtualCircuitId" + description: Virtual Circuit UUID + type: string - name: startDateTime in: query description: startDateTime required: true schema: - $ref: "#/components/schemas/StartDateTime" - example: 2020-11-06T07:00:00Z + $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 + $ref: '#/components/schemas/endDateTime' + example: '2020-11-10T07:00:00Z' - name: viewPoint in: query description: viewPoint required: true schema: - $ref: "#/components/schemas/viewPoint" + $ref: '#/components/schemas/viewPoint' example: aSide responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Statistics" + $ref: '#/components/schemas/Statistics' examples: statsExample: - $ref: "#/components/examples/200_vc" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - deprecated: true + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/serviceProfiles: get: tags: @@ -3881,124 +15988,698 @@ paths: - aSide - zSide responses: - "200": + '200': description: Successful operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfiles" + $ref: '#/components/schemas/ServiceProfiles' examples: ASideServiceProfile: - $ref: "#/components/examples/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 + selectiveRedundancy: 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 ZSideServiceProfile: - $ref: "#/components/examples/SellerServiceProfilesResponse" - "400": + 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 + selectiveRedundancy: 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-read" - "500": + value: + - errorCode: EQ-3001033 + errorMessage: You are not authorized to execute the requested action on the resource + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error post: tags: - Service Profiles summary: Create Service Profile description: Create Service Profile creates Equinix Fabric™ Service Profile operationId: createServiceProfile - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/ServiceProfileRequest" + $ref: '#/components/schemas/ServiceProfileRequest' examples: ServiceProfileCreate: - $ref: "#/components/examples/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 + selectiveRedundancy: 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: - $ref: "#/components/examples/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 + selectiveRedundancy: 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 LmaasServiceProfileCreate: - $ref: "#/components/examples/LmaasServiceProfileCreate" + value: + name: Last Mile Service Profile 1 + description: Sample Last Mile Service Profile + type: LMAAS_PROFILE + notifications: + - emails: + - someone@sample.com + type: QUOTE_NOTIFICATIONS + tags: [] + visibility: PUBLIC + customFields: [] + allowedEmails: [] + ports: + - type: XF_PORT + uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 + location: + metroCode: DC + crossConnectId: ECX.03.00000962 + lastMileConfig: + productCatalogs: + - id: sample-product-offering-id + name: Sample Product Offering + webUrl: https://www.example.com/lastmile + deliveryDate: + min: 10 + max: 30 + unit: DAYS + billingTerms: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + offerings: + - bandwidth: 50 + price: + unit: USD + min: 100 + max: 500 + - bandwidth: 100 + price: + unit: USD + min: 200 + max: 500 + - bandwidth: 200 + price: + unit: USD + min: 300 + max: 500 + - bandwidth: 1000 + price: + unit: USD + min: 1000 + max: 2000 + accessPointTypeConfigs: + - type: COLO + linkProtocolConfig: + namedTags: [] + reuseVlanSTag: false + enableAutoGenerateServiceKey: false + apiConfig: + equinixManagedPort: false + equinixManagedVlan: false + allowOverSubscription: false + overSubscriptionLimit: 1 + apiAvailable: false + integrationId: '' + bandwidthFromApi: false + authenticationKey: + required: false + allowRemoteConnections: true + supportedBandwidths: + - 10 + - 50 + - 200 + - 500 + - 1000 + allowCustomBandwidth: false + connectionLabel: Connection + allowBandwidthAutoApproval: false + connectionRedundancyRequired: false + selectiveRedundancy: true + marketingInfo: + processSteps: [] + promotion: true required: true responses: - "201": + '201': description: Successful Create operation - headers: - ETag: - $ref: "#/components/headers/ETag" content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfile" + $ref: '#/components/schemas/ServiceProfile' examples: ServiceProfile: - $ref: "#/components/examples/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 + selectiveRedundancy: 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 LmaasServiceProfile: - $ref: "#/components/examples/LmaasServiceProfileCreateResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 + uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 + name: Last Mile Service Profile 1 + description: Sample Last Mile Service Profile + type: LMAAS_PROFILE + notifications: + - emails: + - someone@sample.com + type: QUOTE_NOTIFICATIONS + tags: [] + visibility: PUBLIC + customFields: [] + allowedEmails: [] + ports: + - type: XF_PORT + uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 + location: + metroCode: DC + crossConnectId: ECX.03.00000962 + lastMileConfig: + apiIntegration: + siteValidationEnabled: false + dataCenterLocationEnabled: false + productOfferingEnabled: false + poqEnabled: false + quoteEnabled: false + placeOrderEnabled: false + quoteViaAggregatorEnabled: false + productCatalogs: + - id: sample-product-offering-id + name: Sample Product Offering + webUrl: https://www.example.com/lastmile + deliveryDate: + min: 10 + max: 30 + unit: DAYS + billingTerms: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + offerings: + - bandwidth: 50 + price: + unit: USD + min: 100 + max: 500 + - bandwidth: 100 + price: + unit: USD + min: 200 + max: 500 + - bandwidth: 200 + price: + unit: USD + min: 300 + max: 500 + - bandwidth: 1000 + price: + unit: USD + min: 1000 + max: 2000 + accessPointTypeConfigs: + - type: COLO + linkProtocolConfig: + namedTags: [] + reuseVlanSTag: false + enableAutoGenerateServiceKey: false + apiConfig: + equinixManagedPort: false + equinixManagedVlan: false + allowOverSubscription: false + overSubscriptionLimit: 1 + apiAvailable: false + integrationId: '' + bandwidthFromApi: false + authenticationKey: + required: false + allowRemoteConnections: true + supportedBandwidths: + - 10 + - 50 + - 200 + - 500 + - 1000 + allowCustomBandwidth: false + connectionLabel: Connection + allowBandwidthAutoApproval: false + connectionRedundancyRequired: false + selectiveRedundancy: true + marketingInfo: + processSteps: [] + promotion: true + headers: + ETag: + $ref: '#/components/headers/ETag' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-create" - "500": + value: + - errorCode: EQ-3001036 + errorMessage: You are not authorized to execute the requested action on the resource + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error /fabric/v4/serviceProfiles/search: post: tags: @@ -4020,62 +16701,243 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ServiceProfileSearchRequest" + $ref: '#/components/schemas/ServiceProfileSearchRequest' examples: ServiceProfileSearchWithUuid: - $ref: "#/components/examples/ServiceProfileSearchWithUuid" + value: + filter: + property: /uuid + operator: '=' + values: + - 13100b2d-234f-4425-ab5c-1449d4b806be + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime ServiceProfileSearchWithName: - $ref: "#/components/examples/ServiceProfileSearchWithName" + value: + filter: + property: /name + operator: '=' + values: + - My-Service-Profile-1 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime ServiceProfileSearchWithState: - $ref: "#/components/examples/ServiceProfileSearchWithState" + value: + filter: + property: /state + operator: '=' + values: + - ACTIVE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime ServiceProfileSearchWithVisibility: - $ref: "#/components/examples/ServiceProfileSearchWithVisibility" + value: + filter: + property: /visibility + operator: '=' + values: + - PUBLIC + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime ServiceProfileSearchWithProject: - $ref: "#/components/examples/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: - $ref: "#/components/examples/ServiceProfileSearchWithPort" + value: + filter: + property: /ports/uuid + operator: '=' + values: + - 23100b2d-234f-4425-ab5c-1449d4b806bf + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime ServiceProfileSearchWithMultipleFilter: - $ref: "#/components/examples/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 ServiceProfileSearchWithTypeAndMetro: - $ref: "#/components/examples/ServiceProfileSearchWithTypeAndMetro" + value: + filter: + and: + - property: /type + operator: '=' + values: + - L2_PROFILE + - property: /metros/code + operator: '=' + values: + - SG + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime required: true responses: - "200": + '200': description: Successful operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfiles" + $ref: '#/components/schemas/ServiceProfiles' examples: ServiceProfile: - $ref: "#/components/examples/ServiceProfilesResponse" - "400": + 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 + selectiveRedundancy: 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400-search" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "500": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}: get: tags: @@ -4089,7 +16951,9 @@ paths: description: Service Profile UUID required: true schema: - $ref: "#/components/schemas/ServiceProfileId" + description: Service Profile UUID + type: string + format: uuid - name: viewPoint in: query description: flips view between buyer and seller representation @@ -4100,58 +16964,360 @@ paths: - aSide - zSide responses: - "200": + '200': description: Successful operation - headers: - ETag: - $ref: "#/components/headers/ETag" content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfile" + $ref: '#/components/schemas/ServiceProfile' examples: ASideServiceProfile: - $ref: "#/components/examples/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 + selectiveRedundancy: 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 ZSideServiceProfile: - $ref: "#/components/examples/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 + selectiveRedundancy: 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 LmaasServiceProfile: - $ref: "#/components/examples/LmaasServiceProfileResponse" - "400": + value: + state: ACTIVE + account: + orgId: 90925 + organizationName: Sample Organization + globalOrgId: 0017i000011X23ZAAS + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde + changeLog: + createdBy: sampleuser + createdByFullName: Sample User + createdByEmail: someone@sample.com + createdDateTime: '2026-01-01T00:00:00.000Z' + updatedBy: sampleuser + updatedByFullName: Sample User + updatedByEmail: someone@sample.com + updatedDateTime: '2026-01-01T00:00:00.000Z' + href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 + uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 + type: LMAAS_PROFILE + name: Last Mile Service Profile 1 + description:

Sample Last Mile Service Profile

+ notifications: + - type: QUOTE_NOTIFICATIONS + emails: + - someone@sample.com + visibility: PUBLIC + customFields: + - label: Account Id + description: Provider Portal User ID + required: true + dataType: NUMBER + captureInEmail: false + ports: + - type: XF_PORT + uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 + location: + metroCode: DC + crossConnectId: ECX.03.00000962 + metros: + - code: DC + name: Ashburn + ibxs: + - DC6 + - DC5 + displayName: Ashburn + accessPointTypeConfigs: + - uuid: d2d8105b-da0c-4b09-92d7-2584a85cbb33 + type: COLO + supportedBandwidths: + - 10 + - 50 + - 200 + - 500 + - 1000 + allowRemoteConnections: true + allowCustomBandwidth: false + allowBandwidthAutoApproval: false + linkProtocolConfig: + reuseVlanSTag: false + encapsulation: DOT1Q + enableAutoGenerateServiceKey: false + connectionRedundancyRequired: false + selectiveRedundancy: true + apiConfig: + apiAvailable: false + integrationId: '' + equinixManagedPort: false + equinixManagedVlan: false + allowOverSubscription: false + overSubscriptionLimit: 1 + bandwidthFromApi: false + connectionLabel: Connection + authenticationKey: + required: false + marketingInfo: + promotion: true + lastMileConfig: + apiIntegration: + siteValidationEnabled: false + dataCenterLocationEnabled: false + productOfferingEnabled: false + poqEnabled: false + quoteEnabled: false + placeOrderEnabled: false + quoteViaAggregatorEnabled: false + productCatalogs: + - id: Sample-product-offering-id + name: Sample Product Offering + webUrl: https://www.example.com/lastmile + deliveryDate: + unit: DAYS + min: 10 + max: 90 + billingTerms: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + offerings: + - bandwidth: 50 + price: + unit: USD + min: 100 + max: 500 + - bandwidth: 100 + price: + unit: USD + min: 200 + max: 500 + - bandwidth: 500 + price: + unit: USD + min: 500 + max: 1000 + - bandwidth: 1000 + price: + unit: USD + min: 1000 + max: 2000 + headers: + ETag: + $ref: '#/components/headers/ETag' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-read" - "500": + value: + - errorCode: EQ-3001033 + errorMessage: You are not authorized to execute the requested action on the resource + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error put: tags: - Service Profiles @@ -4164,7 +17330,9 @@ paths: description: Service Profile UUID required: true schema: - $ref: "#/components/schemas/ServiceProfileId" + description: Service Profile UUID + type: string + format: uuid - name: If-Match in: header description: conditional request @@ -4175,224 +17343,695 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ServiceProfileRequest" + $ref: '#/components/schemas/ServiceProfileRequest' examples: ServiceProfileUpdate: - $ref: "#/components/examples/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 + selectiveRedundancy: 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 required: true responses: - "202": + '202': description: Successful Put operation - headers: - ETag: - $ref: "#/components/headers/ETag" content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfile" + $ref: '#/components/schemas/ServiceProfile' examples: ServiceProfile: - $ref: "#/components/examples/ServiceProfilePutResponse" - "400": + 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 + selectiveRedundancy: 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 + headers: + ETag: + $ref: '#/components/headers/ETag' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-update" - "404": + value: + - errorCode: EQ-3001035 + errorMessage: You are not authorized to execute the requested action on the resource + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-404-get" - "500": + value: + - errorCode: EQ-3001011 + errorMessage: Invalid uuid + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" - delete: + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error + patch: tags: - Service Profiles - summary: Delete Service Profile - description: delete Service Profile by UUID - operationId: deleteServiceProfileByUuid + summary: Update Service 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" + description: Service Profile UUID + type: string + format: uuid + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/ServiceProfileUpdateRequest' + examples: + ServiceProfilePatchRequest: + value: + - op: add + path: /tags + value: + - sample_tag + ServiceProfilePatchRequestForVisibility: + value: + - op: replace + path: /visibility + value: PUBLIC + required: true responses: - "200": - description: Successful Delete operation - headers: - ETag: - $ref: "#/components/headers/ETag" + '200': + description: Successful Patch operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfile" + $ref: '#/components/schemas/ServiceProfile' examples: ServiceProfile: - $ref: "#/components/examples/ServiceProfileDeleteResponse" - "400": + 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 + selectiveRedundancy: 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 + ServiceProfilePatchResponseForVisibility: + value: + state: ACTIVE + account: + orgId: 91785 + organizationName: testSeller-270010 + globalOrgId: 0016u000003JZ4tAAG + change: + type: PROFILE_UPDATE_ACCEPTANCE + uuid: 9b9f8a9b-4583-4649-9d91-a48494f822a7 + createdDateTime: '2026-02-17T17:23:35.543Z' + 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: PRIVATE + 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 + selectiveRedundancy: 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 + headers: + ETag: + $ref: '#/components/headers/ETag' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400-delete" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-delete" - "404": + value: + - errorCode: EQ-3001035 + errorMessage: You are not authorized to execute the requested action on the resource + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-404-get" - "500": + value: + - errorCode: EQ-3001011 + errorMessage: Invalid uuid + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" - patch: + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error + delete: tags: - Service Profiles - summary: Update Service Profile - description: Update Service Profile by UUID - operationId: updateServiceProfileByUuid + summary: Delete Service 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" - requestBody: - content: - application/json-patch+json: - schema: - $ref: "#/components/schemas/ServiceProfileUpdateRequest" - examples: - ServiceProfilePatchRequest: - $ref: "#/components/examples/ServiceProfilePatchRequest" - ServiceProfilePatchRequestForVisibility: - $ref: "#/components/examples/ServiceProfilePatchRequestForVisibility" - required: true + description: Service Profile UUID + type: string + format: uuid responses: - "200": - description: Successful Patch operation - headers: - ETag: - $ref: "#/components/headers/ETag" + '200': + description: Successful Delete operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfile" + $ref: '#/components/schemas/ServiceProfile' examples: ServiceProfile: - $ref: "#/components/examples/ServiceProfilePatchResponse" - ServiceProfilePatchResponseForVisibility: - $ref: "#/components/examples/ServiceProfilePatchResponseForVisibility" - "400": + 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 + selectiveRedundancy: 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 + headers: + ETag: + $ref: '#/components/headers/ETag' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-400" - "401": + value: + - errorCode: EQ-3001115 + errorMessage: Unable to delete some of the profile because it does not exist + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-update" - "404": + value: + - errorCode: EQ-3001034 + errorMessage: You are not authorized to execute the requested action on the resource + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-404-get" - "500": + value: + - errorCode: EQ-3001011 + errorMessage: Invalid uuid + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}/actions: post: tags: @@ -4406,73 +18045,144 @@ paths: description: Service Profile UUID required: true schema: - $ref: "#/components/schemas/ServiceProfileId" + description: Service Profile UUID + type: string + format: uuid requestBody: content: application/json: schema: - $ref: "#/components/schemas/ServiceProfileActionRequest" + $ref: '#/components/schemas/ServiceProfileActionRequest' examples: AcceptProfileUpdate: - $ref: "#/components/examples/ServiceProfileActionRequest" + value: + type: PROFILE_UPDATE_ACCEPTANCE + description: Approved to migrate to public RejectProfileUpdate: - $ref: "#/components/examples/ServiceProfileActionRejectionRequest" + value: + type: PROFILE_UPDATE_REJECTION + description: Rejected the migration to public required: true responses: - "201": + '201': description: Successful operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceProfileActionResponse" + $ref: '#/components/schemas/ServiceProfileActionResponse' examples: ServiceProfileActionResponse: - $ref: "#/components/examples/ServiceProfileActionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/serviceProfiles/f30a9de3-c79e-443e-b65d-0a0692c6f3e0/actions/ac2a3233-23d9-423c-b375-0e78717bd348 + type: PROFILE_UPDATE_ACCEPTANCE + uuid: ac2a3233-23d9-423c-b375-0e78717bd348 + comments: Approved to migrate to public + changeLog: + createdBy: adminuser + createdDateTime: '2026-03-04T10:30:00Z' + updatedBy: adminuser + updatedDateTime: '2026-03-04T10:35:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-update" - "404": + value: + - errorCode: EQ-3001035 + errorMessage: You are not authorized to execute the requested action on the resource + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-404-get" - "500": + value: + - errorCode: EQ-3001011 + errorMessage: Invalid uuid + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}/environments: get: tags: @@ -4486,7 +18196,9 @@ paths: description: Service Profile UUID required: true schema: - $ref: "#/components/schemas/ServiceProfileId" + description: Service Profile UUID + type: string + format: uuid - name: offset in: query description: offset @@ -4502,51 +18214,141 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Successful operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ProviderEnvironments" + $ref: '#/components/schemas/ProviderEnvironments' examples: ServiceProfileEnvironments: - $ref: "#/components/examples/ServiceProfileEnvironmentsResponse" - "400": + value: + data: + - href: https://api.equinix.com/fabric/v4/serviceProfiles/23ad37d0-6b1c-4d1f-a4eb-9f3d68fbe4fd/environments/6ad498b5-d929-44ac-a199-ce9f0d31d9ac + uuid: 6ad498b5-d929-44ac-a199-ce9f0d31d9ac + type: IC_ENV + name: US West 1 – Production + description: Primary production environment + sellerRegion: us-west-1 + metros: + - code: CH + name: Chicago + displayName: Chicago + - code: DC + name: Ashburn + displayName: Ashburn + supportedBandwidths: + - 1000 + - 10000 + - 100000 + - href: https://api.equinix.com/fabric/v4/serviceProfiles/23ad37d0-6b1c-4d1f-a4eb-9f3d68fbe4fd/environments/1ad498b5-d929-44ac-a199-ce9f0d31d9ab + uuid: 1ad498b5-d929-44ac-a199-ce9f0d31d9ab + type: IC_ENV + name: US East 1 – Production + description: Primary production environment + sellerRegion: us-east-1 + metros: + - code: DC + name: Ashburn + displayName: Ashburn + supportedBandwidths: + - 1000 + - 10000 + - 100000 + pagination: + offset: 0 + limit: 2 + total: 2 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-read" - "500": + value: + - errorCode: EQ-3001033 + errorMessage: You are not authorized to execute the requested action on the resource + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}/environments/{environmentId}/actions: post: tags: @@ -4560,18 +18362,21 @@ paths: description: Service Profile UUID required: true schema: - $ref: "#/components/schemas/ServiceProfileId" + description: Service Profile UUID + type: string + format: uuid - name: environmentId in: path description: Provider Environment Reference required: true schema: - $ref: "#/components/schemas/EnvironmentId" + description: Provider Environment Reference + type: string requestBody: content: application/json: schema: - $ref: "#/components/schemas/EnvironmentActionRequest" + $ref: '#/components/schemas/EnvironmentActionRequest' examples: ValidateActivationKey: value: @@ -4580,48 +18385,102 @@ paths: value: key_here required: true responses: - "201": + '201': description: Successful service profile environment action operation content: application/json: schema: - $ref: "#/components/schemas/EnvironmentActionResponse" - "400": + $ref: '#/components/schemas/EnvironmentActionResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-update" - "500": + value: + - errorCode: EQ-3001035 + errorMessage: You are not authorized to execute the requested action on the resource + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}/metros: get: tags: @@ -4635,7 +18494,9 @@ paths: description: Service Profile UUID required: true schema: - $ref: "#/components/schemas/ServiceProfileId" + description: Service Profile UUID + type: string + format: uuid - name: offset in: query description: offset @@ -4651,51 +18512,164 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Successful operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/ServiceMetros" + $ref: '#/components/schemas/ServiceMetros' examples: ServiceProfileMetros: - $ref: "#/components/examples/ServiceProfilesResponse" - "400": + 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 + selectiveRedundancy: 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/sp-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-401" - "403": + value: + - errorCode: EQ-3001207 + errorMessage: Unauthorized user + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-403-read" - "500": + value: + - errorCode: EQ-3001033 + errorMessage: You are not authorized to execute the requested action on the resource + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/sp-500" + value: + - errorCode: EQ-3001206 + errorMessage: Internal Server Error /fabric/v4/serviceTokens/{serviceTokenId}: get: tags: @@ -4709,52 +18683,214 @@ paths: description: Service Token UUID required: true schema: - $ref: "#/components/schemas/ServiceTokenUUID" + description: Service Token UUID + type: string + format: uuid responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceToken" + $ref: '#/components/schemas/ServiceToken' examples: tokenExample: - $ref: "#/components/examples/getServiceToken" + value: + href: http://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: http://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' tokenVDExample: - $ref: "#/components/examples/getServiceToken-VD" + value: + href: http://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' tokenNetworkExample: - $ref: "#/components/examples/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' tokenDryRunExample: - $ref: "#/components/examples/getServiceToken-DryRun" - "400": + 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 + expirationDateTime: '2020-05-31T10:30:00Z' + connection: + type: EVPL_VC + bandwidthLimit: 100 + allowRemoteConnection: false + allowCustomBandwidth: false + aSide: + accessPointSelectors: + - type: COLO + port: + href: http://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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_UUID" + value: + - errorCode: EQ-3034016 + errorMessage: Token not found + correlationId: 0963d003-ecda-4391-b166-8ccbf31d2d82 + additionalInfo: + - property: tokenUuid + reason: Token not found dryRunExample: - $ref: "#/components/examples/400_dry_run" - "403": + value: + - errorCode: EQ-3034054 + errorMessage: Dry Run is not supported for service tokens based on Network Edge + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - reason: queryParam:dryRun + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "500": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH delete: tags: - Service Tokens @@ -4767,52 +18903,214 @@ paths: description: Service Token UUID required: true schema: - $ref: "#/components/schemas/ServiceTokenUUID" + description: Service Token UUID + type: string + format: uuid responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceToken" + $ref: '#/components/schemas/ServiceToken' examples: tokenExample: - $ref: "#/components/examples/getServiceToken" + value: + href: http://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: http://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' tokenVDExample: - $ref: "#/components/examples/getServiceToken-VD" + value: + href: http://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' tokenNetworkExample: - $ref: "#/components/examples/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' tokenDryRunExample: - $ref: "#/components/examples/getServiceToken-DryRun" - "400": + 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 + expirationDateTime: '2020-05-31T10:30:00Z' + connection: + type: EVPL_VC + bandwidthLimit: 100 + allowRemoteConnection: false + allowCustomBandwidth: false + aSide: + accessPointSelectors: + - type: COLO + port: + href: http://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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_UUID" + value: + - errorCode: EQ-3034016 + errorMessage: Token not found + correlationId: 0963d003-ecda-4391-b166-8ccbf31d2d82 + additionalInfo: + - property: tokenUuid + reason: Token not found dryRunExample: - $ref: "#/components/examples/400_dry_run" - "403": + value: + - errorCode: EQ-3034054 + errorMessage: Dry Run is not supported for service tokens based on Network Edge + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - reason: queryParam:dryRun + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "500": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH patch: tags: - Service Tokens @@ -4825,7 +19123,9 @@ paths: description: Service Token UUID required: true schema: - $ref: "#/components/schemas/ServiceTokenUUID" + description: Service Token UUID + type: string + format: uuid - name: dryRun in: query description: option to verify that API calls will succeed @@ -4837,107 +19137,261 @@ paths: content: application/json-patch+json: schema: - $ref: "#/components/schemas/ServiceTokenUpdateRequest" + $ref: '#/components/schemas/ServiceTokenUpdateRequest' examples: UpdateExpirationDate: - $ref: "#/components/examples/UpdateExpirationDate" + value: + - op: replace + path: /expirationDateTime + value: '2023-01-20T18:50:34.696Z' UpdateTokenName: - $ref: "#/components/examples/UpdateTokenName" + value: + - op: replace + path: /name + value: Az_Aside_Dot1Q_NewName UpdateTokenDescription: - $ref: "#/components/examples/UpdateTokenDescription" + value: + - op: replace + path: /description + value: Az_Aside_Dot1Q_Pri_SV_NewDescription UpdateNotificationEmail: - $ref: "#/components/examples/UpdateNotificationEmail" + value: + - op: replace + path: /notifications/emails + value: + - test1@equinix.com + - test2@equinix.com UpdateAsideTokenBandwidth: - $ref: "#/components/examples/UpdateAsideTokenBandwidth" + value: + - op: replace + path: /connection/bandwidthLimit + value: 100 UpdateZsideTokenBandwidth: - $ref: "#/components/examples/UpdateZsideTokenBandwidth" + value: + - op: replace + path: /connection/supportedBandwidths + value: + - 50 + - 1000 UpdateAsideTokenBandwidthDryRun: - $ref: "#/components/examples/UpdateAsideTokenBandwidth" + value: + - op: replace + path: /connection/bandwidthLimit + value: 100 UpdateZsideTokenBandwidthDryRun: - $ref: "#/components/examples/UpdateZsideTokenBandwidth" + value: + - op: replace + path: /connection/supportedBandwidths + value: + - 50 + - 1000 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceToken" + $ref: '#/components/schemas/ServiceToken' examples: tokenExample: - $ref: "#/components/examples/getServiceToken" + value: + href: http://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: http://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' tokenVDExample: - $ref: "#/components/examples/getServiceToken-VD" + value: + href: http://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' tokenNetworkExample: - $ref: "#/components/examples/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' tokenDryRunExample: - $ref: "#/components/examples/getServiceToken-DryRun" - "400": + 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 + expirationDateTime: '2020-05-31T10:30:00Z' + connection: + type: EVPL_VC + bandwidthLimit: 100 + allowRemoteConnection: false + allowCustomBandwidth: false + aSide: + accessPointSelectors: + - type: COLO + port: + href: http://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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_UUID" + value: + - errorCode: EQ-3034016 + errorMessage: Token not found + correlationId: 0963d003-ecda-4391-b166-8ccbf31d2d82 + additionalInfo: + - property: tokenUuid + reason: Token not found dryRunExample: - $ref: "#/components/examples/400_dry_run" - "403": + value: + - errorCode: EQ-3034054 + errorMessage: Dry Run is not supported for service tokens based on Network Edge + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - reason: queryParam:dryRun + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "500": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/serviceTokens: - get: - tags: - - Service Tokens - summary: Get Service 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 @@ -4956,87 +19410,707 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ServiceToken" + $ref: '#/components/schemas/ServiceToken' examples: AsideTokenWithQnQ: - $ref: "#/components/examples/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 AsideTokenWithDot1Q: - $ref: "#/components/examples/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 AsideTokenWithVxlan: - $ref: "#/components/examples/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 + vni: 510000 + notifications: + - type: NOTIFICATION + emails: + - abc@company.com + - provider@company.com ZsideTokenWithQnQ: - $ref: "#/components/examples/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 ZsideTokenWithDot1Q: - $ref: "#/components/examples/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 ZsideTokenWithVxlan: - $ref: "#/components/examples/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 + vni: 520000 + expirationDateTime: '2021-03-18T06:43:49.980Z' + notifications: + - type: NOTIFICATION + emails: + - abc@company.com ZsideTokenWithVD: - $ref: "#/components/examples/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 ZsideTokenForEVPLAN-Network: - $ref: "#/components/examples/createZsideServiceTokenWithNetworkEvplan" + 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 ZsideTokenForEPLAN-Network: - $ref: "#/components/examples/createZsideServiceTokenWithNetworkEplan" + value: + type: VC_TOKEN + name: zside_Network_token + description: Zside_Network_token + connection: + type: EPLAN_VC + allowRemoteConnection: true + supportedBandwidths: + - 10 + - 50 + - 200 + zSide: + accessPointSelectors: + - type: NETWORK + network: + type: EPLAN + 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 ZsideTokenForEVPTree-Network: - $ref: "#/components/examples/createZsideServiceTokenWithNetworkEvptree" + value: + type: VC_TOKEN + name: zside_Network_token + description: Zside_Network_token + connection: + type: EVPTREE_VC + allowRemoteConnection: true + supportedBandwidths: + - 10 + - 50 + - 200 + zSide: + accessPointSelectors: + - type: NETWORK + network: + type: EVPTREE + 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 ZsideTokenForEPTree-Network: - $ref: "#/components/examples/createZsideServiceTokenWithNetworkEptree" + value: + type: VC_TOKEN + name: zside_Network_token + description: Zside_Network_token + connection: + type: EPTREE_VC + allowRemoteConnection: true + supportedBandwidths: + - 10 + - 50 + - 200 + zSide: + accessPointSelectors: + - type: NETWORK + network: + type: EPTREE + 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 AsideTokenWithDot1QDryRunCreate: - $ref: "#/components/examples/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 AsideFCRWithZsidePortBasedToken: - $ref: "#/components/examples/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 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceToken" + $ref: '#/components/schemas/ServiceToken' examples: ServiceTokenDryRun: - $ref: "#/components/examples/createServiceTokenDryRunResponse" - "201": + 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: http://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 + '201': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceToken" + $ref: '#/components/schemas/ServiceToken' examples: tokenExample: - $ref: "#/components/examples/getServiceToken" + value: + href: http://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: http://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' ZsideTokenForEVPLANNetwork: - $ref: "#/components/examples/createZsideServiceTokenWithNetworkEvplan-Response" + value: + href: https://api.equinix.com/fabric/v4/serviceTokens/7cf92aa3-18b8-435c-b3fc-55e45b1ce964 + type: VC_TOKEN + uuid: 7cf92aa3-18b8-435c-b3fc-55e45b1ce964 + expirationDateTime: '2025-09-09T00:00:00Z' + connection: + type: EVPLAN_VC + allowRemoteConnection: true + allowCustomBandwidth: false + supportedBandwidths: + - 10 + - 50 + - 200 + - 500 + zSide: + accessPointSelectors: + - type: NETWORK + network: + href: https://api.equinix.com/fabric/v4/networks/5e17244a-b3e6-4830-aea3-5269d61efd8c + uuid: 5e17244a-b3e6-4830-aea3-5269d61efd8c + type: EVPLAN + name: AUTO-EVPLAN-939087546 + scope: GLOBAL + state: INACTIVE + notifications: + - type: NOTIFICATION + emails: + - test@equinix.com + - user01@equinix.com + account: + orgId: 90837 + changelog: + createdBy: '890742' + createdDateTime: '2025-06-11T15:23:19.237Z' + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee962 ZsideTokenForEVPTreeNetwork: - $ref: "#/components/examples/createZsideServiceTokenWithNetworkEvptree-Response" - "400": + value: + href: https://api.equinix.com/fabric/v4/serviceTokens/543b869e-a9ba-4492-860b-44927ce619f9 + type: VC_TOKEN + uuid: 543b869e-a9ba-4492-860b-44927ce619f9 + expirationDateTime: '2025-09-09T00:00:00Z' + connection: + type: EVPTREE_VC + allowRemoteConnection: true + allowCustomBandwidth: false + supportedBandwidths: + - 10 + - 50 + - 200 + - 500 + - 1000 + zSide: + accessPointSelectors: + - type: NETWORK + network: + href: https://api.equinix.com/fabric/v4/networks/a3536780-6118-4374-ab65-23b17fc4cbbb + uuid: a3536780-6118-4374-ab65-23b17fc4cbbb + type: EVPTREE + name: EVPTREE-AMER-01 + scope: REGIONAL + location: + region: AMER + state: INACTIVE + notifications: + - type: NOTIFICATION + emails: + - test@equinix.com + - user01@equinix.com + account: + orgId: 90837 + changelog: + createdBy: '890742' + createdDateTime: '2025-06-11T15:54:33.007Z' + project: + projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee962 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400" + value: + - errorCode: EQ-3034026 + errorMessage: ServiceToken provided is in Invalid Format. + correlationId: 0963d003-ecfa-4391-b166-8ccbf31d2d82 + additionalInfo: + - property: tokenUuid + reason: Please Enter Valid serviceToken dryRunExample: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3034054 + errorMessage: Dry Run is not supported for service tokens based on Network Edge + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + get: + tags: + - Service Tokens + summary: Get Service 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: + 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: http://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: http://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' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/serviceTokens/{serviceTokenId}/actions: post: tags: @@ -5050,61 +20124,137 @@ paths: description: Service Token UUID required: true schema: - $ref: "#/components/schemas/ServiceTokenUUID" + description: Service Token UUID + type: string + format: uuid requestBody: content: application/json: schema: - $ref: "#/components/schemas/ServiceTokenActionRequest" + $ref: '#/components/schemas/ServiceTokenActionRequest' examples: ResendServiceToken: - $ref: "#/components/examples/Resend_Service_Token" + value: + type: RESEND_EMAIL_NOTIFICATION required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceToken" + $ref: '#/components/schemas/ServiceToken' examples: connectionActionExample: - $ref: "#/components/examples/postServiceTokenActionResponse" - "400": + value: + href: http://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: http://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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: /aSide/accessPoint/linkProtocol + reason: VlanCtag is Not Required for LinkProtocolType DOT1Q + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: /aSide/accessPoint/linkProtocol + reason: VlanStag is Not Required for LinkProtocolType DOT1Q + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: supported operator '=' + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: supported properties are state and uuid + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: only one uuid/state is supported at this time dryRunExample: - $ref: "#/components/examples/400_dry_run" - "401": + value: + - errorCode: EQ-3034054 + errorMessage: Dry Run is not supported for service tokens based on Network Edge. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - reason: queryParam:dryRun + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3034035 + errorMessage: Bad request - ProjectId provided has no permission. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3034016 + errorMessage: Token not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/serviceTokens/search: post: tags: @@ -5127,59 +20277,202 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ServiceTokenSearchRequest" + $ref: '#/components/schemas/ServiceTokenSearchRequest' examples: ServiceTokenRequest: - $ref: "#/components/examples/postServiceTokenSearchUuid" + value: + filter: + and: + - property: /uuid + operator: '=' + values: + - 407f8239-254c-4fe2-a378-458f197e17c4 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceTokens" + $ref: '#/components/schemas/ServiceTokens' examples: servicetokenSearchExample: - $ref: "#/components/examples/getServiceTokens" - "400": + 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: http://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: http://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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/400" + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: /aSide/accessPoint/linkProtocol + reason: VlanCtag is Not Required for LinkProtocolType DOT1Q + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: /aSide/accessPoint/linkProtocol + reason: VlanStag is Not Required for LinkProtocolType DOT1Q + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: supported operator '=' + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: supported properties are state and uuid + - errorCode: EQ-3034001 + errorMessage: Invalid Argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: only one uuid/state is supported at this time dryRunExample: - $ref: "#/components/examples/400_dry_run" - "403": + value: + - errorCode: EQ-3034054 + errorMessage: Dry Run is not supported for service tokens based on Network Edge. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - reason: queryParam:dryRun + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3034035 + errorMessage: Bad request - ProjectId provided has no permission. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3034016 + errorMessage: Token not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3034011 + 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 /fabric/v4/opticalConnects: post: tags: @@ -5188,70 +20481,282 @@ paths: description: | Create a single Optical Metro Connect circuit. operationId: createOpticalConnect - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/OpticalConnectPostRequest" + $ref: '#/components/schemas/OpticalConnectPostRequest' examples: COLOToCOLO: - $ref: "#/components/examples/ColoOpticalConnectCreate" + description: Both ends terminate on patch panels in colocation space you occupy, so no Letter of Authorization is needed. + value: + type: OC + bandwidth: 100000 + connectionDestinationType: COLO + pathType: UNPROTECTED + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '9' + patchPanelPortB: '10' + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: PP:Demarc:1259695 + patchPanelPortA: '20' + patchPanelPortB: '21' + connectorType: SC + order: + purchaseOrderNumber: '156576' + notifications: + - type: NOTIFICATION + emails: + - test@test.com COLOToRemote: - $ref: "#/components/examples/RemoteOpticalConnectCreate" + description: |- + The Z-side is identified by IBX code and the Letter of Authorization + issued by the destination customer. + value: + type: OC + bandwidth: 100000 + connectionDestinationType: REMOTE + pathType: UNPROTECTED + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + purchaseOrderNumber: '156576' + notifications: + - type: NOTIFICATION + emails: + - test@test.com COLOToBMMR: - $ref: "#/components/examples/BMMROpticalConnectCreate" + description: The Z-side is identified by location and Letter of Authorization.
bmmrType declares who operates the meet-me room. + value: + type: OC + bandwidth: 100000 + connectionDestinationType: BMMR + pathType: UNPROTECTED + bmmrType: EQUINIX + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + purchaseOrderNumber: '156576' + notifications: + - type: NOTIFICATION + emails: + - test@test.com required: true responses: - "202": + '202': description: Accepted Operation content: application/json: schema: - $ref: "#/components/schemas/OpticalConnectResponse" + $ref: '#/components/schemas/OpticalConnectResponse' examples: COLOToCOLO: - $ref: "#/components/examples/ColoOpticalConnectResponseExample" + summary: COLO connection + value: + href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: COLO + pathType: UNPROTECTED + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259690 + patchPanelPortA: '20' + patchPanelPortB: '21' + connectorType: SC + cageUniqueSpaceId: SV2:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV2 + order: + purchaseOrderNumber: '156576' + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2025-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2025-07-24T06:51:46Z' COLOToRemote: - $ref: "#/components/examples/RemoteOpticalConnectResponseExample" + summary: Remote connection + value: + href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: REMOTE + pathType: UNPROTECTED + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + purchaseOrderNumber: '156576' + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2025-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2025-07-24T06:51:46Z' COLOToBMMR: - $ref: "#/components/examples/BMMROpticalConnectResponseExample" - "400": + summary: BMMR connection + value: + href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: BMMR + pathType: UNPROTECTED + bmmrType: EQUINIX + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + purchaseOrderNumber: '156576' + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2025-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2025-07-24T06:51:46Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_400" - "403": + summary: Unknown or inaccessible connection. + value: + - errorCode: EQ-3057103 + errorMessage: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_403" - "404": + summary: Operation not permitted + value: + - errorCode: EQ-3057102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_404" - "500": + summary: Optical connection not found + value: + - errorCode: EQ-3057101 + errorMessage: Optical Connect Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Optical Connect Service not found or already deleted + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_500" + summary: Unexpected server error + value: + - errorCode: EQ-3057104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/opticalConnects/bulk: post: tags: @@ -5260,70 +20765,463 @@ paths: description: | Create a dual diverse pair of circuits on separate optical paths. operationId: createBulkOpticalConnect - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/BulkOpticalConnectRequest" + $ref: '#/components/schemas/BulkOpticalConnectRequest' examples: COLOToCOLO: - $ref: "#/components/examples/ColoOpticalConnectBulkCreate" + summary: COLO diverse pair + description: Two connections on separate patch panels. Equinix assigns the shared redundancy group and returns it on both connections. + value: + data: + - type: OC + bandwidth: 100000 + connectionDestinationType: COLO + pathType: DUAL_DIVERSE + redundancy: + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259690 + patchPanelPortA: '20' + patchPanelPortB: '21' + connectorType: SC + notifications: + - type: NOTIFICATION + emails: + - test@test.com + registeredUsers: + - test + - type: OC + bandwidth: 100000 + connectionDestinationType: COLO + pathType: DUAL_DIVERSE + redundancy: + priority: SECONDARY + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: '14' + patchPanelPortB: '15' + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260385 + patchPanelPortA: '24' + patchPanelPortB: '25' + connectorType: SC + notifications: + - type: NOTIFICATION + emails: + - test@test.com COLOToRemote: - $ref: "#/components/examples/RemoteOpticalConnectBulkCreate" + value: + data: + - type: OC + bandwidth: 100000 + connectionDestinationType: REMOTE + pathType: DUAL_DIVERSE + redundancy: + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + account: + accountNumber: 270848 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + registeredUsers: + - test@test.com + - type: OC + bandwidth: 100000 + connectionDestinationType: REMOTE + pathType: DUAL_DIVERSE + redundancy: + priority: SECONDARY + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: '14' + patchPanelPortB: '15' + connectorType: SC + zSide: + location: + ibxCode: SV2 + loa: + uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 + account: + accountNumber: 270848 + notifications: + - type: NOTIFICATION + emails: + - test@test.com COLOToBMMR: - $ref: "#/components/examples/BMMROpticalConnectBulkCreate" + value: + data: + - type: OC + bandwidth: 100000 + connectionDestinationType: BMMR + pathType: DUAL_DIVERSE + bmmrType: EQUINIX + redundancy: + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + account: + accountNumber: 270848 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + registeredUsers: + - test@test.com + - type: OC + bandwidth: 100000 + connectionDestinationType: BMMR + pathType: DUAL_DIVERSE + bmmrType: EQUINIX + redundancy: + priority: SECONDARY + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: '14' + patchPanelPortB: '15' + connectorType: SC + zSide: + location: + ibxCode: SV2 + loa: + uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 + account: + accountNumber: 270848 + notifications: + - type: NOTIFICATION + emails: + - test@test.com required: true responses: - "202": + '202': description: Accepted Operation content: application/json: schema: - $ref: "#/components/schemas/OpticalConnectBulk" + $ref: '#/components/schemas/OpticalConnectBulk' examples: COLOToCOLO: - $ref: "#/components/examples/ColoOpticalConnectBulkResponseExample" + value: + data: + - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-PRI-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: COLO + pathType: DUAL_DIVERSE + redundancy: + priority: PRIMARY + group: 22f8e668-4754-4564-825d-d1c7889c885a + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259690 + patchPanelPortA: '20' + patchPanelPortB: '21' + connectorType: SC + cageUniqueSpaceId: SV2:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV2 + order: + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + - href: https://api.equinix.com/fabric/v4/opticalConnects/a6f77b33-96c6-4eeb-8d79-76374d950603 + uuid: a6f77b33-96c6-4eeb-8d79-76374d950603 + type: OC + name: 270848-SV1-SV2-SEC-02 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: COLO + pathType: DUAL_DIVERSE + redundancy: + priority: SECONDARY + group: 22f8e668-4754-4564-825d-d1c7889c885a + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: '14' + patchPanelPortB: '15' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260385 + patchPanelPortA: '24' + patchPanelPortB: '25' + connectorType: SC + cageUniqueSpaceId: SV2:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV2 + order: + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com COLOToRemote: - $ref: "#/components/examples/RemoteOpticalConnectBulkResponseExample" + value: + data: + - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-PRI-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: REMOTE + pathType: DUAL_DIVERSE + redundancy: + priority: PRIMARY + group: 22f8e668-4754-4564-825d-d1c7889c885a + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + - href: https://api.equinix.com/fabric/v4/opticalConnects/c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 + uuid: c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 + type: OC + name: 270848-SV1-SV2-SEC-02 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: REMOTE + pathType: DUAL_DIVERSE + redundancy: + priority: SECONDARY + group: 22f8e668-4754-4564-825d-d1c7889c885a + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: '14' + patchPanelPortB: '15' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 + order: + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com COLOToBMMR: - $ref: "#/components/examples/BMMROpticalConnectBulkResponseExample" - "400": + value: + data: + - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-PRI-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: BMMR + pathType: DUAL_DIVERSE + bmmrType: EQUINIX + redundancy: + priority: PRIMARY + group: 22f8e668-4754-4564-825d-d1c7889c885a + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + - href: https://api.equinix.com/fabric/v4/opticalConnects/c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 + uuid: c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 + type: OC + name: 270848-SV1-SV2-SEC-02 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: BMMR + pathType: DUAL_DIVERSE + bmmrType: EQUINIX + redundancy: + priority: SECONDARY + group: 22f8e668-4754-4564-825d-d1c7889c885a + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: '14' + patchPanelPortB: '15' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 + order: + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_400" - "403": + summary: Unknown or inaccessible connection. + value: + - errorCode: EQ-3057103 + errorMessage: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_403" - "404": + summary: Operation not permitted + value: + - errorCode: EQ-3057102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_404" - "500": + summary: Optical connection not found + value: + - errorCode: EQ-3057101 + errorMessage: Optical Connect Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Optical Connect Service not found or already deleted + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_500" + summary: Unexpected server error + value: + - errorCode: EQ-3057104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/opticalConnects/{opticalConnectId}: get: tags: @@ -5338,57 +21236,203 @@ paths: description: Unique identifier of an Optical Connect. required: true schema: - $ref: "#/components/schemas/OpticalConnectId" + description: Unique identifier of an Optical Connect. + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/OpticalConnectResponse" + $ref: '#/components/schemas/OpticalConnectResponse' examples: COLOToCOLO: - $ref: "#/components/examples/ColoOpticalConnectResponseExample" + summary: COLO connection + value: + href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: COLO + pathType: UNPROTECTED + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259690 + patchPanelPortA: '20' + patchPanelPortB: '21' + connectorType: SC + cageUniqueSpaceId: SV2:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV2 + order: + purchaseOrderNumber: '156576' + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2025-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2025-07-24T06:51:46Z' COLOToRemote: - $ref: "#/components/examples/RemoteOpticalConnectResponseExample" + summary: Remote connection + value: + href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: REMOTE + pathType: UNPROTECTED + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + purchaseOrderNumber: '156576' + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2025-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2025-07-24T06:51:46Z' COLOToBMMR: - $ref: "#/components/examples/BMMROpticalConnectResponseExample" - "400": + summary: BMMR connection + value: + href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-01 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: BMMR + pathType: UNPROTECTED + bmmrType: EQUINIX + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV2 + loa: + uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + order: + purchaseOrderNumber: '156576' + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2025-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2025-07-24T06:51:46Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_400" - "403": + summary: Unknown or inaccessible connection. + value: + - errorCode: EQ-3057103 + errorMessage: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_403" - "404": + summary: Operation not permitted + value: + - errorCode: EQ-3057102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_404" - "500": + summary: Optical connection not found + value: + - errorCode: EQ-3057101 + errorMessage: Optical Connect Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Optical Connect Service not found or already deleted + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_500" + summary: Unexpected server error + value: + - errorCode: EQ-3057104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/opticalConnects/search: post: tags: @@ -5397,75 +21441,234 @@ paths: description: | Get Optical Metro Connects matching the supplied criteria, with optional filtering, pagination and sorting. operationId: searchOpticalConnect - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/OpticalConnectSearchRequest" + $ref: '#/components/schemas/OpticalConnectSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/SearchOpticalConnectFilterByStatus" + summary: All provisioned connections + value: + filter: + and: + - property: /state + operator: '=' + values: + - PROVISIONED + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime SearchFilterByName: - $ref: "#/components/examples/SearchOpticalConnectByName" + summary: A named connection of a given type + value: + filter: + and: + - property: /name + operator: '=' + values: + - 270848-SV1-SV2-01 + - property: /type + operator: '=' + values: + - OC + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/updatedDateTime SearchFilterOrAnd: - $ref: "#/components/examples/SearchOpticalConnectFilterOrAnd" + summary: Partial match on uuid or name + description: An OR group nested inside the top-level AND — matches circuits whose uuid starts with the given prefix, or whose name is like the value. + value: + filter: + and: + - or: + - property: /uuid + operator: LIKE + values: + - 676a0c3f-a785-4294-87bc-25fe9318a620% + - property: /name + operator: LIKE + values: + - 270848-SV1-SV2-01 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/OpticalConnectServiceSearchResponse" + $ref: '#/components/schemas/OpticalConnectServiceSearchResponse' examples: Example: - $ref: "#/components/examples/OpticalConnectSearchResponseExample" - "400": + summary: One matching connection. + 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/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: OC + name: 270848-SV1-SV2-01-1 + state: PROVISIONING + bandwidth: 100000 + connectionDestinationType: COLO + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '10' + patchPanelPortB: '11' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259690 + patchPanelPortA: '20' + patchPanelPortB: '21' + cageUniqueSpaceId: SV2:01:002174 + cabinetUniqueSpaceId: Demarc + connectorType: SC + location: + ibxCode: SV2 + order: + purchaseOrderNumber: '156576' + orderNumber: 1-129105284100 + account: + accountNumber: 270848 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2025-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2025-07-24T06:51:46Z' + - href: https://api.equinix.com/fabric/v4/opticalConnects/07abb0e3-e67d-5090-9aff-fc5654abaae0 + uuid: 07abb0e3-e67d-5090-9aff-fc5654abaae0 + type: OC + name: 270848-SV1-SV2-01-2 + state: PROVISIONED + bandwidth: 100000 + connectionDestinationType: COLO + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1234685 + patchPanelPortA: '11' + patchPanelPortB: '12' + connectorType: SC + cageUniqueSpaceId: SV1:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: '22' + patchPanelPortB: '23' + connectorType: SC + cageUniqueSpaceId: SV2:01:002174 + cabinetUniqueSpaceId: Demarc + location: + ibxCode: SV2 + order: + purchaseOrderNumber: '126758' + orderNumber: 1-139105284200 + account: + accountNumber: 280845 + orgId: 123 + notifications: + - type: NOTIFICATION + emails: + - test@test.com + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2024-07-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2024-07-24T06:51:46Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_400_invalid_sorting" - "401": + summary: Invalid sort direction. + value: + - errorCode: EQ-3057105 + errorMessage: Invalid value for sorting direction. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_401" - "403": + summary: Missing or invalid credentials + value: + - errorCode: EQ-3057106 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_403" - "404": + summary: Operation not permitted + value: + - errorCode: EQ-3057102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_404" - "500": + summary: Optical connection not found + value: + - errorCode: EQ-3057101 + errorMessage: Optical Connect Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Optical Connect Service not found or already deleted + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/OpticalConnect_500" + summary: Unexpected server error + value: + - errorCode: EQ-3057104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/metros: get: tags: @@ -5479,7 +21682,7 @@ paths: description: User On Boarded Metros based on Fabric resource availability required: false schema: - $ref: "#/components/schemas/Presence" + $ref: '#/components/schemas/Presence' - name: offset in: query description: offset @@ -5495,42 +21698,130 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/MetroResponse" + $ref: '#/components/schemas/MetroResponse' examples: metroExample: - $ref: "#/components/examples/metro" - "400": + 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 + services: + - type: ETHERNET_IP_SERVICE + - type: TIME_SERVICE + geoScopes: + - CANADA + - CONUS + - JAPAN + - UK + - AUSTRALIA + - BRAZIL + - SWITZERLAND + - EU + geoZones: + - code: EU + name: European Union + description: Note that Ireland and Italy are not currently included + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/MetroErrorList" + $ref: '#/components/schemas/MetroErrorList' examples: example: - $ref: "#/components/examples/400_metros" - "401": + 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': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/MetroErrorList" + $ref: '#/components/schemas/MetroErrorList' examples: example: - $ref: "#/components/examples/401_metros" - "500": + value: + - errorCode: EQ-3036001 + errorMessage: Unauthorized + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/MetroErrorList" + $ref: '#/components/schemas/MetroErrorList' examples: example: - $ref: "#/components/examples/500_metros" + value: + - errorCode: EQ-3036030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An Internal Server Error occured /fabric/v4/metros/{metroCode}: get: tags: @@ -5544,44 +21835,128 @@ paths: description: Metro Code required: true schema: - $ref: "#/components/schemas/MetroCode" + description: Metro Code + type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Metro" + $ref: '#/components/schemas/Metro' examples: metroExample: - $ref: "#/components/examples/metroByCode" - "400": + 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 + services: + - type: ETHERNET_IP_SERVICE + - type: TIME_SERVICE + geoScopes: + - CANADA + - CONUS + - JAPAN + - UK + - AUSTRALIA + - BRAZIL + - SWITZERLAND + - EU + geoZones: + - code: EU + name: European Union + description: Note that Ireland and Italy are not currently included + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/MetroErrorList" + $ref: '#/components/schemas/MetroErrorList' examples: example: - $ref: "#/components/examples/400_metroCode" - "401": + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Path Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: pathparameter-metroCode + reason: Provide valid metro code + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/MetroErrorList" + $ref: '#/components/schemas/MetroErrorList' examples: example: - $ref: "#/components/examples/401_metros" - "500": + value: + - errorCode: EQ-3036001 + errorMessage: Unauthorized + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/MetroErrorList" + $ref: '#/components/schemas/MetroErrorList' examples: example: - $ref: "#/components/examples/500_metros" + value: + - errorCode: EQ-3036030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An Internal Server Error occured /fabric/v4/ports: get: tags: @@ -5596,53 +21971,222 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AllPortsResponse" + $ref: '#/components/schemas/AllPortsResponse' examples: portExample: - $ref: "#/components/examples/ports" - "400": + value: + pagination: + offset: 0 + limit: 1000 + total: 2 + data: + - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-02db-2dbc-ace0-30fa5c00ad04 + type: XF_PORT + uuid: c4d93b39-02db-2dbc-ace0-30fa5c00ad04 + name: gen-l2-qa-01-auto-TY4-L-Qinq-STD-SEC-10G-JUN-598 + physicalPortsSpeed: 10000 + physicalPortsType: 10GBASE_LR + connectivitySourceType: COLO + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + package: + code: STANDARD + state: REPROVISIONING + cvpId: '1616554' + operation: + connectionCount: 0 + evplVCCount: 0 + accessVCCount: 0 + account: + accountNumber: 200559 + accountName: gen-l2-qa-01-auto-200559 + orgId: 90946 + organizationName: gen-l2-qa-01-auto-200551. + ucmId: 500DFED2-EBDB-480d-896C-C7870E52D0D8 + globalCustId: 0017i000011X242AAC + changeLog: + createdBy: vvyugovskiy-IMPORT_JOB + createdDateTime: '2021-06-16T01:46:52Z' + updatedBy: Order-to-activation + updatedDateTime: '2025-04-07T23:03:08.900Z' + bandwidth: 10000 + availableBandwidth: 10000 + usedBandwidth: 0 + location: + metroHref: https://api.equinix.com/fabric/v4/metros/TY + region: APAC + metroName: Tokyo + metroCode: TY + ibx: TY4 + device: + name: sit-tb1-ty-a2.lab + redundancy: + priority: SECONDARY + demarcationPointIbx: TY4 + tetherIbx: TY4 + redundancy: + priority: SECONDARY + encapsulation: + type: QINQ + tagProtocolId: '0x9100' + lagEnabled: false + settings: + buyout: false + physicalPorts: + - type: XF_PHYSICAL_PORT + id: 1362185 + state: TO_BE_ADDED + uuid: 01892489-ce9b-7f25-b1f5-d32a5ac6a423 + tether: + crossConnectId: ECX.05.00001836 + cabinetNumber: Demarc + systemName: TY4:01:002181 + patchPanel: PP:1240:1089399 + patchPanelPortA: '7' + patchPanelPortB: '8' + ibx: TY4 + demarcationPoint: + patchPanel: PP:Demarc:00002181 + patchPanelName: PP:Demarc:00002181 + patchPanelPortA: '5' + patchPanelPortB: '6' + ibx: TY4 + operation: + operationalStatus: UP + - href: https://api.equinix.com/fabric/v4/ports/6f0f3015-2d51-4b6e-a98c-1defb4fe88f1 + type: XF_PORT + uuid: 6f0f3015-2d51-4b6e-a98c-1defb4fe88f1 + name: 200558-SY4-CX-PRI-02 + physicalPortsSpeed: 10000 + physicalPortsType: 10GBASE_LR + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + package: + code: STANDARD + state: ACTIVE + cvpId: '2000348' + operation: + connectionCount: 1 + evplVCCount: 1 + accessVCCount: 0 + maintenanceStatus: SCHEDULED + lockEnabled: true + account: + accountNumber: 200558 + accountName: Gen-L2-Qa-01-Auto-200558 + orgId: 90946 + organizationName: gen-l2-qa-01-auto-200551. + ucmId: 2D26D682-B62E-495d-AFDF-698EC3B353F8 + globalCustId: 0017i000011X242AAC + changeLog: + createdDateTime: '2025-05-06T17:29:30.800Z' + updatedBy: API + updatedDateTime: '2025-05-06T17:29:40.300Z' + bandwidth: 10000 + availableBandwidth: 9500 + usedBandwidth: 500 + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SY + region: APAC + metroName: Sydney + metroCode: SY + ibx: SY4 + device: + name: sit-tb1-sy-e1.lab + redundancy: + group: '1' + priority: PRIMARY + demarcationPointIbx: SY4 + tetherIbx: SY4 + redundancy: + priority: PRIMARY + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + lagEnabled: true + settings: + buyout: false + physicalPorts: + - type: XF_PHYSICAL_PORT + id: 1362737 + state: ACTIVE + uuid: 01892489-ce07-7962-b676-b1a4d8091515 + tether: + crossConnectId: '22035616' + cabinetNumber: Demarc + systemName: SY4:01:002204 + patchPanel: PP:1240:1089399 + patchPanelPortA: '12' + patchPanelPortB: '14' + ibx: SY4 + demarcationPoint: + patchPanel: PP:Demarc:00002204 + patchPanelName: PP:Demarc:00002204 + patchPanelPortA: '17' + patchPanelPortB: '18' + ibx: SY4 + operation: + operationalStatus: UP + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400" - "401": + value: + - errorCode: EQ-3046115 + errorMessage: Invalid Path Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: pathparameter-portUuid + reason: Provide valid port Uuid + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3046117 + errorMessage: Unauthorized user. + correlationId: TEST + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "500": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Service Unavailable content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: portExample: - $ref: "#/components/examples/ports-500" + value: + - errorCode: EQ-3046030 + errorMessage: Internal error. + details: Internal system error userFailureExample: - $ref: "#/components/examples/ports-500-user-failure" + value: + - errorCode: IC-USR-014-01 + errorMessage: Error in getting user's profile post: tags: - Ports @@ -5661,99 +22205,1160 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/PortRequest" + $ref: '#/components/schemas/PortRequest' examples: COLOSinglePortNonLag: - $ref: "#/components/examples/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: '0x8100' + 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: - $ref: "#/components/examples/coloSinglePortLag" + value: + type: XF_PORT + connectivitySourceType: COLO + location: + metroCode: AT + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + account: + accountNumber: 16432 + project: + projectId: e275485c-7072-439f-943a-c923548b2be5 + package: + code: STANDARD + redundancy: + priority: PRIMARY + lagEnabled: true + physicalPorts: + - type: XF_PHYSICAL_PORT + demarcationPoint: + ibx: AT1 + cageUniqueSpaceId: AT1:02:FE50010 + cabinetUniqueSpaceId: '9999' + patchPanel: CD:9999:186947 + connectorType: SC + patchPanelPortA: '4' + patchPanelPortB: '5' + endCustomer: + isDisclosed: true + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + demarcationPointIbx: AT1 + notifications: + - type: TECHNICAL + registeredUsers: + - username + - type: NOTIFICATION + registeredUsers: + - user@equinix.com COLOUnlimitedPlusPortLag: - $ref: "#/components/examples/coloUnlimitedPlusPortLag" + value: + type: XF_PORT + connectivitySourceType: COLO + location: + metroCode: GV + package: + code: UNLIMITED_PLUS + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + account: + accountNumber: 270848 + project: + projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 + redundancy: + priority: PRIMARY + lagEnabled: true + physicalPorts: + - type: XF_PHYSICAL_PORT + demarcationPoint: + ibx: GV1 + cageUniqueSpaceId: GV1:01:002174 + cabinetUniqueSpaceId: Demarc + patchPanel: CP:Demarc:1259684 + connectorType: SC + endCustomer: + isDisclosed: false + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + demarcationPointIbx: GV1 + notifications: + - type: TECHNICAL + registeredUsers: + - jaguarsuser-port-order + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order COLOLagPortNewGroup: - $ref: "#/components/examples/coloLagPortNewGroup" + value: + type: XF_PORT + connectivitySourceType: COLO + location: + metroCode: TR + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + account: + accountNumber: 96127367 + package: + code: UNLIMITED + project: + projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 + redundancy: + priority: PRIMARY + lagEnabled: true + physicalPorts: + - type: XF_PHYSICAL_PORT + demarcationPoint: + ibx: TR1 + cageUniqueSpaceId: TR1:01:JSIT001 + cabinetUniqueSpaceId: DEM + patchPanel: PP:DEM:1265410 + connectorType: LC + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + demarcationPointIbx: TR1 + order: + signature: + signatory: SELF + delegate: + email: jaguars-test-user-001@equinix.com + purchaseOrder: + type: EXEMPTION + notifications: + - type: TECHNICAL + registeredUsers: + - jaguars-test-user-001 + - type: NOTIFICATION + registeredUsers: + - jaguars-test-user-001 COLOAddSecondaryPort: - $ref: "#/components/examples/coloAddSecondaryPort" + value: + type: XF_PORT + physicalPortsSpeed: 10000 + physicalPortsType: 1000BASE_LX + connectivitySourceType: COLO + location: + metroCode: GV + demarcationPointIbx: GV1 + package: + code: STANDARD + redundancy: + priority: SECONDARY + group: 1f6bdb37-f131-5925-c039-fe1785fad165 + lagEnabled: false + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + 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 + cabinetUniqueSpaceId: AM1:02:032575:0105 + cageUniqueSpaceId: AM1:02:032575 + patchPanel: PP:0105:1260379 + patchPanelPortA: '14' + patchPanelPortB: '15' + connectorType: LC COLOSinglePortNonLagDryRun: - $ref: "#/components/examples/COLOSinglePortNonLagCreateDryRun" + 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: '0x8100' + 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 COLOSinglePortLagDryRun: - $ref: "#/components/examples/COLOSinglePortLagCreateDryRun" + 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: '0x8100' + 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 REMOTESinglePortLag: - $ref: "#/components/examples/remoteSinglePortNewGroupLagRequest" + value: + type: XF_PORT + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + connectivitySourceType: REMOTE + physicalPortsCount: 1 + location: + metroCode: GV + demarcationPointIbx: GV1 + package: + code: STANDARD + lagEnabled: true + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + 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: - $ref: "#/components/examples/bmmrSinglePortLag" + value: + type: XF_PORT + connectivitySourceType: BMMR + location: + metroCode: SE + package: + code: STANDARD + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + account: + accountNumber: 200551 + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + redundancy: + priority: PRIMARY + lagEnabled: true + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + demarcationPointIbx: SE2 + bmmrType: SELF + notifications: + - type: TECHNICAL + registeredUsers: + - falconsExternalUser@seller.com + - type: NOTIFICATION + registeredUsers: + - falconsExternalUser@seller.com BMMRSinglePortNoLag: - $ref: "#/components/examples/bmmrSinglePortNoLag" + value: + type: XF_PORT + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + connectivitySourceType: BMMR + location: + metroCode: GV + demarcationPointIbx: GV1 + lagEnabled: false + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + project: + projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 + package: + code: STANDARD + 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: - $ref: "#/components/examples/bmmrAddSecondaryPort" + value: + type: XF_PORT + physicalPortsSpeed: 10000 + physicalPortsType: 1000BASE_LX + connectivitySourceType: BMMR + bmmrType: SELF + location: + metroCode: GV + demarcationPointIbx: GV1 + redundancy: + priority: SECONDARY + group: 1f6bdb37-f131-5925-c039-fe1785fad165 + lagEnabled: false + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + project: + projectId: '567' + package: + code: STANDARD + 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: - $ref: "#/components/examples/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: '0x8100' + 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 IXPublicPrivatePeeringPort: - $ref: "#/components/examples/createIXPublicPrivatePeeringPortRequest" + value: + type: XF_PORT + physicalPortsSpeed: 400000 + physicalPortsType: 400GBASE_LR4 + connectivitySourceType: COLO + location: + metroCode: GV + demarcationPointIbx: GV1 + lagEnabled: false + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + project: + projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 + account: + accountNumber: 270848 + notifications: + - registeredUsers: + - jaguarsuser-port-order + type: TECHNICAL + physicalPorts: + - demarcationPoint: + ibx: GV1 + cabinetUniqueSpaceId: Demarc + cageUniqueSpaceId: GV1:01:002174 + patchPanel: CP:Demarc:1259684 + connectorType: SC + serviceCode: IX IXPublicPeeringPort: - $ref: "#/components/examples/createIXPublicPeeringPortRequest" + value: + type: XF_PORT + physicalPortsSpeed: 400000 + physicalPortsType: 400GBASE_LR4 + connectivitySourceType: COLO + location: + metroCode: GV + demarcationPointIbx: GV1 + lagEnabled: false + encapsulation: + type: UNTAGGED + project: + projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 + account: + accountNumber: 270848 + notifications: + - registeredUsers: + - jaguarsuser-port-order + type: TECHNICAL + physicalPorts: + - demarcationPoint: + ibx: GV1 + cabinetUniqueSpaceId: Demarc + cageUniqueSpaceId: GV1:01:002174 + patchPanel: CP:Demarc:1259684 + connectorType: SC + serviceCode: IX required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Port" + $ref: '#/components/schemas/Port' examples: portDryRunExample: - $ref: "#/components/examples/PortCreateDryRunResponse" + value: + type: XF_PORT + physicalPortsType: 10GBASE_LR + physicalPortsSpeed: 10000 + physicalPortsCount: 1 + location: + metroCode: AM + demarcationPointIbx: AM1 + redundancy: + group: '1' + priority: PRIMARY + lagEnabled: true + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + package: + code: STANDARD + settings: + sharedPortType: false + project: + projectId: '567' + 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 bmmrPortDryRunExample: - $ref: "#/components/examples/bmmrSinglePortCreateDryRunResponse" + value: + type: XF_PORT + connectivitySourceType: BMMR + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + location: + metroCode: AT + demarcationPointIbx: AT1 + redundancy: + priority: PRIMARY + lagEnabled: false + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + package: + code: STANDARD + project: + projectId: b7c8d9e0-f1a2-4b3c-9d4e-5f6a7b8c9d0e + account: + accountNumber: 100001 + accountName: Test-Account + order: + purchaseOrder: + number: Fabric-PO-TEST-001 + amount: '1000' + startDate: '2025-01-01' + endDate: '2030-01-01' + type: EXISTING + signature: + signatory: SELF + delegate: + email: test-user@example.com + notifications: + - type: TECHNICAL + registeredUsers: + - test-technical-user + - type: NOTIFICATION + registeredUsers: + - test-notification-user + loas: + - uuid: a0b1c2d3-e4f5-4678-a6b7-c8d9e0f1a2b3 remotePortDryRunExample: - $ref: "#/components/examples/remoteSinglePortCreateDryRunResponse" - "202": + value: + type: XF_PORT + connectivitySourceType: REMOTE + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + location: + metroCode: AT + demarcationPointIbx: AT1 + redundancy: + priority: PRIMARY + lagEnabled: false + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + package: + code: STANDARD + project: + projectId: e3d4f5a6-7b8c-4d9e-a0b1-c2d3e4f56789 + account: + accountNumber: 100002 + accountName: Test-Account + order: + purchaseOrder: + number: Fabric-PO-TEST-002 + amount: '1000' + startDate: '2025-01-01' + endDate: '2030-01-01' + type: EXISTING + signature: + signatory: SELF + delegate: + email: test-user@example.com + notifications: + - type: TECHNICAL + registeredUsers: + - test-technical-user + - type: NOTIFICATION + registeredUsers: + - test-notification-user + loas: + - uuid: f1e2d3c4-b5a6-4978-8e0f-1a2b3c4d5e6f + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Port" + $ref: '#/components/schemas/Port' examples: COLOSinglePortNonLag: - $ref: "#/components/examples/coloSinglePortNonLagResponse" + value: + href: https://api.equinix.com/fabric/v4/ports/11abfba0-907f-460b-95ff-5a7bda4471ed + type: XF_PORT + uuid: 11abfba0-907f-460b-95ff-5a7bda4471ed + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + connectivitySourceType: COLO + project: + projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 + state: PENDING + order: + orderNumber: 1-233948565342 + uuid: d8ab29fe-e849-417d-b0a0-946e69dcd2ce + 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: + accountNumber: 96127367 + accountName: Jaguars_toronto__sig + ucmId: 86B71B7D-D0CC-4ee9-854D-A2C1AA7FA152 + changeLog: + createdBy: '923209' + createdDateTime: '2025-06-11T22:41:39.669Z' + location: + metroCode: TR + demarcationPointIbx: TR1 + redundancy: + priority: PRIMARY + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + lagEnabled: false + settings: + sharedPortType: false + package: + code: STANDARD + notifications: + - type: TECHNICAL + registeredUsers: + - jaguars-test-user-001 + - type: NOTIFICATION + registeredUsers: + - jaguars-test-user-001 + physicalPorts: + - demarcationPoint: + ibx: GV1 + cabinetUniqueSpaceId: Demarc + cageUniqueSpaceId: GV1:01:002174 + patchPanel: CP:Demarc:1259684 + connectorType: SC BMMRSinglePortLag: - $ref: "#/components/examples/bmmrSinglePortLagResponse" + value: + href: https://api.equinix.com/fabric/v4/ports/ed9d0b79-ff29-404a-b016-566435093afc + type: XF_PORT + uuid: ed9d0b79-ff29-404a-b016-566435093afc + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 0 + connectivitySourceType: BMMR + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + state: PENDING + order: + orderNumber: 1-289477804403 + uuid: b325f02c-69dd-41d2-838b-ea495c873e9d + account: + accountNumber: 200551 + accountName: gen-l2-qa-01-auto-200551 + ucmId: 83C58EBD-E231-4a8b-902E-0CFBE50E32C2 + changeLog: + createdBy: '1067822' + createdDateTime: '2025-06-21T00:15:48.414Z' + location: + metroCode: SE + demarcationPointIbx: SE2 + redundancy: + priority: PRIMARY + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + lagEnabled: true + package: + code: STANDARD + settings: + sharedPortType: false + notifications: + - type: TECHNICAL + registeredUsers: + - falconsExternalUser@seller.com + - type: NOTIFICATION + registeredUsers: + - falconsExternalUser@seller.com + additionalInfo: + - key: lagType + value: New REMOTESinglePortLag: - $ref: "#/components/examples/remoteSinglePortLagResponse" + value: + href: https://api.equinix.com/fabric/v4/ports/68adcd26-d66c-489d-9c72-8990b92a288e + type: XF_PORT + uuid: 68adcd26-d66c-489d-9c72-8990b92a288e + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + connectivitySourceType: REMOTE + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + state: PENDING + order: + orderNumber: 1-289477804403 + uuid: b325f02c-69dd-41d2-838b-ea495c873e9d + purchaseOrder: + type: EXEMPTION + account: + accountNumber: 200551 + accountName: gen-l2-qa-01-auto-200551 + ucmId: 83C58EBD-E231-4a8b-902E-0CFBE50E32C2 + changeLog: + createdBy: '1067822' + createdDateTime: '2025-06-21T00:15:48.414Z' + location: + metroCode: SE + demarcationPointIbx: SE2 + redundancy: + priority: PRIMARY + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + lagEnabled: true + package: + code: STANDARD + settings: + productCode: CX + sharedPortType: false + notifications: + - type: TECHNICAL + registeredUsers: + - falconsExternalUser@seller.com + - type: NOTIFICATION + registeredUsers: + - falconsExternalUser@seller.com + additionalInfo: + - key: lagType + value: New REMOTESinglePortLagWithOrderExemption: - $ref: "#/components/examples/remoteSinglePortLagWithPurchaseOrderExemption" + value: + type: XF_PORT + connectivitySourceType: REMOTE + location: + metroCode: AT + package: + code: STANDARD + settings: + sharedPortType: false + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + account: + accountNumber: 200551 + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + redundancy: + priority: PRIMARY + lagEnabled: true + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + physicalPortsCount: 1 + demarcationPointIbx: AT1 + order: + purchaseOrder: + type: EXEMPTION + notifications: + - type: TECHNICAL + registeredUsers: + - falconsExternalUser@seller.com + - type: NOTIFICATION + registeredUsers: + - falconsExternalUser@seller.com + additionalInfo: + - key: lagType + value: New + loas: + - uuid: 2f78191c-0920-4f13-b1c7-2cef03d07570 IXPublicPrivatePeeringPort: - $ref: "#/components/examples/createIXPublicPrivatePeeringPortResponse" + value: + href: https://api.equinix.com/fabric/v4/ports/11abfba0-907f-460b-95ff-5a7bda4471ed + type: XF_PORT + uuid: 11abfba0-907f-460b-95ff-5a7bda4471ed + physicalPortsSpeed: 400000 + physicalPortsType: 400GBASE_LR4 + physicalPortsCount: 1 + connectivitySourceType: COLO + project: + projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 + state: PENDING + order: + orderNumber: 1-633948565342 + uuid: d8ab29fe-e849-417d-b0a0-946e69dcd2ce + account: + accountNumber: 270848 + accountName: Jaguars_toronto__sig + ucmId: 86B71B7D-D0CC-4ee9-854D-A2C1AA7FA152 + changeLog: + createdBy: '923209' + createdDateTime: '2025-06-11T22:41:39.669Z' + location: + metroCode: GV + demarcationPointIbx: GV1 + redundancy: + priority: PRIMARY + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + lagEnabled: false + settings: + sharedPortType: false + productCode: IX + notifications: + - type: TECHNICAL + registeredUsers: + - jaguars-test-user-001 + - type: NOTIFICATION + registeredUsers: + - jaguars-test-user-001 + physicalPorts: + - demarcationPoint: + ibx: GV1 + cabinetUniqueSpaceId: Demarc + cageUniqueSpaceId: GV1:01:002174 + patchPanel: CP:Demarc:1259684 + connectorType: SC IXPublicPeeringPort: - $ref: "#/components/examples/createIXPublicPeeringPortResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/ports/1babfba0-907f-460b-95ff-5a7bda4471ed + type: XF_PORT + uuid: 1babfba0-907f-460b-95ff-5a7bda4471ed + physicalPortsSpeed: 400000 + physicalPortsType: 400GBASE_LR4 + physicalPortsCount: 1 + connectivitySourceType: COLO + project: + projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 + state: PENDING + order: + orderNumber: 1-233948565342 + uuid: a8ab29fe-e849-417d-b0a0-946e69dcd2ce + account: + accountNumber: 270848 + accountName: Jaguars_toronto__sig + ucmId: 86B71B7D-D0CC-4ee9-854D-A2C1AA7FA152 + changeLog: + createdBy: '923209' + createdDateTime: '2025-06-11T22:41:39.669Z' + location: + metroCode: GV + demarcationPointIbx: GV1 + redundancy: + priority: PRIMARY + encapsulation: + type: UNTAGGED + lagEnabled: false + settings: + sharedPortType: false + productCode: IX + notifications: + - type: TECHNICAL + registeredUsers: + - jaguars-test-user-001 + - type: NOTIFICATION + registeredUsers: + - jaguars-test-user-001 + physicalPorts: + - demarcationPoint: + ibx: GV1 + cabinetUniqueSpaceId: Demarc + cageUniqueSpaceId: GV1:01:002174 + patchPanel: CP:Demarc:1259684 + connectorType: SC + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: validationError: - $ref: "#/components/examples/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-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 badRequest: - $ref: "#/components/examples/createPortBadRequest" - "401": + value: + - errorCode: EQ-3143004 + errorMessage: Json syntax error, please check request body + details: Unknown json property + correlationId: TEST + additionalInfo: + - property: encapsulation.type + reason: Unexpected value 'DOT1' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "500": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/ports/{portId}/physicalPorts/bulk: post: tags: @@ -5767,63 +23372,335 @@ paths: description: Port UUID required: true schema: - $ref: "#/components/schemas/PortUUID" + description: Port UUID + type: string + format: uuid requestBody: content: application/json: schema: - $ref: "#/components/schemas/BulkPhysicalPort" + $ref: '#/components/schemas/BulkPhysicalPort' examples: COLOAddToLag: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AllPhysicalPortsResponse" + $ref: '#/components/schemas/AllPhysicalPortsResponse' examples: COLOAddToLag: - $ref: "#/components/examples/coloAddToLagResponse" - "400": + 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 + uuid: bdfa360d-8ffb-4394-8905-56ea6ae3e87d + notifications: + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order + - 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 + uuid: bdfa360d-8ffb-4394-8905-56ea6ae3e87d + notifications: + - type: NOTIFICATION + registeredUsers: + - jaguarsuser-port-order + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/port-400" - "401": + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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-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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3000036 + errorMessage: Requested path doesn't exists + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: 'Connection not found for UUID: d710a194-baf0-4cc0-aed3-788cc5835239' + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/ports/{portId}: get: tags: @@ -5837,46 +23714,202 @@ paths: description: Port UUID required: true schema: - $ref: "#/components/schemas/PortUUID" + description: Port UUID + type: string + format: uuid responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Port" + $ref: '#/components/schemas/Port' examples: portExample: - $ref: "#/components/examples/portByUUID" + value: + href: https://api.equinix.com/fabric/v4/ports/44c5712b-d704-4ca5-9b42-ee6be32ee06a + type: XF_PORT + uuid: 44c5712b-d704-4ca5-9b42-ee6be32ee06a + name: 270843-DA1-CX-PRI-33 + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + project: + projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 + package: + code: UNLIMITED + state: ACTIVE + cvpId: '2000833' + connectivitySourceType: COLO + operation: + operationalStatus: UP + connectionCount: 10 + evplVCCount: 10 + accessVCCount: 0 + account: + accountNumber: 270843 + accountName: ctr-sit-account1 + orgId: 93055 + organizationName: ctr-sit-account1-270843 + ucmId: 64726950-A62C-4749-98E2-5AA4CA44284F + globalCustId: 0016u000003JZ3XAAW + change: + uuid: ed41e367-e09d-4c2f-b6ab-30506de4437f + type: PORT_UPDATE + status: COMPLETED + data: + op: REPLACE + path: /encapsulation + value: + type: QINQ + tagProtocolId: '0x88a8' + createdDateTime: '2025-05-29T20:38:45.630759Z' + updatedDateTime: '2025-05-29T20:38:49.330822Z' + changeLog: + createdBy: qa-automation + createdDateTime: '2025-05-21T18:12:18.300Z' + updatedBy: qa-automation + updatedDateTime: '2025-05-29T20:38:48.900Z' + bandwidth: 1000 + availableBandwidth: 500 + usedBandwidth: 500 + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DA + region: AMER + metroName: Dallas + metroCode: DA + ibx: DA1 + device: + name: qa3-da-a1.lab + redundancy: + priority: PRIMARY + demarcationPointIbx: DA1 + tetherIbx: DA1 + redundancy: + priority: PRIMARY + encapsulation: + type: QINQ + tagProtocolId: '0x88a8' + lagEnabled: false + settings: + buyout: true + viewPortPermission: true + placeVcOrderPermission: true + physicalPorts: + - type: XF_PHYSICAL_PORT + id: 1426359 + state: ADDED + bandwidth: 0 + uuid: 0189244a-f3ac-7258-a8b4-3167af899305 + tether: + crossConnectId: '513213223' + ibx: DA1 + demarcationPoint: + ibx: DA1 + operation: + operationalStatus: UP maintenanceScheduledPortExample: - $ref: "#/components/examples/maintenanceScheduledPortByUUID" - "400": + value: + href: https://api.equinix.com/fabric/v4/ports/44c5712b-d704-4ca5-9b42-ee6be32ee06a + type: XF_PORT + uuid: 44c5712b-d704-4ca5-9b42-ee6be32ee06a + name: 270843-DA1-CX-PRI-33 + physicalPortsSpeed: 1000 + physicalPortsType: 1000BASE_LX + project: + projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 + package: + code: UNLIMITED + state: ACTIVE + connectivitySourceType: COLO + operation: + operationalStatus: UP + connectionCount: 10 + evplVCCount: 10 + accessVCCount: 0 + maintenanceStatus: SCHEDULED + lockEnabled: true + account: + accountNumber: 270843 + accountName: ctr-sit-account1 + orgId: 93055 + organizationName: ctr-sit-account1-270843 + ucmId: 64726950-A62C-4749-98E2-5AA4CA44284F + globalCustId: 0016u000003JZ3XAAW + changeLog: + createdBy: admin_user + createdDateTime: '2025-05-21T18:12:18.300Z' + updatedBy: test_user + updatedDateTime: '2025-05-29T20:38:48.900Z' + bandwidth: 1000 + availableBandwidth: 500 + usedBandwidth: 500 + location: + metroHref: https://api.equinix.com/fabric/v4/metros/DA + region: AMER + metroName: Dallas + metroCode: DA + ibx: DA1 + demarcationPointIbx: DA1 + tetherIbx: DA1 + redundancy: + priority: PRIMARY + encapsulation: + type: QINQ + tagProtocolId: '0x88a8' + lagEnabled: false + physicalPorts: + - type: XF_PHYSICAL_PORT + state: ADDED + bandwidth: 0 + uuid: 0189244a-f3ac-7258-a8b4-3167af899305 + tether: + crossConnectId: '513213223' + ibx: DA1 + demarcationPoint: + ibx: DA1 + operation: + operationalStatus: UP + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400" - "403": + value: + - errorCode: EQ-3046115 + errorMessage: Invalid Path Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: pathparameter-portUuid + reason: Provide valid port Uuid + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "500": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH delete: tags: - Ports @@ -5889,7 +23922,9 @@ paths: description: Port UUID required: true schema: - $ref: "#/components/schemas/PortUUID" + description: Port UUID + type: string + format: uuid - name: dryRun in: query description: option to verify that API calls will succeed @@ -5898,48 +23933,165 @@ paths: type: boolean default: false responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Port" + $ref: '#/components/schemas/Port' examples: portDryRunExample: - $ref: "#/components/examples/portDryRunDelete" - "202": + value: + type: XF_PORT + uuid: e91484bb-4f65-4ab3-8f77-500dec2f855d + name: test-AT1-Dot1q-L-Secondary-108608 + physicalPortsType: 10GBASE_LR + physicalPortsSpeed: 10000 + physicalPortsCount: 1 + location: + metroCode: AM + demarcationPointIbx: AM1 + redundancy: + group: '1' + priority: PRIMARY + lagEnabled: true + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + package: + code: STANDARD + settings: + sharedPortType: false + project: + projectId: '567' + 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 + physicalPorts: + - 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' + '202': description: Accepted content: application/json: schema: - $ref: "#/components/schemas/Port" + $ref: '#/components/schemas/Port' examples: portExample: - $ref: "#/components/examples/portDelete" - "400": + 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: '0x8100' + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400" - "401": + value: + - errorCode: EQ-3046115 + errorMessage: Invalid Path Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: pathparameter-portUuid + reason: Provide valid port Uuid + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "404": + value: + - errorCode: EQ-3046117 + errorMessage: Unauthorized user. + correlationId: TEST + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' patch: tags: - Ports @@ -5952,7 +24104,9 @@ paths: description: Port UUID required: true schema: - $ref: "#/components/schemas/PortUUID" + description: Port UUID + type: string + format: uuid - name: dryRun in: query description: option to verify that API calls will succeed @@ -5964,65 +24118,244 @@ paths: content: application/json-patch+json: schema: - $ref: "#/components/schemas/PortUpdateRequest" + $ref: '#/components/schemas/PortUpdateRequest' examples: PortUpdateNameRequest: - $ref: "#/components/examples/portUpdateNameRequest" + value: + - op: replace + path: /name + value: 1234-ibx-port PortUpdateEncapsulationAndTagprotocolIdRequest: - $ref: "#/components/examples/portUpdateEncapsulationAndTagProtocolIdRequest" + value: + - op: replace + path: /encapsulation + value: + type: DOT1Q + tagProtocolId: '0x8100' PortUpdateNameDryRunRequest: - $ref: "#/components/examples/PortUpdateNameDryRunRequest" + value: + - op: replace + path: /name + value: 1234-ibx-port PortUpdateLagEnabledRequest: - $ref: "#/components/examples/portUpdateLagEnabledRequest" + value: + - op: replace + path: /lagEnabled + value: true required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AllPortsResponse" + $ref: '#/components/schemas/AllPortsResponse' examples: portDryRunExample: - $ref: "#/components/examples/PortUpdateDryRunResponse" - "202": + 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 + physicalPortsSpeed: 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: '0x8100' + 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 + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Port" + $ref: '#/components/schemas/Port' examples: portExample: - $ref: "#/components/examples/portPatchResponse202" - "400": + value: + href: https://api.equinix.com/fabric/v4/ports/44c5712b-d704-4ca5-9b42-ee6be32ee06a + type: XF_PORT + uuid: 08693250-e67f-431f-b1ac-d3204263876a + name: 290061-SV1-NE-Shared-CX-PRI-01 + physicalPortsSpeed: 10000 + physicalPortsType: 10GBASE_LR + physicalPortsCount: 1 + project: + projectId: '377533000114703' + state: REPROVISIONING + cvpId: '2001190' + account: + accountNumber: 290061 + ucmId: BD8EB6F3-F8EF-40dc-8AAF-032B85804920 + change: + type: PORT_UPDATE + status: REQUESTED + data: + op: REPLACE + path: /encapsulation + value: + type: DOT1Q + tagProtocolId: '0x8100' + bandwidth: 10000 + location: + metroName: Silicon Valley + metroCode: SV + device: + name: qa3-sv-em-e3.lab + redundancy: + priority: PRIMARY + configModel: UPF + demarcationPointIbx: SV5 + encapsulation: + type: QINQ + tagProtocolId: '0x9100' + lagEnabled: true + settings: + buyout: false + additionalInfo: + - key: crossConnectId + value: 21918108-A + package: + code: STANDARD + physicalPorts: + - tether: + crossConnectId: 21918108-A + patchPanel: CP:Demarc:1257694 + patchPanelPortA: '21' + patchPanelPortB: '22' + demarcationPoint: + patchPanelPortA: '18' + patchPanelPortB: '19' + ibx: SV1 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidUUID: - $ref: "#/components/examples/400" + value: + - errorCode: EQ-3046115 + errorMessage: Invalid Path Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: pathparameter-portUuid + reason: Provide valid port Uuid ResourceUsedError: - $ref: "#/components/examples/portPatchMultipleConnections400Response" - "403": + value: + - errorCode: EQ-3143253 + errorMessage: Port is used by one or more Connections, connectors, subscriptions and/or tokens + details: There are 9 Connections/ connectors/ subscriptions/ tokens associated to this port + correlationId: TEST + additionalInfo: + - property: /uuid + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "500": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3143001 + errorMessage: Internal Error + details: Internal system error + correlationId: 5c340fe0-48bd-11f0-9332-c344b6c9d7d7 + - errorCode: IC-USR-014-01 + errorMessage: Error in getting user's profile /fabric/v4/ports/{portUuid}/linkProtocols: get: tags: @@ -6050,39 +24383,229 @@ paths: description: Port UUID required: true schema: - $ref: "#/components/schemas/PortUUID" + description: Port UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Get Vlans content: application/json: schema: - $ref: "#/components/schemas/LinkProtocolGetResponse" + $ref: '#/components/schemas/LinkProtocolGetResponse' examples: LinkProtocolQ1NQResponse: - $ref: "#/components/examples/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' LinkProtocolDOT1QResponse: - $ref: "#/components/examples/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' LinkProtocolVlanRangeResponse: - $ref: "#/components/examples/LinkProtocolGetVlanRangeResponseExample" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_portId" - "403": + 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': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403-port-access" + value: + - errorCode: EQ-3035002 + errorMessage: Access Forbidden + correlationId: UnAuthorized User- Cannot perform action /fabric/v4/ports/search: post: tags: @@ -6090,75 +24613,357 @@ paths: 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" + $ref: '#/components/schemas/PortV4SearchRequest' examples: PortSearchDirection: - $ref: "#/components/examples/portSearchByProjectId" + value: + filter: + or: + - and: + - property: /state + operator: '=' + values: + - ACTIVE + - REPROVISIONING + - property: /settings/productCode + operator: '=' + values: + - CX + - property: /project/projectId + operator: '=' + values: + - 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 + pagination: + limit: 1000 + offset: 0 + sort: + - property: /device/name + direction: DESC PortSearchOptionalFilter: - $ref: "#/components/examples/portSearchByOptionalFilters" + value: + filter: + or: + - and: + - property: /device/name + operator: '=' + values: + - qa3-sv-em-e3.lab + - property: /physicalPorts/tether/crossConnectId + operator: '=' + values: + - 21918108-A + - property: /physicalPorts/interface/name + operator: '=' + values: + - et-0/0/0 + - property: /uuid + operator: '=' + values: + - 08693250-e67f-431f-b1ac-d3204263876a + - property: /name + operator: LIKE + values: + - port-name + - property: /account/orgId + operator: '=' + values: + - '94513' + - property: /account/accountNumber + operator: '=' + values: + - '290061' + - property: /location/metroCode + operator: IN + values: + - SV + pagination: + limit: 1000 + offset: 0 + sort: + - property: /device/name + direction: DESC PortSearchRangeOperators: - $ref: "#/components/examples/portSearchRangeOperators" + value: + filter: + or: + - and: + - property: /changeLog/createdDateTime + operator: BETWEEN + values: + - '2023-06-27T15:05:37Z' + - '2023-07-27T15:05:37Z' + - property: /badwidth + operator: '>=' + values: + - '1000' + pagination: + limit: 1000 + offset: 0 + sort: + - property: /changeLog/createdDateTime + direction: DESC PortSearchByMaintenanceStatus: - $ref: "#/components/examples/portSearchByMaintenanceStatus" + value: + filter: + and: + - property: /operation/maintenanceStatus + operator: IN + values: + - SCHEDULED + - COMPLETED + - property: /operation/lockEnabled + operator: IN + values: + - 'true' + pagination: + limit: 25 + offset: 0 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AllPortsResponse" + $ref: '#/components/schemas/AllPortsResponse' examples: portExample: - $ref: "#/components/examples/ports" - "400": + value: + pagination: + offset: 0 + limit: 1000 + total: 2 + data: + - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-02db-2dbc-ace0-30fa5c00ad04 + type: XF_PORT + uuid: c4d93b39-02db-2dbc-ace0-30fa5c00ad04 + name: gen-l2-qa-01-auto-TY4-L-Qinq-STD-SEC-10G-JUN-598 + physicalPortsSpeed: 10000 + physicalPortsType: 10GBASE_LR + connectivitySourceType: COLO + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + package: + code: STANDARD + state: REPROVISIONING + cvpId: '1616554' + operation: + connectionCount: 0 + evplVCCount: 0 + accessVCCount: 0 + account: + accountNumber: 200559 + accountName: gen-l2-qa-01-auto-200559 + orgId: 90946 + organizationName: gen-l2-qa-01-auto-200551. + ucmId: 500DFED2-EBDB-480d-896C-C7870E52D0D8 + globalCustId: 0017i000011X242AAC + changeLog: + createdBy: vvyugovskiy-IMPORT_JOB + createdDateTime: '2021-06-16T01:46:52Z' + updatedBy: Order-to-activation + updatedDateTime: '2025-04-07T23:03:08.900Z' + bandwidth: 10000 + availableBandwidth: 10000 + usedBandwidth: 0 + location: + metroHref: https://api.equinix.com/fabric/v4/metros/TY + region: APAC + metroName: Tokyo + metroCode: TY + ibx: TY4 + device: + name: sit-tb1-ty-a2.lab + redundancy: + priority: SECONDARY + demarcationPointIbx: TY4 + tetherIbx: TY4 + redundancy: + priority: SECONDARY + encapsulation: + type: QINQ + tagProtocolId: '0x9100' + lagEnabled: false + settings: + buyout: false + physicalPorts: + - type: XF_PHYSICAL_PORT + id: 1362185 + state: TO_BE_ADDED + uuid: 01892489-ce9b-7f25-b1f5-d32a5ac6a423 + tether: + crossConnectId: ECX.05.00001836 + cabinetNumber: Demarc + systemName: TY4:01:002181 + patchPanel: PP:1240:1089399 + patchPanelPortA: '7' + patchPanelPortB: '8' + ibx: TY4 + demarcationPoint: + patchPanel: PP:Demarc:00002181 + patchPanelName: PP:Demarc:00002181 + patchPanelPortA: '5' + patchPanelPortB: '6' + ibx: TY4 + operation: + operationalStatus: UP + - href: https://api.equinix.com/fabric/v4/ports/6f0f3015-2d51-4b6e-a98c-1defb4fe88f1 + type: XF_PORT + uuid: 6f0f3015-2d51-4b6e-a98c-1defb4fe88f1 + name: 200558-SY4-CX-PRI-02 + physicalPortsSpeed: 10000 + physicalPortsType: 10GBASE_LR + project: + projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 + package: + code: STANDARD + state: ACTIVE + cvpId: '2000348' + operation: + connectionCount: 1 + evplVCCount: 1 + accessVCCount: 0 + maintenanceStatus: SCHEDULED + lockEnabled: true + account: + accountNumber: 200558 + accountName: Gen-L2-Qa-01-Auto-200558 + orgId: 90946 + organizationName: gen-l2-qa-01-auto-200551. + ucmId: 2D26D682-B62E-495d-AFDF-698EC3B353F8 + globalCustId: 0017i000011X242AAC + changeLog: + createdDateTime: '2025-05-06T17:29:30.800Z' + updatedBy: API + updatedDateTime: '2025-05-06T17:29:40.300Z' + bandwidth: 10000 + availableBandwidth: 9500 + usedBandwidth: 500 + location: + metroHref: https://api.equinix.com/fabric/v4/metros/SY + region: APAC + metroName: Sydney + metroCode: SY + ibx: SY4 + device: + name: sit-tb1-sy-e1.lab + redundancy: + group: '1' + priority: PRIMARY + demarcationPointIbx: SY4 + tetherIbx: SY4 + redundancy: + priority: PRIMARY + encapsulation: + type: DOT1Q + tagProtocolId: '0x8100' + lagEnabled: true + settings: + buyout: false + physicalPorts: + - type: XF_PHYSICAL_PORT + id: 1362737 + state: ACTIVE + uuid: 01892489-ce07-7962-b676-b1a4d8091515 + tether: + crossConnectId: '22035616' + cabinetNumber: Demarc + systemName: SY4:01:002204 + patchPanel: PP:1240:1089399 + patchPanelPortA: '12' + patchPanelPortB: '14' + ibx: SY4 + demarcationPoint: + patchPanel: PP:Demarc:00002204 + patchPanelName: PP:Demarc:00002204 + patchPanelPortA: '17' + patchPanelPortB: '18' + ibx: SY4 + operation: + operationalStatus: UP + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: invalidUuid: - $ref: "#/components/examples/400" + value: + - errorCode: EQ-3046115 + errorMessage: Invalid Path Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: pathparameter-portUuid + reason: Provide valid port Uuid invalidProjectIdRequest: - $ref: "#/components/examples/portSearchInvalidProjectRequest" + value: + - errorCode: EQ-3046110 + errorMessage: ProjectID required. + details: ProjectId and ports are not found for the user + correlationId: TEST + additionalInfo: + - property: /project/projectId + reason: ' before searching for ports, assign project and ports' invalidRequest: - $ref: "#/components/examples/portSearchInvalidRequest" + value: + - errorCode: EQ-3046116 + errorMessage: JSON syntax error. + details: Unknown json property + correlationId: TEST + additionalInfo: + - property: filter.or.[0].and.[1].property + reason: Unexpected value '/settings/productCod' invalidSearchFieldProperty: - $ref: "#/components/examples/portSearchInvalidSearchFieldProperty" + value: + - errorCode: EQ-3046116 + errorMessage: JSON syntax error. + details: Please refer the contracts for correct fields + correlationId: TEST invalidSearchFieldArgument: - $ref: "#/components/examples/portSearchInvalidSearchFieldArgument" - "401": + value: + - errorCode: EQ-3046112 + errorMessage: Invalid argument value. + details: Please refer the contracts for correct fields + correlationId: TEST + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "404": + value: + - errorCode: EQ-3046117 + errorMessage: Unauthorized user. + correlationId: TEST + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Service Unavailable content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: portExample: - $ref: "#/components/examples/ports-500" + value: + - errorCode: EQ-3046030 + errorMessage: Internal error. + details: Internal system error userFailureExample: - $ref: "#/components/examples/ports-500-user-failure" + value: + - errorCode: IC-USR-014-01 + errorMessage: Error in getting user's profile /fabric/v4/portPackages: get: tags: @@ -6166,53 +24971,102 @@ paths: summary: List Port Packages description: Get All Port Packages returns details of all available port packages for the specified user credentials operationId: getPortPackages - parameters: [] responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AllPortPackagesResponse" + $ref: '#/components/schemas/AllPortPackagesResponse' examples: portPackagesExample: - $ref: "#/components/examples/port-packages" - "401": + value: + data: + - href: /fabric/v4/portPackages/XF_UNLIMITED_PLUS + type: PORT_PACKAGE + code: XF_UNLIMITED_PLUS + vcBandwidthMax: 100000 + vcRemoteSupported: true + supportedServiceTypes: + - MSP + supportedSourceTypes: + - COLO + supportedMetros: + - SV + - DA + - href: /fabric/v4/portPackages/XF_UNLIMITED + type: PORT_PACKAGE + code: XF_UNLIMITED + vcBandwidthMax: 100000 + vcRemoteSupported: false + supportedServiceTypes: + - MSP + supportedSourceTypes: + - REMOTE + - COLO + - href: /fabric/v4/portPackages/XF_STANDARD + type: PORT_PACKAGE + code: XF_STANDARD + vcBandwidthMax: 100000 + vcRemoteSupported: false + supportedServiceTypes: + - MSP + supportedSourceTypes: + - BMMR + - REMOTE + - COLO + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: portPackagesInternalErrorExample: - $ref: "#/components/examples/port-packages-500" + value: + - errorCode: EQ-3143001 + errorMessage: Internal Error + details: Internal system error + correlationId: 80066c00-0f20-11f0-8367-d5075ee362a7 /fabric/v4/connections/{connectionId}/routeAggregations: get: tags: @@ -6226,73 +25080,125 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetAllConnectionRouteAggregationsResponse" + $ref: '#/components/schemas/GetAllConnectionRouteAggregationsResponse' examples: ConnectionRouteAggregationsResponse: - $ref: "#/components/examples/ConnectionRouteAggregationsGetAll" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 4 + 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_IPv4_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_IPv4_PREFIX_AGGREGATION + uuid: 65d74639-8f48-4e10-9684-45d364645e97 + attachmentStatus: ATTACHED + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/connections/{connectionId}/routeAggregations/{routeAggregationId}: get: tags: @@ -6306,79 +25212,116 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteAggregationData" + $ref: '#/components/schemas/ConnectionRouteAggregationData' examples: ConnectionRouteAggregationAttachResponse: - $ref: "#/components/examples/AttachConnectionRouteAggregationsResponse" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 put: tags: - Route Aggregations @@ -6391,77 +25334,110 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteAggregationData" + $ref: '#/components/schemas/ConnectionRouteAggregationData' examples: ConnectionRouteAggregationAttachResponse: - $ref: "#/components/examples/AttachConnectionRouteAggregationsResponse" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: TransientState: - $ref: "#/components/examples/400_transient_state" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 delete: tags: - Route Aggregations @@ -6474,77 +25450,110 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteAggregationData" + $ref: '#/components/schemas/ConnectionRouteAggregationData' examples: ConnectionRouteAggregationDetachResponse: - $ref: "#/components/examples/DetachConnectionRouteAggregationResponse" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_transient_state" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/connections/{connectionId}/routeFilters: get: tags: @@ -6558,73 +25567,129 @@ paths: description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetAllConnectionRouteFiltersResponse" + $ref: '#/components/schemas/GetAllConnectionRouteFiltersResponse' examples: ConnectionRouteFiltersResponse: - $ref: "#/components/examples/ConnectionRouteFiltersGetAll" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 4 + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}: get: tags: @@ -6638,79 +25703,117 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteFilterData" + $ref: '#/components/schemas/ConnectionRouteFilterData' examples: ConnectionRouteFilterAttachResponse: - $ref: "#/components/examples/AttachConnectionRouteFiltersResponse" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 put: tags: - Route Filters @@ -6723,90 +25826,131 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteFiltersBase" + $ref: '#/components/schemas/ConnectionRouteFiltersBase' examples: ConnectionRouteFilterAttachInboundExample: - $ref: "#/components/examples/AttachConnectionRouteFilterInbound" + value: + direction: INBOUND ConnectionRouteFilterAttachOutboundExample: - $ref: "#/components/examples/AttachConnectionRouteFilterOutbound" + value: + direction: OUTBOUND required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteFilterData" + $ref: '#/components/schemas/ConnectionRouteFilterData' examples: ConnectionRouteFilterAttachResponse: - $ref: "#/components/examples/AttachConnectionRouteFiltersResponse" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidDirection: - $ref: "#/components/examples/400_invalid_direction" + value: + - errorCode: EQ-3044001 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: direction TransientState: - $ref: "#/components/examples/400_transient_state" - "401": + value: + - errorCode: EQ-3044008 + errorMessage: Cannot attach or detach route filter with connection in transient state + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Cannot attach or detach route filter with connection in transient state + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 delete: tags: - Route Filters @@ -6819,79 +25963,118 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: - $ref: "#/components/schemas/ConnectionId" + description: Connection UUID + type: string + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionRouteFilterData" + $ref: '#/components/schemas/ConnectionRouteFilterData' examples: ConnectionRouteFilterDetachInboundResponse: - $ref: "#/components/examples/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 ConnectionRouteFilterDetachOutboundResponse: - $ref: "#/components/examples/DetachConnectionRouteFilterOutboundResponse" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_transient_state" - "401": + value: + - errorCode: EQ-3044008 + errorMessage: Cannot attach or detach route filter with connection in transient state + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Cannot attach or detach route filter with connection in transient state + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters: post: tags: @@ -6899,82 +26082,136 @@ paths: summary: Create Route Filter description: This API provides capability to create a Route Filter operationId: createRouteFilter - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersBase" + $ref: '#/components/schemas/RouteFiltersBase' examples: RouteFilterBgpIpv4Prefix: - $ref: "#/components/examples/RouteFilterCreateBgpIpv4Prefix" + value: + type: BGP_IPv4_PREFIX_FILTER + name: My-route-filter-v4 + description: Test filter + project: + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 RouteFilterBgpIpv6Prefix: - $ref: "#/components/examples/RouteFilterCreateBgpIpv6Prefix" + value: + type: BGP_IPv6_PREFIX_FILTER + name: My-route-filter-v6 + description: Test filter + project: + projectId: '567' required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersData" + $ref: '#/components/schemas/RouteFiltersData' examples: GetSpecificRouteFilterResponse: - $ref: "#/components/examples/RouteFilterCreateBgpIpv4PrefixResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: TransientState: - $ref: "#/components/examples/400_transient_state" - "401": + value: + - errorCode: EQ-3044008 + errorMessage: Cannot attach or detach route filter with connection in transient state + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Cannot attach or detach route filter with connection in transient state + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}: get: tags: @@ -6988,73 +26225,124 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersData" + $ref: '#/components/schemas/RouteFiltersData' examples: GetSpecificRouteFilterResponse: - $ref: "#/components/examples/RouteFilterCreateBgpIpv4PrefixResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 delete: tags: - Route Filters @@ -7067,71 +26355,126 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersData" + $ref: '#/components/schemas/RouteFiltersData' examples: RouteFilterDeleteBgpIpv4PrefixResponse: - $ref: "#/components/examples/RouteFilterDeleteBgpIpv4PrefixResponse" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_attached_connection" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 patch: tags: - Route Filters @@ -7144,86 +26487,139 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersPatchRequest" + $ref: '#/components/schemas/RouteFiltersPatchRequest' examples: RouteFilterNamePatchExample: - $ref: "#/components/examples/PatchRouteFilterName" + value: + - op: replace + path: /name + value: My-route-filter-v4-updated application/json-patch+json: schema: - $ref: "#/components/schemas/RouteFiltersPatchRequest" + $ref: '#/components/schemas/RouteFiltersPatchRequest' examples: RouteFilterNamePatchExample: - $ref: "#/components/examples/PatchRouteFilterName" + value: + - op: replace + path: /name + value: My-route-filter-v4-updated required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersData" + $ref: '#/components/schemas/RouteFiltersData' examples: RouteFilterNamePatchResponse: - $ref: "#/components/examples/RouteFilterNamePatchResponse" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation" - "401": + value: + - errorCode: EQ-3044011 + errorMessage: Invalid argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Only replace name operation is supported. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}/changes: get: tags: @@ -7237,7 +26633,9 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: offset in: query description: offset @@ -7253,62 +26651,126 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Fabric Route Filter Change object content: application/json: schema: - $ref: "#/components/schemas/RouteFilterChangeDataResponse" + $ref: '#/components/schemas/RouteFilterChangeDataResponse' examples: RouteFilterChangesResponse: - $ref: "#/components/examples/RouteFilterGetAllChangesResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: replace + path: /name + value: + type: BGP_IPv4_PREFIX_FILTER + name: My-route-filter-v4-updated + description: Test filter + project: + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}/changes/{changeId}: get: tags: @@ -7322,70 +26784,115 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: changeId in: path description: Routing Protocol Change UUID required: true schema: - $ref: "#/components/schemas/ChangeId_1" + description: Route Filters Change UUID + type: string + format: uuid + example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: - "200": + '200': description: Fabric Route Filter Change object content: application/json: schema: - $ref: "#/components/schemas/RouteFilterChangeData" + $ref: '#/components/schemas/RouteFilterChangeData' examples: RouteFilterChangeResponse: - $ref: "#/components/examples/RouteFilterGetChangeResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + type: BGP_IPv4_PREFIX_FILTER + name: My-route-filter-v4 + description: Test filter + project: + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}/connections: get: tags: @@ -7399,73 +26906,115 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetRouteFilterGetConnectionsResponse" + $ref: '#/components/schemas/GetRouteFilterGetConnectionsResponse' examples: RouteFilterGetConnectionsResponse: - $ref: "#/components/examples/RouteFilterGetConnectionsResponse" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/search: post: tags: @@ -7473,86 +27022,212 @@ paths: summary: Search Route Filters description: This API provides capability to search Route Filters operationId: searchRouteFilters - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersSearchRequest" + $ref: '#/components/schemas/RouteFiltersSearchRequest' examples: searchRouteFiltersAndRequest: - $ref: "#/components/examples/SearchRouteFiltersAndRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_FILTER + - property: /state + operator: IN + values: + - PROVISIONED + - PROVISIONING + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC searchRouteFiltersOrRequest: - $ref: "#/components/examples/SearchRouteFiltersOrRequest" + value: + filter: + or: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_FILTER + - property: /name + operator: LIKE + values: + - '%Route_Filter_Demo%' + - property: /project/projectId + operator: IN + values: + - dadd3ab6-c0af-430c-8216-43d44f08c1c5 + - 4f08c1c6-c0af-430c-8216-43d44f08c1c5 + pagination: + offset: 1 + limit: 2 + sort: + - property: /changeLog/updatedDateTime + direction: DESC searchRouteFiltersNestedRequest: - $ref: "#/components/examples/SearchRouteFiltersNestedRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_FILTER + - property: /changeLog/createdDateTime + operator: '>' + values: + - '2025-03-28T04:12:36.607Z' + - or: + - property: /name + operator: LIKE + values: + - '%Demo%' + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFiltersSearchResponse" + $ref: '#/components/schemas/RouteFiltersSearchResponse' examples: SearchRouteFiltersResponse: - $ref: "#/components/examples/SearchRouteFiltersResponse" - "400": + value: + pagination: + offset: 1 + limit: 2 + total: 10 + next: /search?offset=3&limit=2 + previous: /search?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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules: get: tags: @@ -7566,7 +27241,9 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: offset in: query description: offset @@ -7582,57 +27259,115 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetRouteFilterRulesResponse" + $ref: '#/components/schemas/GetRouteFilterRulesResponse' examples: getAllRouteFilterRules: - $ref: "#/components/examples/RouteFilterRulesGetAll" - "400": + 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: BGP_IPv4_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: BGP_IPv4_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' + '400': description: Resource not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044201 + errorMessage: Route filter rule Id not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter Rule ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 post: tags: - Route Filter Rules @@ -7645,83 +27380,164 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesBase" + $ref: '#/components/schemas/RouteFilterRulesBase' examples: RouteFilterRuleBgpIpv4Prefix: - $ref: "#/components/examples/RouteFilterRuleCreateBgpIpv4Prefix" + value: + name: Private-subnet-filter + description: Test rule + prefix: 192.168.0.0/24 + prefixMatch: exact RouteFilterRuleBgpIpv6Prefix: - $ref: "#/components/examples/RouteFilterRuleCreateBgpIpv6Prefix" + value: + name: Private-subnet-filter + description: Test rule + prefix: 2001:7a9::34f4:0:f3dd:1/126 + prefixMatch: orlonger required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesData" + $ref: '#/components/schemas/RouteFilterRulesData' examples: GetSpecificRouteFilterRuleIpv4Response: - $ref: "#/components/examples/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' GetSpecificRouteFilterRuleIpv6Response: - $ref: "#/components/examples/RouteFilterRuleCreateBgpIpv6PrefixResponse" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidType: - $ref: "#/components/examples/400_bad_request" + value: + - errorCode: EQ-3044013 + errorMessage: Invalid argument value passed + additionalInfo: + - property: prefixMatch + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter Rule ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "415": + $ref: '#/components/schemas/ErrorList' + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}: get: tags: @@ -7735,264 +27551,509 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: - $ref: "#/components/schemas/RouteFilterRuleId" + description: Route Filter Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesData" + $ref: '#/components/schemas/RouteFilterRulesData' examples: GetSpecificRouteFilterRuleIpv4Response: - $ref: "#/components/examples/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' GetSpecificRouteFilterRuleIpv6Response: - $ref: "#/components/examples/RouteFilterRuleCreateBgpIpv6PrefixResponse" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidType: - $ref: "#/components/examples/400_bad_request" + value: + - errorCode: EQ-3044013 + errorMessage: Invalid argument value passed + additionalInfo: + - property: prefixMatch + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" - put: + value: + - errorCode: EQ-3044011 + 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 + delete: tags: - Route Filter Rules - summary: Replace Route Filter Rule - description: This API provides capability to replace a Route Filter Rule completely - operationId: replaceRouteFilterRuleByUuid + 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" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - 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 + description: Route Filter Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesData" + $ref: '#/components/schemas/RouteFilterRulesData' examples: - RouteFilterRuleIpv4ReplaceResponse: - $ref: "#/components/examples/RouteFilterRuleReplaceIpv4Response" - routeFilterRuleIpv6ReplaceResponse: - $ref: "#/components/examples/RouteFilterRuleReplaceIpv6Response" - "400": + RouteFilterDeleteBgpIpv4PrefixResponse: + 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' + routeFilterDeleteBgpIpv6PrefixResponse: + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: - InvalidType: - $ref: "#/components/examples/400_bad_request" - InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" - delete: + value: + - errorCode: EQ-3044011 + 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 + put: tags: - Route Filter Rules - summary: Delete Route Filter Rule - description: This API provides capability to delete a Route Filter Rule - operationId: deleteRouteFilterRuleByUuid + 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" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: - $ref: "#/components/schemas/RouteFilterRuleId" + description: Route Filter Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RouteFilterRulesBase' + examples: + RouteFilterIpv4ReplaceExample: + value: + name: Private-subnet-filter-update + description: Test rule + prefix: 192.168.0.0/24 + prefixMatch: exact + RouteFilterIpv6ReplaceExample: + value: + name: Private-subnet-filter-update + description: Test rule + prefix: 2001:7a9::34f4:0:f3dd:1/126 + prefixMatch: exact + required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesData" + $ref: '#/components/schemas/RouteFilterRulesData' examples: - RouteFilterDeleteBgpIpv4PrefixResponse: - $ref: "#/components/examples/RouteFilterRuleDeleteBgpIpv4PrefixResponse" - routeFilterDeleteBgpIpv6PrefixResponse: - $ref: "#/components/examples/RouteFilterRuleDeleteBgpIpv6PrefixResponse" - "400": + RouteFilterRuleIpv4ReplaceResponse: + 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' + routeFilterRuleIpv6ReplaceResponse: + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: - example: - $ref: "#/components/examples/400_transient_filter" - "401": + InvalidType: + value: + - errorCode: EQ-3044013 + errorMessage: Invalid argument value passed + additionalInfo: + - property: prefixMatch + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + InvalidId: + value: + - errorCode: EQ-3044201 + errorMessage: Route filter rule Id not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 patch: tags: - Route Filter Rules @@ -8005,104 +28066,200 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: - $ref: "#/components/schemas/RouteFilterRuleId" + description: Route Filter Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesPatchRequest" + $ref: '#/components/schemas/RouteFilterRulesPatchRequest' examples: RouteFilterRuleName: - $ref: "#/components/examples/PatchRouteFilterRuleName" + value: + - op: replace + path: /name + value: test-route-filter-name-patch RouteFilterRulePrefix: - $ref: "#/components/examples/PatchRouteFilterRulePrefix" + value: + - op: replace + path: /prefix + value: 192.168.0.0/30 RouteFilterRulePrefixMatch: - $ref: "#/components/examples/PatchRouteFilterRulePrefixMatch" + value: + - op: replace + path: /prefixMatch + value: orlonger application/json-patch+json: schema: - $ref: "#/components/schemas/RouteFilterRulesPatchRequest" + $ref: '#/components/schemas/RouteFilterRulesPatchRequest' examples: RouteFilterRuleName: - $ref: "#/components/examples/PatchRouteFilterRuleName" + value: + - op: replace + path: /name + value: test-route-filter-name-patch RouteFilterRulePrefix: - $ref: "#/components/examples/PatchRouteFilterRulePrefix" + value: + - op: replace + path: /prefix + value: 192.168.0.0/30 RouteFilterRulePrefixMatch: - $ref: "#/components/examples/PatchRouteFilterRulePrefixMatch" + value: + - op: replace + path: /prefixMatch + value: orlonger required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesData" + $ref: '#/components/schemas/RouteFilterRulesData' examples: RouteFilterRuleIpv4ReplaceResponse: - $ref: "#/components/examples/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' routeFilterRuleIpv6ReplaceResponse: - $ref: "#/components/examples/RouteFilterRuleReplaceIpv6Response" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidType: - $ref: "#/components/examples/400_bad_request" + value: + - errorCode: EQ-3044013 + errorMessage: Invalid argument value passed + additionalInfo: + - property: prefixMatch + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044201 + errorMessage: Route filter rule Id not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}/changes: get: tags: @@ -8116,13 +28273,17 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: - $ref: "#/components/schemas/RouteFilterRuleId" + description: Route Filter Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b - name: offset in: query description: offset @@ -8138,62 +28299,140 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Fabric Route Filter Rule Change object content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesChangeDataResponse" + $ref: '#/components/schemas/RouteFilterRulesChangeDataResponse' examples: RouteFilterRuleChangesResponse: - $ref: "#/components/examples/RouteFilterRulesGetAllChangesResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + name: Private-subnet-filter + description: Test rule + prefix: 192.168.0.0/25 + prefixMatch: exact + - 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: replace + path: /prefixMatch + value: + name: Private-subnet-filter + description: Test rule + prefix: 192.168.0.0/25 + prefixMatch: orlonger + - 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: replace + path: /prefixMatch + value: + name: Private-subnet-filter + description: Test rule + prefix: 192.168.0.0/25 + prefixMatch: exact + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}/changes/{changeId}: get: tags: @@ -8207,76 +28446,122 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: - $ref: "#/components/schemas/RouteFilterRuleId" + description: Route Filter Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b - name: changeId in: path description: Route Filter Rule Change UUID required: true schema: - $ref: "#/components/schemas/ChangeId_2" + description: Route Filter Rule Change UUID + type: string + format: uuid + example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: - "200": + '200': description: Fabric Route Filter Change object content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesChangeData" + $ref: '#/components/schemas/RouteFilterRulesChangeData' examples: RouteFilterChangeResponse: - $ref: "#/components/examples/RouteFilterRuleGetChangeResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + name: Private-subnet-filter + description: Test rule + prefix: 192.168.0.0/25 + prefixMatch: exact + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/bulk: post: tags: @@ -8290,77 +28575,149 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesPostRequest" + $ref: '#/components/schemas/RouteFilterRulesPostRequest' required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetRouteFilterRulesResponse" + $ref: '#/components/schemas/GetRouteFilterRulesResponse' examples: getAllRouteFilterRules: - $ref: "#/components/examples/RouteFilterRulesBulkResponse" - "400": + 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: BGP_IPv4_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: BGP_IPv4_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' + '400': description: Resource not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044201 + errorMessage: Route filter rule Id not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400" - "415": + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/search: post: tags: @@ -8374,76 +28731,186 @@ paths: description: Route Filters Id required: true schema: - $ref: "#/components/schemas/RouteFilterId" + description: Route Filters UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesSearchRequest" + $ref: '#/components/schemas/RouteFilterRulesSearchRequest' examples: SearchRouteFilterRulesAndRequest: - $ref: "#/components/examples/SearchRouteFilterRulesAndRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_FILTER_RULE + - property: /state + operator: '=' + values: + - PROVISIONED + - or: + - property: /name + operator: LIKE + values: + - '%Demo%' + - property: /name + operator: LIKE + values: + - '%Production%' + - or: + - property: /state + operator: '=' + values: + - PROVISIONED + - and: + - property: /prefix + operator: '=' + values: + - 192.168.2.0/24 + - property: /prefixMatch + operator: '=' + values: + - exact + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC SearchRouteFilterRulesOrRequest: - $ref: "#/components/examples/SearchRouteFilterRulesOrRequest" + value: + filter: + or: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_FILTER_RULE + - property: /state + operator: '=' + values: + - PROVISIONED + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteFilterRulesSearchResponse" + $ref: '#/components/schemas/RouteFilterRulesSearchResponse' examples: SearchRouteFilterRulesResponse: - $ref: "#/components/examples/SearchRouteFilterRulesResponse" - "400": + value: + pagination: + offset: 1 + limit: 2 + total: 10 + next: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/search?offset=3&limit=2 + previous: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/search?offset=0&limit=2 + 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: Route_Filter_Rule_Demo1 + description: Test rule1 + prefixMatch: exact + action: PERMIT + prefix: 192.168.10.0/24 + state: PROVISIONED + 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: Route_Filter_Rule_Demo2 + description: Test rule2 + prefixMatch: orlonger + action: PERMIT + prefix: 192.168.20.0/24 + state: PROVISIONED + changelog: + createdBy: testuser + createdByEmail: testuser@equinix.com + createdByFullName: testuser testuser + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter Rule ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "415": + $ref: '#/components/schemas/ErrorList' + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/routeAggregations: post: tags: @@ -8451,80 +28918,128 @@ paths: summary: Create Route Aggregation description: This API provides capability to create a Route Aggregation operationId: createRouteAggregation - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsBase" + $ref: '#/components/schemas/RouteAggregationsBase' examples: RouteAggregationBgpIpv4Prefix: - $ref: "#/components/examples/RouteAggregationCreateBgpIpv4Prefix" + value: + type: BGP_IPv4_PREFIX_AGGREGATION + name: My-route-aggregation-v4 + description: Test aggregation + project: + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsData" + $ref: '#/components/schemas/RouteAggregationsData' examples: GetSpecificRouteAggregationResponse: - $ref: "#/components/examples/RouteAggregationCreateBgpIpv4PrefixResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: TransientState: - $ref: "#/components/examples/400_transient_state" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}: get: tags: @@ -8538,73 +29053,123 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsData" + $ref: '#/components/schemas/RouteAggregationsData' examples: GetSpecificRouteAggregationResponse: - $ref: "#/components/examples/RouteAggregationCreateBgpIpv4PrefixResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 delete: tags: - Route Aggregations @@ -8617,71 +29182,125 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsData" + $ref: '#/components/schemas/RouteAggregationsData' examples: RouteAggregationDeleteBgpIpv4PrefixResponse: - $ref: "#/components/examples/RouteAggregationDeleteBgpIpv4PrefixResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_attached_connection" - "401": + value: + - errorCode: EQ-3044007 + errorMessage: Cannot delete route aggregation still attached to a connection + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Cannot delete Route Aggregation still attached to a Connection + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 patch: tags: - Route Aggregations @@ -8694,86 +29313,138 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsPatchRequest" + $ref: '#/components/schemas/RouteAggregationsPatchRequest' examples: RouteAggregationNamePatchExample: - $ref: "#/components/examples/PatchRouteAggregationName" + value: + - op: replace + path: /name + value: My-route-aggregation-v4-updated application/json-patch+json: schema: - $ref: "#/components/schemas/RouteAggregationsPatchRequest" + $ref: '#/components/schemas/RouteAggregationsPatchRequest' examples: RouteAggregationNamePatchExample: - $ref: "#/components/examples/PatchRouteAggregationName" + value: + - op: replace + path: /name + value: My-route-aggregation-v4-updated required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsData" + $ref: '#/components/schemas/RouteAggregationsData' examples: RouteAggregationNamePatchResponse: - $ref: "#/components/examples/RouteAggregationNamePatchResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation" - "401": + value: + - errorCode: EQ-3044011 + errorMessage: Invalid argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Only replace name operation is supported. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}/changes: get: tags: @@ -8787,7 +29458,9 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: offset in: query description: offset @@ -8803,62 +29476,126 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Fabric Route Aggregation Change object content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationChangeDataResponse" + $ref: '#/components/schemas/RouteAggregationChangeDataResponse' examples: RouteAggregationChangesResponse: - $ref: "#/components/examples/RouteAggregationGetAllChangesResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: replace + path: /name + value: + type: BGP_IPv4_PREFIX_AGGREGATION + name: My-route-aggregations-v4-updated + description: Test Aggregation + project: + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}/changes/{changeId}: get: tags: @@ -8872,70 +29609,115 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: changeId in: path description: Routing Protocol Change UUID required: true schema: - $ref: "#/components/schemas/ChangeId_3" + description: Route Aggregations Change UUID + type: string + format: uuid + example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: - "200": + '200': description: Fabric Route Aggregation Change object content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationChangeData" + $ref: '#/components/schemas/RouteAggregationChangeData' examples: RouteAggregationChangeResponse: - $ref: "#/components/examples/RouteAggregationGetChangeResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + type: BGP_IPv4_PREFIX_AGGREGATION + name: My-route-aggregation-v4 + description: Test aggregation + project: + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}/connections: get: tags: @@ -8949,73 +29731,115 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetRouteAggregationGetConnectionsResponse" + $ref: '#/components/schemas/GetRouteAggregationGetConnectionsResponse' examples: RouteAggregationGetConnectionsResponse: - $ref: "#/components/examples/RouteAggregationGetConnectionsResponse" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/search: post: tags: @@ -9023,86 +29847,210 @@ paths: summary: Search Route Aggregations description: This API provides capability to search Route Aggregations operationId: searchRouteAggregations - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsSearchRequest" + $ref: '#/components/schemas/RouteAggregationsSearchRequest' examples: searchRouteAggregationsAndRequest: - $ref: "#/components/examples/SearchRouteAggregationsAndRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_AGGREGATION + - property: /state + operator: IN + values: + - PROVISIONED + - DEPROVISIONING + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC searchRouteAggregationsOrRequest: - $ref: "#/components/examples/SearchRouteAggregationsOrRequest" + value: + filter: + or: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_AGGREGATION + - property: /name + operator: LIKE + values: + - '%Route_Aggregation_Demo%' + - property: /project/projectId + operator: IN + values: + - dadd3ab6-c0af-430c-8216-43d44f08c1c5 + - 8c1c5ab6-c0af-d44f-430c-43d44f08c1c5 + pagination: + offset: 1 + limit: 2 + sort: + - property: /changeLog/updatedDateTime + direction: DESC searchRouteAggregationsNestedRequest: - $ref: "#/components/examples/SearchRouteAggregationsNestedRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_AGGREGATION + - property: /changeLog/createdDateTime + operator: '>' + values: + - '2025-03-28T04:12:36.607Z' + - or: + - property: /name + operator: LIKE + values: + - '%Demo%' + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationsSearchResponse" + $ref: '#/components/schemas/RouteAggregationsSearchResponse' examples: SearchRouteAggregationsResponse: - $ref: "#/components/examples/SearchRouteAggregationsResponse" - "400": + value: + pagination: + offset: 1 + limit: 2 + total: 10 + next: /search?offset=3&limit=2 + previous: /search?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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules: get: tags: @@ -9116,7 +30064,9 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: offset in: query description: offset @@ -9132,57 +30082,111 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetRouteAggregationRulesResponse" + $ref: '#/components/schemas/GetRouteAggregationRulesResponse' examples: getAllRouteAggregationRules: - $ref: "#/components/examples/RouteAggregationRulesGetAll" - "400": + 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: BGP_IPv4_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: BGP_IPv4_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' + '400': description: Resource not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044401 + errorMessage: Route aggregation rule ID not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation Rule ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 post: tags: - Route Aggregation Rules @@ -9195,79 +30199,131 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesBase" + $ref: '#/components/schemas/RouteAggregationRulesBase' examples: RouteAggregationRuleBgpIpv4Prefix: - $ref: "#/components/examples/RouteAggregationRuleCreateBgpIpv4Prefix" + value: + name: Private-subnet-aggregation + description: Test rule + prefix: 192.168.0.0/24 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesData" + $ref: '#/components/schemas/RouteAggregationRulesData' examples: GetSpecificRouteAggregationRuleIpv4Response: - $ref: "#/components/examples/RouteAggregationRuleCreateBgpIpv4PrefixResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidType: - $ref: "#/components/examples/400_bad_request" + value: + - errorCode: EQ-3044413 + errorMessage: Invalid argument value passed + additionalInfo: + - property: /prefix + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044401 + errorMessage: Route aggregation rule ID not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation Rule ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "415": + $ref: '#/components/schemas/ErrorList' + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}: get: tags: @@ -9281,256 +30337,420 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: - $ref: "#/components/schemas/RouteAggregationRuleId" + description: Route Aggregation Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesData" + $ref: '#/components/schemas/RouteAggregationRulesData' examples: GetSpecificRouteAggregationRuleIpv4Response: - $ref: "#/components/examples/RouteAggregationRuleCreateBgpIpv4PrefixResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidType: - $ref: "#/components/examples/400_bad_request" + value: + - errorCode: EQ-3044413 + errorMessage: Invalid argument value passed + additionalInfo: + - property: /prefix + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044401 + errorMessage: Route aggregation rule ID not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" - put: + value: + - errorCode: EQ-3044308 + 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 + delete: tags: - Route Aggregation Rules - summary: Replace Route Aggregation Rule - description: This API provides capability to replace a Route Aggregation Rule completely - operationId: replaceRouteAggregationRuleByUuid + summary: Delete Route Aggregation Rule + 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" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - 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 + description: Route Aggregation Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesData" + $ref: '#/components/schemas/RouteAggregationRulesData' examples: - RouteAggregationRuleIpv4ReplaceResponse: - $ref: "#/components/examples/RouteAggregationRuleReplaceIpv4Response" - "400": + RouteAggregationDeleteBgpIpv4PrefixResponse: + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: - InvalidType: - $ref: "#/components/examples/400_bad_request" - InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + example: + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" - delete: + value: + - errorCode: EQ-3044308 + 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 + put: tags: - Route Aggregation Rules - summary: Delete Route Aggregation Rule - description: This API provides capability to delete a Route aggregation Rule - operationId: deleteRouteAggregationRuleByUuid + summary: Replace Route Aggregation Rule + 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" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: - $ref: "#/components/schemas/RouteAggregationRuleId" + description: Route Aggregation Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RouteAggregationRulesBase' + examples: + RouteaggregationIpv4ReplaceExample: + value: + name: Private-subnet-aggregation-update + description: Test rule + prefix: 192.168.0.0/24 + required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesData" + $ref: '#/components/schemas/RouteAggregationRulesData' examples: - RouteAggregationDeleteBgpIpv4PrefixResponse: - $ref: "#/components/examples/RouteAggregationRuleDeleteBgpIpv4PrefixResponse" - "400": + RouteAggregationRuleIpv4ReplaceResponse: + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: - example: - $ref: "#/components/examples/400_transient_aggregation" - "401": + InvalidType: + value: + - errorCode: EQ-3044413 + errorMessage: Invalid argument value passed + additionalInfo: + - property: /prefix + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + InvalidId: + value: + - errorCode: EQ-3044401 + errorMessage: Route aggregation rule ID not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 patch: tags: - Route Aggregation Rules @@ -9543,98 +30763,164 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: - $ref: "#/components/schemas/RouteAggregationRuleId" + description: Route Aggregation Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesPatchRequest" + $ref: '#/components/schemas/RouteAggregationRulesPatchRequest' examples: RouteaggregationRuleName: - $ref: "#/components/examples/PatchRouteAggregationRuleName" + value: + - op: replace + path: /name + value: test-route-aggregation-name-patch RouteaggregationRulePrefix: - $ref: "#/components/examples/PatchRouteAggregationRulePrefix" + value: + - op: replace + path: /prefix + value: 192.168.0.0/30 application/json-patch+json: schema: - $ref: "#/components/schemas/RouteAggregationRulesPatchRequest" + $ref: '#/components/schemas/RouteAggregationRulesPatchRequest' examples: RouteaggregationRuleName: - $ref: "#/components/examples/PatchRouteAggregationRuleName" + value: + - op: replace + path: /name + value: test-route-aggregation-name-patch RouteaggregationRulePrefix: - $ref: "#/components/examples/PatchRouteAggregationRulePrefix" + value: + - op: replace + path: /prefix + value: 192.168.0.0/30 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesData" + $ref: '#/components/schemas/RouteAggregationRulesData' examples: RouteAggregationRuleIpv4ReplaceResponse: - $ref: "#/components/examples/RouteAggregationRuleReplaceIpv4Response" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidType: - $ref: "#/components/examples/400_bad_request" + value: + - errorCode: EQ-3044413 + errorMessage: Invalid argument value passed + additionalInfo: + - property: /prefix + reason: Invalid argument value passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec InvalidId: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044401 + errorMessage: Route aggregation rule ID not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes: get: tags: @@ -9648,13 +30934,17 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: - $ref: "#/components/schemas/RouteAggregationRuleId" + description: Route Aggregation Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b - name: offset in: query description: offset @@ -9670,62 +30960,107 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Fabric Route Aggregation Rule Change object content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesChangeDataResponse" + $ref: '#/components/schemas/RouteAggregationRulesChangeDataResponse' examples: RouteAggregationRuleChangesResponse: - $ref: "#/components/examples/RouteAggregationRulesGetAllChangesResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + name: Private-subnet-aggregation + description: Test rule + prefix: 192.168.0.0/25 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes/{changeId}: get: tags: @@ -9739,76 +31074,121 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: - $ref: "#/components/schemas/RouteAggregationRuleId" + description: Route Aggregation Rule UUID + type: string + example: 65b025ef-022b-4180-85cf-82cfc1ab655b - name: changeId in: path description: Route Aggregation Rule Change UUID required: true schema: - $ref: "#/components/schemas/ChangeId_4" + description: Route Aggregation Rule Change UUID + type: string + format: uuid + example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: - "200": + '200': description: Fabric Route Aggregation Change object content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesChangeData" + $ref: '#/components/schemas/RouteAggregationRulesChangeData' examples: RouteAggregationChangeResponse: - $ref: "#/components/examples/RouteAggregationRuleGetChangeResponseExample" - "400": + 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 + createdDateTime: '2020-05-21T10:30:00Z' + updatedBy: _system + updatedDateTime: '2020-05-21T10:30:00Z' + data: + op: add + path: / + value: + name: Private-subnet-aggregation + description: Test rule + prefix: 192.168.0.0/25 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "500": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/bulk: post: tags: @@ -9822,77 +31202,145 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesPostRequest" + $ref: '#/components/schemas/RouteAggregationRulesPostRequest' required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetRouteAggregationRulesResponse" + $ref: '#/components/schemas/GetRouteAggregationRulesResponse' examples: getAllRouteAggregationRules: - $ref: "#/components/examples/RouteAggregationRulesBulkResponse" - "400": + 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: BGP_IPv4_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: BGP_IPv4_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' + '400': description: Resource not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "401": + value: + - errorCode: EQ-3044401 + errorMessage: Route aggregation rule ID not found. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400" - "415": + value: + - errorCode: EQ-3036013 + errorMessage: Invalid Query Parameter + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: presence + reason: Allowed value for presence is MY_SERVICES + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/search: post: tags: @@ -9906,76 +31354,173 @@ paths: description: Route Aggregations Id required: true schema: - $ref: "#/components/schemas/RouteAggregationId" + description: Route Aggregations UUID + type: string + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesSearchRequest" + $ref: '#/components/schemas/RouteAggregationRulesSearchRequest' examples: SearchRouteAggregationRulesAndRequest: - $ref: "#/components/examples/SearchRouteAggregationRulesAndRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_AGGREGATION_RULE + - property: /state + operator: '=' + values: + - PROVISIONED + - or: + - property: /name + operator: LIKE + values: + - '%Demo%' + - property: /name + operator: LIKE + values: + - '%Production%' + - or: + - property: /prefix + operator: '=' + values: + - 192.168.2.0/24 + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC SearchRouteAggregationRulesOrRequest: - $ref: "#/components/examples/SearchRouteAggregationRulesOrRequest" + value: + filter: + or: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_AGGREGATION_RULE + - property: /state + operator: '=' + values: + - PROVISIONED + pagination: + offset: 0 + limit: 20 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteAggregationRulesSearchResponse" + $ref: '#/components/schemas/RouteAggregationRulesSearchResponse' examples: SearchRouteAggregationRulesResponse: - $ref: "#/components/examples/SearchRouteAggregationRulesResponse" - "400": + value: + pagination: + offset: 1 + limit: 2 + total: 10 + next: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/search?offset=3&limit=2 + previous: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/search?offset=0&limit=2 + 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: Route_Aggregation_Rule_Demo1 + description: Test rule1 + prefix: 192.168.10.0/24 + state: PROVISIONED + 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: Route_Aggregation_Rule_Demo2 + description: Test rule2 + prefix: 192.168.20.0/24 + state: PROVISIONED + changeLog: + createdBy: testuser + createdByEmail: testuser@equinix.com + createdByFullName: testuser testuser + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation Rule ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "415": + $ref: '#/components/schemas/ErrorList' + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/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 /fabric/v4/routers: post: tags: @@ -9995,80 +31540,231 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/CloudRouterPostRequest" + $ref: '#/components/schemas/CloudRouterPostRequest' examples: CreateLabPackage: - $ref: "#/components/examples/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' CreateProPackage: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 required: true responses: - "200": + '200': description: Fabric Cloud Router object content: application/json: schema: - $ref: "#/components/schemas/CloudRouter" + $ref: '#/components/schemas/CloudRouter' examples: cloudRouterResponse: - $ref: "#/components/examples/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' cloudRouterResponseForMarketplaceSubscription: - $ref: "#/components/examples/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' cloudRouterResponseDryRun: - $ref: "#/components/examples/CloudRouterResponseExampleDryRun" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: invalidPackage: - $ref: "#/components/examples/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 invalidName: - $ref: "#/components/examples/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 invalidAccount: - $ref: "#/components/examples/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 maxLabFcrReached: - $ref: "#/components/examples/400_max_lab_fcr_demo" - "401": + value: + - errorCode: EQ-3040060 + errorMessage: Create request rejected + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Only 3 Lab Fabric Cloud Routers allowed per Organization + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3040047 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3040030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/routers/{routerId}: get: tags: @@ -10082,55 +31778,141 @@ paths: description: Cloud Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Fabric Cloud Router object content: application/json: schema: - $ref: "#/components/schemas/CloudRouterReadResponse" + $ref: '#/components/schemas/CloudRouterReadResponse' examples: cloudRouterResponse: - $ref: "#/components/examples/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' cloudRouterResponseMarketplace: - $ref: "#/components/examples/CloudRouterResponseExampleMarketplace" - "401": + 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' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3040047 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3040020 + errorMessage: Fabric Cloud Router not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric Cloud Router not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3040030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error delete: tags: - Cloud Routers @@ -10143,57 +31925,83 @@ paths: description: Cloud Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "204": + '204': description: Deleted Cloud Router Successfully - "400": + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: invalidState: - $ref: "#/components/examples/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. GatewayAttached: - $ref: "#/components/examples/400_attached_to_gateway" - "401": + value: + - errorCode: EQ-3000039 + errorMessage: Gateway must be detached before deleting Fabric Cloud Router. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01586 + details: User must detach Gateway before deleting a Fabric Cloud Router. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3040047 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3040020 + errorMessage: Fabric Cloud Router not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric Cloud Router not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3040030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error patch: tags: - Cloud Routers @@ -10206,171 +32014,186 @@ paths: description: Cloud Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/CloudRouterUpdateRequest" + $ref: '#/components/schemas/CloudRouterUpdateRequest' examples: UpdatePackage: - $ref: "#/components/examples/UpdatePackage" + value: + - op: replace + path: /package/code + value: PREMIUM UpdateName: - $ref: "#/components/examples/UpdateName" + value: + - op: replace + path: /name + value: Router-name-2 UpdateNotificationEmail: - $ref: "#/components/examples/UpdateNotifications" + value: + - op: replace + path: /notifications + value: + - type: ALL + emails: + - testEmail1@equinix.com + - testEmail2@equinix.com UpdateTermLength: - $ref: "#/components/examples/UpdateTermLength" + value: + - op: replace + path: /order/termLength + value: 12 UpdatePackageAndTermLength: - $ref: "#/components/examples/UpdatePackageAndTermLength" + value: + - op: replace + path: /package/code + value: PREMIUM + - op: replace + path: /order/termLength + value: 12 required: true responses: - "200": + '200': description: Fabric Cloud Router object content: application/json: schema: - $ref: "#/components/schemas/CloudRouter" + $ref: '#/components/schemas/CloudRouter' examples: cloudRouterResponse: - $ref: "#/components/examples/CloudRouterPatchResponseExample" - "400": + 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' + data: + - op: replace + path: /package/code + value: PREMIUM + - op: replace + path: /order/termLength + value: 12 + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation" - "401": + value: + - errorCode: EQ-3040054 + errorMessage: Invalid Argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Only replace name, replace package and replace notifications operations are supported. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3040047 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3040020 + errorMessage: Fabric Cloud Router not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric Cloud Router not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3040030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/routers/{routerId}/actions: - get: - tags: - - Cloud Routers - summary: Get Route Table Actions - description: This API provides capability to fetch all actions for a given cloud router - operationId: getCloudRouterActions - parameters: - - name: routerId - in: path - description: Router UUID - required: true - schema: - $ref: "#/components/schemas/RouterId" - - name: state - in: query - description: Action state - schema: - $ref: "#/components/schemas/ActionState" - responses: - "200": - description: Successful operation - content: - application/json: - schema: - $ref: "#/components/schemas/CloudRouterActionsSearchResponse" - examples: - routerActionExample: - $ref: "#/components/examples/CloudRouterActionSearchResponse" - "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 @@ -10383,175 +32206,452 @@ paths: description: Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/CloudRouterActionRequest" + $ref: '#/components/schemas/CloudRouterActionRequest' examples: RouteEntriesStatusUpdate: - $ref: "#/components/examples/RouteEntriesStatusUpdate" + value: + type: ROUTE_TABLE_ENTRY_UPDATE ReceivedRouteEntriesStatusUpdate: - $ref: "#/components/examples/ReceivedRouteEntriesStatusUpdate" + value: + type: RECEIVED_ROUTE_ENTRY_UPDATE + connection: + uuid: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 AdvertisedRouteEntriesStatusUpdate: - $ref: "#/components/examples/AdvertisedRouteEntriesStatusUpdate" + value: + type: ADVERTISED_ROUTE_ENTRY_UPDATE + connection: + uuid: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 required: true responses: - "202": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterActionResponse" + $ref: '#/components/schemas/CloudRouterActionResponse' examples: cloudRouterActionExample: - $ref: "#/components/examples/CloudRouterActionResponse" + value: + type: ROUTE_TABLE_ENTRY_UPDATE + uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 + state: PENDING + changeLog: + createdDateTime: '2020-05-21T10:30:00Z' receivedRouteEntriesExample: - $ref: "#/components/examples/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' advertisedRouteEntriesExample: - $ref: "#/components/examples/CloudRouterAdvertisedRoutesActionResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation" - "401": + value: + - errorCode: EQ-3043002 + errorMessage: Invalid argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid argument passed + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router action not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router action not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - /fabric/v4/routers/{routerId}/actions/search: - post: + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error + get: tags: - Cloud Routers - summary: Search Route Table Actions - description: This API provides capability to search route table actions for a given cloud router - operationId: searchRouterActions + summary: Get Route Table Actions + description: This API provides capability to fetch all actions for a given cloud router + operationId: getCloudRouterActions parameters: - name: routerId in: path description: Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CloudRouterActionsSearchRequest" - examples: - CloudRouterActionsSearchByType: - $ref: "#/components/examples/CloudRouterActionsSearchByType" - required: true + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + - name: state + in: query + description: Action state + schema: + $ref: '#/components/schemas/CloudRouterActionState' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterActionsSearchResponse" + $ref: '#/components/schemas/CloudRouterActionsSearchResponse' examples: routerActionExample: - $ref: "#/components/examples/CloudRouterActionSearchResponse" - "400": + value: + pagination: + offset: 0 + limit: 1 + total: 2 + prev: null + next: null + data: + - href: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9 + uuid: 1e9414f1-763e-4c0a-86c6-0bc8336048d9 + type: RECEIVED_ROUTE_ENTRY_UPDATE + state: SUCCEEDED + connection: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 3066ab1d-af87-49d7-8a14-c9bdb57ac809 + type: IP_VC + operation: + bgpIpv4RoutesCount: 6 + bgpIpv6RoutesCount: 6 + distinctIpv4PrefixesCount: 4 + distinctIpv6PrefixesCount: 4 + changeLog: + createdDateTime: '2024-01-01T01:00:00Z' + updatedDateTime: '2024-01-01T01:01:00Z' + - href: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9 + uuid: 1e9414f1-763e-4c0a-86c6-0bc8336048d9 + type: ROUTE_TABLE_ENTRY_UPDATE + state: SUCCEEDED + router: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 3066ab1d-af87-49d7-8a14-c9bdb57ac809 + type: XF_ROUTER + operation: + bgpIpv4RoutesCount: 6 + bgpIpv6RoutesCount: 6 + distinctIpv4PrefixesCount: 4 + distinctIpv6PrefixesCount: 4 + changeLog: + createdDateTime: '2024-01-01T01:00:00Z' + updatedDateTime: '2024-01-01T01:01:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_sorting" - "401": + value: + - errorCode: EQ-3043002 + errorMessage: Invalid argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid argument passed + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router action not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router action not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error + /fabric/v4/routers/{routerId}/actions/search: + post: + tags: + - Cloud Routers + summary: Search Route Table Actions + description: This API provides capability to search route table actions for a given cloud router + operationId: searchRouterActions + parameters: + - name: routerId + in: path + description: Router UUID + required: true + schema: + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CloudRouterActionsSearchRequest' + examples: + CloudRouterActionsSearchByType: + value: + filter: + and: + - property: /type + operator: '=' + values: + - ROUTE_TABLE_ENTRY_UPDATE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime + required: true + responses: + '200': + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/CloudRouterActionsSearchResponse' + examples: + routerActionExample: + value: + pagination: + offset: 0 + limit: 1 + total: 2 + prev: null + next: null + data: + - href: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9 + uuid: 1e9414f1-763e-4c0a-86c6-0bc8336048d9 + type: RECEIVED_ROUTE_ENTRY_UPDATE + state: SUCCEEDED + connection: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 3066ab1d-af87-49d7-8a14-c9bdb57ac809 + type: IP_VC + operation: + bgpIpv4RoutesCount: 6 + bgpIpv6RoutesCount: 6 + distinctIpv4PrefixesCount: 4 + distinctIpv6PrefixesCount: 4 + changeLog: + createdDateTime: '2024-01-01T01:00:00Z' + updatedDateTime: '2024-01-01T01:01:00Z' + - href: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9 + uuid: 1e9414f1-763e-4c0a-86c6-0bc8336048d9 + type: ROUTE_TABLE_ENTRY_UPDATE + state: SUCCEEDED + router: + href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + uuid: 3066ab1d-af87-49d7-8a14-c9bdb57ac809 + type: XF_ROUTER + operation: + bgpIpv4RoutesCount: 6 + bgpIpv6RoutesCount: 6 + distinctIpv4PrefixesCount: 4 + distinctIpv6PrefixesCount: 4 + changeLog: + createdDateTime: '2024-01-01T01:00:00Z' + updatedDateTime: '2024-01-01T01:01:00Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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. + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + 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': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router action not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router action not found + '415': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error /fabric/v4/routers/{routerId}/actions/{actionId}: get: tags: @@ -10565,250 +32665,464 @@ paths: description: Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: actionId in: path description: Action UUID required: true schema: - $ref: "#/components/schemas/ActionId_1" + description: Action UUID + type: string + format: uuid + example: 457400f8-d360-11e9-bb65-2a2ae2dbcced - name: state in: query description: Action state schema: - $ref: "#/components/schemas/ActionState" + $ref: '#/components/schemas/CloudRouterActionState' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterActionResponse" + $ref: '#/components/schemas/CloudRouterActionResponse' examples: searchResponseExample: - $ref: "#/components/examples/CloudRouterActionResponse" - "400": + value: + type: ROUTE_TABLE_ENTRY_UPDATE + uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 + state: PENDING + changeLog: + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation" - "401": + value: + - errorCode: EQ-3043002 + errorMessage: Invalid argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid argument passed + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router action not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router action not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error /fabric/v4/routers/{routerId}/commands: - get: + post: tags: - Cloud Routers - summary: Get Commands - description: This API provides capability to fetch all commands - operationId: getAllCloudRouterCommands + summary: Create 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" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CloudRouterCommandPostRequest' + examples: + InitiatePingCommand: + 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 + InitiateTracerouteCommand: + value: + type: TRACEROUTE_COMMAND + name: traceroute-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 + probes: 3 + hopsMax: 20 + required: true responses: - "200": + '202': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetAllCloudRouterCommands" + $ref: '#/components/schemas/CloudRouterCommand' examples: - getAllCommandsExample: - $ref: "#/components/examples/GetAllPingCommandResponse" - "400": + initiatePingCommandsExample: + 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' + initiateTracerouteCommandsExample: + value: + href: https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00 + type: TRACEROUTE_COMMAND + uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 + name: traceroute-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 + probes: 3 + hopsMax: 20 + changeLog: + createdBy: testuser + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation_commands" - "401": + value: + - errorCode: EQ-3043002 + errorMessage: Invalid argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid argument passed + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403_commands" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_commands" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router command not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router command not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415_commands" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_commands" - post: + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error + get: tags: - Cloud Routers - summary: Create Command - description: This API provides capability to initiate Command - operationId: createCloudRouterCommand + 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" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CloudRouterCommandPostRequest" - examples: - InitiatePingCommand: - $ref: "#/components/examples/PostRequestPingCommand" - InitiateTracerouteCommand: - $ref: "#/components/examples/PostRequestTracerouteCommand" - required: true + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterCommand" + $ref: '#/components/schemas/GetAllCloudRouterCommands' examples: - initiatePingCommandsExample: - $ref: "#/components/examples/PostResponsePingCommand" - initiateTracerouteCommandsExample: - $ref: "#/components/examples/PostResponseTracerouteCommand" - "400": + getAllCommandsExample: + 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 + 108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms + 108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms + 108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms + 108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms + --- 8.8.8.8 ping statistics --- + 4 packets transmitted, 4 packets received, 0.0% packet loss + round-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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation_commands" - "401": + value: + - errorCode: EQ-3043002 + errorMessage: Invalid argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid argument passed + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403_commands" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_commands" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router command not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router command not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415_commands" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_commands" + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error /fabric/v4/routers/{routerId}/commands/search: post: tags: @@ -10822,80 +33136,187 @@ paths: description: Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/CloudRouterCommandSearchRequest" + $ref: '#/components/schemas/CloudRouterCommandSearchRequest' examples: SearchByState: - $ref: "#/components/examples/SearchByStateRequest" + value: + filter: + and: + - property: /state + operator: '=' + values: + - SUCCEEDED + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterCommandSearchResponse" + $ref: '#/components/schemas/CloudRouterCommandSearchResponse' examples: searchCommandsExample: - $ref: "#/components/examples/SearchResponse" - "400": + 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 + 108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms + 108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms + 108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms + 108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms + --- 8.8.8.8 ping statistics --- + 4 packets transmitted, 4 packets received, 0.0% packet loss + round-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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_sorting_commands" - "401": + 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. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403_commands" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_commands" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router command not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router command not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415_commands" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_commands" + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error /fabric/v4/routers/{routerId}/commands/{commandId}: get: tags: @@ -10909,79 +33330,195 @@ paths: description: Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: commandId in: path description: Command UUID required: true schema: - $ref: "#/components/schemas/CommandId" + description: Command UUID + type: string + format: uuid + example: 37c10edc-ba2e-4240-a850-8a48f9c47d00 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterCommand" + $ref: '#/components/schemas/CloudRouterCommand' examples: getCommandExample: - $ref: "#/components/examples/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 + 108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms + 108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms + 108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms + 108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms + --- 8.8.8.8 ping statistics --- + 4 packets transmitted, 4 packets received, 0.0% packet loss + round-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' getTracerouteCommandWithErrorExample: - $ref: "#/components/examples/GetResponseTracerouteCommandWithError" - "400": + value: + href: https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00 + type: TRACEROUTE_COMMAND + uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 + name: traceroute-test-1 + description: Testing FCR-SV-1 + state: FAILED + project: + projectId: b11d4cb5-978a-418a-8b13-bf19abb97938 + request: + destination: 8.8.8.8 + sourceConnection: + uuid: 1da3778c-6aa3-4e47-b2fe-83a0773dde18 + timeout: 2 + probes: 3 + hopsMax: 20 + response: + errors: + - errorCode: EQ-3041105 + errorMessage: Request timeout. + correlationId: 86c57a79-06fb-4ba3-b496-5387f3b45380 + details: Request timeout after 480 seconds. + additionalInfo: + - reason: Request timeout after 480 seconds. + changeLog: + createdBy: testuser + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_operation_commands" - "401": + value: + - errorCode: EQ-3043002 + errorMessage: Invalid argument passed + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Invalid argument passed + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403_commands" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_commands" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router command not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router command not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415_commands" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_commands" + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error delete: tags: - Cloud Routers @@ -10994,61 +33531,86 @@ paths: description: Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: commandId in: path description: Command UUID required: true schema: - $ref: "#/components/schemas/CommandId" + description: Command UUID + type: string + format: uuid + example: 37c10edc-ba2e-4240-a850-8a48f9c47d00 responses: - "204": + '204': description: Deleted command successfully - "400": + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_state_commands" - "401": + 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. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403_commands" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_commands" - "500": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router command not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router command not found + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_commands" + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error /fabric/v4/routers/{routerId}/routes/search: post: tags: @@ -11062,88 +33624,199 @@ paths: description: Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/RouteTableEntrySearchRequest" + $ref: '#/components/schemas/RouteTableEntrySearchRequest' examples: SearchFilterByNextHop: - $ref: "#/components/examples/SearchFilterByNextHop" + value: + filter: + and: + - property: /nextHop + operator: '=' + values: + - 10.10.10.5 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterByPrefix: - $ref: "#/components/examples/SearchFilterByPrefix" + value: + filter: + and: + - property: /prefix + operator: '=' + values: + - 192.168.10.0/24 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterByType: - $ref: "#/components/examples/SearchFilterByType" + value: + filter: + and: + - property: /type + operator: '=' + values: + - IPv4_BGP_ROUTE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterByStatus: - $ref: "#/components/examples/SearchFilterByStatus" + value: + filter: + and: + - property: /state + operator: '=' + values: + - ACTIVE + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterOrAnd: - $ref: "#/components/examples/SearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /type + operator: LIKE + values: + - IPv4_BGP_ROUTE + - property: /type + operator: LIKE + values: + - abc required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/RouteTableEntrySearchResponse" + $ref: '#/components/schemas/RouteTableEntrySearchResponse' examples: activeRoutesResponse: - $ref: "#/components/examples/CloudRouterActiveRoutesSearchResponse" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + data: + - type: IPv4_BGP_ROUTE + protocolType: BGP + state: ACTIVE + prefix: 192.168.10.0/24 + nextHop: 10.10.10.5 + asPath: + - '20001' + changeLog: + createdBy: johnsmith + createdByFullName: John Smith + createdByEmail: john.smith@example.com + createdDateTime: '2020-11-06T07:00:00Z' + updatedBy: johnsmith + updatedByFullName: John Smith + updatedByEmail: john.smith@example.com + updatedDateTime: '2020-11-06T07:00:00Z' + deletedBy: johnsmith + deletedByFullName: John Smith + deletedByEmail: john.smith@example.com + deletedDateTime: '2020-11-06T07:00:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_sorting" - "401": + 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. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + 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': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3043022 + errorMessage: Cloud router action not found + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Cloud router action not found + '415': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3043029 + errorMessage: Unsupported media type + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3043005 + errorMessage: Internal server error + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: Internal server error /fabric/v4/routers/{routerId}/validate: post: tags: @@ -11157,39 +33830,72 @@ paths: description: Cloud Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ValidateRequest" + $ref: '#/components/schemas/ValidateRequest' examples: ValidateDirectIpv4: - $ref: "#/components/examples/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 ValidateDirectIpv6: - $ref: "#/components/examples/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 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ValidateSubnetResponse" + $ref: '#/components/schemas/ValidateSubnetResponse' examples: ValidateSubnet: - $ref: "#/components/examples/Response-200" - "400": + value: + additionalInfo: + - key: message + value: The provided subnet is valid. + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: Bad Request: - $ref: "#/components/examples/error-400" + value: + - errorCode: EQ-2041022 + errorMessage: Invalid argument value passed. + correlationId: 5f9f9ab9-a6cb-4e8a-aa34-105cd4cb6cc8 Subnet Overlapping: - $ref: "#/components/examples/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 /fabric/v4/routers/{routerId}/routeFilters/search: post: tags: @@ -11203,82 +33909,157 @@ paths: description: Cloud Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/CloudRouterRouteFiltersSearchBase" + $ref: '#/components/schemas/CloudRouterRouteFiltersSearchBase' examples: searchRouteFiltersRequest: - $ref: "#/components/examples/CloudRouterSearchRouteFiltersRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_FILTER + - property: /direction + operator: '=' + values: + - INBOUND + - property: /attachmentStatus + operator: '=' + values: + - ATTACHED + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterRouteFiltersSearchResponse" + $ref: '#/components/schemas/CloudRouterRouteFiltersSearchResponse' examples: SearchRouteFiltersResponse: - $ref: "#/components/examples/CloudRouterSearchRouteFiltersResponse" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 2 + next: /search?offset=3&limit=2 + previous: /search?offset=0&limit=2 + data: + - href: https://api.equinix.com/fabric/v4/connections/57f82f8c-d899-4a21-93ae-5cfe33c50556/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d + type: BGP_IPv4_PREFIX_FILTER + uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d + direction: INBOUND + attachmentStatus: ATTACHED + changeLog: + createdBy: testuser + createdDateTime: '2020-05-21T10:30:00Z' + - href: https://api.equinix.com/fabric/v4/connections/500589e0-4196-4839-8d43-a0c073b4d747/routeFilters/4ed45b37-2b26-49de-ab35-4ad039586c7a + type: BGP_IPv4_PREFIX_FILTER + uuid: 4ed45b37-2b26-49de-ab35-4ad039586c7a + direction: INBOUND + attachmentStatus: ATTACHED + changeLog: + createdBy: testuser + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044101 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044004 + errorMessage: Route filter does not exist or do not belong to user, Please check route filter Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Filter ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044006 + errorMessage: The route filter Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044011 + 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 /fabric/v4/routers/{routerId}/routeAggregations/search: post: tags: @@ -11292,82 +34073,151 @@ paths: description: Cloud Router UUID required: true schema: - $ref: "#/components/schemas/RouterId" + description: Cloud Router UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/CloudRouterRouteAggregationsSearchBase" + $ref: '#/components/schemas/CloudRouterRouteAggregationsSearchBase' examples: searchRouteAggregationsRequest: - $ref: "#/components/examples/CloudRouterSearchRouteAggregationsRequest" + value: + filter: + and: + - property: /type + operator: '=' + values: + - BGP_IPv4_PREFIX_AGGREGATION + - property: /attachmentStatus + operator: '=' + values: + - ATTACHED + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CloudRouterRouteAggregationsSearchResponse" + $ref: '#/components/schemas/CloudRouterRouteAggregationsSearchResponse' examples: SearchRouteAggregationsResponse: - $ref: "#/components/examples/CloudRouterSearchRouteAggregationsResponse" - "400": + value: + pagination: + offset: 1 + limit: 2 + total: 10 + next: /search?offset=3&limit=2 + previous: /search?offset=0&limit=2 + data: + - href: https://api.equinix.com/fabric/v4/connections/57f82f8c-d899-4a21-93ae-5cfe33c50556/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d + type: BGP_IPv4_PREFIX_AGGREGATION + uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d + attachmentStatus: ATTACHED + changeLog: + createdBy: testuser + createdDateTime: '2020-05-21T10:30:00Z' + - href: https://api.equinix.com/fabric/v4/connections/500589e0-4196-4839-8d43-a0c073b4d747/routeAggregations/4ed45b37-2b26-49de-ab35-4ad039586c7a + type: BGP_IPv4_PREFIX_AGGREGATION + uuid: 4ed45b37-2b26-49de-ab35-4ad039586c7a + attachmentStatus: ATTACHED + changeLog: + createdBy: testuser + createdDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidInput: - $ref: "#/components/examples/400_invalid_input" + value: + - errorCode: EQ-3044305 + errorMessage: Invalid input + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: type InvalidId: - $ref: "#/components/examples/400_Invalid_id" - "401": + value: + - errorCode: EQ-3044304 + errorMessage: Route aggregation does not exist or do not belong to user. Please check route aggregation Id + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Route Aggregation ID Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404_invalid_id" - "415": + value: + - errorCode: EQ-3044307 + errorMessage: The route aggregation Id was not found or was already deleted. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + 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': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500_internal_error" + value: + - errorCode: EQ-3044308 + 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 /fabric/v4/routers/search: post: tags: @@ -11375,75 +34225,188 @@ paths: 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" + $ref: '#/components/schemas/CloudRouterSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/SearchFilterByStatus" + 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 SearchFilterByNameAndMetroName: - $ref: "#/components/examples/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 SearchFilterOrAnd: - $ref: "#/components/examples/SearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /uuid + operator: LIKE + values: + - 676a0c3f-a785-4294-87bc-25fe9318a620% + - property: /name + operator: LIKE + values: + - abc + - property: /project/projectId + operator: '=' + values: + - '995072000433550' required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/SearchResponse" + $ref: '#/components/schemas/SearchResponse' examples: Example: - $ref: "#/components/examples/search-example" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_sorting" - "401": + 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. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3040047 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3040030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/routerPackages: get: tags: @@ -11467,51 +34430,123 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Fabric Cloud Router Packages content: application/json: schema: - $ref: "#/components/schemas/PackageResponse" + $ref: '#/components/schemas/PackageResponse' examples: Example: - $ref: "#/components/examples/ListFCRPackagesResponse" - "401": + 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' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3040047 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3040030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/routerPackages/{routerPackageCode}: get: tags: @@ -11525,65 +34560,102 @@ paths: description: Equinix-assigned Cloud Router package identifier required: true schema: - $ref: "#/components/schemas/RouterPackageCode" + $ref: '#/components/schemas/RouterPackageCode' responses: - "200": + '200': description: Fabric Cloud Router Package details content: application/json: schema: - $ref: "#/components/schemas/CloudRouterPackage" - "400": + $ref: '#/components/schemas/CloudRouterPackage' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: invalidPackage: - $ref: "#/components/examples/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 invalidName: - $ref: "#/components/examples/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 invalidAccount: - $ref: "#/components/examples/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 maxLabFcrReached: - $ref: "#/components/examples/400_max_lab_fcr_demo" - "401": + value: + - errorCode: EQ-3040060 + errorMessage: Create request rejected + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Only 3 Lab Fabric Cloud Routers allowed per Organization + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3040047 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3040030 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/health: get: tags: @@ -11591,17 +34663,42 @@ paths: summary: Get Service Status description: Retrieves the operational health status of all Equinix Fabric services, enabling customers to monitor service availability and detect potential disruptions across regions where they have a presence. Supports an optional query parameter to filter results by customer operationId: getStatus - parameters: [] responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/HealthResponse" + $ref: '#/components/schemas/HealthResponse' examples: metroExample: - $ref: "#/components/examples/healthResponse" + value: + href: https://api.equinix.com/fabric/v4/health + version: '4.4' + release: 2022.4.0 + 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' /fabric/v4/connections/validate: post: tags: @@ -11609,73 +34706,411 @@ paths: 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" + $ref: '#/components/schemas/ValidateRequest' examples: Alibaba-ValidateAuthKey: - $ref: "#/components/examples/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 Aws-ValidateAuthKey: - $ref: "#/components/examples/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 Azure-ValidateAuthKey: - $ref: "#/components/examples/Request_Azure" + value: + filter: + and: + - property: /zSide/accessPoint/authenticationKey + operator: '=' + values: + - xxx-xxx-xxx + - property: /zSide/accessPoint/profile/uuid + operator: '=' + values: + - xxx-xxx-xxx Google-ValidateAuthKey: - $ref: "#/components/examples/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 IBM-1.0-ValidateAuthKey: - $ref: "#/components/examples/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 IBM-2.0-ValidateAuthKey: - $ref: "#/components/examples/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 Oracle-ValidateAuthKey: - $ref: "#/components/examples/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-ValidateVlanAvailability: - $ref: "#/components/examples/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-ValidateVlanAvailability: - $ref: "#/components/examples/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' required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ConnectionResponse" + $ref: '#/components/schemas/ConnectionResponse' examples: Alibaba-ValidateAuthKey: - $ref: "#/components/examples/Response-Alibaba" + value: + additionalInfo: + - key: message + value: Authorization key provided is valid Aws-ValidateAuthKey: - $ref: "#/components/examples/Response-Aws" + value: + additionalInfo: + - key: message + value: Authorization key provided is valid Azure-ValidateAuthKey-no-existing-connections: - $ref: "#/components/examples/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 Azure-ValidateAuthKey-1-existing-Dot1q-connection: - $ref: "#/components/examples/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 Azure-ValidateAuthKey-1-existing-Qinq-connection: - $ref: "#/components/examples/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 Azure-ValidateAuthKey-2-existing-Dot1q-connection: - $ref: "#/components/examples/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 Google-ValidateAuthKey: - $ref: "#/components/examples/Response-Google" + value: + additionalInfo: + - key: message + value: Authorization key provided is valid IBM-1.0-ValidateAuthKey: - $ref: "#/components/examples/Response-IBM-1" + value: + additionalInfo: + - key: message + value: Authorization key provided is valid IBM-2.0-ValidateAuthKey: - $ref: "#/components/examples/Response-IBM-2" + value: + additionalInfo: + - key: message + value: Authorization key provided is valid Oracle-ValidateAuthKey: - $ref: "#/components/examples/Response-Oracle" + value: + additionalInfo: + - key: message + value: Authorization key provided is valid + data: + - bandwidth: 1000 Dot1q-ValidateAuthKey: - $ref: "#/components/examples/Response-Dot1q-Vlan" + value: + additionalInfo: + - key: message + value: vlanTag(s) provided is available Qinq-ValidateAuthKey: - $ref: "#/components/examples/Response-Qinq-Vlan" - "400": + value: + additionalInfo: + - key: message + value: vlanTag(s) provided is available + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: Bad Request: - $ref: "#/components/examples/error-400" + value: + - errorCode: EQ-3142308 + errorMessage: Authentication key is required + additionalInfo: + - property: /zSide/accessPoint/authenticationKey /fabric/v4/networks: post: tags: @@ -11695,123 +35130,696 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/NetworkPostRequest" + $ref: '#/components/schemas/NetworkPostRequest' examples: Create-Global-EVPLAN-Network: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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 NetworkDryRunCreate: - $ref: "#/components/examples/CreateNetworkDryRunResponse" + value: + type: EVPLAN + name: My-EVPLAN-1 + scope: GLOBAL + project: + projectId: z1a596ed-s24a-097c-12a8-44e00000ee11 + notifications: + - type: ALL + emails: + - test@equinix.com required: true responses: - "201": + '201': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/Network" + $ref: '#/components/schemas/Network' examples: EVPLAN-Global-Network: - $ref: "#/components/examples/Create-Global-EVPLAN-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-03T19:37:29.326Z' + links: + - href: http://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 EVPLAN-Regional-Network: - $ref: "#/components/examples/Create-Regional-EVPLAN-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-03T19:21:43.145Z' + links: + - href: http://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 EVPLAN-Local-Network: - $ref: "#/components/examples/Create-Local-EVPLAN-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-03T19:43:20.145Z' + links: + - href: http://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 EPLAN-Global-Network: - $ref: "#/components/examples/Create-Global-EPLAN-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-03T20:52:23.469Z' + links: + - href: http://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 EPLAN-Regional-Network: - $ref: "#/components/examples/Create-Regional-EPLAN-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-03T19:21:43.145Z' + links: + - href: http://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 EPLAN-Local-Network: - $ref: "#/components/examples/Create-Local-EPLAN-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-03T20:55:57.858Z' + links: + - href: http://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 EVPTREE-Global-Network: - $ref: "#/components/examples/Create-Global-EVPTREE-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-05T21:17:46.656Z' + links: + - href: http://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 EVPTREE-Regional-Network: - $ref: "#/components/examples/Create-Regional-EVPTREE-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-05T20:57:07.206Z' + links: + - href: http://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 EVPTREE-Local-Network: - $ref: "#/components/examples/Create-Local-EVPTREE-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-05T21:22:30.984Z' + links: + - href: http://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 EPTREE-Global-Network: - $ref: "#/components/examples/Create-Global-EPTREE-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-05T21:37:08.370Z' + links: + - href: http://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 EPTREE-Regional-Network: - $ref: "#/components/examples/Create-Regional-EPTREE-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-06T00:23:29.030Z' + links: + - href: http://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 EPTREE-Local-Network: - $ref: "#/components/examples/Create-Local-EPTREE-Network-Response" + value: + href: http://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: http://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 + createdDateTime: '2025-03-06T00:30:42.972Z' + links: + - href: http://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 networkDryRun: - $ref: "#/components/examples/CreateNetworkDryRunResponse" - "202": + value: + type: EVPLAN + name: My-EVPLAN-1 + scope: GLOBAL + project: + projectId: z1a596ed-s24a-097c-12a8-44e00000ee11 + notifications: + - type: ALL + emails: + - test@equinix.com + '202': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/Network" + $ref: '#/components/schemas/Network' examples: networkResponse: - $ref: "#/components/examples/NetworkPostResponseExample" - "400": + 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' + updatedBy: testuser + updatedDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400" - "401": + value: + - errorCode: EQ-3152001 + errorMessage: Invalid input + details: Max 24 characters are allowed for Network Name + correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 + additionalInfo: + - property: /name + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3152006 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/networks/{networkId}: get: tags: @@ -11825,44 +35833,85 @@ paths: description: Network UUID required: true schema: - $ref: "#/components/schemas/NetworkId" + description: Network UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/Network" + $ref: '#/components/schemas/Network' examples: networkResponse: - $ref: "#/components/examples/NetworkGetResponseExample" - "401": + 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' + updatedBy: testuser + updatedDateTime: '2020-05-21T10:30:00Z' + links: + - href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/connections + rel: getConnectionsByNetworkUuid + method: GET + contentType: application/json + authenticate: true + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3152005 + errorMessage: Fabric Network not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric network not found or already deleted delete: tags: - Networks @@ -11875,53 +35924,97 @@ paths: description: Network UUID required: true schema: - $ref: "#/components/schemas/NetworkId" + description: Network UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '202': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/Network" + $ref: '#/components/schemas/Network' examples: networkResponse: - $ref: "#/components/examples/NetworkDeleteResponseExample" - "400": + 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' + updatedBy: testuser1 + updatedDateTime: '2020-05-21T10:30:00Z' + deletedBy: testuser1 + deletedDateTime: '2020-05-21T10:30:00Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_state" - "401": + value: + - errorCode: EQ-3152003 + errorMessage: Cannot perform action. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Given Fabric Network in transient state + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3152005 + errorMessage: Fabric Network not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric network not found or already deleted patch: tags: - Networks @@ -11934,73 +36027,136 @@ paths: description: Network UUID required: true schema: - $ref: "#/components/schemas/NetworkId" + description: Network UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/NetworkUpdateRequest" + $ref: '#/components/schemas/NetworkUpdateRequest' examples: UpdateName: - $ref: "#/components/examples/UpdateNetworkName" + value: + - op: replace + path: /name + value: NewName UpdateNotificationEmail: - $ref: "#/components/examples/UpdateNetworkNotifications" + value: + - op: replace + path: /notifications + value: + - type: ALL + emails: + - test1@test.com + - test2@test.com required: true responses: - "200": + '200': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/Network" + $ref: '#/components/schemas/Network' examples: networkResponse: - $ref: "#/components/examples/NetworkPatchResponseExample" - "400": + 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' + updatedBy: testuser + updatedDateTime: '2020-05-21T10:30:00Z' + links: + - href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/connections + rel: getConnectionsByNetworkUuid + method: GET + contentType: application/json + authenticate: true + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_state" - "401": + value: + - errorCode: EQ-3152003 + errorMessage: Cannot perform action. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Given Fabric Network in transient state + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3152005 + errorMessage: Fabric Network not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric network not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" + value: + - errorCode: EQ-3152006 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. /fabric/v4/networks/search: post: tags: @@ -12008,64 +36164,146 @@ paths: summary: Search Networks description: The API provides capability to search 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" + $ref: '#/components/schemas/NetworkSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/SearchFilterByStatus" + value: + filter: + and: + - property: /operation/equinixStatus + operator: '=' + values: + - PROVISIONED + - property: /project/projectId + operator: '=' + values: + - '1234567' + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterOrAnd: - $ref: "#/components/examples/SearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /uuid + operator: LIKE + values: + - 92dc376a-a932-43aa-a6a2-c806dedbd784% + - property: /name + operator: LIKE + values: + - abc% + - property: /project/projectId + operator: '=' + values: + - '1234567' required: true responses: - "200": + '200': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/NetworkSearchResponse" + $ref: '#/components/schemas/NetworkSearchResponse' examples: networkResponse: - $ref: "#/components/examples/NetworkSearchResponseExample" - "400": + 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' + updatedBy: testuser1 + updatedDateTime: '2020-05-21T10:30:00Z' + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_sorting" - "401": + value: + - errorCode: EQ-3152002 + errorMessage: Invalid value for sorting direction. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" + value: + - errorCode: EQ-3152006 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. /fabric/v4/networks/{networkId}/connections: get: tags: @@ -12079,53 +36317,81 @@ paths: description: Network UUID required: true schema: - $ref: "#/components/schemas/NetworkId" + description: Network UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/NetworkConnections" + $ref: '#/components/schemas/NetworkConnections' examples: networkResponse: - $ref: "#/components/examples/GetNetworkConnectionExample" - "400": + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_uuid" - "401": + value: + - errorCode: EQ-3152004 + errorMessage: Invalid inlput + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Network does not exists with gievn uuid + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" + value: + - errorCode: EQ-3152006 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. /fabric/v4/networks/{networkId}/changes: get: tags: @@ -12139,53 +36405,87 @@ paths: description: Network UUID required: true schema: - $ref: "#/components/schemas/NetworkId" + description: Network UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/NetworkChangeResponse" + $ref: '#/components/schemas/NetworkChangeResponse' examples: networkResponse: - $ref: "#/components/examples/NetworkChangeResponseExample" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_uuid" - "401": + value: + - errorCode: EQ-3152004 + errorMessage: Invalid inlput + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Network does not exists with gievn uuid + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" + value: + - errorCode: EQ-3152006 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. /fabric/v4/networks/{networkId}/changes/{changeId}: get: tags: @@ -12199,59 +36499,85 @@ paths: description: Network UUID required: true schema: - $ref: "#/components/schemas/NetworkId" + description: Network UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: changeId in: path description: Network Change UUID required: true schema: - $ref: "#/components/schemas/ChangeId_5" + description: Network Change UUID + type: string + format: uuid + example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: - "200": + '200': description: Fabric Network Access point object content: application/json: schema: - $ref: "#/components/schemas/NetworkChange" + $ref: '#/components/schemas/NetworkChange' examples: networkResponse: - $ref: "#/components/examples/NetworkGetChangeResponseExample" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/400_invalid_uuid" - "401": + value: + - errorCode: EQ-3152004 + errorMessage: Invalid inlput + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Network does not exists with gievn uuid + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" + value: + - errorCode: EQ-3152005 + errorMessage: Fabric Network not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric network not found or already deleted /fabric/v4/timeServices: post: tags: @@ -12259,264 +36585,606 @@ paths: 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" + $ref: '#/components/schemas/precisionTimeServiceRequest' examples: ntpStandard: - $ref: "#/components/examples/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 ptpStandard: - $ref: "#/components/examples/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 ntpEnterprise: - $ref: "#/components/examples/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 ptpEnterprise: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: PTP + domain: 127 + priority1: 0 + priority2: 1 + logAnnounceInterval: 1 + logSyncInterval: -4 + logDelayReqInterval: -4 + transportMode: UNICAST + grantTime: 300 ptpEnterpriseWithAdvancedConfiguration: - $ref: "#/components/examples/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: PTP + domain: 127 + priority1: 0 + priority2: 1 + logAnnounceInterval: 1 + logSyncInterval: -4 + logDelayReqInterval: -4 + transportMode: UNICAST + grantTime: 300 ntpEnterpriseWithAdvancedConfiguration: - $ref: "#/components/examples/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: YmFzZTY0X3ByaW50YWJsZV9rZXk= + - type: HEX + keyNumber: 65535 + key: YTFhMWExYTFhMWExYTE= required: true responses: - "202": + '202': description: Successful Accepted operation content: application/json: schema: - $ref: "#/components/schemas/precisionTimeServiceResponse" + $ref: '#/components/schemas/precisionTimeServiceResponse' examples: ntpStandard: - $ref: "#/components/examples/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' ntpEnterprise: - $ref: "#/components/examples/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: YmFzZTY0X3ByaW50YWJsZV9rZXk= + - type: HEX + keyNumber: 65535 + key: YTFhMWExYTFhMWExYTE= + account: + accountNumber: 123456 + changeLog: + createdByEmail: abc@xyz.com + createdDateTime: '2024-08-24T06:50:46Z' + updatedByEmail: abc@xyz.com + updatedDateTime: '2024-08-24T06:51:46Z' ptpStandard: - $ref: "#/components/examples/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: PTP + 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' ptpEnterprise: - $ref: "#/components/examples/ptpEnterpriseCreateResponse" - "400": + 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: PTP + 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': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidName: - $ref: "#/components/examples/400-Invalid-Name" + value: + - errorCode: EQ-4800010 + errorMessage: Validation Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: /name + reason: Invalid name provided ValidateName: - $ref: "#/components/examples/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 DuplicateName: - $ref: "#/components/examples/400-Duplicate-Name" + value: + - errorCode: EQ-4800101 + errorMessage: Service name is already in use + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryConnectionUuid: - $ref: "#/components/examples/400-Mandatory-ConnectionUUid" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field ConnectionUUid is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionUuidFormat: - $ref: "#/components/examples/400-Invalid-ConnectionUuid-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid connection uuid format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionStatus: - $ref: "#/components/examples/400-Invalid-Connection-Status" + value: + - errorCode: EQ-4800102 + errorMessage: Connection should be in Pending Approval state + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateConnectionUuid: - $ref: "#/components/examples/400-Validate-ConnectionUuid" + value: + - errorCode: EQ-4800103 + errorMessage: Connection does not belong to this user + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionLocation: - $ref: "#/components/examples/400-Invalid-Connection-Location" + value: + - errorCode: EQ-4800104 + errorMessage: Connection location is not supported by EPT + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackageType: - $ref: "#/components/examples/400-Mandatory-PackageType" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field Package Type is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackageType: - $ref: "#/components/examples/400-Invalid-PackageType" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Package Type - Allowed types are PTP, NTP + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackageType: - $ref: "#/components/examples/400-Invalid-Connection-PackageType" + value: + - errorCode: EQ-4800105 + errorMessage: Connection Package type is different + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackage: - $ref: "#/components/examples/400-Mandatory-Package" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field Package is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackage: - $ref: "#/components/examples/400-Invalid-Package" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Package - Allowed packages are STANDARD, ENTERPRISE + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackage: - $ref: "#/components/examples/400-Invalid-Connection-Package" + value: + - errorCode: EQ-4800106 + errorMessage: Connection Package is different + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPrimaryIP: - $ref: "#/components/examples/400-Mandatory-PrimaryIP" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field PrimaryIP is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPrimaryIPFormat: - $ref: "#/components/examples/400-Invalid-PrimaryIP-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid PrimaryIP format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePrimaryIP: - $ref: "#/components/examples/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 MandatorySecondaryIP: - $ref: "#/components/examples/400-Mandatory-SecondaryIP" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field SecondaryIP is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidSecondaryIPFormat: - $ref: "#/components/examples/400-Invalid-SecondaryIP-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid SecondaryIP format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateSecondaryIP: - $ref: "#/components/examples/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 ValidateSameSubnet: - $ref: "#/components/examples/400-Validate-SameSubnet" + value: + - errorCode: EQ-4800108 + errorMessage: Primary and Secondary IPs should be in the same subnet + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryNetworkMask: - $ref: "#/components/examples/400-Mandatory-NetworkMask" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field NetworkMask is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidNetworkMaskFormat: - $ref: "#/components/examples/400-Invalid-NetworkMask-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid NetworkMask format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateNetworkMask: - $ref: "#/components/examples/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 InvalidDefaultGatewayFormat: - $ref: "#/components/examples/400-Invalid-DefaultGateway-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid DefaultGateway + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateDefaultGateway: - $ref: "#/components/examples/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 InvalidTimeScale: - $ref: "#/components/examples/400-Invalid-TimeScale" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid TimeScale - Allowed values are ARB, PTP + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidDomain: - $ref: "#/components/examples/400-Invalid-Domain" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Domain- Allowed values are from 0 to 127 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority1: - $ref: "#/components/examples/400-Invalid-Priority1" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Priority1 - Allowed values are 0 to 248 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority2: - $ref: "#/components/examples/400-Invalid-Priority2" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Priority2 - Allowed values are 0 to 248 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogAnnounceInterval: - $ref: "#/components/examples/400-Invalid-LogAnnounceInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid LogAnnounceInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogAnnounceIntervalRange: - $ref: "#/components/examples/400-Validate-LogAnnounceInterval-Range" + value: + - errorCode: EQ-4800111 + errorMessage: Invalid LogAnnounceInterval range - Allowed range is -3 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogSyncInterval: - $ref: "#/components/examples/400-Invalid-LogSyncInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid LogSyncInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogSyncIntervalRange: - $ref: "#/components/examples/400-Validate-LogSyncInterval-Range" + value: + - errorCode: EQ-4800112 + errorMessage: Invalid LogSyncInterval range - Allowed range is -5 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogDelayReqInterval: - $ref: "#/components/examples/400-Invalid-LogDelayReqInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid logDelayReqInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogDelayReqIntervalRange: - $ref: "#/components/examples/400-Validate-LogDelayReqInterval-Range" + value: + - errorCode: EQ-4800112 + errorMessage: Invalid logDelayReqInterval range - Allowed range is -5 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidTransportMode: - $ref: "#/components/examples/400-Invalid-TransportMode" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid TransportMode - Allowed values are Multicast, Unicast, Hybrid + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidGrantTime: - $ref: "#/components/examples/400-Invalid-GrantTime" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid GrantTime + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateGrantTimeRange: - $ref: "#/components/examples/400-Validate-GrantTime-Range" + value: + - errorCode: EQ-4800113 + errorMessage: Invalid GrantTime range - Allowed range is 30 to 7200 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidType: - $ref: "#/components/examples/400-Invalid-Type" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Type - Allowed values are ASCII, HEX + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidId: - $ref: "#/components/examples/400-Invalid-Id" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Id - Only Integers are allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPassword: - $ref: "#/components/examples/400-Invalid-Password" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Password + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePassword: - $ref: "#/components/examples/400-Validate-Password" - "401": + value: + - errorCode: EQ-4800114 + errorMessage: Only HEX allowed, chars value length should between 10 - 40 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/timeServices/{serviceId}: - get: - tags: - - Precision Time Services - summary: Get Time 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 Services @@ -12529,238 +37197,942 @@ paths: description: Service UUID required: true schema: - $ref: "#/components/schemas/ServiceId" + description: Precision Time Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/precisionTimeServiceRequest" + $ref: '#/components/schemas/precisionTimeServiceRequest' examples: ntpStandard: - $ref: "#/components/examples/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 ptpStandard: - $ref: "#/components/examples/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 ntpEnterpriseWithAdvanceConfiguration: - $ref: "#/components/examples/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: YmFzZTY0X3ByaW50YWJsZV9rZXk= + - type: HEX + keyNumber: 65535 + key: YTFhMWExYTFhMWExYTE= ptpEnterpriseWithAdvanceConfiguration: - $ref: "#/components/examples/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: PTP + domain: 127 + priority1: 0 + priority2: 1 + logAnnounceInterval: 1 + logSyncInterval: -4 + logDelayReqInterval: -4 + transportMode: UNICAST + grantTime: 300 required: true responses: - "202": + '202': description: Successful Accepted operation content: application/json: schema: - $ref: "#/components/schemas/precisionTimeServiceResponse" + $ref: '#/components/schemas/precisionTimeServiceResponse' examples: ntpStandard: - $ref: "#/components/examples/ntpStandardConfigureResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidName: - $ref: "#/components/examples/400-Invalid-Name" + value: + - errorCode: EQ-4800010 + errorMessage: Validation Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: /name + reason: Invalid name provided ValidateName: - $ref: "#/components/examples/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 DuplicateName: - $ref: "#/components/examples/400-Duplicate-Name" + value: + - errorCode: EQ-4800101 + errorMessage: Service name is already in use + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryConnectionUuid: - $ref: "#/components/examples/400-Mandatory-ConnectionUUid" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field ConnectionUUid is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionUuidFormat: - $ref: "#/components/examples/400-Invalid-ConnectionUuid-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid connection uuid format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionStatus: - $ref: "#/components/examples/400-Invalid-Connection-Status" + value: + - errorCode: EQ-4800102 + errorMessage: Connection should be in Pending Approval state + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateConnectionUuid: - $ref: "#/components/examples/400-Validate-ConnectionUuid" + value: + - errorCode: EQ-4800103 + errorMessage: Connection does not belong to this user + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionLocation: - $ref: "#/components/examples/400-Invalid-Connection-Location" + value: + - errorCode: EQ-4800104 + errorMessage: Connection location is not supported by EPT + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackageType: - $ref: "#/components/examples/400-Mandatory-PackageType" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field Package Type is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackageType: - $ref: "#/components/examples/400-Invalid-PackageType" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Package Type - Allowed types are PTP, NTP + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackageType: - $ref: "#/components/examples/400-Invalid-Connection-PackageType" + value: + - errorCode: EQ-4800105 + errorMessage: Connection Package type is different + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackage: - $ref: "#/components/examples/400-Mandatory-Package" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field Package is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackage: - $ref: "#/components/examples/400-Invalid-Package" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Package - Allowed packages are STANDARD, ENTERPRISE + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackage: - $ref: "#/components/examples/400-Invalid-Connection-Package" + value: + - errorCode: EQ-4800106 + errorMessage: Connection Package is different + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPrimaryIP: - $ref: "#/components/examples/400-Mandatory-PrimaryIP" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field PrimaryIP is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPrimaryIPFormat: - $ref: "#/components/examples/400-Invalid-PrimaryIP-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid PrimaryIP format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePrimaryIP: - $ref: "#/components/examples/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 MandatorySecondaryIP: - $ref: "#/components/examples/400-Mandatory-SecondaryIP" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field SecondaryIP is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidSecondaryIPFormat: - $ref: "#/components/examples/400-Invalid-SecondaryIP-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid SecondaryIP format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateSecondaryIP: - $ref: "#/components/examples/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 ValidateSameSubnet: - $ref: "#/components/examples/400-Validate-SameSubnet" + value: + - errorCode: EQ-4800108 + errorMessage: Primary and Secondary IPs should be in the same subnet + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryNetworkMask: - $ref: "#/components/examples/400-Mandatory-NetworkMask" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field NetworkMask is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidNetworkMaskFormat: - $ref: "#/components/examples/400-Invalid-NetworkMask-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid NetworkMask format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateNetworkMask: - $ref: "#/components/examples/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 InvalidDefaultGatewayFormat: - $ref: "#/components/examples/400-Invalid-DefaultGateway-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid DefaultGateway + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateDefaultGateway: - $ref: "#/components/examples/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 InvalidTimeScale: - $ref: "#/components/examples/400-Invalid-TimeScale" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid TimeScale - Allowed values are ARB, PTP + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidDomain: - $ref: "#/components/examples/400-Invalid-Domain" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Domain- Allowed values are from 0 to 127 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority1: - $ref: "#/components/examples/400-Invalid-Priority1" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Priority1 - Allowed values are 0 to 248 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority2: - $ref: "#/components/examples/400-Invalid-Priority2" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Priority2 - Allowed values are 0 to 248 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogAnnounceInterval: - $ref: "#/components/examples/400-Invalid-LogAnnounceInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid LogAnnounceInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogAnnounceIntervalRange: - $ref: "#/components/examples/400-Validate-LogAnnounceInterval-Range" + value: + - errorCode: EQ-4800111 + errorMessage: Invalid LogAnnounceInterval range - Allowed range is -3 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogSyncInterval: - $ref: "#/components/examples/400-Invalid-LogSyncInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid LogSyncInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogSyncIntervalRange: - $ref: "#/components/examples/400-Validate-LogSyncInterval-Range" + value: + - errorCode: EQ-4800112 + errorMessage: Invalid LogSyncInterval range - Allowed range is -5 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogDelayReqInterval: - $ref: "#/components/examples/400-Invalid-LogDelayReqInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid logDelayReqInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogDelayReqIntervalRange: - $ref: "#/components/examples/400-Validate-LogDelayReqInterval-Range" + value: + - errorCode: EQ-4800112 + errorMessage: Invalid logDelayReqInterval range - Allowed range is -5 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidTransportMode: - $ref: "#/components/examples/400-Invalid-TransportMode" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid TransportMode - Allowed values are Multicast, Unicast, Hybrid + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidGrantTime: - $ref: "#/components/examples/400-Invalid-GrantTime" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid GrantTime + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateGrantTimeRange: - $ref: "#/components/examples/400-Validate-GrantTime-Range" + value: + - errorCode: EQ-4800113 + errorMessage: Invalid GrantTime range - Allowed range is 30 to 7200 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidType: - $ref: "#/components/examples/400-Invalid-Type" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Type - Allowed values are ASCII, HEX + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidId: - $ref: "#/components/examples/400-Invalid-Id" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Id - Only Integers are allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPassword: - $ref: "#/components/examples/400-Invalid-Password" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Password + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePassword: - $ref: "#/components/examples/400-Validate-Password" - "401": + value: + - errorCode: EQ-4800114 + errorMessage: Only HEX allowed, chars value length should between 10 - 40 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3040020 + errorMessage: Fabric Precision Time Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric Precision Time Service not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - delete: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH + get: tags: - Precision Time Services - summary: Delete Time Service by ID - description: The API provides capability to delete Precision Time Service by service id - operationId: deleteTimeServiceById + summary: Get Time 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" + description: Precision Time Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": - description: Successful Delete + '200': + description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/precisionTimeServiceResponse" + $ref: '#/components/schemas/precisionTimeServiceResponse' examples: - ntpStandard: - $ref: "#/components/examples/ntpStandardDeletingResponse" - "401": + ntpStandardOriginPort: + 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 + operation: + operationalStatus: UP + 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' + ntpStandardOriginVirtualDevice: + 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 + operation: + operationalStatus: UP + 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' + ntpStandardOriginCloudRouter: + 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 + operation: + operationalStatus: UP + 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' + ntpEnterpriseOriginPort: + 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 + operation: + operationalStatus: UP + 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' + ntpEnterpriseWithAdvConfigOriginPort: + 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 + operation: + operationalStatus: UP + 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= + - type: HEX + keyNumber: 65535 + key: YTFhMWExYTFhMWExYTE= + 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' + ntpEnterpriseWithAdvConfigOriginVirtualDevice: + 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 + operation: + operationalStatus: UP + 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= + - type: HEX + keyNumber: 65535 + key: YTFhMWExYTFhMWExYTE= + 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' + ntpEnterpriseWithAdvConfigOriginCloudRouter: + 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 + operation: + operationalStatus: UP + 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= + - type: HEX + keyNumber: 65535 + key: YTFhMWExYTFhMWExYTE= + 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' + ptpStandardOriginPort: + 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 + operation: + operationalStatus: UP + 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' + ptpEnterpriseOriginPort: + 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 + operation: + operationalStatus: UP + 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: PTP + 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' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3040020 + errorMessage: Fabric Precision Time Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric Precision Time Service not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH patch: tags: - Precision Time Services @@ -12773,176 +38145,545 @@ paths: description: Service UUID required: true schema: - $ref: "#/components/schemas/ServiceId" + description: Precision Time Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json-patch+json: schema: - maxItems: 1 - minItems: 1 type: array + minItems: 1 + maxItems: 1 items: - $ref: "#/components/schemas/precisionTimeChangeOperation" + $ref: '#/components/schemas/precisionTimeChangeOperation' examples: updateName: - $ref: "#/components/examples/updateName" + value: + - op: replace + path: /name + value: Updated-Service-Name updatePackageCode: - $ref: "#/components/examples/updatePackageCode" + value: + - op: replace + path: /package/code + value: NTP_ENTERPRISE updateNetworkInformation: - $ref: "#/components/examples/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: - $ref: "#/components/examples/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: - $ref: "#/components/examples/updateNtpAdvancedConfiguration" + value: + - op: replace + path: /ntpAdvancedConfiguration + value: + - type: ASCII + keyNumber: 65534 + key: YmFzZTY0X3ByaW50YWJsZV9rZXk= + - type: HEX + keyNumber: 65535 + key: YTFhMWExYTFhMWExYTE= required: true responses: - "202": + '202': description: Successful Accepted operation content: application/json: schema: - $ref: "#/components/schemas/precisionTimeServiceResponse" + $ref: '#/components/schemas/precisionTimeServiceResponse' examples: ntpStandard: - $ref: "#/components/examples/ntpStandardReprovisionResponse" - "400": + 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 + operation: + operationalStatus: UP + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidName: - $ref: "#/components/examples/400-Invalid-Name" + value: + - errorCode: EQ-4800010 + errorMessage: Validation Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: /name + reason: Invalid name provided ValidateName: - $ref: "#/components/examples/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 DuplicateName: - $ref: "#/components/examples/400-Duplicate-Name" + value: + - errorCode: EQ-4800101 + errorMessage: Service name is already in use + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryConnectionUuid: - $ref: "#/components/examples/400-Mandatory-ConnectionUUid" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field ConnectionUUid is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionUuidFormat: - $ref: "#/components/examples/400-Invalid-ConnectionUuid-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid connection uuid format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionStatus: - $ref: "#/components/examples/400-Invalid-Connection-Status" + value: + - errorCode: EQ-4800102 + errorMessage: Connection should be in Pending Approval state + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateConnectionUuid: - $ref: "#/components/examples/400-Validate-ConnectionUuid" + value: + - errorCode: EQ-4800103 + errorMessage: Connection does not belong to this user + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionLocation: - $ref: "#/components/examples/400-Invalid-Connection-Location" + value: + - errorCode: EQ-4800104 + errorMessage: Connection location is not supported by EPT + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackageType: - $ref: "#/components/examples/400-Mandatory-PackageType" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field Package Type is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackageType: - $ref: "#/components/examples/400-Invalid-PackageType" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Package Type - Allowed types are PTP, NTP + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackageType: - $ref: "#/components/examples/400-Invalid-Connection-PackageType" + value: + - errorCode: EQ-4800105 + errorMessage: Connection Package type is different + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackage: - $ref: "#/components/examples/400-Mandatory-Package" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field Package is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackage: - $ref: "#/components/examples/400-Invalid-Package" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Package - Allowed packages are STANDARD, ENTERPRISE + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackage: - $ref: "#/components/examples/400-Invalid-Connection-Package" + value: + - errorCode: EQ-4800106 + errorMessage: Connection Package is different + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPrimaryIP: - $ref: "#/components/examples/400-Mandatory-PrimaryIP" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field PrimaryIP is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPrimaryIPFormat: - $ref: "#/components/examples/400-Invalid-PrimaryIP-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid PrimaryIP format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePrimaryIP: - $ref: "#/components/examples/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 MandatorySecondaryIP: - $ref: "#/components/examples/400-Mandatory-SecondaryIP" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field SecondaryIP is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidSecondaryIPFormat: - $ref: "#/components/examples/400-Invalid-SecondaryIP-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid SecondaryIP format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateSecondaryIP: - $ref: "#/components/examples/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 ValidateSameSubnet: - $ref: "#/components/examples/400-Validate-SameSubnet" + value: + - errorCode: EQ-4800108 + errorMessage: Primary and Secondary IPs should be in the same subnet + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryNetworkMask: - $ref: "#/components/examples/400-Mandatory-NetworkMask" + value: + - errorCode: EQ-4800011 + errorMessage: Mandatory field NetworkMask is missing + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidNetworkMaskFormat: - $ref: "#/components/examples/400-Invalid-NetworkMask-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid NetworkMask format + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateNetworkMask: - $ref: "#/components/examples/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 InvalidDefaultGatewayFormat: - $ref: "#/components/examples/400-Invalid-DefaultGateway-Format" + value: + - errorCode: EQ-4800023 + errorMessage: Invalid DefaultGateway + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateDefaultGateway: - $ref: "#/components/examples/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 InvalidTimeScale: - $ref: "#/components/examples/400-Invalid-TimeScale" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid TimeScale - Allowed values are ARB, PTP + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidDomain: - $ref: "#/components/examples/400-Invalid-Domain" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Domain- Allowed values are from 0 to 127 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority1: - $ref: "#/components/examples/400-Invalid-Priority1" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Priority1 - Allowed values are 0 to 248 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority2: - $ref: "#/components/examples/400-Invalid-Priority2" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Priority2 - Allowed values are 0 to 248 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogAnnounceInterval: - $ref: "#/components/examples/400-Invalid-LogAnnounceInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid LogAnnounceInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogAnnounceIntervalRange: - $ref: "#/components/examples/400-Validate-LogAnnounceInterval-Range" + value: + - errorCode: EQ-4800111 + errorMessage: Invalid LogAnnounceInterval range - Allowed range is -3 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogSyncInterval: - $ref: "#/components/examples/400-Invalid-LogSyncInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid LogSyncInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogSyncIntervalRange: - $ref: "#/components/examples/400-Validate-LogSyncInterval-Range" + value: + - errorCode: EQ-4800112 + errorMessage: Invalid LogSyncInterval range - Allowed range is -5 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogDelayReqInterval: - $ref: "#/components/examples/400-Invalid-LogDelayReqInterval" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid logDelayReqInterval + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogDelayReqIntervalRange: - $ref: "#/components/examples/400-Validate-LogDelayReqInterval-Range" + value: + - errorCode: EQ-4800112 + errorMessage: Invalid logDelayReqInterval range - Allowed range is -5 to 1 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidTransportMode: - $ref: "#/components/examples/400-Invalid-TransportMode" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid TransportMode - Allowed values are Multicast, Unicast, Hybrid + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidGrantTime: - $ref: "#/components/examples/400-Invalid-GrantTime" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid GrantTime + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateGrantTimeRange: - $ref: "#/components/examples/400-Validate-GrantTime-Range" + value: + - errorCode: EQ-4800113 + errorMessage: Invalid GrantTime range - Allowed range is 30 to 7200 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidType: - $ref: "#/components/examples/400-Invalid-Type" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Type - Allowed values are ASCII, HEX + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidId: - $ref: "#/components/examples/400-Invalid-Id" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Id - Only Integers are allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPassword: - $ref: "#/components/examples/400-Invalid-Password" + value: + - errorCode: EQ-4800010 + errorMessage: Invalid Password + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePassword: - $ref: "#/components/examples/400-Validate-Password" - "401": + value: + - errorCode: EQ-4800114 + errorMessage: Only HEX allowed, chars value length should between 10 - 40 + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3040020 + errorMessage: Fabric Precision Time Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric Precision Time Service not found or already deleted + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH + delete: + tags: + - Precision Time Services + summary: Delete Time Service 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: + description: Precision Time Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + responses: + '202': + description: Successful Delete + content: + application/json: + schema: + $ref: '#/components/schemas/precisionTimeServiceResponse' + examples: + ntpStandard: + 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 + operation: + operationalStatus: UP + 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' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3040020 + errorMessage: Fabric Precision Time Service not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Fabric Precision Time Service not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/timeServices/search: post: tags: @@ -12950,75 +38691,191 @@ paths: 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" + $ref: '#/components/schemas/TimeServicesSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/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 SearchFilterByNameAndProtocol: - $ref: "#/components/examples/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 SearchFilterOrAnd: - $ref: "#/components/examples/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' required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceSearchResponse" + $ref: '#/components/schemas/ServiceSearchResponse' examples: Example: - $ref: "#/components/examples/serviceSearchResponse" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/service_400_invalid_sorting" - "401": + 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. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/timeServices/{serviceId}/connections: get: tags: @@ -13032,53 +38889,84 @@ paths: description: Service UUID required: true schema: - $ref: "#/components/schemas/ServiceId" + description: Precision Time Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Return Time Service Connection content: application/json: schema: - $ref: "#/components/schemas/precisionTimeServiceConnectionsResponse" + $ref: '#/components/schemas/precisionTimeServiceConnectionsResponse' examples: example: - $ref: "#/components/examples/serviceConnectionsResponse" - "401": + 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 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/timeServicePackages: get: tags: @@ -13086,35 +38974,106 @@ paths: summary: Get Packages description: The API provides capability to get timing service's packages operationId: getTimeServicesPackages - parameters: [] responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/precisionTimeServicePackagesResponse" - examples: - example: - $ref: "#/components/examples/servicePackagesResponse" - "415": + $ref: '#/components/schemas/precisionTimeServicePackagesResponse' + examples: + example: + 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' + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/timeServicePackages/{packageCode}: get: tags: @@ -13135,33 +39094,58 @@ paths: - PTP_STANDARD - PTP_ENTERPRISE responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/precisionTimePackageResponse" + $ref: '#/components/schemas/precisionTimePackageResponse' examples: example: - $ref: "#/components/examples/servicePackageResponse" - "415": + 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' + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH /fabric/v4/marketplaceSubscriptions/{subscriptionId}: get: tags: @@ -13175,54 +39159,226 @@ paths: description: Subscription UUID required: true schema: - $ref: "#/components/schemas/SubscriptionId" + description: Subscription Id + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/SubscriptionResponse" + $ref: '#/components/schemas/SubscriptionResponse' + examples: + example: + 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' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3142402 + errorMessage: Do not have create connection permission on this port + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/subscription-response" - "401": + value: + - errorCode: EQ-3040016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3034003 + errorMessage: Method not supported,Please check the URL passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: method:PATCH + /fabric/v4/streams: + post: + tags: + - Streams + summary: Create Stream + description: This API provides capability to create user's stream + operationId: createStreams + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StreamPostRequest' + examples: + CreateStream: + value: + type: TELEMETRY_STREAM + name: splunk1 + description: subscription-1 + project: + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 + account: + accountNumber: 123456 + notifications: + - type: ALL + emails: + - johndoe@equinix.com + required: true + responses: + '202': + description: Stream object + content: + application/json: + schema: + $ref: '#/components/schemas/Stream' + examples: + StreamSubscriptionResponse: + 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 + account: + accountNumber: 123456 + notifications: + - type: ALL + emails: + - johndoe@equinix.com + state: PROVISIONED + assetsCount: 1 + streamSubscriptionsCount: 2 + alertRulesCount: 3 + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - /fabric/v4/streams: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error get: tags: - Streams @@ -13245,119 +39401,84 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetAllStreamResponse" + $ref: '#/components/schemas/GetAllStreamResponse' examples: Example: - $ref: "#/components/examples/stream-get-all-example" - "401": + 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 + alertRulesCount: 3 + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '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" + $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": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/streams/search: post: tags: @@ -13365,62 +39486,117 @@ paths: summary: Search Streams description: This API provides capability to search streams operationId: searchStreams - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/StreamSearchRequest" + $ref: '#/components/schemas/StreamSearchRequest' examples: SearchStreams: - $ref: "#/components/examples/StreamSearchRequestExample" + value: + filter: + and: + - property: /project/projectId + operator: IN + values: + - 2f7f1a59-2dbf-43f8-b1a4-3c1f4e4b55b5 + - or: + - property: /uuid + operator: IN + values: + - 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 + - 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + - property: /state + operator: '=' + values: + - PROVISIONED + sort: + - direction: DESC + property: /changeLog/createdDateTime + pagination: + offset: 0 + limit: 20 required: false responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/SearchStreamResponse" + $ref: '#/components/schemas/SearchStreamResponse' examples: Example: - $ref: "#/components/examples/stream-search-all-example" - "401": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + data: + - href: https://api.equinix.com/fabric/v4/streams/12f4d4a1-c7cb-4def-9f77-5ce93c19d999 + uuid: 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 + type: TELEMETRY_STREAM + name: stream-dev-01 + description: Observability stream for project assets + project: + projectId: 2f7f1a59-2dbf-43f8-b1a4-3c1f4e4b55b5 + state: PROVISIONED + assetsCount: 3 + streamSubscriptionsCount: 1 + alertRulesCount: 2 + changeLog: + createdDateTime: '2026-06-17T10:15:30Z' + updatedDateTime: '2026-06-18T10:15:30Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/streams/{streamId}: get: tags: @@ -13434,207 +39610,317 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 responses: - "200": + '200': description: Stream object content: application/json: schema: - $ref: "#/components/schemas/Stream" + $ref: '#/components/schemas/Stream' examples: StreamSubscriptionResponse: - $ref: "#/components/examples/StreamResponseExample" - "400": + 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 + account: + accountNumber: 123456 + notifications: + - type: ALL + emails: + - johndoe@equinix.com + state: PROVISIONED + assetsCount: 1 + streamSubscriptionsCount: 2 + alertRulesCount: 3 + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - put: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error + delete: tags: - Streams - summary: Update Stream - description: This API provides capability to update user's stream - operationId: updateStreamByUuid + 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" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/StreamPutRequest" - examples: - UpdateStream: - $ref: "#/components/examples/StreamPutRequestExample" - required: true + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 responses: - "202": + '202': description: Stream object content: application/json: schema: - $ref: "#/components/schemas/Stream" + $ref: '#/components/schemas/Stream' examples: - StreamResponse: - $ref: "#/components/examples/StreamResponseExample" - "400": + StreamSubscriptionResponse: + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $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": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - delete: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error + put: tags: - Streams - summary: Delete Stream - description: This API provides capability to delete user's stream - operationId: deleteStreamByUuid + 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" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StreamPutRequest' + examples: + UpdateStream: + value: + name: splunk1 + description: subscription 1 + required: true responses: - "202": + '202': description: Stream object content: application/json: schema: - $ref: "#/components/schemas/Stream" + $ref: '#/components/schemas/Stream' examples: - StreamSubscriptionResponse: - $ref: "#/components/examples/StreamDeleteRequestExample" - "400": + StreamResponse: + 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 + account: + accountNumber: 123456 + notifications: + - type: ALL + emails: + - johndoe@equinix.com + state: PROVISIONED + assetsCount: 1 + streamSubscriptionsCount: 2 + alertRulesCount: 3 + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/streamAssets/search: post: tags: @@ -13642,68 +39928,116 @@ paths: summary: Search Stream Assets description: This API provides capability to search stream assets operationId: searchStreamAssets - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/StreamAssetSearchRequest" + $ref: '#/components/schemas/StreamAssetSearchRequest' examples: SearchStreamAssets: - $ref: "#/components/examples/StreamAssetSearchRequestExample" + value: + filter: + and: + - property: /uuid + operator: IN + values: + - 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + - 9ac8ecfe-c7cb-4def-9f77-5ce93c19d83e + - property: /streamUuid + operator: '=' + values: + - 4719e319-65ae-4001-aabf-ca5f107b9b29 + - property: /attachmentStatus + operator: IN + values: + - ATTACHED + - ATTACHING + sort: + - direction: DESC + property: /uuid + pagination: + offset: 0 + limit: 20 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/SearchStreamAssetResponse" + $ref: '#/components/schemas/SearchStreamAssetResponse' examples: Example: - $ref: "#/components/examples/stream-asset-search-all-example" - "400": + 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 + streamUuid: e784aa26-8276-48b7-bb42-a6d9def0a424 + type: XF_PORT + metricsEnabled: false + attachmentStatus: ATTACHED + projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/streams/{streamId}/{asset}/{assetId}: get: tags: @@ -13717,71 +40051,97 @@ paths: description: asset UUID required: true schema: - $ref: "#/components/schemas/AssetId_1" + description: Stream Asset UUID + type: string + format: uuid + example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - name: asset in: path description: asset required: true schema: - $ref: "#/components/schemas/Asset" + $ref: '#/components/schemas/Asset' - name: streamId in: path description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 responses: - "200": + '200': description: Stream asset object content: application/json: schema: - $ref: "#/components/schemas/StreamAsset" + $ref: '#/components/schemas/StreamAsset' examples: StreamSubscriptionResponse: - $ref: "#/components/examples/StreamConnectionAssetResponseExample" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error put: tags: - Streams @@ -13794,89 +40154,120 @@ paths: description: asset UUID required: true schema: - $ref: "#/components/schemas/AssetId_1" + description: Stream Asset UUID + type: string + format: uuid + example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - name: asset in: path description: asset required: true schema: - $ref: "#/components/schemas/Asset" + $ref: '#/components/schemas/Asset' - name: streamId in: path description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 requestBody: content: application/json: schema: - $ref: "#/components/schemas/StreamAssetPutRequest" + $ref: '#/components/schemas/StreamAssetPutRequest' examples: UpdateStream: - $ref: "#/components/examples/StreamAssetPutRequestExample" + value: + metricsEnabled: false required: true responses: - "202": + '202': description: Stream object content: application/json: schema: - $ref: "#/components/schemas/StreamAsset" + $ref: '#/components/schemas/StreamAsset' examples: StreamAssetResponse: - $ref: "#/components/examples/StreamRouterAssetAttachResponseExample" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error delete: tags: - Streams @@ -13889,71 +40280,97 @@ paths: description: asset UUID required: true schema: - $ref: "#/components/schemas/AssetId_1" + description: Stream Asset UUID + type: string + format: uuid + example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - name: asset in: path description: asset required: true schema: - $ref: "#/components/schemas/Asset" + $ref: '#/components/schemas/Asset' - name: streamId in: path description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 responses: - "202": + '202': description: Stream object content: application/json: schema: - $ref: "#/components/schemas/StreamAsset" + $ref: '#/components/schemas/StreamAsset' examples: StreamAssetResponse: - $ref: "#/components/examples/StreamRouterAssetDetachResponseExample" - "400": + 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 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/streams/{streamId}/devices/{deviceId}: get: tags: @@ -13967,65 +40384,104 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: deviceId in: path description: Network Edge Device UUID required: true schema: - $ref: "#/components/schemas/DeviceId" + description: Network Edge Device UUID + type: string + format: uuid + example: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d responses: - "200": + '200': description: Stream Network Edge Device asset object content: application/json: schema: - $ref: "#/components/schemas/StreamAsset" + $ref: '#/components/schemas/StreamAsset' examples: StreamDeviceAssetResponse: - $ref: "#/components/examples/StreamDeviceAssetResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d + uuid: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d + type: VIRTUAL_DEVICE + metricsEnabled: true + attachmentStatus: ATTACHED + interfaces: + - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3 + id: 3 + uuid: 1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b + type: DATA + state: ASSIGNED + attachmentStatus: ATTACHED + - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5 + id: 5 + uuid: 4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d + type: DATA + state: ASSIGNED + attachmentStatus: ATTACHED + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error put: tags: - Streams @@ -14039,83 +40495,130 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: deviceId in: path description: Network Edge Device UUID required: true schema: - $ref: "#/components/schemas/DeviceId" + description: Network Edge Device UUID + type: string + format: uuid + example: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d requestBody: content: application/json: schema: - $ref: "#/components/schemas/StreamDevicePutRequest" + $ref: '#/components/schemas/StreamDevicePutRequest' examples: UpdateStreamDevice: - $ref: "#/components/examples/StreamDevicePutRequestExample" + value: + metricsEnabled: true + interfaces: + - id: 3 + - id: 5 required: true responses: - "202": + '202': description: Stream Network Edge Device asset object content: application/json: schema: - $ref: "#/components/schemas/StreamAsset" + $ref: '#/components/schemas/StreamAsset' examples: StreamDeviceAssetResponse: - $ref: "#/components/examples/StreamDeviceAssetAttachResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d + uuid: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d + type: VIRTUAL_DEVICE + metricsEnabled: true + attachmentStatus: ATTACHING + interfaces: + - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3 + id: 3 + uuid: 1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b + type: DATA + state: ASSIGNED + attachmentStatus: ATTACHING + - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5 + id: 5 + uuid: 4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d + type: DATA + state: ASSIGNED + attachmentStatus: ATTACHING + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error delete: tags: - Streams @@ -14128,139 +40631,105 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: deviceId in: path description: Network Edge Device UUID required: true schema: - $ref: "#/components/schemas/DeviceId" + description: Network Edge Device UUID + type: string + format: uuid + example: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d responses: - "202": + '202': description: Stream Network Edge Device asset object content: application/json: schema: - $ref: "#/components/schemas/StreamAsset" + $ref: '#/components/schemas/StreamAsset' examples: StreamDeviceAssetResponse: - $ref: "#/components/examples/StreamDeviceAssetDetachResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d + uuid: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d + type: VIRTUAL_DEVICE + metricsEnabled: true + attachmentStatus: DETACHING + interfaces: + - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3 + id: 3 + uuid: 1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b + type: DATA + state: ASSIGNED + attachmentStatus: DETACHING + - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5 + id: 5 + uuid: 4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d + type: DATA + state: ASSIGNED + attachmentStatus: DETACHING + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /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 @@ -14273,255 +40742,599 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 requestBody: content: application/json: schema: - $ref: "#/components/schemas/StreamSubscriptionPostRequest" + $ref: '#/components/schemas/StreamSubscriptionPostRequest' examples: CreateStreamSubscription_Splunk_Simple: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleSimpleDefaultSplunk" + value: + type: STREAM_SUBSCRIPTION + name: splunk1 + description: subscription-1 + enabled: true + sink: + uri: https://http-inputs-.splunkcloud.com:/services/collector/event + type: SPLUNK_HEC + credential: + type: ACCESS_TOKEN + accessToken: Splunk + settings: + source: Equinix + eventIndex: idx-hec-event + metricIndex: idx-hec-metric CreateStreamSubscription_Splunk: - $ref: "#/components/examples/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://http-inputs-.splunkcloud.com:/services/collector/event + type: SPLUNK_HEC + credential: + type: ACCESS_TOKEN + accessToken: Splunk + settings: + source: Equinix + eventIndex: idx-hec-event + metricIndex: idx-hec-metric CreateStreamSubscription_Slack: - $ref: "#/components/examples/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 CreateStreamSubscription_Pagerduty: - $ref: "#/components/examples/StreamSubscriptionPostRequestExamplePagerduty" + value: + type: STREAM_SUBSCRIPTION + name: pagerduty + description: subscription-1 + enabled: true + metricSelector: + include: + - equinix.fabric.connection.* + eventSelector: + include: + - equinix.fabric.connection.* + sink: + host: https://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 CreateStreamSubscription_Datadog: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleDatadog" + value: + type: STREAM_SUBSCRIPTION + name: datadog + description: subscription-1 + enabled: true + metricSelector: + include: + - equinix.fabric.connection.* + sink: + host: https://.datadoghq.com + type: DATADOG + credential: + type: API_KEY + apiKey: my-api-key + settings: + source: Equinix + applicationKey: my-application-key + eventUri: https://.datadoghq.com/api/v1/events + metricUri: https://.datadoghq.com/api/v2/series CreateStreamSubscription_Dynatrace: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleDynatrace" + value: + type: STREAM_SUBSCRIPTION + name: dynatrace-subscription + description: subscription-1 + enabled: true + metricSelector: + include: + - equinix.fabric.connection.* + sink: + type: DYNATRACE + credential: + type: API_TOKEN + apiToken: + settings: + eventUri: https://.live.dynatrace.com/platform/ingest/v1/events + metricUri: https://.live.dynatrace.com/api/v2/metrics/ingest CreateStreamSubscription_Microsoft_Teams: - $ref: "#/components/examples/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 CreateStreamSubscription_Servicenow: - $ref: "#/components/examples/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 CreateStreamSubscription_Generic_Webhook_No_Auth: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleGenericWebhookNoAuth" + value: + type: STREAM_SUBSCRIPTION + name: webhook + description: subscription-1 + enabled: true + sink: + type: WEBHOOK + settings: + eventUri: https://xxxxxx + metricUri: https://xxxxxx + format: CLOUDEVENT CreateStreamSubscription_Generic_Webhook_With_ApiKey: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleGenericWebhookApiKey" + value: + type: STREAM_SUBSCRIPTION + name: webhook + description: subscription-1 + enabled: true + sink: + type: WEBHOOK + settings: + eventUri: https://xxxxxx + metricUri: https://xxxxxx + format: CLOUDEVENT + credential: + type: API_KEY + apiKey: CreateStreamSubscription_Generic_Webhook_With_AccessToken: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleGenericWebhookAccessToken" + value: + type: STREAM_SUBSCRIPTION + name: webhook + description: subscription-1 + enabled: true + sink: + type: WEBHOOK + settings: + eventUri: https://xxxxxx + metricUri: https://xxxxxx + format: CLOUDEVENT + credential: + type: ACCESS_TOKEN + accessToken: CreateStreamSubscription_Generic_Webhook_With_Username_Password: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleGenericWebhookUsernamePassword" + value: + type: STREAM_SUBSCRIPTION + name: webhook + description: subscription-1 + enabled: true + sink: + type: WEBHOOK + settings: + eventUri: https://xxxxxx + metricUri: https://xxxxxx + format: CLOUDEVENT + credential: + type: USERNAME_PASSWORD + username: + password: CreateStreamSubscription_Grafana_Webhook: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleGrafanaWebhook" + value: + type: STREAM_SUBSCRIPTION + name: webhook + description: subscription-1 + enabled: true + metricSelector: + include: + - equinix.fabric.connection.* + sink: + type: WEBHOOK + settings: + eventUri: https:///otlp/v1/logs + metricUri: https:///otlp/v1/metrics + format: OPENTELEMETRY + credential: + type: API_KEY + apiKey: : CreateStreamSubscription_Google_PubSub: - $ref: "#/components/examples/StreamSubscriptionPostRequestExampleGooglePubSub" + value: + type: STREAM_SUBSCRIPTION + name: gcp-pubsub + description: subscription-1 + enabled: true + metricSelector: + include: + - equinix.fabric.connection.* + sink: + type: GOOGLE_PUBSUB + uri: https://pubsub.googleapis.com/v1/projects//topics/:publish + credential: + type: ACCESS_TOKEN + accessToken: required: true responses: - "202": + '202': description: Stream Subscription object content: application/json: schema: - $ref: "#/components/schemas/StreamSubscription" + $ref: '#/components/schemas/StreamSubscription' examples: StreamSubscriptionResponse: - $ref: "#/components/examples/StreamSubscriptionResponseExample" - "400": + 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://http-inputs-.splunkcloud.com:/services/collector/event + 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 + operation: + eventsDeliveredCount: 0 + metricsDeliveredCount: 0 + alertsDeliveredCount: 0 + errors: [] + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - /fabric/v4/streams/{streamId}/subscriptions/{subscriptionId}: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error get: tags: - Stream Subscriptions - summary: Get Subscription - description: This API provides capability to delete user's get Stream Subscriptions - operationId: getStreamSubscriptionByUuid + 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: subscriptionId - in: path - description: Stream Subscription UUID - required: true + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 + - name: offset + in: query + description: offset + required: false schema: - $ref: "#/components/schemas/StreamSubscriptionId" + 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 Subscription object + '200': + description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/StreamSubscription" + $ref: '#/components/schemas/GetAllStreamSubscriptionResponse' examples: - StreamSubscriptionResponse: - $ref: "#/components/examples/StreamSubscriptionResponseExample" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - "401": + 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 + operation: + eventsDeliveredCount: 0 + metricsDeliveredCount: 0 + alertsDeliveredCount: 0 + errors: [] + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - put: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error + /fabric/v4/streams/{streamId}/subscriptions/{subscriptionId}: + get: tags: - Stream Subscriptions - summary: Update Subscription - description: This API provides capability to update user's Stream Subscriptions - operationId: updateStreamSubscriptionByUuid + 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" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - 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 + description: Stream Subscription UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '200': description: Stream Subscription object content: application/json: schema: - $ref: "#/components/schemas/StreamSubscription" + $ref: '#/components/schemas/StreamSubscription' examples: StreamSubscriptionResponse: - $ref: "#/components/examples/StreamSubscriptionResponseExample" - "400": + 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://http-inputs-.splunkcloud.com:/services/collector/event + 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 + operation: + eventsDeliveredCount: 0 + metricsDeliveredCount: 0 + alertsDeliveredCount: 0 + errors: [] + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '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" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error delete: tags: - Stream Subscriptions @@ -14534,208 +41347,421 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: subscriptionId in: path description: Stream Subscription UUID required: true schema: - $ref: "#/components/schemas/StreamSubscriptionId" + description: Stream Subscription UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '202': description: Stream Subscription object content: application/json: schema: - $ref: "#/components/schemas/StreamSubscription" + $ref: '#/components/schemas/StreamSubscription' examples: StreamSubscriptionResponse: - $ref: "#/components/examples/StreamSubscriptionDeleteResponseExample" - "400": + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - /fabric/v4/streamSubscriptions/search: - post: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error + put: tags: - Stream Subscriptions - summary: Search Stream Subscriptions - description: This API provides capability to search stream subscriptions - operationId: searchStreamSubscriptions - parameters: [] + 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: + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 + - name: subscriptionId + in: path + description: Stream Subscription UUID + required: true + schema: + description: Stream Subscription UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/StreamSubscriptionSearchRequest" + $ref: '#/components/schemas/StreamSubscriptionPutRequest' examples: - SearchStreamSubscriptions: - $ref: "#/components/examples/StreamSubscriptionSearchRequestExample" + UpdateSubscription: + 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: my-access-token + settings: + source: Equinix + eventIndex: idx-hec-event + metricIndex: idx-hec-metric + batchEnabled: false + batchSizeMax: 50 + batchWaitTimeMax: 5 required: true responses: - "200": - description: Successful operation + '202': + description: Stream Subscription object content: application/json: schema: - $ref: "#/components/schemas/SearchStreamSubscriptionResponse" + $ref: '#/components/schemas/StreamSubscription' examples: - Example: - $ref: "#/components/examples/stream-subscription-search-all-example" - "400": + StreamSubscriptionResponse: + 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://http-inputs-.splunkcloud.com:/services/collector/event + 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 + operation: + eventsDeliveredCount: 0 + metricsDeliveredCount: 0 + alertsDeliveredCount: 0 + errors: [] + changeLog: + createdDateTime: '2024-05-06T16:21:18.545214Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" - /fabric/v4/streams/{streamId}/alertRules: - get: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error + /fabric/v4/streamSubscriptions/search: + post: 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 + - Stream Subscriptions + summary: Search Stream Subscriptions + description: This API provides capability to search stream subscriptions + operationId: searchStreamSubscriptions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StreamSubscriptionSearchRequest' + examples: + SearchStreamSubscriptions: + value: + filter: + and: + - property: /streamUuid + operator: '=' + values: + - 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 + - or: + - property: /uuid + operator: '=' + values: + - 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + - property: /name + operator: ILIKE + values: + - demo% + sort: + - direction: DESC + property: /changeLog/createdDateTime + pagination: + offset: 0 + limit: 20 + required: true responses: - "200": - description: Stream Alert Rules object + '200': + description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/GetAllStreamAlertRuleResponse" + $ref: '#/components/schemas/SearchStreamSubscriptionResponse' examples: - GetAllStreamAlertRuleResponse: - $ref: "#/components/examples/stream-alert-rules-get-all-example" - "401": + Example: + value: + pagination: + offset: 0 + limit: 20 + total: 1 + data: + - href: https://api.equinix.com/fabric/v4/streams/12f4d4a1-c7cb-4def-9f77-5ce93c19d999/subscriptions/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + uuid: 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d + type: STREAM_SUBSCRIPTION + name: demo-subscription + description: Subscription for demo stream events + state: PROVISIONED + enabled: true + metricSelector: + include: + - equinix.fabric.connection.* + eventSelector: + include: + - equinix.fabric.connection.* + sink: + uri: https://hooks.example.com/fabric + type: WEBHOOK + batchEnabled: false + batchSizeMax: 50 + batchWaitTimeMax: 5 + operation: + eventsDeliveredCount: 12 + metricsDeliveredCount: 4 + alertsDeliveredCount: 0 + errors: [] + changeLog: + createdDateTime: '2026-06-17T10:15:30Z' + updatedDateTime: '2026-06-18T10:15:30Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error + /fabric/v4/streams/{streamId}/alertRules: post: tags: - Stream Alert Rules @@ -14748,70 +41774,257 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 requestBody: content: application/json: schema: - $ref: "#/components/schemas/AlertRulePostRequest" + $ref: '#/components/schemas/AlertRulePostRequest' examples: CreateStreamAlertRules: - $ref: "#/components/examples/StreamAlertRulePostRequestExample" + value: + name: metric-alert-1 + type: METRIC_ALERT + description: metric-alert-1 + enabled: true + metricSelector: + include: + - equinix.fabric.connection.bandwidth_tx.usage + resourceSelector: + include: + - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b + detectionMethod: + type: THRESHOLD + windowSize: PT15M + warningThreshold: '35000000' + criticalThreshold: '45000000' CreateStreamSmartAlertRules: - $ref: "#/components/examples/StreamSmartAlertRulePostRequestExample" + value: + name: metric-alert-1 + type: METRIC_ALERT + description: metric-alert-1 + enabled: true + metricSelector: + include: + - equinix.fabric.metro.sv_sy.latency + resourceSelector: + include: + - /fabric/v4/metros/SV + detectionMethod: + type: OUTLIER required: true responses: - "202": + '202': description: Stream Alert Rules object content: application/json: schema: - $ref: "#/components/schemas/StreamAlertRule" + $ref: '#/components/schemas/StreamAlertRule' examples: StreamAlertRuleRequestResponse: - $ref: "#/components/examples/StreamAlertRuleResponseExample" - "400": + 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 + metricSelector: + include: + - equinix.fabric.connection.bandwidth_tx.usage + resourceSelector: + include: + - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b + detectionMethod: + type: THRESHOLD + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "415": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error + 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: + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 + - 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/GetAllStreamAlertRuleResponse' + examples: + GetAllStreamAlertRuleResponse: + 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 + metricSelector: + include: + - equinix.fabric.connection.bandwidth_tx.usage + resourceSelector: + include: + - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b + detectionMethod: + type: THRESHOLD + windowSize: PT15M + operand: ABOVE + warningThreshold: '35000000' + criticalThreshold: '45000000' + changeLog: + createdBy: user + createdDateTime: '2024-05-06T16:21:18.545214Z' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/streams/{streamId}/alertRules/{alertRuleId}: get: tags: @@ -14825,65 +42038,110 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: alertRuleId in: path description: alert rule UUID required: true schema: - $ref: "#/components/schemas/AlertRuleId" + description: Stream Alert Rule UUID + type: string + format: uuid + example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 responses: - "200": + '200': description: Stream Alert Rules object content: application/json: schema: - $ref: "#/components/schemas/StreamAlertRule" + $ref: '#/components/schemas/StreamAlertRule' examples: StreamAlertRuleResponse: - $ref: "#/components/examples/StreamAlertRuleResponseExample" - "400": + 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 + metricSelector: + include: + - equinix.fabric.connection.bandwidth_tx.usage + resourceSelector: + include: + - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b + detectionMethod: + type: THRESHOLD + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error put: tags: - Stream Alert Rules @@ -14896,83 +42154,148 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: alertRuleId in: path description: alert rule UUID required: true schema: - $ref: "#/components/schemas/AlertRuleId" + description: Stream Alert Rule UUID + type: string + format: uuid + example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 requestBody: content: application/json: schema: - $ref: "#/components/schemas/AlertRulePutRequest" + $ref: '#/components/schemas/AlertRulePutRequest' examples: UpdateStreamAlertRules: - $ref: "#/components/examples/StreamAlertRulePutRequestExample" + value: + name: metric-alert-1 + type: METRIC_ALERT + description: metric-alert-1 + enabled: true + metricSelector: + include: + - equinix.fabric.connection.bandwidth_tx.usage + resourceSelector: + include: + - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b + detectionMethod: + type: THRESHOLD + windowSize: PT15M + operand: ABOVE + warningThreshold: '35000000' + criticalThreshold: '45000000' required: true responses: - "202": + '202': description: Stream Alert Rules object content: application/json: schema: - $ref: "#/components/schemas/StreamAlertRule" + $ref: '#/components/schemas/StreamAlertRule' examples: StreamAlertRuleRequestResponse: - $ref: "#/components/examples/StreamAlertRuleResponseExample" - "400": + 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 + metricSelector: + include: + - equinix.fabric.connection.bandwidth_tx.usage + resourceSelector: + include: + - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b + detectionMethod: + type: THRESHOLD + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "415": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/415" - "500": + value: + - errorCode: EQ-3045009 + errorMessage: Unsupported media type + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Content type application/json not supported. + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error delete: tags: - Stream Alert Rules @@ -14985,65 +42308,110 @@ paths: description: Stream UUID required: true schema: - $ref: "#/components/schemas/StreamId" + description: Stream UUID + type: string + format: uuid + example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: alertRuleId in: path description: alert rule UUID required: true schema: - $ref: "#/components/schemas/AlertRuleId" + description: Stream Alert Rule UUID + type: string + format: uuid + example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 responses: - "202": + '202': description: Stream Alert Rules object content: application/json: schema: - $ref: "#/components/schemas/StreamAlertRule" + $ref: '#/components/schemas/StreamAlertRule' examples: StreamAlertRuleDeleteResponse: - $ref: "#/components/examples/StreamAlertRuleDeleteResponseExample" - "400": + 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 + metricSelector: + include: + - equinix.fabric.connection.bandwidth_tx.usage + resourceSelector: + include: + - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b + detectionMethod: + type: THRESHOLD + 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' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/403" - "404": + value: + - errorCode: EQ-3045003 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/404" - "500": + value: + - errorCode: EQ-3045811 + errorMessage: Stream Subscription not found or already deleted + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Stream Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/500" + value: + - errorCode: EQ-3045004 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + details: Internal Server Error /fabric/v4/companyProfiles: post: tags: @@ -15051,38 +42419,37 @@ paths: summary: Create Company Profile description: Create a new company profile Beta operationId: createCompanyProfile - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/CompanyProfileRequest" + $ref: '#/components/schemas/CompanyProfileRequest' required: true responses: - "202": + '202': description: Company profile created and pending for approval content: application/json: schema: - $ref: "#/components/schemas/CompanyProfileResponse" - "400": + $ref: '#/components/schemas/CompanyProfileResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}: get: tags: @@ -15098,30 +42465,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CompanyProfileResponse" - "400": + $ref: '#/components/schemas/CompanyProfileResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' delete: tags: - Company Profiles @@ -15136,30 +42503,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CompanyProfileResponse" - "400": + $ref: '#/components/schemas/CompanyProfileResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/search: post: tags: @@ -15179,27 +42546,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/CompanyProfileSearchRequest" + $ref: '#/components/schemas/CompanyProfileSearchRequest' required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/CompanyProfileSearchResponse" - "400": + $ref: '#/components/schemas/CompanyProfileSearchResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/serviceProfiles: get: tags: @@ -15215,30 +42582,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/ServiceProfileListResponse" - "400": + $ref: '#/components/schemas/ServiceProfileListResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/serviceProfiles/{serviceProfileId}: put: tags: @@ -15260,30 +42627,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AttachServiceProfileResponse" - "400": + $ref: '#/components/schemas/AttachServiceProfileResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' delete: tags: - Company Profiles @@ -15304,30 +42671,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AttachServiceProfileResponse" - "400": + $ref: '#/components/schemas/AttachServiceProfileResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/tags: get: tags: @@ -15343,30 +42710,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/TagListResponse" - "400": + $ref: '#/components/schemas/TagListResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/tags/{tagId}: put: tags: @@ -15388,30 +42755,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AttachTagResponse" - "400": + $ref: '#/components/schemas/AttachTagResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' delete: tags: - Company Profiles @@ -15432,30 +42799,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AttachTagResponse" - "400": + $ref: '#/components/schemas/AttachTagResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/privateServices: get: tags: @@ -15471,30 +42838,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/PrivateServiceListResponse" - "400": + $ref: '#/components/schemas/PrivateServiceListResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/privateServices/{privateServiceId}: put: tags: @@ -15516,30 +42883,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AttachPrivateServiceResponse" - "400": + $ref: '#/components/schemas/AttachPrivateServiceResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' delete: tags: - Company Profiles @@ -15560,30 +42927,30 @@ paths: schema: type: string responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AttachPrivateServiceResponse" - "400": + $ref: '#/components/schemas/AttachPrivateServiceResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/logos: post: tags: @@ -15591,44 +42958,43 @@ paths: summary: Create Logo description: Create Logo for Equinix Fabric™ Company Profile operationId: createLogo - parameters: [] requestBody: content: multipart/form-data: schema: - $ref: "#/components/schemas/LogoRequest" + $ref: '#/components/schemas/LogoRequest' required: true responses: - "201": + '201': description: Successful Create operation content: application/json: schema: - $ref: "#/components/schemas/LogoResponse" - "400": + $ref: '#/components/schemas/LogoResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/logos/{uuid}: get: tags: @@ -15645,43 +43011,43 @@ paths: type: string format: uuid responses: - "200": + '200': description: Successful Get operation content: multipart/mixed: schema: type: string format: binary - "400": + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' delete: tags: - Logos @@ -15697,36 +43063,36 @@ paths: type: string format: uuid responses: - "202": + '202': description: Successful Delete operation content: application/json; charset=UTF-8: schema: - $ref: "#/components/schemas/LogoResponse" - "401": + $ref: '#/components/schemas/LogoResponse' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/loas: post: tags: @@ -15734,87 +43100,270 @@ paths: summary: Create Loa description: The API provides capability to create a new Loa operationId: createLoa - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/CreateLoa" + $ref: '#/components/schemas/CreateLoa' examples: IssueLoa-OnCageWithCageId: - $ref: "#/components/examples/IssueLoaOnCageWithCageId" + value: + type: CAGE_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + expirationDateTime: '2026-12-31T23:59:59Z' + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + demarcationPoint: + cageUniqueSpaceId: AM7:0G:0202 IssueLoa-OnPatchPanelPort: - $ref: "#/components/examples/IssueLoaOnPatchPanelPort" + value: + type: PATCH_PANEL_PORT_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for patch panel port access to Equinix at SV1 + authorizedProductType: XC + expirationDateTime: '2026-12-31T23:59:59Z' + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 24 + connectorType: SC IssueLoa-OnPatchPanel: - $ref: "#/components/examples/IssueLoaOnPatchPanel" + value: + type: PATCH_PANEL_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for patch panel access to Equinix at SV1 + authorizedProductType: XC + expirationDateTime: '2026-12-31T23:59:59Z' + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + demarcationPoint: + patchPanelId: CP:Demarc:1259684 RequestLoa-OnCage: - $ref: "#/components/examples/RequestLoaOnCage" + value: + type: CAGE_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for patch panel port access to Equinix at SV1 + authorizedProductType: XC + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + location: + ibxCode: SV11 RequestLoa-OnPatchPanel: - $ref: "#/components/examples/RequestLoaOnPatchPanel" + value: + type: PATCH_PANEL_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for patch panel port access to Equinix at SV1 + authorizedProductType: XC + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + location: + ibxCode: SV11 RequestLoa-OnPatchPanelPort: - $ref: "#/components/examples/RequestLoaOnPatchPanelPort" + value: + type: PATCH_PANEL_PORT_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for patch panel port access to Equinix at SV1 + authorizedProductType: XC + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + location: + ibxCode: SV11 required: true responses: - "202": + '202': description: Accepted content: application/json: schema: - $ref: "#/components/schemas/LoaResponse" + $ref: '#/components/schemas/LoaResponse' examples: ByRequestor: - $ref: "#/components/examples/LoaCreateResponseByRequestor" + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: PATCH_PANEL_PORT_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + state: PENDING_AUTHORIZATION + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + location: + ibxCode: SV1 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org1.com ByIssuerWithCageType: - $ref: "#/components/examples/LoaCreateResponseByIssuerWithCageType" + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: CAGE_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + state: PENDING_ACCEPTANCE + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + demarcationPoint: + cageUniqueSpaceId: SV1:01:10:200 + location: + ibxCode: SV1 + changeLog: + createdDateTime: '2025-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com ByIssuerWithPatchPanelPortType: - $ref: "#/components/examples/LoaCreateResponseByIssuerWithPatchPanelPortType" + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: PATCH_PANEL_PORT_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + state: PENDING_ACCEPTANCE + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 23 + connectorType: SC + location: + ibxCode: SV1 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com ByIssuerWithPatchPanelType: - $ref: "#/components/examples/LoaCreateResponseByIssuerWithPatchPanelType" - "400": + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: PATCH_PANEL_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + state: PENDING_ACCEPTANCE + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + location: + ibxCode: SV1 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_400" - "401": + value: + - errorCode: EQ-3070103 + errorMessage: Loa does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/loas/{loaId}: get: tags: @@ -15828,62 +43377,121 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 responses: - "200": + '200': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/LoaResponse" + $ref: '#/components/schemas/LoaResponse' examples: LoaExample: - $ref: "#/components/examples/LoaResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: PATCH_PANEL_PORT_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + state: INACTIVE + expirationDateTime: '2024-12-31T23:59:59Z' + operation: + consumersCount: 10 + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + demarcationPoint: + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0105 + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 23 + connectorType: SC + location: + ibxCode: SV1 + changeLog: + createdDateTime: '2025-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_400" - "401": + value: + - errorCode: EQ-3070103 + errorMessage: Loa does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request patch: tags: - Loas @@ -15896,71 +43504,130 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/LoaUpdate" + $ref: '#/components/schemas/LoaUpdate' examples: LoaPatchRequest: - $ref: "#/components/examples/LoaPatchRequest" + value: + - op: replace + path: /demarcationPoint/patchPanelId + value: CP:Demarc:1259685 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/LoaResponse" + $ref: '#/components/schemas/LoaResponse' examples: PatchLoaResponse: - $ref: "#/components/examples/LoaPatchResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: PATCH_PANEL_PORT_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + state: INACTIVE + operation: + consumersCount: 1 + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 23 + connectorType: SC + location: + ibxCode: SV1 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_400" - "401": + value: + - errorCode: EQ-3070103 + errorMessage: Loa does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/loas/{loaId}/actions: post: tags: @@ -15974,85 +43641,166 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 requestBody: content: application/json: schema: - $ref: "#/components/schemas/LoaActionRequest" + $ref: '#/components/schemas/LoaActionRequest' examples: AuthorizeLoa: - $ref: "#/components/examples/AuthorizeLoaActionRequest" + value: + type: LOA_ISSUER_AUTHORIZATION + data: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 23 + connectorType: SC + expirationDateTime: '2026-08-07T07:00:00Z' AcceptLoa: - $ref: "#/components/examples/AcceptLoaActionRequest" + value: + type: LOA_REQUESTOR_ACCEPTANCE CopyLoa: - $ref: "#/components/examples/CopyLoaActionRequest" + value: + type: LOA_COPY_LINK SendLoa: - $ref: "#/components/examples/SendLoaActionRequest" + value: + type: LOA_SEND_EMAIL_NOTIFICATION CancelLoa: - $ref: "#/components/examples/CancelLoaActionRequest" + value: + type: LOA_CANCEL required: true responses: - "202": + '202': description: Accepted content: application/json: schema: - $ref: "#/components/schemas/LoaActionResponse" + $ref: '#/components/schemas/LoaActionResponse' examples: AuthorizeLoa: - $ref: "#/components/examples/AuthorizeLoaActionResponse" + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: LOA_ISSUER_AUTHORIZATION + state: COMPLETED + data: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 23 + connectorType: SC + expirationDateTime: '2026-08-07T07:00:00Z' + changeLog: + createdDateTime: '2026-06-24T06:50:46Z' + createdBy: user + createdByEmail: user@org1.com AcceptLoa: - $ref: "#/components/examples/AcceptLoaActionResponse" + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: LOA_REQUESTOR_ACCEPTANCE + state: COMPLETED + changeLog: + createdDateTime: '2025-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com SendLoa: - $ref: "#/components/examples/SendLoaActionResponse" + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: LOA_SEND_EMAIL_NOTIFICATION + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com CopyLoa: - $ref: "#/components/examples/CopyLoaActionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: LOA_COPY_LINK + state: COMPLETED + data: + portalUrl: https://portal.equinix.com/fabric/loa/inventory/issuer/29cc7878-54e3-4e1a-8651-87a61354bac2/authorize + changeLog: + createdDateTime: '2026-06-24T06:50:46Z' + createdBy: user + createdByEmail: user@org1.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_Action_400" - "401": + value: + - errorCode: EQ-3070107 + errorMessage: Loa Action does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa Action does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_Action_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa Action not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa 3070101 does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/loas/{loaId}/actions/{actionId}: get: tags: @@ -16066,68 +43814,114 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 - name: actionId in: path description: Action UUID required: true schema: - $ref: "#/components/schemas/ActionId_2" + description: Action UUID + type: string + format: uuid + example: 30cc7878-54e3-4e1a-8651-87a61354bad4 responses: - "200": + '200': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/LoaActionResponse" + $ref: '#/components/schemas/LoaActionResponse' examples: AuthorizeLoaActionExample: - $ref: "#/components/examples/AuthorizeLoaActionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: LOA_ISSUER_AUTHORIZATION + state: COMPLETED + data: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 23 + connectorType: SC + expirationDateTime: '2026-08-07T07:00:00Z' + changeLog: + createdDateTime: '2026-06-24T06:50:46Z' + createdBy: user + createdByEmail: user@org1.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_Action_400" - "401": + value: + - errorCode: EQ-3070107 + errorMessage: Loa Action does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa Action does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_Action_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa Action not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa 3070101 does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/loas/search: post: tags: @@ -16135,73 +43929,175 @@ paths: summary: Search Loas description: The API provides capability to get list of user's Loa using search criteria, including optional filtering, pagination and sorting operationId: searchLoa - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/LoaSearchRequest" + $ref: '#/components/schemas/LoaSearchRequest' examples: SearchByNameWithType: - $ref: "#/components/examples/LoaSearchByNameWithType" + summary: A named loa of a given type + value: + filter: + and: + - property: /name + operator: ILIKE + values: + - LOA-Equinix-SV1 + - property: /type + operator: '=' + values: + - PATCH_PANEL_PORT_LOA + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC SearchByStateWithPartnerOrIbx: - $ref: "#/components/examples/LoaSearchStateWithPartnerOrIbx" + summary: Partial match on state with partner name or with ibx code + value: + filter: + and: + - property: /state + operator: '=' + values: + - PENDING_ACCEPTANCE + - or: + - property: /requestor/orgName + operator: ILIKE + values: + - abc + - property: /location/ibxCode + operator: ILIKE + values: + - MB + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/LoaSearchResponse" - examples: - example: - $ref: "#/components/examples/LoaSearchResponse" - "400": + $ref: '#/components/schemas/LoaSearchResponse' + examples: + example: + value: + pagination: + offset: 0 + limit: 25 + total: 1 + sort: + - property: /changeLog/createdDateTime + direction: DESC + data: + - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: PATCH_PANEL_PORT_LOA + name: LOA-Equinix-SV1-2026 + description: Authorization for cage access to Equinix at SV1 + authorizedProductType: XC + state: INACTIVE + expirationDateTime: '2026-12-31T23:59:59Z' + operation: + consumersCount: 1 + requestor: + email: user@org1.com + orgId: 95900 + orgName: organizationName1 + issuer: + email: user@org2.com + orgId: 95901 + orgName: organizationName2 + demarcationPoint: + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0105 + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 23 + patchPanelPortB: 23 + connectorType: SC + location: + ibxCode: SV1 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_400" - "401": + value: + - errorCode: EQ-3070103 + errorMessage: Loa does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/loas/{loaId}/actions/search: post: tags: @@ -16215,71 +44111,127 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 requestBody: content: application/json: schema: - $ref: "#/components/schemas/LoaActionSearchRequest" + $ref: '#/components/schemas/LoaActionSearchRequest' examples: ActionTypeSearch: - $ref: "#/components/examples/LoaActionSearchByActionType" + value: + filter: + and: + - property: /type + operator: '=' + values: + - LOA_REQUESTOR_ACCEPTANCE + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/createdDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/LoaActionSearchResponse" + $ref: '#/components/schemas/LoaActionSearchResponse' examples: LoaActionSearchExample: - $ref: "#/components/examples/LoaSearchActionResponse" - "400": + value: + pagination: + offset: 0 + limit: 25 + total: 1 + sort: + - property: /changeLog/createdDateTime + direction: DESC + data: + - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: LOA_ISSUER_AUTHORIZATION + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: user + createdByEmail: user@org2.com + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_Action_400" - "401": + value: + - errorCode: EQ-3070107 + errorMessage: Loa Action does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa Action does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_Action_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa Action not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa 3070101 does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/loas/{loaId}/consumers: get: tags: @@ -16293,62 +44245,105 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 responses: - "200": + '200': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/LoaConsumersResponse" + $ref: '#/components/schemas/LoaConsumersResponse' examples: LoaConsumersExample: - $ref: "#/components/examples/LoaConsumersResponse" - "400": + value: + pagination: + offset: 0 + limit: 25 + total: 2 + data: + - href: https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2 + uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 + type: XF_PORT + changeLog: + createdDateTime: '2025-07-24T06:50:46Z' + - href: https://api.equinix.com/fabric/v4/ports/b7e14c2d-93f8-4a61-8d5b-c29f71e4a306 + uuid: b7e14c2d-93f8-4a61-8d5b-c29f71e4a306 + type: XF_PORT + changeLog: + createdDateTime: '2025-07-26T06:50:46Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_400" - "401": + value: + - errorCode: EQ-3070103 + errorMessage: Loa does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/loas/{loaId}/notes: get: tags: @@ -16362,62 +44357,101 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 responses: - "200": + '200': description: Successful Operation content: application/json: schema: - $ref: "#/components/schemas/LoaNotesResponse" + $ref: '#/components/schemas/LoaNotesResponse' examples: GetLoaNotesExample: - $ref: "#/components/examples/LoaNotesResponse" - "400": + value: + data: + - type: ISSUER + href: https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + comments: test note from issuer + createdDateTime: '2026-07-24T06:50:46Z' + - type: REQUESTOR + href: https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/a41f485e-3094-42de-8797-0ef19a51df81 + uuid: a41f485e-3094-42de-8797-0ef19a51df81 + comments: test note from requestor + createdDateTime: '2026-07-25T06:50:46Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_400" - "401": + value: + - errorCode: EQ-3070103 + errorMessage: Loa does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request post: tags: - Loas @@ -16430,71 +44464,105 @@ paths: description: Loa UUID required: true schema: - $ref: "#/components/schemas/LoaId" + description: Loa UUID + type: string + format: uuid + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 requestBody: content: application/json: schema: - $ref: "#/components/schemas/CreateLoaNote" + $ref: '#/components/schemas/CreateLoaNote' examples: LoaNoteRequest: - $ref: "#/components/examples/LoaNoteRequest" + value: + comments: LOA under review by our team. Expected response within 2 business days. required: true responses: - "201": + '201': description: Created content: application/json: schema: - $ref: "#/components/schemas/LoaNoteDetails" + $ref: '#/components/schemas/LoaNoteDetails' examples: CreateLoaNoteExample: - $ref: "#/components/examples/CreateLoaNoteResponse" - "400": + value: + type: ISSUER + href: https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + comments: LOA under review by our team. Expected response within 2 business days. + createdDateTime: '2026-06-24T06:50:46Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_400" - "401": + value: + - errorCode: EQ-3070103 + errorMessage: Loa does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '401': description: Unauthorized request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_401" - "403": + value: + - errorCode: EQ-3070106 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_403" - "404": + value: + - errorCode: EQ-3070102 + errorMessage: Operation not allowed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: Operation not allowed for current user + '404': description: Not found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_404" - "500": + value: + - errorCode: EQ-3070101 + errorMessage: Loa not found + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: uuid + reason: Loa does not exist. Please check Loa UUID + '500': description: Internal Server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/Loa_500" + value: + - errorCode: EQ-3070104 + errorMessage: Internal Server Error + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: An unexpected error occurred while processing the request /fabric/v4/crossConnects: post: tags: @@ -16502,91 +44570,732 @@ paths: summary: Create Cross Connect description: The API provides capability to create a new Cross Connect. operationId: createCrossConnect - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/CreateCrossConnect" + $ref: '#/components/schemas/CreateCrossConnect' examples: StandardCrossConnect: - $ref: "#/components/examples/StandardCrossConnectRequest" + summary: Standard Cross Connect + description: Minimal Cross Connect request with only the required fields. + value: + type: XC + name: My-CC-service + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 12 + patchPanelPortB: 24 + connectorType: SC + schedule: + code: STANDARD + requestedDateTime: '2026-02-27T07:21:39Z' StandardCrossConnectWithServices: - $ref: "#/components/examples/StandardCCWithServicesRequest" + summary: Standard Cross Connect With Services + description: Standard Cross Connect with additional services - link light verification and patch equipment. + value: + type: XC + name: My-CC-service + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 12 + patchPanelPortB: 24 + connectorType: SC + schedule: + code: STANDARD + requestedDateTime: '2026-02-27T07:21:39Z' + services: + - type: XC_LINK_LIGHT_VERIFICATION + - type: XC_PATCH_EQUIPMENT + device: + cabinetUniqueSpaceId: SV2:00:000000:0100 + port: 32 + connectorType: SC + description: device description + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + customerReferenceId: '12345' StandardCrossConnectByPatchPanel: - $ref: "#/components/examples/StandardCCByPatchPanelRequest" + summary: Standard Cross Connect By Patch Panel + description: Standard Cross Connect using patch panel demarcation points on both sides. + value: + type: XC + name: My-CC-service + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 12 + patchPanelPortB: 24 + connectorType: SC + schedule: + code: STANDARD + requestedDateTime: '2026-02-27T07:21:39Z' + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + purchaseOrder: + number: '1233' + amount: '10000' + startDate: '2026-02-26' + endDate: '2027-02-26' + attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 + type: NEW + customerReferenceId: '12345' + notes: + - comments: test note + attachments: + - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 StandardCrossConnectByLoa: - $ref: "#/components/examples/StandardCCByLoaRequest" + summary: Standard Cross Connect By LOA + description: Standard Cross Connect where the z-side is specified via a Letter of Authorization. + value: + type: XC + name: My-CC-service + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + zSide: + loa: + uuid: c61f485e-3094-42de-8797-0ef19a51df79 + schedule: + code: STANDARD + requestedDateTime: '2026-02-27T07:21:39Z' + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + customerReferenceId: '12345' + notes: + - comments: test note + attachments: + - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 ExtendedCrossConnectEquinixManaged: - $ref: "#/components/examples/ExtendedCCEquinixManagedRequest" + summary: Extended Cross Connect Equinix Managed + description: 'Extended Cross Connect with Equinix-managed meet-me room (bmmrType: EQUINIX).' + value: + type: XC + name: My-CC-service + bmmrType: EQUINIX + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + zSide: + location: + ibxCode: SV11 + loa: + uuid: c61f485e-3094-42de-8797-0ef19a51df79 + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + customerReferenceId: '12345' + notes: + - comments: test note + attachments: + - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 ExtendedCrossConnectSelfManaged: - $ref: "#/components/examples/ExtendedCCSelfManagedRequest" + summary: Extended Cross Connect Self Managed + description: 'Extended Cross Connect with self-managed meet-me room (bmmrType: SELF).' + value: + type: XC + name: My-CC-service + bmmrType: SELF + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + zSide: + location: + ibxCode: SV11 + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + customerReferenceId: '12345' + notes: + - comments: test note + attachments: + - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 DiverseWithExistingCrossConnect: - $ref: "#/components/examples/DiverseWithExistingCCRequest" + summary: Diverse with Existing Cross Connect + description: Add a SECONDARY Cross Connect to an existing PRIMARY by providing the PRIMARY's redundancy group identifier, or its serial number, as the redundancy group. + value: + type: XC + name: My-CC-service-SEC + redundancy: + priority: SECONDARY + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 14 + patchPanelPortB: 15 + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 22 + patchPanelPortB: 23 + connectorType: SC + schedule: + code: STANDARD + requestedDateTime: '2026-02-27T07:21:39Z' + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + customerReferenceId: '12345' required: true responses: - "202": + '202': description: Accepted. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectResponse" + $ref: '#/components/schemas/CrossConnectResponse' examples: StandardCrossConnectByPatchPanel: - $ref: "#/components/examples/StandardCCByPatchPanelResponse" + summary: Standard Cross Connect By Patch Panel + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 45 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV2:00:000000 + cabinetUniqueSpaceId: SV2:00:000000:0100 + location: + ibxCode: SV1 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser StandardCrossConnectByLoa: - $ref: "#/components/examples/StandardCCByLoaResponse" + summary: Standard Cross Connect By LOA + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + loa: + href: https://api.equinix.com/fabric/v4/loas/b51f485e-3094-42de-8797-0ef19a51df79 + uuid: c61f485e-3094-42de-8797-0ef19a51df79 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser ExtendedCrossConnectEquinixManaged: - $ref: "#/components/examples/ExtendedCCEquinixManagedResponse" + summary: Extended Cross Connect Equinix Managed + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + bmmrType: EQUINIX + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV11 + loa: + href: https://api.equinix.com/fabric/v4/loas/c61f485e-3094-42de-8797-0ef19a51df79 + uuid: c61f485e-3094-42de-8797-0ef19a51df79 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser ExtendedCrossConnectSelfManaged: - $ref: "#/components/examples/ExtendedCCSelfManagedResponse" + summary: Extended Cross Connect Self Managed + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + bmmrType: SELF + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV11 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser DiverseWithExistingCrossConnect: - $ref: "#/components/examples/DiverseWithExistingCCResponse" - "400": + summary: Diverse with Existing Cross Connect + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service-SEC + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: SECONDARY + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 14 + patchPanelPortB: 15 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 22 + patchPanelPortB: 23 + connectorType: SC + cageUniqueSpaceId: SV2:00:000000 + cabinetUniqueSpaceId: SV2:00:000000:0100 + location: + ibxCode: SV1 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/bulk: post: tags: @@ -16595,71 +45304,319 @@ paths: description: | The API provides capability to create several Cross Connects in a single order - a diverse pair where the PRIMARY and the SECONDARY Cross Connect are placed at the same time, or multiple Cross Connects by sending one entry per Cross Connect. operationId: createDiverseCrossConnect - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/DiverseCrossConnectRequest" + $ref: '#/components/schemas/DiverseCrossConnectRequest' examples: DiverseCrossConnectPair: - $ref: "#/components/examples/DiverseCCPairRequest" + summary: Diverse pair + description: Two Cross Connects placed at the same time on separate patch panels - one PRIMARY and one SECONDARY. + value: + data: + - type: XC + name: My-CC-service-PRI + redundancy: + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 12 + patchPanelPortB: 24 + connectorType: SC + schedule: + code: STANDARD + requestedDateTime: '2026-02-27T07:21:39Z' + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + customerReferenceId: '12345' + - type: XC + name: My-CC-service-SEC + redundancy: + priority: SECONDARY + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 14 + patchPanelPortB: 15 + connectorType: SC + zSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 22 + patchPanelPortB: 23 + connectorType: SC + schedule: + code: STANDARD + requestedDateTime: '2026-02-27T07:21:39Z' + notifications: + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + order: + customerReferenceId: '12345' required: true responses: - "202": + '202': description: Accepted. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectDiverse" + $ref: '#/components/schemas/CrossConnectDiverse' examples: DiverseCrossConnectPair: - $ref: "#/components/examples/DiverseCCPairResponse" - "400": + summary: Diverse Cross Connect Pair + value: + data: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + name: My-CC-service-PRI + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 12 + patchPanelPortB: 24 + connectorType: SC + cageUniqueSpaceId: SV2:00:000000 + cabinetUniqueSpaceId: SV2:00:000000:0100 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser + - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603 + type: XC + uuid: a6f77b33-96c6-4eeb-8d79-76374d950603 + name: My-CC-service-SEC + state: PROVISIONING + serialNumber: '234567891' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: SECONDARY + aSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 14 + patchPanelPortB: 15 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: PP:Demarc:1260379 + patchPanelPortA: 22 + patchPanelPortB: 23 + connectorType: SC + cageUniqueSpaceId: SV2:00:000000 + cabinetUniqueSpaceId: SV2:00:000000:0100 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567891 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400_diverse" - "401": + summary: Invalid diverse pair + value: + - errorCode: EQ-3071106 + errorMessage: Invalid diverse Cross Connect request + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + details: A diverse pair order must contain exactly two Cross Connects, one PRIMARY and one SECONDARY. + additionalInfo: + - property: /data + reason: Expected two entries with complementary redundancy priorities. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/search: post: tags: @@ -16667,73 +45624,220 @@ paths: summary: Search Cross Connects description: The API provides capability to get list of user's Cross Connects using search criteria, including optional filtering, pagination and sorting. operationId: searchCrossConnects - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/CrossConnectSearchRequest" + $ref: '#/components/schemas/CrossConnectSearchRequest' examples: SearchByNameWithState: - $ref: "#/components/examples/CrossConnectSearchByNameWithState" + value: + filter: + and: + - property: /name + operator: LIKE + values: + - My-CC-service + - property: /state + operator: IN + values: + - PENDING + - PENDING_ACTION + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/updatedDateTime + direction: DESC SearchByIbxWithType: - $ref: "#/components/examples/CrossConnectSearchByIbxWithType" + value: + filter: + and: + - property: /type + operator: '=' + values: + - XC + - or: + - property: /aSide/location/ibxCode + operator: '=' + values: + - SV1 + - property: /zSide/location/ibxCode + operator: '=' + values: + - SV1 + pagination: + limit: 25 + offset: 0 + sort: + - property: /name + direction: ASC required: true responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectSearchResponse" - examples: - example: - $ref: "#/components/examples/CrossConnectSearchResponse" - "400": + $ref: '#/components/schemas/CrossConnectSearchResponse' + examples: + example: + value: + pagination: + offset: 0 + limit: 25 + total: 1 + sort: + - property: /changeLog/updatedDateTime + direction: DESC + data: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + name: My-CC-service + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + loa: + href: https://api.equinix.com/fabric/v4/loas/b51f485e-3094-42de-8797-0ef19a51df79 + uuid: c61f485e-3094-42de-8797-0ef19a51df79 + location: + ibxCode: SV1 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-26T07:21:39Z' + createdBy: testuser + updatedDateTime: '2026-02-28T07:21:39Z' + updatedBy: '1234' + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}: get: tags: @@ -16747,68 +45851,404 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectResponse" + $ref: '#/components/schemas/CrossConnectResponse' examples: StandardCrossConnectByPatchPanel: - $ref: "#/components/examples/StandardCCByPatchPanelResponse" + summary: Standard Cross Connect By Patch Panel + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 45 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV2:00:000000 + cabinetUniqueSpaceId: SV2:00:000000:0100 + location: + ibxCode: SV1 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser StandardCrossConnectByLoa: - $ref: "#/components/examples/StandardCCByLoaResponse" + summary: Standard Cross Connect By LOA + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + loa: + href: https://api.equinix.com/fabric/v4/loas/b51f485e-3094-42de-8797-0ef19a51df79 + uuid: c61f485e-3094-42de-8797-0ef19a51df79 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser ExtendedCrossConnectEquinixManaged: - $ref: "#/components/examples/ExtendedCCEquinixManagedResponse" + summary: Extended Cross Connect Equinix Managed + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + bmmrType: EQUINIX + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV11 + loa: + href: https://api.equinix.com/fabric/v4/loas/c61f485e-3094-42de-8797-0ef19a51df79 + uuid: c61f485e-3094-42de-8797-0ef19a51df79 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser ExtendedCrossConnectSelfManaged: - $ref: "#/components/examples/ExtendedCCSelfManagedResponse" - "400": + summary: Extended Cross Connect Self Managed + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: XC + name: My-CC-service + uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + bmmrType: SELF + state: PROVISIONING + serialNumber: '234567890' + redundancy: + group: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: PRIMARY + aSide: + demarcationPoint: + patchPanelId: CP:Demarc:1259684 + patchPanelPortA: 35 + patchPanelPortB: 32 + connectorType: SC + cageUniqueSpaceId: SV1:00:000000 + cabinetUniqueSpaceId: SV1:00:000000:0100 + location: + ibxCode: SV1 + zSide: + location: + ibxCode: SV11 + account: + accountNumber: 123456 + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + order: + orderNumber: 1-1234567890 + customerReferenceId: '12345' + links: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules + rel: getCrossConnectSchedulesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services + rel: getCrossConnectServicesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes + rel: getCrossConnectNotesByUuid + method: GET + contentType: application/json + authenticate: true + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments + rel: getCrossConnectAttachmentsByUuid + method: GET + contentType: application/json + authenticate: true + changeLog: + createdDateTime: '2026-02-28T07:21:39Z' + createdBy: testuser + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/schedules: get: tags: @@ -16822,62 +46262,115 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/SchedulesResponse" + $ref: '#/components/schemas/SchedulesResponse' examples: SchedulesExample: - $ref: "#/components/examples/CrossConnectSchedulesResponse" - "400": + value: + data: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + type: XC_INSTALL_SCHEDULE + code: EXPEDITE + state: COMPLETED + autoConvertToStandard: true + readinessDateTime: '2026-08-23T07:21:39Z' + requestedDateTime: '2026-08-24T07:21:39Z' + equinixProposedDateTime: '2026-08-25T07:21:39Z' + installationDateTime: '2026-08-25T09:21:39Z' + changeLog: + createdBy: testuser + createdDateTime: '2026-08-22T07:21:39Z' + updatedBy: '124' + updatedDateTime: '2026-08-25T09:21:39Z' + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/a11f485e-3094-42de-8797-0ef19a51df79 + uuid: a11f485e-3094-42de-8797-0ef19a51df79 + type: XC_DEINSTALL_SCHEDULE + code: STANDARD + state: PENDING + requestedDateTime: '2026-09-14T17:21:25.586Z' + deinstallationDateTime: '2026-09-16T17:21:25.586Z' + changeLog: + createdBy: testuser + createdDateTime: '2026-09-12T07:21:39Z' + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/services: get: tags: @@ -16891,62 +46384,109 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectServicesResponse" + $ref: '#/components/schemas/CrossConnectServicesResponse' examples: GetCrossConnectServices: - $ref: "#/components/examples/CrossConnectServicesResponse" - "400": + value: + data: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + type: XC_LINK_LIGHT_VERIFICATION + state: PENDING + changeLog: + createdBy: testuser + createdDateTime: '2026-02-28T07:21:39Z' + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/a11f485e-3094-42de-8797-0ef19a51df79 + uuid: a11f485e-3094-42de-8797-0ef19a51df79 + type: XC_PATCH_EQUIPMENT + state: PENDING + device: + cabinetUniqueSpaceId: SV2:00:000000:0100 + port: 32 + connectorType: SC + description: additional notes for patch equipment + changeLog: + createdBy: testuser + createdDateTime: '2026-02-28T07:21:39Z' + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/attachments: get: tags: @@ -16960,62 +46500,109 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectAttachmentsResponse" + $ref: '#/components/schemas/CrossConnectAttachmentsResponse' examples: GetCrossConnectAttachments: - $ref: "#/components/examples/CrossConnectAttachmentsResponse" - "400": + summary: Cross Connect attachments + value: + data: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + type: ATTACHMENT + source: CUSTOMER + attachmentId: a11f485e-3094-42de-8797-0ef19a51df79 + downloadHref: https://api.equinix.com/ecp/attachments/a11f485e-3094-42de-8797-0ef19a51df79 + changeLog: + createdBy: '123' + createdDateTime: '2026-02-28T07:21:39Z' + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/a41f485e-3094-42de-8797-0ef19a51df81 + uuid: a41f485e-3094-42de-8797-0ef19a51df81 + type: ATTACHMENT + source: EQUINIX + attachmentId: b21f485e-3094-42de-8797-0ef19a51df80 + downloadHref: https://api.equinix.com/ecp/attachments/b21f485e-3094-42de-8797-0ef19a51df80 + changeLog: + createdBy: EQUINIX + createdDateTime: '2026-02-27T07:21:39Z' + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/notes: get: tags: @@ -17029,7 +46616,10 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - name: offset in: query description: offset @@ -17045,60 +46635,106 @@ paths: type: integer example: 10 responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectNotesResponse" + $ref: '#/components/schemas/CrossConnectNotesResponse' examples: GetCrossConnectNotes: - $ref: "#/components/examples/CrossConnectNotesResponse" - "400": + summary: Cross Connect notes + value: + pagination: + offset: 0 + limit: 10 + total: 2 + data: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + type: NOTE + source: CUSTOMER + comments: Additional note to EQUINIX technician. + changeLog: + createdBy: '124' + createdDateTime: '2026-02-28T07:21:39Z' + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79 + uuid: a11f485e-3094-42de-8797-0ef19a51df79 + type: NOTE + source: EQUINIX + comments: Please confirm the patch panel port before the scheduled installation. + changeLog: + createdBy: SYSTEM + createdDateTime: '2026-02-27T07:21:39Z' + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/actions: post: tags: @@ -17113,91 +46749,265 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 requestBody: content: application/json: schema: - $ref: "#/components/schemas/CrossConnectActionRequest" + $ref: '#/components/schemas/CrossConnectActionRequest' examples: SendSignatureQuote: - $ref: "#/components/examples/SendSignatureQuoteActionRequest" + value: + type: XC_SIGNATURE_SUBMISSION AcceptProposedDateTime: - $ref: "#/components/examples/AcceptProposedDateTimeActionRequest" + value: + type: XC_PROPOSED_DATE_TIME_ACCEPTANCE RejectProposedDateTime: - $ref: "#/components/examples/RejectProposedDateTimeActionRequest" + value: + type: XC_PROPOSED_DATE_TIME_REJECTION CancelCrossConnect: - $ref: "#/components/examples/CancelCrossConnectActionRequest" + value: + type: XC_CANCEL DeinstallCrossConnect: - $ref: "#/components/examples/DeinstallCrossConnectActionRequest" + summary: Deinstall a Cross Connect + description: Removal of a provisioned Cross Connect, along with the patch equipment. The notification contacts are appended to the ones already held on the Cross Connect, while the purchase order and the customer reference identifier replace the existing ones. + value: + type: XC_DEINSTALL + data: + schedule: + code: STANDARD + requestedDateTime: '2026-06-14T17:21:25.586Z' + deinstallationDateTime: '2026-06-16T17:21:25.586Z' + liveTrafficConsentProvided: true + services: + - type: XC_PATCH_EQUIPMENT + device: + cabinetUniqueSpaceId: SV2:00:000000:0100 + port: 32 + connectorType: SC + description: device description + notifications: + - type: TECHNICAL + emails: + - abc@test.com + attachments: + - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 + order: + purchaseOrder: + number: '1233' + amount: '23' + startDate: '2026-02-26' + endDate: '2027-02-26' + customerReferenceId: '12345' UpdateInformation: - $ref: "#/components/examples/UpdateInformationActionRequest" + value: + type: XC_INFORMATION_UPDATE + data: + notes: + - parentNote: + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + comments: Please proceed + attachments: + - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 required: true responses: - "202": + '202': description: Accepted. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectActionResponse" + $ref: '#/components/schemas/CrossConnectActionResponse' examples: SendSignatureQuote: - $ref: "#/components/examples/SendSignatureQuoteActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: XC_SIGNATURE_SUBMISSION + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser AcceptProposedDateTime: - $ref: "#/components/examples/AcceptProposedDateTimeActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/41dd8989-65f4-4f2b-9762-98b72465cbe5 + uuid: 41dd8989-65f4-4f2b-9762-98b72465cbe5 + type: XC_PROPOSED_DATE_TIME_ACCEPTANCE + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser RejectProposedDateTime: - $ref: "#/components/examples/RejectProposedDateTimeActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/52ee9090-76a5-4a3c-a873-a9c83576dcf6 + uuid: 52ee9090-76a5-4a3c-a873-a9c83576dcf6 + type: XC_PROPOSED_DATE_TIME_REJECTION + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser CancelCrossConnect: - $ref: "#/components/examples/CancelCrossConnectActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/63ffa1a1-87b6-4b4d-b984-bad94687edf7 + uuid: 63ffa1a1-87b6-4b4d-b984-bad94687edf7 + type: XC_CANCEL + state: PENDING + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser DeinstallCrossConnect: - $ref: "#/components/examples/DeinstallCrossConnectActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/74ffa1a1-87b6-4b4d-b984-bad94687edf8 + uuid: 74ffa1a1-87b6-4b4d-b984-bad94687edf8 + type: XC_DEINSTALL + state: PENDING + data: + attachments: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 + uuid: b41f485e-3094-42de-8797-0ef19a51df82 + attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 + schedule: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/c51f485e-3094-42de-8797-0ef19a51df83 + uuid: c51f485e-3094-42de-8797-0ef19a51df83 + type: XC_DEINSTALL_SCHEDULE + code: STANDARD + state: PENDING + requestedDateTime: '2026-06-14T17:21:25.586Z' + deinstallationDateTime: '2026-06-16T17:21:25.586Z' + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser + liveTrafficConsentProvided: true + services: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/d61f485e-3094-42de-8797-0ef19a51df84 + uuid: d61f485e-3094-42de-8797-0ef19a51df84 + type: XC_PATCH_EQUIPMENT + state: PENDING + device: + cabinetUniqueSpaceId: SV2:00:000000:0100 + port: 32 + connectorType: SC + description: device description + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser UpdateInformation: - $ref: "#/components/examples/UpdateInformationActionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/7400b2b2-98c7-4c5e-ca95-cbea5798fe08 + uuid: 7400b2b2-98c7-4c5e-ca95-cbea5798fe08 + type: XC_INFORMATION_UPDATE + state: COMPLETED + data: + notes: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + parentNote: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79 + uuid: a11f485e-3094-42de-8797-0ef19a51df79 + comments: Please proceed + attachments: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 + uuid: b41f485e-3094-42de-8797-0ef19a51df82 + attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_Action_400" - "401": + value: + - errorCode: EQ-3071104 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect Action type is not one of the allowedActions of the Cross Connect. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_Action_404" - "500": + value: + - errorCode: EQ-3071105 + errorMessage: Cross Connect Action does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect Action does not exist. Please check the Action UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/actions/{actionId}: get: tags: @@ -17211,78 +47021,214 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - name: actionId in: path description: Cross Connect Action UUID. required: true schema: - $ref: "#/components/schemas/ActionId_3" + description: Cross Connect Action UUID. + type: string + format: uuid + example: 30cc7878-54e3-4e1a-8651-87a61354bad4 responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectActionResponse" + $ref: '#/components/schemas/CrossConnectActionResponse' examples: SendSignatureQuote: - $ref: "#/components/examples/SendSignatureQuoteActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: XC_SIGNATURE_SUBMISSION + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser AcceptProposedDateTime: - $ref: "#/components/examples/AcceptProposedDateTimeActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/41dd8989-65f4-4f2b-9762-98b72465cbe5 + uuid: 41dd8989-65f4-4f2b-9762-98b72465cbe5 + type: XC_PROPOSED_DATE_TIME_ACCEPTANCE + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser RejectProposedDateTime: - $ref: "#/components/examples/RejectProposedDateTimeActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/52ee9090-76a5-4a3c-a873-a9c83576dcf6 + uuid: 52ee9090-76a5-4a3c-a873-a9c83576dcf6 + type: XC_PROPOSED_DATE_TIME_REJECTION + state: COMPLETED + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser CancelCrossConnect: - $ref: "#/components/examples/CancelCrossConnectActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/63ffa1a1-87b6-4b4d-b984-bad94687edf7 + uuid: 63ffa1a1-87b6-4b4d-b984-bad94687edf7 + type: XC_CANCEL + state: PENDING + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser DeinstallCrossConnect: - $ref: "#/components/examples/DeinstallCrossConnectActionResponse" + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/74ffa1a1-87b6-4b4d-b984-bad94687edf8 + uuid: 74ffa1a1-87b6-4b4d-b984-bad94687edf8 + type: XC_DEINSTALL + state: PENDING + data: + attachments: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 + uuid: b41f485e-3094-42de-8797-0ef19a51df82 + attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 + schedule: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/c51f485e-3094-42de-8797-0ef19a51df83 + uuid: c51f485e-3094-42de-8797-0ef19a51df83 + type: XC_DEINSTALL_SCHEDULE + code: STANDARD + state: PENDING + requestedDateTime: '2026-06-14T17:21:25.586Z' + deinstallationDateTime: '2026-06-16T17:21:25.586Z' + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser + liveTrafficConsentProvided: true + services: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/d61f485e-3094-42de-8797-0ef19a51df84 + uuid: d61f485e-3094-42de-8797-0ef19a51df84 + type: XC_PATCH_EQUIPMENT + state: PENDING + device: + cabinetUniqueSpaceId: SV2:00:000000:0100 + port: 32 + connectorType: SC + description: device description + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser + notifications: + - type: ORDERING + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: TECHNICAL + emails: + - abc@test.com + phone: + - type: MOBILE + number: '+14085551234' + contactPreference: + timezone: PST + availability: ANYTIME + - type: NOTIFICATION + emails: + - abc@test.com + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser UpdateInformation: - $ref: "#/components/examples/UpdateInformationActionResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/7400b2b2-98c7-4c5e-ca95-cbea5798fe08 + uuid: 7400b2b2-98c7-4c5e-ca95-cbea5798fe08 + type: XC_INFORMATION_UPDATE + state: COMPLETED + data: + notes: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + parentNote: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79 + uuid: a11f485e-3094-42de-8797-0ef19a51df79 + comments: Please proceed + attachments: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 + uuid: b41f485e-3094-42de-8797-0ef19a51df82 + attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_Action_400" - "401": + value: + - errorCode: EQ-3071104 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect Action type is not one of the allowedActions of the Cross Connect. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_Action_404" - "500": + value: + - errorCode: EQ-3071105 + errorMessage: Cross Connect Action does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect Action does not exist. Please check the Action UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/actions/search: post: tags: @@ -17296,71 +47242,137 @@ paths: description: Cross Connect UUID. required: true schema: - $ref: "#/components/schemas/CrossConnectId" + description: Cross Connect UUID. + type: string + format: uuid + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 requestBody: content: application/json: schema: - $ref: "#/components/schemas/CrossConnectActionSearchRequest" + $ref: '#/components/schemas/CrossConnectActionSearchRequest' examples: ActionTypeSearch: - $ref: "#/components/examples/CrossConnectActionSearchByActionType" + value: + filter: + and: + - property: /type + operator: '=' + values: + - XC_INFORMATION_UPDATE + pagination: + limit: 25 + offset: 0 + sort: + - property: /changeLog/createdDateTime + direction: DESC required: true responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/CrossConnectActionSearchResponse" + $ref: '#/components/schemas/CrossConnectActionSearchResponse' examples: CrossConnectActionSearchExample: - $ref: "#/components/examples/CrossConnectActionSearchResponse" - "400": + value: + pagination: + offset: 0 + limit: 25 + total: 1 + sort: + - property: /changeLog/createdDateTime + direction: DESC + data: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/7400b2b2-98c7-4c5e-ca95-cbea5798fe08 + uuid: 7400b2b2-98c7-4c5e-ca95-cbea5798fe08 + type: XC_INFORMATION_UPDATE + state: COMPLETED + data: + notes: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: e41f485e-3094-42de-8797-0ef19a51df79 + parentNote: + href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79 + uuid: a11f485e-3094-42de-8797-0ef19a51df79 + comments: Please proceed + attachments: + - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 + uuid: b41f485e-3094-42de-8797-0ef19a51df82 + attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 + changeLog: + createdDateTime: '2026-07-24T06:50:46Z' + createdBy: testuser + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_Action_400" - "401": + value: + - errorCode: EQ-3071104 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect Action type is not one of the allowedActions of the Cross Connect. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_Action_404" - "500": + value: + - errorCode: EQ-3071105 + errorMessage: Cross Connect Action does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect Action does not exist. Please check the Action UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnectSchedules/search: post: tags: @@ -17369,72 +47381,215 @@ paths: description: | The API provides capability to search the Cross Connect schedule windows offered at an IBX, including optional filtering, pagination and sorting. operationId: searchCrossConnectSchedules - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/CrossConnectScheduleSearchRequest" + $ref: '#/components/schemas/CrossConnectScheduleSearchRequest' examples: SearchInstallSchedules: - $ref: "#/components/examples/SearchInstallSchedulesRequest" + summary: Installation schedule windows + value: + filter: + and: + - property: /type + operator: '=' + values: + - XC_INSTALL_SCHEDULE + - property: /code + operator: IN + values: + - EXPEDITE + - FLEXIBLE + - STANDARD + - property: /aSide/location/ibxCode + operator: '=' + values: + - SV11 + - property: /zSide/location/ibxCode + operator: '=' + values: + - SV11 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /startDateTime required: true responses: - "200": + '200': description: Successful operation. content: application/json: schema: - $ref: "#/components/schemas/SearchSchedulesResponse" + $ref: '#/components/schemas/SearchSchedulesResponse' examples: SearchInstallSchedules: - $ref: "#/components/examples/SearchInstallSchedulesResponse" - "400": + summary: Installation schedule windows + value: + pagination: + offset: 0 + limit: 20 + total: 3 + data: + - href: https://api.equinix.com/fabric/v4/crossConnectSchedules/EXPEDITE + type: XC_INSTALL_SCHEDULE + code: EXPEDITE + aSide: + location: + ibxCode: SV11 + zSide: + location: + ibxCode: SV11 + startDateTime: '2026-03-05T17:00:00Z' + endDateTime: '2026-03-10T17:24:00Z' + unavailableDates: + - '2026-03-07' + - '2026-03-08' + - href: https://api.equinix.com/fabric/v4/crossConnectSchedules/STANDARD + type: XC_INSTALL_SCHEDULE + code: STANDARD + aSide: + location: + ibxCode: SV11 + zSide: + location: + ibxCode: SV11 + startDateTime: '2026-03-10T18:00:00Z' + endDateTime: '2026-04-10T17:24:00Z' + unavailableDates: + - '2026-03-27' + - '2026-03-28' + - '2026-03-29' + - href: https://api.equinix.com/fabric/v4/crossConnectSchedules/FLEXIBLE + type: XC_INSTALL_SCHEDULE + code: FLEXIBLE + aSide: + location: + ibxCode: SV11 + zSide: + location: + ibxCode: SV11 + startDateTime: '2026-04-10T18:00:00Z' + endDateTime: '2026-06-10T17:24:00Z' + unavailableDates: + - '2026-04-17' + - '2026-04-18' + - '2026-04-19' + '400': description: Bad request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_400" - "401": + value: + - errorCode: EQ-3071100 + errorMessage: Bad request. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: type + reason: Cross Connect type is required. + '401': description: Unauthorized request. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_401" - "403": + value: + - errorCode: EQ-3071101 + errorMessage: User not found in request or invalid. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + '403': description: Operation not allowed. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_403" - "404": + value: + - errorCode: EQ-3071102 + errorMessage: Operation not allowed. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: projectId + reason: User does not have access to the specified project. + '404': description: Not found. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_404" - "500": + value: + - errorCode: EQ-3071103 + errorMessage: Cross Connect does not exist. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec + additionalInfo: + - property: uuid + reason: Cross Connect does not exist. Please check Cross Connect UUID. + '500': description: Internal Server error. content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/CrossConnect_500" + value: + - errorCode: EQ-3071199 + errorMessage: Internal server error. + correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/tags: + post: + tags: + - Tags + summary: Create Tag + description: Create Tag for Equinix Fabric™ + operationId: createTag + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagRequest' + required: true + responses: + '202': + description: Successfully created tag and pending for approval + content: + application/json: + schema: + $ref: '#/components/schemas/TagResponse' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' get: tags: - Tags @@ -17463,85 +47618,41 @@ paths: description: Limit for pagination required: false schema: - maximum: 100 type: integer format: int32 default: 20 + maximum: 100 responses: - "200": + '200': description: Successful List operation content: application/json: schema: - $ref: "#/components/schemas/TagListResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - "401": - description: Unauthorized - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - "403": - description: Forbidden - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - "500": - description: Internal Server Error - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - post: - tags: - - Tags - summary: Create Tag - description: Create Tag for Equinix Fabric™ - operationId: createTag - parameters: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/TagRequest" - required: true - responses: - "202": - description: Successfully created tag and pending for approval - content: - application/json: - schema: - $ref: "#/components/schemas/TagResponse" - "400": + $ref: '#/components/schemas/TagListResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/tags/{uuid}: get: tags: @@ -17558,42 +47669,42 @@ paths: type: string format: uuid responses: - "200": + '200': description: Successful Get operation content: application/json: schema: - $ref: "#/components/schemas/TagResponse" - "400": + $ref: '#/components/schemas/TagResponse' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "401": + $ref: '#/components/schemas/ErrorList' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "403": + $ref: '#/components/schemas/ErrorList' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "404": + $ref: '#/components/schemas/ErrorList' + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" - "500": + $ref: '#/components/schemas/ErrorList' + '500': description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' /fabric/v4/appDomains: post: tags: @@ -17601,71 +47712,112 @@ paths: summary: Create Domain description: This API provides capability to create user's App Domain operationId: createAppDomain - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppDomainPostRequest" + $ref: '#/components/schemas/AppDomainPostRequest' examples: CreateAppDomain: - $ref: "#/components/examples/AppDomainCreate" + value: + type: APP_DOMAIN + name: atlassian.net + description: Atlassian Domain + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "202": + '202': description: App Domain object content: application/json: schema: - $ref: "#/components/schemas/AppDomain" + $ref: '#/components/schemas/AppDomain' examples: AppDomainResponse: - $ref: "#/components/examples/AppDomainPostResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + description: Atlassian Domain + state: PENDING_VERIFICATION + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidName: - $ref: "#/components/examples/AppDomain_400_InvalidName" - "401": + value: + - errorCode: EQ-3810022 + errorMessage: Domain name is invalid + correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e + details: Domain name is invalid + additionalInfo: + - property: /name + reason: Domain name is invalid + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_401" - "403": + value: + - errorCode: EQ-3810001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_403" - "415": + value: + - errorCode: EQ-3810002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_415" - "500": + value: + - errorCode: EQ-3810016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_500" + value: + - errorCode: EQ-3810030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appDomains/{appDomainId}: get: tags: @@ -17679,53 +47831,86 @@ paths: description: App Domain UUID required: true schema: - $ref: "#/components/schemas/AppDomainId" + description: App Domain UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: - "200": + '200': description: App Domain object content: application/json: schema: - $ref: "#/components/schemas/AppDomain" + $ref: '#/components/schemas/AppDomain' examples: AppDomainResponse: - $ref: "#/components/examples/AppDomainGetResponseExample" - "401": + value: + href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + description: Atlassian Domain + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_401" - "403": + value: + - errorCode: EQ-3810001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_403" - "404": + value: + - errorCode: EQ-3810002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_404" - "500": + value: + - errorCode: EQ-3810020 + errorMessage: App Domain not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Domain not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_500" + value: + - errorCode: EQ-3810030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error delete: tags: - Application Domains @@ -17738,62 +47923,101 @@ paths: description: App Domain UUID required: true schema: - $ref: "#/components/schemas/AppDomainId" + description: App Domain UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: - "202": + '202': description: App Domain object content: application/json: schema: - $ref: "#/components/schemas/AppDomain" + $ref: '#/components/schemas/AppDomain' examples: AppDomainResponse: - $ref: "#/components/examples/AppDomainDeleteResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + description: Atlassian Domain + state: DEPROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + deletedBy: test + deletedDateTime: '2026-06-29T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_400_InvalidState" - "401": + value: + - errorCode: EQ-3810030 + errorMessage: Cannot delete App Domain in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot delete App Domain in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_401" - "403": + value: + - errorCode: EQ-3810001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_403" - "404": + value: + - errorCode: EQ-3810002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_404" - "500": + value: + - errorCode: EQ-3810020 + errorMessage: App Domain not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Domain not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_500" + value: + - errorCode: EQ-3810030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error patch: tags: - Application Domains @@ -17806,80 +48030,133 @@ paths: description: App Domain UUID required: true schema: - $ref: "#/components/schemas/AppDomainId" + description: App Domain UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/AppDomainUpdateRequest" + $ref: '#/components/schemas/AppDomainUpdateRequest' examples: UpdateDescription: - $ref: "#/components/examples/AppDomainUpdateDescription" + value: + - op: replace + path: /description + value: Updated Atlassian Domain required: true responses: - "202": + '202': description: App Domain object content: application/json: schema: - $ref: "#/components/schemas/AppDomain" + $ref: '#/components/schemas/AppDomain' examples: AppDomainResponse: - $ref: "#/components/examples/AppDomainPatchResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + description: Updated Atlassian Domain + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + change: + uuid: 531c4ab5-43b0-4352-8975-ee9045325841 + type: APP_DOMAIN_UPDATE + status: REQUESTED + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedDateTime: '2026-06-28T04:20:55.471Z' + data: + - op: replace + path: /description + value: Updated Atlassian Domain + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_400_InvalidOperation" - "401": + value: + - errorCode: EQ-3810022 + errorMessage: Invalid Argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_403" - "404": + value: + - errorCode: EQ-3810002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_404" - "415": + value: + - errorCode: EQ-3810020 + errorMessage: App Domain not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Domain not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_415" - "500": + value: + - errorCode: EQ-3810016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_500" + value: + - errorCode: EQ-3810030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appDomains/search: post: tags: @@ -17887,75 +48164,156 @@ paths: summary: Search Domains description: The API provides capability to get list of user's App Domains using search criteria, including optional filtering, pagination and sorting operationId: searchAppDomains - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppDomainSearchRequest" + $ref: '#/components/schemas/AppDomainSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/AppDomainSearchFilterByStatus" + value: + filter: + and: + - property: /state + operator: '=' + values: + - PROVISIONED + - property: /project/projectId + operator: IN + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterByName: - $ref: "#/components/examples/AppDomainSearchFilterByName" + value: + filter: + and: + - property: /name + operator: '=' + values: + - test- + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterOrAnd: - $ref: "#/components/examples/AppDomainSearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /name + operator: LIKE + values: + - abc% + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppDomainSearchResponse" + $ref: '#/components/schemas/AppDomainSearchResponse' examples: Example: - $ref: "#/components/examples/AppDomainSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + description: Atlassian Domain + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3810039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_401" - "403": + value: + - errorCode: EQ-3810001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_403" - "415": + value: + - errorCode: EQ-3810002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_415" - "500": + value: + - errorCode: EQ-3810016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_500" + value: + - errorCode: EQ-3810030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appDomains/{appDomainId}/appLinks: get: tags: @@ -17969,7 +48327,10 @@ paths: description: App Domain UUID required: true schema: - $ref: "#/components/schemas/AppDomainId" + description: App Domain UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - name: offset in: query description: offset @@ -17991,74 +48352,116 @@ paths: style: form explode: false schema: - $ref: "#/components/schemas/AttachedAppLinkState" + $ref: '#/components/schemas/AttachedAppLinkState' - name: order in: query description: Sort order for attached App Links. required: false schema: - $ref: "#/components/schemas/AttachedAppLinkOrder" + $ref: '#/components/schemas/AttachedAppLinkOrder' - name: style in: query description: Detail level of the response. required: false schema: - $ref: "#/components/schemas/Style" + $ref: '#/components/schemas/Style' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppDomainAttachedAppLinks" + $ref: '#/components/schemas/AppDomainAttachedAppLinks' examples: Example: - $ref: "#/components/examples/AppDomainAttachedAppLinksGetResponseExample" - "400": + value: + pagination: + limit: 20 + offset: 0 + total: 1 + data: + - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + type: APP_LINK + uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + name: Atlassian App Link + description: Atlassian App Link in SV + state: PROVISIONED + router: + href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + type: XF_ROUTER + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + bandwidth: 1000 + ipv4Subnet: 192.168.10.0/29 + ipv4Address: 192.168.10.3 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3810039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_401" - "403": + value: + - errorCode: EQ-3810001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_403" - "404": + value: + - errorCode: EQ-3810002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_404" - "500": + value: + - errorCode: EQ-3810020 + errorMessage: App Domain not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Domain not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppDomain_500" + value: + - errorCode: EQ-3810030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks: post: tags: @@ -18066,71 +48469,123 @@ paths: summary: Create Link description: This API provides capability to create user's Link operationId: createAppLink - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppLinkPostRequest" + $ref: '#/components/schemas/AppLinkPostRequest' examples: CreateAppLink: - $ref: "#/components/examples/AppLinkCreate" + value: + type: APP_LINK + name: Atlassian App Link + description: Atlassian App Link in SV + router: + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + ipv4Subnet: 192.168.10.0/29 + bandwidth: 1000 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "202": + '202': description: App Link object content: application/json: schema: - $ref: "#/components/schemas/AppLink" + $ref: '#/components/schemas/AppLink' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkPostResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + type: APP_LINK + name: Atlassian App Link + description: Atlassian App Link in SV + state: PROVISIONING + router: + href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + type: XF_ROUTER + ipv4Subnet: 192.168.10.0/29 + ipv4Address: 192.168.10.3 + bandwidth: 1000 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidName: - $ref: "#/components/examples/AppLink_400_InvalidName" - "401": + value: + - errorCode: EQ-3820022 + errorMessage: Name is minimum 0 and up to 50 characters in length + correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e + details: Name is minimum 0 and up to 50 characters in length + additionalInfo: + - property: /name + reason: Name is minimum 0 and up to 50 characters in length + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "415": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}: get: tags: @@ -18144,53 +48599,93 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 responses: - "200": + '200': description: App Link object content: application/json: schema: - $ref: "#/components/schemas/AppLink" + $ref: '#/components/schemas/AppLink' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkGetResponseExample" - "401": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + type: APP_LINK + name: Atlassian App Link + description: Atlassian App Link in SV + state: PROVISIONED + router: + href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + type: XF_ROUTER + ipv4Subnet: 192.168.10.0/29 + ipv4Address: 192.168.10.3 + bandwidth: 1000 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error delete: tags: - Application Links @@ -18203,62 +48698,108 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 responses: - "202": + '202': description: App Link object content: application/json: schema: - $ref: "#/components/schemas/AppLink" + $ref: '#/components/schemas/AppLink' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkDeleteResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + type: APP_LINK + name: Atlassian App Link + description: Atlassian App Link in SV + state: DEPROVISIONING + router: + href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + type: XF_ROUTER + ipv4Subnet: 192.168.10.0/29 + ipv4Address: 192.168.10.3 + bandwidth: 1000 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + deletedBy: test + deletedDateTime: '2026-06-29T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidState" - "401": + value: + - errorCode: EQ-3820030 + errorMessage: Cannot delete App Link in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot delete App Link in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error patch: tags: - Application Links @@ -18271,80 +48812,140 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/AppLinkUpdateRequest" + $ref: '#/components/schemas/AppLinkUpdateRequest' examples: UpdateName: - $ref: "#/components/examples/AppLinkUpdateName" + value: + - op: replace + path: /name + value: Updated Atlassian App Link required: true responses: - "202": + '202': description: App Link object content: application/json: schema: - $ref: "#/components/schemas/AppLink" + $ref: '#/components/schemas/AppLink' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkPatchResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + type: APP_LINK + name: Updated Atlassian App Link + description: Atlassian App Link in SV + state: REPROVISIONING + router: + href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + type: XF_ROUTER + ipv4Subnet: 192.168.10.0/29 + ipv4Address: 192.168.10.3 + bandwidth: 1000 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + change: + uuid: 531c4ab5-43b0-4352-8975-ee9045325841 + type: APP_LINK_UPDATE + status: REQUESTED + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedDateTime: '2026-06-28T04:20:55.471Z' + data: + - op: replace + path: /name + value: Updated Atlassian App Link + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidOperation" - "401": + value: + - errorCode: EQ-3040054 + errorMessage: Invalid Argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "415": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/search: post: tags: @@ -18352,289 +48953,484 @@ paths: summary: Search Links description: The API provides capability to get list of user's App Links using search criteria, including optional filtering, pagination and sorting operationId: searchAppLinks - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppLinkSearchRequest" + $ref: '#/components/schemas/AppLinkSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/AppLinkSearchFilterByStatus" + value: + filter: + and: + - property: /state + operator: '=' + values: + - PROVISIONED + - property: /project/projectId + operator: IN + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterByName: - $ref: "#/components/examples/AppLinkSearchFilterByName" + value: + filter: + and: + - property: /name + operator: '=' + values: + - test- + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterOrAnd: - $ref: "#/components/examples/AppLinkSearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /name + operator: LIKE + values: + - abc% + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppLinkSearchResponse" + $ref: '#/components/schemas/AppLinkSearchResponse' examples: Example: - $ref: "#/components/examples/AppLinkSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + type: APP_LINK + name: Atlassian App Link + description: Atlassian App Link in SV + state: PROVISIONED + router: + href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + type: XF_ROUTER + ipv4Subnet: 192.168.10.0/29 + ipv4Address: 192.168.10.3 + bandwidth: 1000 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3820039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "415": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appDomains/{appDomainId}: - get: + put: tags: - Application Links - summary: Get Attached Domain for Link - description: This API provides ability to retrieve an App Domain attached to an App Link - operationId: getAttachedAppDomainByUuid + summary: Attach Domain to Link + description: This API provides ability to attach the user's App Domain to App Link + operationId: attachAppDomainToAppLink parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appDomainId in: path description: App Domain UUID required: true schema: - $ref: "#/components/schemas/AppDomainId" + description: App Domain UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: - "200": - description: Attached App Domain object + '202': + description: Attach App Domain object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppDomainAttachment" + $ref: '#/components/schemas/AppLinkAppDomainAttachment' examples: - AppLinkDomainResponse: - $ref: "#/components/examples/AppLinkAttachDomainResponse" - "401": + AppLinkAttachDomainResponse: + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + attachmentStatus: ATTACHING + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-27T04:20:55.471Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3820030 + errorMessage: Cannot perform attach or detach operation in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot perform attach or detach operation in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" - put: + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error + delete: tags: - Application Links - summary: Attach Domain to Link - description: This API provides ability to attach the user's App Domain to App Link - operationId: attachAppDomainToAppLink + summary: Detach Domain from Link + description: This API provides ability to detach App Domain from App Link + operationId: detachAppDomainFromAppLink parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appDomainId in: path description: App Domain UUID required: true schema: - $ref: "#/components/schemas/AppDomainId" + description: App Domain UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: - "202": - description: Attach App Domain object + '202': + description: Detach App Domain object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppDomainAttachment" + $ref: '#/components/schemas/AppLinkAppDomainAttachment' examples: - AppLinkAttachDomainResponse: - $ref: "#/components/examples/AppLinkAttachDomainAttachResponse" - "400": + AppLinkDetachDomainResponse: + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + attachmentStatus: DETACHING + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidAttachState" - "401": + value: + - errorCode: EQ-3820030 + errorMessage: Cannot perform attach or detach operation in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot perform attach or detach operation in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" - delete: + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error + get: tags: - Application Links - summary: Detach Domain from Link - description: This API provides ability to detach App Domain from App Link - operationId: detachAppDomainFromAppLink + summary: Get Attached Domain for Link + description: This API provides ability to retrieve an App Domain attached to an App Link + operationId: getAttachedAppDomainByUuid parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appDomainId in: path description: App Domain UUID required: true schema: - $ref: "#/components/schemas/AppDomainId" + description: App Domain UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: - "202": - description: Detach App Domain object - content: - application/json: - schema: - $ref: "#/components/schemas/AppLinkAppDomainAttachment" - examples: - AppLinkDetachDomainResponse: - $ref: "#/components/examples/AppLinkAttachDomainDetachResponse" - "400": - description: Bad request + '200': + description: Attached App Domain object content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/AppLinkAppDomainAttachment' examples: - example: - $ref: "#/components/examples/AppLink_400_InvalidAttachState" - "401": + AppLinkDomainResponse: + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + attachmentStatus: ATTACHED + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appDomains/search: post: tags: @@ -18648,73 +49444,131 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachDomainSearchRequest" + $ref: '#/components/schemas/AppLinkAttachDomainSearchRequest' examples: SearchAttachedDomainFilterByStatus: - $ref: "#/components/examples/AppLinkAttachDomainSearchFilterByStatus" + value: + filter: + and: + - property: /attachmentStatus + operator: '=' + values: + - ATTACHED + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchAttachedDomainFilterOrAnd: - $ref: "#/components/examples/AppLinkAttachDomainSearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /uuid + operator: '=' + values: + - 20f3ef8e-d670-4236-86fa-bb0038adcfc3 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachDomainSearchResponse" + $ref: '#/components/schemas/AppLinkAttachDomainSearchResponse' examples: Example: - $ref: "#/components/examples/AppLinkAttachDomainSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + attachmentStatus: ATTACHED + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3820039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "415": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appDomains: get: tags: @@ -18728,7 +49582,10 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: offset in: query description: offset @@ -18750,380 +49607,585 @@ paths: style: form explode: false schema: - $ref: "#/components/schemas/AttachedAppDomainAttachmentStatus" + $ref: '#/components/schemas/AttachedAppDomainAttachmentStatus' - name: order in: query description: Sort order for attached App Domains. required: false schema: - $ref: "#/components/schemas/AttachedAppDomainOrder" + $ref: '#/components/schemas/AttachedAppDomainOrder' - name: style in: query description: Detail level of the response. required: false schema: - $ref: "#/components/schemas/Style" + $ref: '#/components/schemas/Style' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachedAppDomains" + $ref: '#/components/schemas/AppLinkAttachedAppDomains' examples: Example: - $ref: "#/components/examples/AppLinkAttachDomainGetExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_DOMAIN + name: atlassian.net + description: Atlassian Domain + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + attachmentStatus: ATTACHED + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3820039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appServices/{appServiceId}: - get: + put: tags: - Application Links - summary: Get Attached Service for Link - description: This API provides ability to retrieve an App Service attached to an App Link - operationId: getAttachedAppServiceByUuid + summary: Attach Service to Link + description: This API provides ability to attach the user's App Service to App Link + operationId: attachAppServiceToAppLink parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appServiceId in: path description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppLinkAttachServiceRequest' + examples: + AttachAppLinkToService: + value: + geoScope: GLOBAL + destinationIp: 10.10.1.110 + required: true responses: - "200": - description: Attached App Service object + '202': + description: Attach App Service object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppServiceAttachment" + $ref: '#/components/schemas/AppLinkAppServiceAttachment' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkAttachServiceResponse" - "401": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + geoScope: GLOBAL + destinationIp: 10.10.1.110 + attachmentStatus: ATTACHING + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-27T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" - put: + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error + delete: tags: - Application Links - summary: Attach Service to Link - description: This API provides ability to attach the user's App Service to App Link - operationId: attachAppServiceToAppLink + summary: Detach Service from Link + description: This API provides ability to detach App Service from App Link + operationId: detachAppServiceFromAppLink parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appServiceId in: path description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AppLinkAttachServiceRequest" - examples: - AttachAppLinkToService: - $ref: "#/components/examples/AppLinkAttachService" - required: true + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": - description: Attach App Service object + '202': + description: Detach App Service object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppServiceAttachment" + $ref: '#/components/schemas/AppLinkAppServiceAttachment' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkAttachServiceAttachResponse" - "401": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + geoScope: GLOBAL + destinationIp: 10.10.1.110 + attachmentStatus: DETACHING + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3820030 + errorMessage: Cannot delete App Link in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot delete App Link in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" - delete: + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error + patch: tags: - Application Links - summary: Detach Service from Link - description: This API provides ability to detach App Service from App Link - operationId: detachAppServiceFromAppLink + summary: Update Service Attachment for Link + description: This API provides ability to update the App Service attachment to App Link + operationId: updateAppServiceAttachmentToAppLink parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appServiceId in: path description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/AppLinkAttachServiceUpdateRequest' + examples: + UpdateDestinationIp: + value: + - op: replace + path: /destinationIp + value: 10.10.1.120 + required: true responses: - "202": - description: Detach App Service object + '202': + description: Update App Service attachment object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppServiceAttachment" + $ref: '#/components/schemas/AppLinkAppServiceAttachment' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkAttachServiceDetachResponse" - "400": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + geoScope: GLOBAL + destinationIp: 10.10.1.120 + attachmentStatus: ATTACHING + change: + uuid: 531c4ab5-43b0-4352-8975-ee9045325841 + type: APP_SERVICE_UPDATE + status: REQUESTED + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedDateTime: '2026-06-27T04:20:55.471Z' + data: + - op: replace + path: /destinationIp + value: 10.10.1.120 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-27T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidState" - "401": + value: + - errorCode: EQ-3040054 + errorMessage: Invalid Argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" - patch: + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error + get: tags: - Application Links - summary: Update Service Attachment for Link - description: This API provides ability to update the App Service attachment to App Link - operationId: updateAppServiceAttachmentToAppLink + summary: Get Attached Service for Link + description: This API provides ability to retrieve an App Service attached to an App Link + operationId: getAttachedAppServiceByUuid parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appServiceId in: path description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" - requestBody: - content: - application/json-patch+json: - schema: - $ref: "#/components/schemas/AppLinkAttachServiceUpdateRequest" - examples: - UpdateDestinationIp: - $ref: "#/components/examples/AppLinkAttachServicePatchDestinationIp" - required: true + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": - description: Update App Service attachment object + '200': + description: Attached App Service object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppServiceAttachment" + $ref: '#/components/schemas/AppLinkAppServiceAttachment' examples: AppLinkResponse: - $ref: "#/components/examples/AppLinkAttachServicePatchResponse" - "400": - description: Bad request - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/AppLink_400_InvalidOperation" - "401": + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + geoScope: GLOBAL + destinationIp: 10.10.1.110 + attachmentStatus: ATTACHED + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "415": - description: Unsupported Media Type - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appServices/search: post: tags: @@ -19137,73 +50199,132 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachServiceSearchRequest" + $ref: '#/components/schemas/AppLinkAttachServiceSearchRequest' examples: SearchAttachedServiceFilterByStatus: - $ref: "#/components/examples/AppLinkAttachServiceSearchFilterByStatus" + value: + filter: + and: + - property: /attachmentStatus + operator: '=' + values: + - ATTACHED + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchAttachedServiceFilterOrAnd: - $ref: "#/components/examples/AppLinkAttachServiceSearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /uuid + operator: '=' + values: + - 20f3ef8e-d670-4236-86fa-bb0038adcfc3 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachServiceSearchResponse" + $ref: '#/components/schemas/AppLinkAttachServiceSearchResponse' examples: Example: - $ref: "#/components/examples/AppLinkAttachServiceSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + geoScope: GLOBAL + destinationIp: 10.10.1.110 + attachmentStatus: ATTACHED + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3820039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "415": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appServices: get: tags: @@ -19217,7 +50338,10 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: offset in: query description: offset @@ -19239,306 +50363,471 @@ paths: style: form explode: false schema: - $ref: "#/components/schemas/AttachedAppServiceAttachmentStatus" + $ref: '#/components/schemas/AttachedAppServiceAttachmentStatus' - name: order in: query description: Sort order for attached App Services. required: false schema: - $ref: "#/components/schemas/AttachedAppServiceOrder" + $ref: '#/components/schemas/AttachedAppServiceOrder' - name: style in: query description: Detail level of the response. required: false schema: - $ref: "#/components/schemas/Style" + $ref: '#/components/schemas/Style' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachedAppServices" + $ref: '#/components/schemas/AppLinkAttachedAppServices' examples: Example: - $ref: "#/components/examples/AppLinkAttachServiceGetExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + name: Atlassian App Service + description: Atlassian App Service in SV + state: PROVISIONED + endpoint: equinixjira.atlassian.net + sourceDomains: + - equinix.com + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + geoScope: GLOBAL + destinationIp: 10.10.1.110 + attachmentStatus: ATTACHED + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3820039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appProcessors/{appProcessorId}: - get: + put: tags: - Application Links - summary: Get attached App Processor for App Link - description: This API provides ability to get an App Processor attached to an App Link. - operationId: getAttachedAppProcessor + summary: Attach Processor to Link + description: This API provides ability to attach an App Processor to an App Link. + operationId: attachAppProcessorToAppLink parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appProcessorId in: path description: App Processor UUID required: true schema: - $ref: "#/components/schemas/AppProcessorId" + description: App Processor UUID + type: string + format: uuid + example: 90ee425c-9988-454c-96d9-1128bc16350f + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppLinkAttachProcessorRequest' + examples: + AttachAppProcessorToAppLink: + value: + config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... + required: true responses: - "200": - description: App Processor attachment object + '202': + description: Attach App Processor object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppProcessorAttachment" + $ref: '#/components/schemas/AppLinkAppProcessorAttachment' examples: - AppLinkAttachProcessorGetResponse: - $ref: "#/components/examples/AppLinkAttachProcessorGetResponse" - "401": + AppLinkAttachProcessorResponse: + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + uuid: 90ee425c-9988-454c-96d9-1128bc16350f + type: APP_PROCESSOR + config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... + endpoint: 123456.privateai.link + attachmentStatus: ATTACHING + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-27T04:20:55.471Z' + '400': + description: Bad request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3820030 + errorMessage: Cannot perform attach or detach operation in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot perform attach or detach operation in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' + examples: + example: + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" - put: + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error + delete: tags: - Application Links - summary: Attach Processor to Link - description: This API provides ability to attach an App Processor to an App Link. - operationId: attachAppProcessorToAppLink + summary: Detach App Processor from App Link + description: This API provides ability to detach an App Processor from an App Link. + operationId: detachAppProcessorFromAppLink parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appProcessorId in: path description: App Processor UUID required: true schema: - $ref: "#/components/schemas/AppProcessorId" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AppLinkAttachProcessorRequest" - examples: - AttachAppProcessorToAppLink: - $ref: "#/components/examples/AppLinkAttachProcessor" - required: true + description: App Processor UUID + type: string + format: uuid + example: 90ee425c-9988-454c-96d9-1128bc16350f responses: - "202": - description: Attach App Processor object + '202': + description: Detach App Processor object content: application/json: schema: - $ref: "#/components/schemas/AppLinkAppProcessorAttachment" + $ref: '#/components/schemas/AppLinkAppProcessorAttachment' examples: - AppLinkAttachProcessorResponse: - $ref: "#/components/examples/AppLinkAttachProcessorAttachResponse" - "400": + AppLinkDetachProcessorResponse: + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + uuid: 90ee425c-9988-454c-96d9-1128bc16350f + type: APP_PROCESSOR + config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... + endpoint: 123456.privateai.link + attachmentStatus: DETACHING + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidAttachState" - "401": + value: + - errorCode: EQ-3820030 + errorMessage: Cannot perform attach or detach operation in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot perform attach or detach operation in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "415": - description: Unsupported Media Type - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorList" - examples: - example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" - delete: + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error + get: tags: - Application Links - summary: Detach App Processor from App Link - description: This API provides ability to detach an App Processor from an App Link. - operationId: detachAppProcessorFromAppLink + summary: Get attached App Processor for App Link + description: This API provides ability to get an App Processor attached to an App Link. + operationId: getAttachedAppProcessor parameters: - name: appLinkId in: path description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: appProcessorId in: path description: App Processor UUID required: true schema: - $ref: "#/components/schemas/AppProcessorId" + description: App Processor UUID + type: string + format: uuid + example: 90ee425c-9988-454c-96d9-1128bc16350f responses: - "202": - description: Detach App Processor object - content: - application/json: - schema: - $ref: "#/components/schemas/AppLinkAppProcessorAttachment" - examples: - AppLinkDetachProcessorResponse: - $ref: "#/components/examples/AppLinkAttachProcessorDetachResponse" - "400": - description: Bad request + '200': + description: App Processor attachment object content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/AppLinkAppProcessorAttachment' examples: - example: - $ref: "#/components/examples/AppLink_400_InvalidAttachState" - "401": + AppLinkAttachProcessorGetResponse: + value: + href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + uuid: 90ee425c-9988-454c-96d9-1128bc16350f + type: APP_PROCESSOR + config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... + endpoint: 123456.privateai.link + attachmentStatus: ATTACHED + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appProcessors/search: post: tags: @@ -19552,71 +50841,123 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachProcessorSearchRequest" + $ref: '#/components/schemas/AppLinkAttachProcessorSearchRequest' examples: SearchAttachedProcessorFilterByStatus: - $ref: "#/components/examples/AppLinkAttachProcessorSearchFilterByStatus" + value: + filter: + and: + - property: /attachmentStatus + operator: '=' + values: + - ATTACHED + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachProcessorSearchResponse" + $ref: '#/components/schemas/AppLinkAttachProcessorSearchResponse' examples: Example: - $ref: "#/components/examples/AppLinkAttachProcessorSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + uuid: 90ee425c-9988-454c-96d9-1128bc16350f + type: APP_PROCESSOR + config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... + endpoint: 123456.privateai.link + attachmentStatus: ATTACHED + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3820039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "415": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_415" - "500": + value: + - errorCode: EQ-3820016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appProcessors: get: tags: @@ -19630,7 +50971,10 @@ paths: description: App Link UUID required: true schema: - $ref: "#/components/schemas/AppLinkId" + description: App Link UUID + type: string + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: offset in: query description: offset @@ -19652,74 +50996,114 @@ paths: style: form explode: false schema: - $ref: "#/components/schemas/AttachedAppProcessorAttachmentStatus" + $ref: '#/components/schemas/AttachedAppProcessorAttachmentStatus' - name: order in: query description: Sort order for attached App Processors. required: false schema: - $ref: "#/components/schemas/AttachedAppProcessorOrder" + $ref: '#/components/schemas/AttachedAppProcessorOrder' - name: style in: query description: Detail level of the response. required: false schema: - $ref: "#/components/schemas/Style" + $ref: '#/components/schemas/Style' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppLinkAttachedAppProcessors" + $ref: '#/components/schemas/AppLinkAttachedAppProcessors' examples: Example: - $ref: "#/components/examples/AppLinkAttachProcessorListExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /appProcessors?offset=1&limit=20 + previous: /appProcessors?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + uuid: 90ee425c-9988-454c-96d9-1128bc16350f + type: APP_PROCESSOR + attachmentStatus: ATTACHED + config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... + endpoint: 123456.privateai.link + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3820039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_401" - "403": + value: + - errorCode: EQ-3820001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_403" - "404": + value: + - errorCode: EQ-3820002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_404" - "500": + value: + - errorCode: EQ-3820020 + errorMessage: AppLink not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppLink not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppLink_500" + value: + - errorCode: EQ-3820030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appProcessors/{appProcessorId}: get: tags: @@ -19733,53 +51117,89 @@ paths: description: App Processor UUID required: true schema: - $ref: "#/components/schemas/AppProcessorId" + description: App Processor UUID + type: string + format: uuid + example: 90ee425c-9988-454c-96d9-1128bc16350f responses: - "200": + '200': description: App Processor object content: application/json: schema: - $ref: "#/components/schemas/AppProcessor" + $ref: '#/components/schemas/AppProcessor' examples: AppProcessorResponse: - $ref: "#/components/examples/AppProcessorGetResponseExample" - "401": + value: + href: https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + uuid: 90ee425c-9988-454c-96d9-1128bc16350f + type: APP_PROCESSOR + name: agent-gateway + description: llm-routing, a2a-routing, mcp-routing + registryId: agentgateway/agentgateway:1.3.0 + marketplace: + visibility: PUBLIC + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-09-08T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-09-08T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_401" - "403": + value: + - errorCode: EQ-3850001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_403" - "404": + value: + - errorCode: EQ-3850002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_404" - "500": + value: + - errorCode: EQ-3850020 + errorMessage: AppProcessor not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: AppProcessor not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_500" + value: + - errorCode: EQ-3850030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appProcessors/search: post: tags: @@ -19787,75 +51207,159 @@ paths: summary: Search Processors description: The API provides capability to get list of user's App Processors using search criteria, including optional filtering, pagination and sorting operationId: searchAppProcessors - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppProcessorSearchRequest" + $ref: '#/components/schemas/AppProcessorSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/AppProcessorSearchFilterByStatus" + value: + filter: + and: + - property: /state + operator: '=' + values: + - PROVISIONED + - property: /project/projectId + operator: IN + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterByName: - $ref: "#/components/examples/AppProcessorSearchFilterByName" + value: + filter: + and: + - property: /name + operator: '=' + values: + - agent- + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterOrAnd: - $ref: "#/components/examples/AppProcessorSearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /name + operator: LIKE + values: + - agent% + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppProcessorSearchResponse" + $ref: '#/components/schemas/AppProcessorSearchResponse' examples: Example: - $ref: "#/components/examples/AppProcessorSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + uuid: 90ee425c-9988-454c-96d9-1128bc16350f + type: APP_PROCESSOR + name: agent-gateway + description: llm-routing, a2a-routing, mcp-routing + registryId: agentgateway/agentgateway:1.3.0 + marketplace: + visibility: PUBLIC + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3850039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_401" - "403": + value: + - errorCode: EQ-3850001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_403" - "415": + value: + - errorCode: EQ-3850002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_415" - "500": + value: + - errorCode: EQ-3850016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppProcessor_500" + value: + - errorCode: EQ-3850030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appServices: post: tags: @@ -19863,71 +51367,118 @@ paths: summary: Create Service description: This API provides capability to create user's Service operationId: createAppService - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppServicePostRequest" + $ref: '#/components/schemas/AppServicePostRequest' examples: CreateAppService: - $ref: "#/components/examples/AppServiceCreate" + value: + type: APP_SERVICE + name: Atlassian App Service + description: Atlassian App Service in SV + endpoint: equinixjira.atlassian.net + sourceDomains: + - equinix.com + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "202": + '202': description: App Service object content: application/json: schema: - $ref: "#/components/schemas/AppService" + $ref: '#/components/schemas/AppService' examples: AppServiceResponse: - $ref: "#/components/examples/AppServicePostResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + name: Atlassian App Service + description: Atlassian App Service in SV + state: PROVISIONING + endpoint: equinixjira.atlassian.net + sourceDomains: + - equinix.com + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: InvalidName: - $ref: "#/components/examples/AppService_400_InvalidName" - "401": + value: + - errorCode: EQ-3830022 + errorMessage: Name is minimum 0 and up to 50 characters in length + correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e + details: Name is minimum 0 and up to 50 characters in length + additionalInfo: + - property: /name + reason: Name is minimum 0 and up to 50 characters in length + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_401" - "403": + value: + - errorCode: EQ-3830001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "415": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_415" - "500": + value: + - errorCode: EQ-3830016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appServices/{appServiceId}: get: tags: @@ -19941,53 +51492,91 @@ paths: description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "200": + '200': description: App Service object content: application/json: schema: - $ref: "#/components/schemas/AppService" + $ref: '#/components/schemas/AppService' examples: AppServiceResponse: - $ref: "#/components/examples/AppServiceGetResponseExample" - "401": + value: + href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + name: Atlassian App Service + description: Atlassian App Service in SV + state: PROVISIONED + endpoint: equinixjira.atlassian.net + sourceDomains: + - equinix.com + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + account: + organizationName: atlassian + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_401" - "403": + value: + - errorCode: EQ-3830001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "404": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_404" - "500": + value: + - errorCode: EQ-3830020 + errorMessage: App Service not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Service not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error delete: tags: - Application Services @@ -20000,62 +51589,104 @@ paths: description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: - "202": + '202': description: App Service object content: application/json: schema: - $ref: "#/components/schemas/AppService" + $ref: '#/components/schemas/AppService' examples: AppServiceResponse: - $ref: "#/components/examples/AppServiceDeleteResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + name: Atlassian App Service + description: Atlassian App Service in SV + state: DEPROVISIONING + endpoint: equinixjira.atlassian.net + sourceDomains: + - equinix.com + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + deletedBy: test + deletedDateTime: '2026-06-29T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_400_InvalidState" - "401": + value: + - errorCode: EQ-3830030 + errorMessage: Cannot delete App Service in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot delete App Service in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_401" - "403": + value: + - errorCode: EQ-3830001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "404": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_404" - "500": + value: + - errorCode: EQ-3830020 + errorMessage: App Service not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Service not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error patch: tags: - Application Services @@ -20068,80 +51699,136 @@ paths: description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/AppServiceUpdateRequest" + $ref: '#/components/schemas/AppServiceUpdateRequest' examples: UpdateName: - $ref: "#/components/examples/AppServiceUpdateName" + value: + - op: replace + path: /name + value: Updated Atlassian App Service required: true responses: - "202": + '202': description: App Service object content: application/json: schema: - $ref: "#/components/schemas/AppService" + $ref: '#/components/schemas/AppService' examples: AppServiceResponse: - $ref: "#/components/examples/AppServicePatchResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + name: Updated Atlassian App Service + description: Atlassian App Service in SV + state: REPROVISIONING + endpoint: equinixjira.atlassian.net + sourceDomains: + - equinix.com + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + change: + uuid: 531c4ab5-43b0-4352-8975-ee9045325841 + type: APP_SERVICE_UPDATE + status: REQUESTED + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedDateTime: '2026-06-28T04:20:55.471Z' + data: + - op: replace + path: /name + value: Updated Atlassian App Service + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_400_InvalidOperation" - "401": + value: + - errorCode: EQ-3040054 + errorMessage: Invalid Argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "404": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_404" - "415": + value: + - errorCode: EQ-3830020 + errorMessage: App Service not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Service not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_415" - "500": + value: + - errorCode: EQ-3830016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appServices/search: post: tags: @@ -20149,75 +51836,161 @@ paths: summary: Search Services description: The API provides capability to get list of user's App Services using search criteria, including optional filtering, pagination and sorting operationId: searchAppServices - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppServiceSearchRequest" + $ref: '#/components/schemas/AppServiceSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/AppServiceSearchFilterByStatus" + value: + filter: + and: + - property: /state + operator: '=' + values: + - PROVISIONED + - property: /project/projectId + operator: IN + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterByName: - $ref: "#/components/examples/AppServiceSearchFilterByName" + value: + filter: + and: + - property: /name + operator: '=' + values: + - test- + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterOrAnd: - $ref: "#/components/examples/AppServiceSearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /name + operator: LIKE + values: + - abc% + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppServiceSearchResponse" + $ref: '#/components/schemas/AppServiceSearchResponse' examples: Example: - $ref: "#/components/examples/AppServiceSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 + type: APP_SERVICE + name: Atlassian App Service + description: Atlassian App Service in SV + state: PROVISIONED + endpoint: equinixjira.atlassian.net + sourceDomains: + - equinix.com + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + account: + organizationName: atlassian + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3830039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_401" - "403": + value: + - errorCode: EQ-3830001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "415": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_415" - "500": + value: + - errorCode: EQ-3830016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appServices/{appServiceId}/appLinks: get: tags: @@ -20231,7 +52004,10 @@ paths: description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: offset in: query description: offset @@ -20253,74 +52029,116 @@ paths: style: form explode: false schema: - $ref: "#/components/schemas/AttachedAppLinkState_1" + $ref: '#/components/schemas/AttachedAppLinkState' - name: order in: query description: Sort order for attached App Links. required: false schema: - $ref: "#/components/schemas/AttachedAppLinkOrder" + $ref: '#/components/schemas/AttachedAppLinkOrder' - name: style in: query description: Detail level of the response. required: false schema: - $ref: "#/components/schemas/Style" + $ref: '#/components/schemas/Style' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppServiceAttachedAppLinks" + $ref: '#/components/schemas/AppServiceAttachedAppLinks' examples: Example: - $ref: "#/components/examples/AppServiceAttachedAppLinksGetResponseExample" - "400": + value: + pagination: + limit: 20 + offset: 0 + total: 1 + data: + - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + type: APP_LINK + uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + name: Atlassian App Link + description: Atlassian App Link in SV + state: PROVISIONED + router: + href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + type: XF_ROUTER + uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 + bandwidth: 1000 + ipv4Subnet: 192.168.10.0/29 + ipv4Address: 192.168.10.3 + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3830039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_401" - "403": + value: + - errorCode: EQ-3830001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "404": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_404" - "500": + value: + - errorCode: EQ-3830020 + errorMessage: App Service not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Service not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appServices/{appServiceId}/appSubscriptions: get: tags: @@ -20334,7 +52152,10 @@ paths: description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: offset in: query description: offset @@ -20356,74 +52177,107 @@ paths: style: form explode: false schema: - $ref: "#/components/schemas/AttachedAppSubscriptionState" + $ref: '#/components/schemas/AttachedAppSubscriptionState' - name: order in: query description: Sort order for attached App Subscriptions. required: false schema: - $ref: "#/components/schemas/AttachedAppSubscriptionOrder" + $ref: '#/components/schemas/AttachedAppSubscriptionOrder' - name: style in: query description: Detail level of the response. required: false schema: - $ref: "#/components/schemas/Style" + $ref: '#/components/schemas/Style' responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptions" + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptions' examples: Example: - $ref: "#/components/examples/AppServiceAttachedAppSubscriptionsGetResponseExample" - "400": + value: + pagination: + limit: 20 + offset: 0 + total: 1 + data: + - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_SUBSCRIPTION + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + state: PROVISIONED + account: + organizationName: equinix + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3830039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_401" - "403": + value: + - errorCode: EQ-3830001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "404": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_404" - "500": + value: + - errorCode: EQ-3830020 + errorMessage: App Service not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Service not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appServices/{appServiceId}/appSubscriptions/search: post: tags: @@ -20437,68 +52291,106 @@ paths: description: App Service UUID required: true schema: - $ref: "#/components/schemas/AppServiceId" + description: App Service UUID + type: string + format: uuid + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionSearchRequest" + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSearchRequest' required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionSearchResponse" + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSearchResponse' examples: Example: - $ref: "#/components/examples/AppServiceAttachedAppSubscriptionSearchExample" - "400": + value: + pagination: + limit: 20 + offset: 0 + total: 1 + data: + - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_SUBSCRIPTION + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + state: PROVISIONED + account: + organizationName: equinix + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3830039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_401" - "403": + value: + - errorCode: EQ-3830001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_403" - "415": + value: + - errorCode: EQ-3830002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_415" - "500": + value: + - errorCode: EQ-3830016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppService_500" + value: + - errorCode: EQ-3830030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appSubscriptions: post: tags: @@ -20506,62 +52398,112 @@ paths: summary: Create Subscription description: This API provides capability to create user's Subscription operationId: createAppSubscription - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppSubscriptionPostRequest" + $ref: '#/components/schemas/AppSubscriptionPostRequest' examples: CreateAppSubscription: - $ref: "#/components/examples/AppSubscriptionCreate" + value: + type: APP_SUBSCRIPTION + source: + appLink: + uuid: e32c9c7a-0149-4582-8345-192b82aef972 + ipSubnets: + - 192.168.100.0/24 + target: + appService: + uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d + geoScope: GLOBAL + prioritization: LATENCY + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "202": + '202': description: App Subscription object content: application/json: schema: - $ref: "#/components/schemas/AppSubscription" + $ref: '#/components/schemas/AppSubscription' examples: AppSubscriptionResponse: - $ref: "#/components/examples/AppSubscriptionPostResponseExample" - "401": + value: + href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_SUBSCRIPTION + source: + appLink: + uuid: e32c9c7a-0149-4582-8345-192b82aef972 + ipSubnets: + - 192.168.100.0/24 + target: + appService: + uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d + geoScope: GLOBAL + prioritization: LATENCY + state: PROVISIONING + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_401" - "403": + value: + - errorCode: EQ-3840001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_403" - "415": + value: + - errorCode: EQ-3840002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_415" - "500": + value: + - errorCode: EQ-3840016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_500" + value: + - errorCode: EQ-3840030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appSubscriptions/{appSubscriptionId}: get: tags: @@ -20575,53 +52517,94 @@ paths: description: App Subscription UUID required: true schema: - $ref: "#/components/schemas/AppSubscriptionId" + description: App Subscription UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: - "200": + '200': description: App Subscription object content: application/json: schema: - $ref: "#/components/schemas/AppSubscription" + $ref: '#/components/schemas/AppSubscription' examples: AppSubscriptionResponse: - $ref: "#/components/examples/AppSubscriptionGetResponseExample" - "401": + value: + href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_SUBSCRIPTION + source: + appLink: + uuid: e32c9c7a-0149-4582-8345-192b82aef972 + ipSubnets: + - 192.168.100.0/24 + target: + appService: + uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d + geoScope: GLOBAL + prioritization: LATENCY + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_401" - "403": + value: + - errorCode: EQ-3840001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_403" - "404": + value: + - errorCode: EQ-3840002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_404" - "500": + value: + - errorCode: EQ-3840020 + errorMessage: App Subscription not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_500" + value: + - errorCode: EQ-3840030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error delete: tags: - Application Subscriptions @@ -20634,62 +52617,109 @@ paths: description: App Subscription UUID required: true schema: - $ref: "#/components/schemas/AppSubscriptionId" + description: App Subscription UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: - "202": + '202': description: App Subscription object content: application/json: schema: - $ref: "#/components/schemas/AppSubscription" + $ref: '#/components/schemas/AppSubscription' examples: AppSubscriptionResponse: - $ref: "#/components/examples/AppSubscriptionDeleteResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_SUBSCRIPTION + source: + appLink: + uuid: e32c9c7a-0149-4582-8345-192b82aef972 + ipSubnets: + - 192.168.100.0/24 + target: + appService: + uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d + geoScope: GLOBAL + prioritization: LATENCY + state: DEPROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + deletedBy: test + deletedDateTime: '2026-06-29T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_400_InvalidState" - "401": + value: + - errorCode: EQ-3840030 + errorMessage: Cannot delete App Subscription in transient state + correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff + details: Cannot delete App Subscription in transient state. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_401" - "403": + value: + - errorCode: EQ-3840001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_403" - "404": + value: + - errorCode: EQ-3840002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_404" - "500": + value: + - errorCode: EQ-3840020 + errorMessage: App Subscription not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Subscription not found or already deleted + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_500" + value: + - errorCode: EQ-3840030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error patch: tags: - Application Subscriptions @@ -20702,80 +52732,144 @@ paths: description: App Subscription UUID required: true schema: - $ref: "#/components/schemas/AppSubscriptionId" + description: App Subscription UUID + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 requestBody: content: application/json-patch+json: schema: - $ref: "#/components/schemas/AppSubscriptionUpdateRequest" + $ref: '#/components/schemas/AppSubscriptionUpdateRequest' examples: UpdateSourceIpSubnets: - $ref: "#/components/examples/AppSubscriptionUpdateSourceIpSubnets" + value: + - op: add + path: /source/ipSubnets + value: + - 192.168.200.0/24 required: true responses: - "202": + '202': description: App Subscription object content: application/json: schema: - $ref: "#/components/schemas/AppSubscription" + $ref: '#/components/schemas/AppSubscription' examples: AppSubscriptionResponse: - $ref: "#/components/examples/AppSubscriptionPatchResponseExample" - "400": + value: + href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_SUBSCRIPTION + source: + appLink: + uuid: e32c9c7a-0149-4582-8345-192b82aef972 + ipSubnets: + - 192.168.100.0/24 + - 192.168.200.0/24 + target: + appService: + uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d + geoScope: GLOBAL + prioritization: LATENCY + state: PROVISIONING + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + change: + uuid: 531c4ab5-43b0-4352-8975-ee9045325841 + type: APP_SUBSCRIPTION_UPDATE + status: REQUESTED + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedDateTime: '2026-06-28T04:20:55.471Z' + data: + - op: add + path: /source/ipSubnets + value: + - 192.168.200.0/24 + changeLog: + createdBy: test + createdDateTime: '2026-06-27T04:20:55.471Z' + updatedBy: test + updatedDateTime: '2026-06-28T04:20:55.471Z' + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_400_InvalidOperation" - "401": + value: + - errorCode: EQ-3040054 + errorMessage: Invalid Argument passed + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/401" - "403": + value: + - errorCode: EQ-3000039 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_403" - "404": + value: + - errorCode: EQ-3840002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_404" - "415": + value: + - errorCode: EQ-3840020 + errorMessage: App Subscription not found or already deleted + correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 + details: App Subscription not found or already deleted + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_415" - "500": + value: + - errorCode: EQ-3840016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_500" + value: + - errorCode: EQ-3840030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error /fabric/v4/appSubscriptions/search: post: tags: @@ -20783,82 +52877,613 @@ paths: summary: Search Subscriptions description: The API provides capability to get list of user's App Subscriptions using search criteria, including optional filtering, pagination and sorting operationId: searchAppSubscriptions - parameters: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/AppSubscriptionSearchRequest" + $ref: '#/components/schemas/AppSubscriptionSearchRequest' examples: SearchFilterByStatus: - $ref: "#/components/examples/AppSubscriptionSearchFilterByStatus" + value: + filter: + and: + - property: /state + operator: IN + values: + - PROVISIONED + - property: /project/projectId + operator: IN + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + pagination: + offset: 0 + limit: 20 + sort: + - direction: DESC + property: /changeLog/createdDateTime SearchFilterOrAnd: - $ref: "#/components/examples/AppSubscriptionSearchFilterOrAnd" + value: + filter: + and: + - or: + - property: /uuid + operator: '=' + values: + - 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + - property: /project/projectId + operator: '=' + values: + - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: - "200": + '200': description: Successful operation content: application/json: schema: - $ref: "#/components/schemas/AppSubscriptionSearchResponse" + $ref: '#/components/schemas/AppSubscriptionSearchResponse' examples: Example: - $ref: "#/components/examples/AppSubscriptionSearchExample" - "400": + value: + pagination: + offset: 0 + limit: 20 + total: 1 + next: /search?offset=1&limit=20 + previous: /search?offset=0&limit=20 + data: + - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + type: APP_SUBSCRIPTION + source: + appLink: + uuid: e32c9c7a-0149-4582-8345-192b82aef972 + ipSubnets: + - 192.168.100.0/24 + target: + appService: + uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d + geoScope: GLOBAL + prioritization: LATENCY + state: PROVISIONED + project: + projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 + '400': description: Bad request content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_400_InvalidSorting" - "401": + value: + - errorCode: EQ-3840039 + errorMessage: Invalid value for sorting direction. + correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 + additionalInfo: + - reason: Only accept DESC and ASC for sorting direction. + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_401" - "403": + value: + - errorCode: EQ-3840001 + errorMessage: User not found in request or invalid. + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - reason: You are unauthorized to perform this operation + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_403" - "415": + value: + - errorCode: EQ-3840002 + errorMessage: Operation not allowed + correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd + details: Operation not allowed for current user + '415': description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_415" - "500": + value: + - errorCode: EQ-3840016 + errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding + correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 + additionalInfo: + - property: contentType + reason: The payload format is in an unsupported format + '500': description: Internal server error content: application/json: schema: - $ref: "#/components/schemas/ErrorList" + $ref: '#/components/schemas/ErrorList' examples: example: - $ref: "#/components/examples/AppSubscription_500" + value: + - errorCode: EQ-3840030 + errorMessage: Internal Server Error + correlationId: f9018571-1001-4422-978b-bfa38ed6b92e + details: Internal Server Error components: + securitySchemes: + BearerAuth: + type: http + scheme: bearer + bearerFormat: JWT schemas: + Project: + type: object + properties: + projectId: + description: Subscriber-assigned project ID + type: string + example: 44f4c4f8-2f39-494e-838c-d8e640591be5 + required: + - projectId + AsnRirRegion: + type: string + description: Regional Internet Registry region + enum: + - AFRINIC + - APNIC + - ARIN + - LACNIC + - RIPE_NCC + AsnOwnershipChallengeDetails: + type: object + description: Ownership challenge details for public ASN verification + required: + - type + properties: + type: + $ref: '#/components/schemas/AsnOwnershipChallengeType' + discriminator: + propertyName: type + mapping: + RPKI: '#/components/schemas/AsnOwnershipChallengeRpki' + LOA: '#/components/schemas/AsnOwnershipChallengeLoa' + AsnOwnershipChallengeRpki: + allOf: + - $ref: '#/components/schemas/AsnOwnershipChallengeDetails' + - type: object + properties: + message: + type: string + description: Challenge message to sign + example: eqx-rpki-challenge-2026-04-21T11:20:00Z-64497 + signature: + type: string + description: Signed challenge value + example: MEUCIQCrExampleBase64SignatureValue7h4Yg== + AsnOwnershipChallengeLoa: + allOf: + - $ref: '#/components/schemas/AsnOwnershipChallengeDetails' + - type: object + properties: + contentFormat: + type: string + description: Document content format + example: pdf + documentReference: + type: string + description: Document reference identifier + example: loa-2026-00019 + AsnOwnershipChallengeType: + type: string + description: Type of ownership challenge + enum: + - RPKI + - LOA + x-enum-varnames: + - RPKI + - LOA + 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: + deprecated: true + type: string + example: AM1 + AsnRange: + type: string + description: ASN range selection + enum: + - 16_BIT + - 32_BIT + CreateAsnRequest: + type: object + description: Create ASN request body + required: + - project + - type + properties: + project: + $ref: '#/components/schemas/Project' + number: + type: integer + format: int64 + description: ASN number used for public ASN creation. + example: 64497 + rirRegion: + $ref: '#/components/schemas/AsnRirRegion' + ownershipChallengeDetails: + $ref: '#/components/schemas/AsnOwnershipChallengeDetails' + location: + $ref: '#/components/schemas/SimplifiedLocation' + range: + $ref: '#/components/schemas/AsnRange' + AsnState: + type: string + description: ASN lifecycle state + enum: + - REQUESTED + - PROVISIONING + - PENDING + - PROVISIONED + - ATTACHED + - FAILED + - PROVISIONING_FAILED + - DEPROVISIONING + - DEPROVISIONING_FAILED + - DEPROVISIONED + x-enum-varnames: + - REQUESTED + - PROVISIONING + - PENDING + - PROVISIONED + - ATTACHED + - FAILED + - PROVISIONING_FAILED + - DEPROVISIONING + - DEPROVISIONING_FAILED + - DEPROVISIONED + AsnChange: + type: object + description: Change reference for ASN + properties: + href: + type: string + description: URL path to the change event + example: /cloudEvents + AsnAssetService: + type: object + description: Associated Internet Access Service reference + properties: + href: + type: string + type: + type: string + enum: + - IA + uuid: + type: string + example: 52fbdb3f-8def-410d-868b-ef920878bff8 + AsnAssetIpBlockRef: + type: object + properties: + href: + type: string + type: + type: string + enum: + - IPV4_IP_BLOCK + - IPV6_IP_BLOCK + uuid: + type: string + example: 129afa61-f706-41cb-a03a-69a276bdb0b4 + Changelog: + description: Change log + type: object + properties: + createdBy: + type: string + example: johnsmith + description: Created by User Key + createdByFullName: + type: string + example: John Smith + description: Created by User Full Name + createdByEmail: + type: string + example: john.smith@example.com + description: Created by User Email Address + createdDateTime: + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + description: Created by Date and Time + updatedBy: + type: string + example: johnsmith + description: Updated by User Key + updatedByFullName: + type: string + example: John Smith + description: Updated by User Full Name + updatedByEmail: + type: string + example: john.smith@example.com + description: Updated by User Email Address + updatedDateTime: + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + description: Updated by Date and Time + deletedBy: + type: string + example: johnsmith + description: Deleted by User Key + deletedByFullName: + type: string + example: John Smith + description: Deleted by User Full Name + deletedByEmail: + type: string + example: john.smith@example.com + description: Deleted by User Email Address + deletedDateTime: + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + description: Deleted by Date and Time + AsnAsset: + type: object + description: Asset associated with ASN + properties: + uuid: + type: string + example: 52fbdb3f-8def-410d-868b-ef920878bff8 + service: + $ref: '#/components/schemas/AsnAssetService' + announcingMetro: + type: string + example: LD + ipBlocks: + type: array + items: + $ref: '#/components/schemas/AsnAssetIpBlockRef' + changeLog: + $ref: '#/components/schemas/Changelog' + Error: + description: Error Response with details + required: + - errorCode + - errorMessage + type: object + properties: + errorCode: + type: string + pattern: ^EQ-\d{7}$ + errorMessage: + type: string + correlationId: + type: string + details: + type: string + help: + type: string + additionalInfo: + type: array + items: + type: object + properties: + property: + type: string + reason: + type: string + Asn: + type: object + description: ASN Record + properties: + href: + type: string + uuid: + type: string + format: uuid + description: Unique identifier for the ASN record + example: 6db706f8-2a37-4546-a3ed-1df113a84d43 + state: + $ref: '#/components/schemas/AsnState' + project: + $ref: '#/components/schemas/Project' + number: + type: integer + format: int64 + description: Autonomous System Number + example: 64497 + rirRegion: + $ref: '#/components/schemas/AsnRirRegion' + location: + $ref: '#/components/schemas/SimplifiedLocation' + range: + $ref: '#/components/schemas/AsnRange' + ownershipChallengeDetails: + $ref: '#/components/schemas/AsnOwnershipChallengeDetails' + change: + $ref: '#/components/schemas/AsnChange' + assets: + type: array + items: + $ref: '#/components/schemas/AsnAsset' + errors: + type: array + items: + $ref: '#/components/schemas/Error' + description: List of errors + changeLog: + $ref: '#/components/schemas/Changelog' ErrorList: - type: array description: List of Error Message + type: array + items: + $ref: '#/components/schemas/Error' + PaginationRequest: + description: Pagination request information + type: object + properties: + offset: + type: integer + description: Index of the first element. + minimum: 0 + default: 0 + limit: + type: integer + description: Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + minimum: 1 + default: 20 + 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' + AsnSearchSortCriteria: + type: object + properties: + direction: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + property: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + AsnSearchRequestBody: + type: object + properties: + pagination: + $ref: '#/components/schemas/PaginationRequest' + filter: + $ref: '#/components/schemas/SearchExpression' + sort: + type: array + items: + $ref: '#/components/schemas/AsnSearchSortCriteria' + Pagination: + description: Pagination response information + type: object + properties: + offset: + type: integer + description: Index of the first item returned in the response. The default is 0. + minimum: 0 + default: 0 + limit: + type: integer + description: Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20. + minimum: 0 + default: 20 + total: + type: integer + description: Total number of elements returned. + minimum: 0 + 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. + required: + - limit + - total + AsnSearchResponseBody: + type: object + required: + - pagination + - data + properties: + pagination: + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/AsnSearchSortCriteria' + data: + type: array + items: + $ref: '#/components/schemas/Asn' + AsnPatchOperation: + type: object + required: + - op + - path + - value + properties: + op: + type: string + description: JSON Patch operation + enum: + - add + - remove + - replace + path: + type: string + description: JSON Pointer to the field to update + example: /ownershipChallengeDetails/signature + value: + description: New value for add or replace operations + example: MEUCIQCrExampleBase64SignatureValue7h4Yg== + AsnPatchRequest: + type: array items: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/AsnPatchOperation' CloudEventAssetType: - type: string enum: - ports - connections @@ -20870,132 +53495,158 @@ components: - organizations - timeServices - companyProfiles - AssetId: type: string - description: Asset UUID - format: uuid - example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 StartDateTime: - type: string description: Start date and time + type: string format: date-time - example: 2024-07-11T18:06:21Z + example: '2024-07-11T18:06:21.000Z' EndDateTime: - type: string description: End date and time + type: string format: date-time - example: 2024-07-11T18:06:21Z + example: '2024-07-11T18:06:21.000Z' Offset: - type: integer description: Pagination offset - example: 0 + type: integer default: 0 + example: 0 Limit: - type: integer description: Pagination limit - example: 20 + type: integer default: 100 - GetCloudEventsByAssetResponse: + example: 20 + OperationalStatus: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/CloudEvent" - CloudEventId: - type: string - description: Cloud Event UUID - format: uuid - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + operationalStatus: + description: Operational status for the resource target of the event + type: string + ResourceData: + type: object + properties: + href: + description: Cloud Event asset href + type: string + uuid: + description: Cloud Event asset uuid + type: string + type: + description: Cloud Event asset type + type: string + name: + description: Cloud Event asset name + type: string + state: + description: Cloud Event asset state + type: string + operation: + $ref: '#/components/schemas/OperationalStatus' + AuthContext: + type: object + properties: + authtype: + description: Cloud Event auth type + type: string + enum: + - system + - user + authid: + description: Cloud Event auth identifier + type: string + enum: + - equinix + - userId + name: + description: Cloud Event username + type: string + email: + description: Cloud Event email + type: string + CloudEventData: + type: object + properties: + message: + description: Cloud Event message + type: string + resource: + $ref: '#/components/schemas/ResourceData' + auth: + $ref: '#/components/schemas/AuthContext' CloudEvent: + description: Cloud Event object type: object properties: specversion: - type: string description: Cloud Event Open Telemetry specification + type: string readOnly: true source: - type: string description: Cloud Event source - id: type: string + id: description: Cloud Event identifier + type: string format: uuid type: - type: string description: Equinix supported event type - subject: type: string + subject: description: Cloud Event subject - time: type: string + time: description: Cloud Event time the event occurred + type: string format: date-time dataschema: - type: string description: Cloud Event dataschema reference - datacontenttype: type: string + datacontenttype: description: Cloud Event data content type - severitynumber: type: string + severitynumber: description: Cloud Event severity number - severitytext: type: string + severitytext: description: Cloud Event severity text - equinixalert: type: string + equinixalert: description: Equinix alert - equinixorganization: type: string + equinixorganization: description: Equinix organization identifier - equinixproject: type: string + equinixproject: description: Equinix project identifier - authtype: type: string + authtype: description: Cloud Event auth type - authid: type: string + authid: description: Cloud Event user identifier - traceparent: type: string + traceparent: description: Cloud Event traceparent - tracestate: type: string + tracestate: description: Cloud Event tracestate + type: string data: - $ref: "#/components/schemas/CloudEventData" - description: Cloud Event object - CloudEventSearchRequest: - required: - - filter + $ref: '#/components/schemas/CloudEventData' + GetCloudEventsByAssetResponse: type: object properties: - filter: - $ref: "#/components/schemas/CloudEventFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" - description: Search requests containing criteria - CloudEventFilters: - type: object - properties: - and: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. type: array items: - $ref: "#/components/schemas/CloudEventFilter" - CloudEventFilter: - type: object - anyOf: - - $ref: "#/components/schemas/CloudEventSimpleExpression" + $ref: '#/components/schemas/CloudEvent' CloudEventSimpleExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: * `/id` - Cloud Event identifier @@ -21008,9 +53659,9 @@ components: * `/severitytext` - cloud event severity text * `/authid` - Equinix user key to identify the user that performed the action that triggered the Cloud Event * `/authtype` - Equinix user type either user or system + type: string example: /subject operator: - type: string description: | Possible operators to use on filters: * `=` - equal @@ -21025,126 +53676,180 @@ components: * `ILIKE` - like case-insensitive * `IS NULL` - is null * `IS NOT NULL` - is not null - example: = + type: string + example: '=' values: type: array items: type: string example: equinix.fabric.port.status.* - LiveEventSearchRequest: + CloudEventFilter: type: object - properties: - filter: - $ref: "#/components/schemas/LiveEventFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - description: Search requests containing criteria - LiveEventFilters: + anyOf: + - $ref: '#/components/schemas/CloudEventSimpleExpression' + CloudEventFilters: type: object properties: and: type: array items: - $ref: "#/components/schemas/LiveEventFilter" - LiveEventFilter: + $ref: '#/components/schemas/CloudEventFilter' + CloudEventSearchRequest: type: object - anyOf: - - $ref: "#/components/schemas/LiveEventSimpleExpression" + description: Search requests containing criteria + required: + - filter + properties: + filter: + $ref: '#/components/schemas/CloudEventFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' LiveEventSimpleExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: * `/subject` - Cloud Event subject description + type: string example: /subject operator: - type: string description: | Possible operators to use on filters: * `=` - equal * `IN` - in - example: = + type: string + example: '=' values: type: array items: type: string + LiveEventFilter: + type: object + anyOf: + - $ref: '#/components/schemas/LiveEventSimpleExpression' + LiveEventFilters: + type: object + properties: + and: + type: array + items: + $ref: '#/components/schemas/LiveEventFilter' + LiveEventSearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/LiveEventFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' SearchLiveEventResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: - type: array description: Data returned from the API call. + type: array items: - $ref: "#/components/schemas/CloudEvent" + $ref: '#/components/schemas/CloudEvent' MetricAssetType: - type: string enum: - ports - connections - metros - Limit_1: - type: integer + type: string + Limit-2: description: Pagination limit - example: 20 + type: integer default: 20 + example: 20 + Metric: + description: Metric object + type: object + properties: + type: + description: Equinix supported metric type + type: string + name: + description: Metric name + type: string + unit: + description: Metric unit + type: string + interval: + description: Metric interval (set automatically based on search range) + type: string + resource: + description: Metric resource + type: object + properties: + href: + description: Metric resource href + type: string + uuid: + description: Metric resource UUID + type: string + type: + description: Metric resource type + type: string + state: + description: Metric resource state + type: string + name: + description: Metric resource name + type: string + description: + description: Metric resource description + type: string + summary: + description: Metric summary + type: string + datapoints: + description: Metric data points + type: array + items: + type: object + properties: + endDateTime: + description: Datapoint end date and time + type: string + format: date-time + startDateTime: + description: Datapoint start date and time + type: string + format: date-time + value: + description: Datapoint value + type: number GetMetricsByAssetResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: - type: array description: Data returned from the API call. + type: array items: - $ref: "#/components/schemas/Metric" - PortUUID: - type: string - description: Port UUID - format: uuid + $ref: '#/components/schemas/Metric' Value: - type: string description: Which value to retrieve + type: string example: last GetMetricsByNameResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: - type: array description: Data returned from the API call. - items: - $ref: "#/components/schemas/Metric" - MetricsSearchRequest: - required: - - filter - type: object - properties: - filter: - $ref: "#/components/schemas/MetricFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - description: Search requests containing criteria - MetricFilters: - type: object - properties: - and: type: array items: - $ref: "#/components/schemas/MetricFilter" - MetricFilter: - type: object - anyOf: - - $ref: "#/components/schemas/MetricSimpleExpression" + $ref: '#/components/schemas/Metric' MetricSimpleExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: * `/subject` - Metric subject description (required and limited to 1 value) @@ -21153,9 +53858,9 @@ components: * `/time` - Time of Metrics * `/interval` - ISO-8601 duration format to specify the interval of metrics data points * `/value` - specific data points of the metric to return (e.g. 'last' - for metros only) + type: string example: /subject operator: - type: string description: | Possible operators to use on filters: * `=` - equal @@ -21165,14703 +53870,13892 @@ components: * `<=` - less than or equal to * `BETWEEN` - between * `IN` - in - example: = + type: string + example: '=' values: type: array items: type: string example: equinix.fabric.port.bandwidth_rx.usage - ConnectionPostRequest: - required: - - aSide - - bandwidth - - name - - notifications - - type - - zSide + MetricFilter: + type: object + anyOf: + - $ref: '#/components/schemas/MetricSimpleExpression' + MetricFilters: 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: 100000 - 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: + and: 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: + $ref: '#/components/schemas/MetricFilter' + MetricsSearchRequest: + type: object + description: Search requests containing criteria required: - - aSide - - bandwidth - - name - - type - - zSide + - filter + properties: + filter: + $ref: '#/components/schemas/MetricFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + ConnectionType: + description: Connection type + type: string + enum: + - EVPL_VC + - EPL_VC + - EC_VC + - IP_VC + - ACCESS_EPL_VC + - EIA_VC + - EVPLAN_VC + - EPLAN_VC + - EVPTREE_VC + - EPTREE_VC + - IPWAN_VC + - IA_VC + - MC_VC + - IX_VC + - GW_VC + - IPX_VC + Order: type: object properties: - href: + purchaseOrderNumber: + description: Purchase order number type: string - description: Connection URI - format: uri - readOnly: true - type: - $ref: "#/components/schemas/ConnectionType" - uuid: + customerReferenceNumber: + description: Customer reference number type: string - description: Equinix-assigned connection identifier - name: + billingTier: + description: Billing tier for connection bandwidth type: string - description: Customer-provided connection name - description: + orderId: + description: Order Identification 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 + orderNumber: + description: Order Reference Number + type: string + termLength: + description: Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case). + default: 1 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 + minimum: 1 + maximum: 60 + contractedBandwidth: + description: Contracted bandwidth + type: integer + ContactPreference: + description: Contact preference for the phone number type: object properties: - type: - $ref: "#/components/schemas/Actions" - description: + timezone: + description: Timezone of the contact preference type: string - description: Connection rejection reason detail - data: - $ref: "#/components/schemas/ConnectionAcceptanceData" - description: Connection action request - ConnectionAction: - required: - - data - - type - - uuid + availability: + description: Availability of the contact preference + type: string + enum: + - WORK_HOURS + - ANYTIME + Phone: 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 - state: + description: Notification Type type: string - description: Connection action response state enum: - - SUCCEEDED - description: + - MOBILE + - OFFICE + example: MOBILE + number: + description: Phone number 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: + pattern: ^\+[1-9]\d{1,14}$ + contactPreference: + $ref: '#/components/schemas/ContactPreference' + SimplifiedNotification: type: object properties: - property: + type: + description: Notification Type 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: + enum: + - NOTIFICATION + - BANDWIDTH_ALERT + - CONNECTION_APPROVAL + - PROFILE_LIFECYCLE + - ALL + - SALES_REP_NOTIFICATIONS + - TECHNICAL + - ORDERING + - QUOTE_NOTIFICATIONS + example: BANDWIDTH_ALERT + sendInterval: 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: + emails: + description: Array of contact emails 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: + format: email + registeredUsers: + description: Array of registered users 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: string + phone: + description: Array of contact phone numbers type: array - description: List of Routing Protocols items: - $ref: "#/components/schemas/RoutingProtocolData" - RoutingProtocolBase: - required: - - type - type: object - properties: - type: - type: string - description: Routing protocol type - enum: - - BGP - - DIRECT - oneOf: - - $ref: "#/components/schemas/RoutingProtocolBGPType" - - $ref: "#/components/schemas/RoutingProtocolDirectType" - RoutingProtocolBGPType: + $ref: '#/components/schemas/Phone' required: - type + - emails + GeoScopeType: + description: Geographic boundary types + type: string + enum: + - CANADA + - CONUS + - JAPAN + - UK + - AUSTRALIA + - BRAZIL + - SWITZERLAND + - EU + ConnectionPriority: + description: Connection priority in redundancy group + type: string + enum: + - PRIMARY + - SECONDARY + ConnectionRedundancy: + description: Connection redundancy configuration type: object properties: - type: + group: + description: Redundancy group identifier (UUID of primary connection) type: string - description: Routing protocol type - enum: - - BGP + priority: + $ref: '#/components/schemas/ConnectionPriority' name: + description: Customer-provided name for the redundancy group 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 - bgpAuthKey: + description: + description: Customer-provided description for the redundancy group type: string - description: BGP authorization key - asOverrideEnabled: - type: boolean - description: Enable AS number override - bfd: - $ref: "#/components/schemas/RoutingProtocolBFD" - RoutingProtocolDirectType: - required: - - type + ServiceTokenType: + description: Type of Service Token + type: string + enum: + - VC_TOKEN + - EPL_TOKEN + SimplifiedMetadataEntity: + description: Configuration details for port used at the access point. type: object properties: - type: + href: type: string - description: Routing protocol type - enum: - - DIRECT - name: + format: uri + description: url to entity + uuid: + description: Equinix assigned Identifier type: string - example: My-direct-route-1 - directIpv4: - $ref: "#/components/schemas/DirectConnectionIpv4" - directIpv6: - $ref: "#/components/schemas/DirectConnectionIpv6" - RoutingProtocolData: - type: object - properties: + format: uuid type: + description: Type of Port 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: + cvpId: + description: Customer virtual port Id + type: integer + bandwidth: + description: Port Bandwidth + type: number + portName: + description: Port Name + type: string + encapsulationProtocolType: + description: Port Encapsulation + type: string + accountName: + description: Account Name + type: string + priority: + description: Port Priority + type: string + location: + $ref: '#/components/schemas/SimplifiedLocation' + LinkProtocolType: + description: Type of Link Protocol 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: + enum: + - UNTAGGED + - DOT1Q + - QINQ + - EVPN_VXLAN + - VXLAN + SimplifiedLinkProtocol: + description: Connection link protocol Configuration 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: + $ref: '#/components/schemas/LinkProtocolType' + vlanTag: + description: vlanTag value specified for DOT1Q connections + type: integer + minimum: 2 + maximum: 4092 + vlanSTag: + description: vlanSTag value specified for QINQ connections + type: integer + minimum: 2 + maximum: 4092 + vlanCTag: + description: vlanCTag value specified for QINQ connections + type: integer + minimum: 2 + maximum: 4092 + SimplifiedAccount: type: object properties: - type: - $ref: "#/components/schemas/BGPActions" - description: BGP action request - BGPActionData: + accountNumber: + description: Account number + type: integer + format: int64 + accountName: + description: Account name + type: string + orgId: + description: Customer organization identifier + type: integer + format: int64 + organizationName: + description: Customer organization name + type: string + globalOrgId: + description: Global organization identifier + type: string + globalOrganizationName: + description: Global organization name + type: string + ucmId: + description: Account ucmId + type: string + globalCustId: + description: Account name + type: string + deprecated: true + resellerAccountNumber: + description: Reseller account number + type: integer + format: int64 + resellerAccountName: + description: Reseller account name + type: string + resellerUcmId: + description: Reseller account ucmId + type: string + resellerOrgId: + description: Reseller customer organization identifier + type: integer + format: int64 + SimplifiedVirtualDevice: 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 + description: url to entity uuid: + description: Network Edge assigned Virtual Device Identifier type: string - description: Routing protocol identifier format: uuid - example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + name: + description: Customer-assigned Virtual Device name + type: string type: - $ref: "#/components/schemas/BGPActions" - description: + description: Type of Virtual Device 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: + enum: + - EDGE + account: + $ref: '#/components/schemas/SimplifiedAccount' + cluster: + description: Virtual Device Cluster Information + type: string + VirtualDeviceInterface: + description: Virtual Device Interface Information type: object properties: - status: + type: + description: Type of interface type: string - description: Current outcome of the change flow enum: - - COMPLETED - - FAILED - - REQUESTED - createdBy: + - NETWORK + id: + description: Network Edge assigned identifier + type: integer + uuid: + description: Interface identifier type: string - description: Created by User Key - createdDateTime: + format: uuid + SimplifiedTokenNetwork: + type: object + properties: + href: type: string - description: Set when change flow starts - format: date-time - updatedBy: + format: uri + description: url to entity + uuid: + description: Network Identifier type: string - description: Updated by User Key - updatedDateTime: + format: uuid + type: + description: Type of Network type: string - description: Set when change object is updated - format: date-time - information: + enum: + - EVPLAN + - EPLAN + - IPWAN + - EVPTREE + - EPTREE + name: + description: Network Name type: string - description: Additional information - data: - $ref: "#/components/schemas/RoutingProtocolChangeOperation" - description: Current state of latest Routing Protocol change - allOf: - - $ref: "#/components/schemas/RoutingProtocolChange" - RoutingProtocolChangeDataResponse: + scope: + description: scope of Network + type: string + enum: + - LOCAL + - REGIONAL + - GLOBAL + location: + $ref: '#/components/schemas/SimplifiedLocation' + AccessPointSelector: + description: List of criteria for selecting network access points with optimal efficiency, security, compatibility, and availability. type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + type: + description: Type of Access point + type: string + enum: + - COLO + - VD + - NETWORK + hideAssetInfo: + deprecated: true + type: boolean + 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' + ServiceTokenSide: + description: Connection link protocol,virtual device or network configuration + type: object + properties: + accessPointSelectors: + description: List of AccessPointSelectors type: array items: - $ref: "#/components/schemas/RoutingProtocolChangeData" - description: List of network changes - ExchangeServiceCreateRequest: - required: - - name - - publicPeeringConnection - - routingProtocol - - type + $ref: '#/components/schemas/AccessPointSelector' + ServiceTokenConnection: + description: Service Token Connection Type Information type: object properties: type: + description: Type of Connection type: string - description: Internet Exchange Service type - example: IX enum: - - IX - name: - maxLength: 50 - minLength: 1 + - EVPL_VC + - EPL_VC + - EVPLAN_VC + - EPLAN_VC + - IPWAN_VC + - IP_VC + - EVPTREE_VC + - EPTREE_VC + href: + description: An absolute URL that is the subject of the link's context. type: string - description: Customer-provided internet exchange service name - example: ix_exchange_service - description: - maxLength: 255 - minLength: 1 + format: uri + readOnly: true + uuid: + description: Equinix-assigned connection identifier type: string - description: Customer-provided internet exchange service description - example: ix_exchange_service - publicPeeringConnection: - $ref: "#/components/schemas/PublicPeeringConnectionRequest" - routingProtocol: - $ref: "#/components/schemas/RoutingProtocolRequest" - order: - $ref: "#/components/schemas/ExchangeServiceOrder" - project: - $ref: "#/components/schemas/Project" - account: - $ref: "#/components/schemas/SimplifiedAccount" - notifications: + format: uuid + allowRemoteConnection: + description: Authorization to connect remotely + type: boolean + default: false + allowCustomBandwidth: + description: Allow custom bandwidth value + type: boolean + default: false + bandwidthLimit: + description: Connection bandwidth limit in Mbps + type: integer + minimum: 0 + maximum: 100000 + supportedBandwidths: + description: List of permitted bandwidths. type: array - description: Preferences for notifications on Internet Exchange Service configuration or status changes items: - $ref: "#/components/schemas/ExchangeServiceNotification" - ExchangeServiceResponse: + type: integer + aSide: + $ref: '#/components/schemas/ServiceTokenSide' + zSide: + $ref: '#/components/schemas/ServiceTokenSide' + ServiceTokenState: + description: Service token state + type: string + enum: + - ACTIVE + - INACTIVE + - EXPIRED + - DELETED + ServiceToken: + 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. type: object properties: + type: + $ref: '#/components/schemas/ServiceTokenType' href: + description: An absolute URL that is the subject of the link's context. type: string - description: Internet Exchange Service URI - example: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 + format: uri + readOnly: true + expiry: + deprecated: true + type: integer uuid: + description: Equinix-assigned service token identifier type: string - description: Internet Exchange Service identifier format: uuid - example: a8ba52de-faae-43b5-b0b1-6904d37ee011 - type: + issuerSide: + deprecated: true + description: information about token side type: string - description: Internet Exchange Service Type - example: IX - default: IX - enum: - - IX name: + description: Customer-provided service token name type: string - description: Name - example: ix_exchange_service - bandwidth: - type: integer - description: bandwidth in Mbps - example: 400000 description: + description: Customer-provided service token description type: string - description: Description - example: ix_exchange_service - state: + expirationDateTime: + description: Expiration date and time of the service token. type: string - description: State - example: PROVISIONING - enum: - - PROVISIONING - - PROVISIONING_FAILED - - PENDING_ACTIVATION - - ACTIVATING - - ACTIVATING_FAILED - - PROVISIONED - - REPROVISIONING - - REPROVISIONING_FAILED - - DEPROVISIONING - - DEPROVISIONED - - DEPROVISIONING_FAILED - location: - $ref: "#/components/schemas/SimplifiedLocation" - publicPeeringConnection: - $ref: "#/components/schemas/PublicPeeringConnectionResponse" - routingProtocol: - $ref: "#/components/schemas/RoutingProtocolResponse" - order: - $ref: "#/components/schemas/ExchangeServiceOrder" - project: - $ref: "#/components/schemas/Project" - account: - $ref: "#/components/schemas/SimplifiedAccount" + format: date-time + example: '2020-11-06T07:00:00Z' + connection: + $ref: '#/components/schemas/ServiceTokenConnection' + state: + $ref: '#/components/schemas/ServiceTokenState' notifications: + description: Service token related notifications type: array - description: Preferences for notifications on Internet Exchange Service configuration or status changes items: - $ref: "#/components/schemas/ExchangeServiceNotification" + $ref: '#/components/schemas/SimplifiedNotification' + account: + description: AM-CRH customers can provide Account number + example: 272010 + $ref: '#/components/schemas/SimplifiedAccount' changelog: - $ref: "#/components/schemas/PlatformChangelog" - additionalInfo: - $ref: "#/components/schemas/ExchangeServiceAdditionalInfo" - ExchangeServiceId: + $ref: '#/components/schemas/Changelog' + project: + description: Project is optional for AM-CRH customers. If not provided, a default project will be assigned. + $ref: '#/components/schemas/Project' + AccessPointType: + description: Access point type type: string - description: Internet Exchange Service UUID - format: uuid - example: a8ba52de-faae-43b5-b0b1-6904d37ee011 - JsonPatch: - type: array - items: - $ref: "#/components/schemas/ExchangeServiceReplaceOperation" - ExchangeServiceReplaceOperation: - required: - - op - - path - - value - type: object - properties: - op: - $ref: "#/components/schemas/ExchangeServiceOpEnum" - path: - $ref: "#/components/schemas/ExchangeServicePath" - value: - description: value to replace with - description: Replace attribute value or sub-resource in the existing model - ExchangeServiceOpEnum: + enum: + - VD + - VG + - SP + - IGW + - COLO + - SUBNET + - CLOUD_ROUTER + - NETWORK + - METAL_NETWORK + - VPIC_INTERFACE + - APP_LINK + - IC + PortType: + description: Type of Port type: string - description: the operation to be performed enum: - - replace - - add - ExchangeServicePath: + - XF_PORT + PortState: + description: Port lifecycle state type: string - description: | - ### A JSON Pointer path. - * `/name` - Name of the Internet Exchange Service - * `/description` - Description of the Internet Exchange Service - * `routingProtocol/macAddress` - MAC Address - * `routingProtocol/bgpIpv4/domainName` - Domain Name for BGP IPv4 - * `routingProtocol/bgpIpv4/asSet` - AS Set for BGP IPv4 - * `routingProtocol/bgpIpv4/md5AuthKey` - MD5 Auth Key for BGP IPv4 - * `routingProtocol/bgpIpv4/rcMd5AuthKey` - RC MD5 Auth Key for BGP IPv4 - * `routingProtocol/bgpIpv4/ipPrefixes` - IP Prefixes for BGP IPv4 - * `routingProtocol/bgpIpv6/mlpeEnabled` - MLPE Enabled for BGP IPv4 - * `routingProtocol/bgpIpv6/domainName`- Domain Name for BGP IPv6 - * `routingProtocol/bgpIpv6/asSet`- AS Set for BGP IPv6 - * `routingProtocol/bgpIpv6/md5AuthKey` - MD5 Auth Key for BGP IPv6 - * `routingProtocol/bgpIpv6/rcMd5AuthKey` - RC MD5 Auth Key for BGP IPv6 - * `routingProtocol/bgpIpv6/ipPrefixes` - IP Prefixes for BGP IPv6 - * `routingProtocol/bgpIpv6/mlpeEnabled` - MLPE Enabled for BGP IPv6 - ExchangeServiceSearchRequest: + enum: + - PENDING + - PROVISIONING + - REPROVISIONING + - PENDING_CROSS_CONNECT + - PROVISIONED + - ACTIVE + - DEPROVISIONING + - DEPROVISIONED + - INACTIVE + - FAILED + - ADDED + - DELETED + - TO_BE_ADDED + - TO_BE_DELETED + maintenanceState: + description: Maintenance lifecycle state + type: string + enum: + - SCHEDULED + - IN_PROGRESS + - COMPLETED + - CANCELLED + - POSTPONED + example: SCHEDULED + PortOperation: + description: Operational specifications for ports. type: object properties: - filter: - $ref: "#/components/schemas/ExchangeServiceSearchExpression" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/ExchangeServiceSearchSortCriteria" - description: Search requests containing criteria - ExchangeServiceSearchExpression: - oneOf: - - $ref: "#/components/schemas/ExchangeServiceAndExpression" - - $ref: "#/components/schemas/ExchangeServiceOrExpression" - - $ref: "#/components/schemas/ExchangeServicePropertyExpression" - ExchangeServiceAndExpression: - required: - - and + operationalStatus: + description: Availability of a given physical port. + type: string + enum: + - UP + - DOWN + - PARTIAL + connectionCount: + description: Total number of connections. + type: integer + format: int64 + evplVCCount: + description: Total number of connections. + type: integer + format: int64 + fgVCCount: + description: Total number of connections. + type: integer + format: int64 + accessVCCount: + description: Total number of connections. + type: integer + format: int64 + opStatusChangedAt: + description: Date and time at which port availability changed. + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + maintenanceStatus: + allOf: + - $ref: '#/components/schemas/maintenanceState' + lockEnabled: + description: Indicates whether the port configuration is locked due to an ongoing or scheduled maintenance. + type: boolean + example: true + PortServiceCode: + description: Identifies the service type associated with this port + type: string + enum: + - CX + - IX + - IA + - MC + PortDeviceRedundancy: + description: Device redundancy type: object properties: - and: - type: array - items: - $ref: "#/components/schemas/ExchangeServiceSearchExpression" - ExchangeServiceOrExpression: - required: - - or + group: + description: Device redundancy group + type: string + priority: + description: Device redundancy priority + type: string + enum: + - PRIMARY + - SECONDARY + PortDevice: + description: Port device type: object properties: - or: - type: array - items: - $ref: "#/components/schemas/ExchangeServiceSearchExpression" - ExchangeServicePropertyExpression: - required: - - operator - - property - - values + name: + description: Device name + type: string + deprecated: true + redundancy: + deprecated: true + $ref: '#/components/schemas/PortDeviceRedundancy' + vcBandwidthMax: + description: Maximum bandwidth allowed for connection. + type: integer + format: int64 + PortInterface: + description: Port interface type: object properties: - property: - type: string - description: Possible field names to use on filters - enum: - - /project/projectId - - /uuid - - /state - - /name - - /bandwidth - - /changelog/createdDateTime - - /changelog/updatedDateTime - - /changelog/deletedDateTime - - /location/metroCode - operator: + type: + description: Port interface type type: string - enum: - - = - - "!=" - - BETWEEN - - < - - <= - - ">" - - ">=" - - LIKE - - ILIKE - - IN - values: - minItems: 1 - type: array - items: - type: string - ExchangeServiceSearchSortCriteria: + PortTether: + description: Port physical connection type: object properties: - direction: + crossConnectId: + description: Port cross connect identifier type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - property: + cabinetNumber: + description: Port cabinet number type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime - enum: - - /name - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - ExchangeServiceSearchResponse: + systemName: + description: Port system name + type: string + patchPanel: + description: Port patch panel + type: string + patchPanelPortA: + description: Port patch panel port A + type: string + patchPanelPortB: + description: Port patch panel port B + type: string + ibx: + description: z-side/Equinix IBX + type: string + PortDemarcationPoint: + description: Customer physical Port type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - sort: - type: array - items: - $ref: "#/components/schemas/ExchangeServiceSearchSortCriteria" - data: - type: array - items: - $ref: "#/components/schemas/ExchangeServiceResponse" - description: List of Internet Exchange Service - ExchangeServiceActionRequest: - required: - - type + cabinetUniqueSpaceId: + description: Port cabinet unique space id + type: string + cageUniqueSpaceId: + description: Port cage unique space id + type: string + patchPanel: + description: Port patch panel + type: string + patchPanelName: + deprecated: true + description: Port patch panel + type: string + patchPanelPortA: + description: Port patch panel port A + type: string + patchPanelPortB: + description: Port patch panel port B + type: string + connectorType: + description: Port connector type + type: string + ibx: + description: Port ibx identifier + type: string + PortPriority: + description: Port priority in redundancy group + type: string + enum: + - PRIMARY + - SECONDARY + PortRedundancy: + description: Port redundancy configuration type: object properties: - type: + enabled: + description: Access point redundancy + type: boolean + group: + deprecated: true + description: Port UUID of respective primary port type: string - enum: - - EXCHANGE_SERVICE_ACTIVATE - - EXCHANGE_SERVICE_VALIDATE - - EXCHANGE_SERVICE_RETRY_PROVISION - description: Internet Exchange Service Action Request - ExchangeServiceActionResponse: - allOf: - - $ref: "#/components/schemas/ExchangeServiceActionRequest" - - type: object - properties: - href: - type: string - description: Internet Exchange Service Action URI - example: https://api.equinix.com/fabric/v4/exchangeService/e8ba52fe-faae-43b5-b0b1-6904d37ee011/actions/a8ba52de-faae-43b5-b0b1-6904d37ee011 - uuid: - type: string - description: Action identifier - format: uuid - example: a8ba52de-faae-43b5-b0b1-6904d37ee011 - description: - maxLength: 255 - minLength: 0 - type: string - description: Action description - example: Action description text - state: - type: string - description: State - example: PENDING - enum: - - PENDING - - SUCCEEDED - - FAILED - changelog: - $ref: "#/components/schemas/PlatformChangelog" - InternetAccessPostRequest: - required: - - account - - billing - - name - - project - - routingProtocol - - type + priority: + $ref: '#/components/schemas/PortPriority' + PortEncapsulation: + description: Port encapsulation configuration type: object properties: type: - $ref: "#/components/schemas/InternetAccessServiceType" - name: + description: Port encapsulation protocol type type: string - description: The name of the EIA Service - bandwidth: - type: integer - description: Bandwidth of the service - bandwidthCommit: - type: integer - description: Minimum bandwidth commit for burst billing variant of the service - routingProtocol: - $ref: "#/components/schemas/InternetAccessRoutingProtocolRequest" - order: - $ref: "#/components/schemas/InternetAccessOrderRequest" - billing: - $ref: "#/components/schemas/InternetAccessPostRequest_billing" - project: - $ref: "#/components/schemas/Project" - account: - $ref: "#/components/schemas/InternetAccessAccount" - InternetAccessRoutingProtocolRequest: - required: - - customerRoutes - - type + enum: + - DOT1Q + - QINQ + - UNTAGGED + tagProtocolId: + description: Port encapsulation tag protocol identifier + type: string + Package: + description: Package settings for port type: object properties: - type: - $ref: "#/components/schemas/InternetAccessRoutingProtocolType" - customerRoutes: - maxItems: 100 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/InternetAccessCustomerRouteRequest" - discriminator: - propertyName: type - mapping: - BGP: "#/components/schemas/InternetAccessRoutingProtocolBgpRequest" - DIRECT: "#/components/schemas/InternetAccessRoutingProtocolDirectRequest" - STATIC: "#/components/schemas/InternetAccessRoutingProtocolStaticRequest" - InternetAccessCustomerRouteRequest: - required: - - ipBlock + code: + type: string + description: Type of Port Package + enum: + - STANDARD + - UNLIMITED + - UNLIMITED_PLUS + PortSettings: + description: Port configuration settings type: object properties: - ipBlock: - $ref: "#/components/schemas/InternetAccessIpBlockRequest" - InternetAccessIpBlockRequest: - required: - - uuid - type: object + buyout: + deprecated: true + type: boolean + viewPortPermission: + deprecated: true + type: boolean + placeVcOrderPermission: + deprecated: true + type: boolean + layer3Enabled: + deprecated: true + type: boolean + packageType: + description: Type of Port Package + deprecated: true + type: string + enum: + - STANDARD + - UNLIMITED + - UNLIMITED_PLUS + PortAdditionalInfo: + description: Additional information properties: - uuid: + key: + description: Key type: string - description: Unique identifier for the IP Block - format: uuid - InternetAccessRoutingProtocolBgpRequest: - allOf: - - $ref: "#/components/schemas/InternetAccessRoutingProtocolRequest" - - required: - - connections - - exportPolicy - type: object - properties: - connections: - maxItems: 2 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/InternetAccessConnectionBgpRequest" - exportPolicy: - $ref: "#/components/schemas/InternetAccessExportPolicy" - asn: - $ref: "#/components/schemas/InternetAccessRoutingProtocolBgpRequest_asn" - customerAsn: - type: integer - description: Customer ASN. Valid range is 1-64495 or 65536-4199999999. - format: int64 - example: 16220 - deprecated: true - bgpAuthKey: - type: string - description: BGP authentication key - example: SecretKey - customerAsnRange: - $ref: "#/components/schemas/InternetAccessCustomerAsnRange" - InternetAccessConnectionBgpRequest: - required: - - uuid + value: + description: Value + type: string + PhysicalPortType: + description: Type of Port + type: string + enum: + - XF_PHYSICAL_PORT + PortNotification: type: object properties: - uuid: + type: + description: Notification Type type: string - description: Unique identifier for the connection - format: uuid - InternetAccessRoutingProtocolDirectRequest: - allOf: - - $ref: "#/components/schemas/InternetAccessRoutingProtocolRequest" - - required: - - connections - type: object - properties: - connections: - maxItems: 2 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/InternetAccessConnectionDirectRequest" - InternetAccessConnectionDirectRequest: + enum: + - NOTIFICATION + - TECHNICAL + - PEERING + - ESCALATION + registeredUsers: + description: Array of registered users + type: array + items: + type: string required: - - uuid + - type + - registeredUsers + PortOrderPurchaseOrder: + description: Purchase Order information associate to the account type: object properties: - uuid: + number: + type: string + description: purchase order number + amount: + type: string + description: purchase order amount + startDate: + type: string + endDate: + type: string + attachmentId: type: string - description: Unique identifier for the connection format: uuid - peeringIpv4: - $ref: "#/components/schemas/InternetAccessPeeringIpv4Request" - peeringIpv6: - $ref: "#/components/schemas/InternetAccessPeeringIpv6Request" - InternetAccessPeeringIpv4Request: + selectionType: + type: string + deprecated: true + enum: + - EXEMPTION + - EXISTING + - NEW + - BLANKET + type: + type: string + enum: + - EXEMPTION + - EXISTING + - NEW + - BLANKET + PortOrderSignatureDelegate: + description: order delegate details type: object properties: - equinixPeerIp: - pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + firstName: + description: first name of delegate type: string - description: IPv4 address of the Equinix peering IP - equinixVrrpIp: - pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + lastName: + description: last Name of delegate type: string - description: IPv4 address for Equinix VRRP IP - InternetAccessPeeringIpv6Request: + email: + description: email of delegate + type: string + PortOrderSignature: + description: Port signature details type: object properties: - equinixPeerIp: - pattern: ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$ - type: string - description: IPv6 address of the Equinix peering IP - equinixVrrpIp: - pattern: ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$ + signatory: + description: Port signature Type type: string - description: IPv6 address for Equinix VRRP IP - InternetAccessRoutingProtocolStaticRequest: - allOf: - - $ref: "#/components/schemas/InternetAccessRoutingProtocolRequest" - - required: - - connections - type: object - properties: - connections: - maxItems: 2 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/InternetAccessConnectionStaticRequest" - InternetAccessConnectionStaticRequest: - required: - - uuid + enum: + - DELEGATE + - SELF + - ACCOUNT_SUPPORT + delegate: + $ref: '#/components/schemas/PortOrderSignatureDelegate' + PortOrder: type: object + properties: + purchaseOrder: + $ref: '#/components/schemas/PortOrderPurchaseOrder' + customerReferenceId: + description: Customer order reference Id + type: string + signature: + $ref: '#/components/schemas/PortOrderSignature' + PortLoa: + description: Port Loas properties: uuid: + description: uuid type: string - description: Unique identifier for the connection - format: uuid - InternetAccessOrderRequest: + type: + description: Loa type + type: string + example: DIGITAL_LOA + PhysicalPort: + description: Physical Port specification type: object properties: - purchaseOrderNumber: + href: + description: Equinix assigned response attribute for an absolute URL that is the subject of the link's context. type: string - description: Purchase order number - nullable: true - orderNumber: + format: uri + readOnly: true + type: + $ref: '#/components/schemas/PhysicalPortType' + id: + deprecated: true + description: Equinix assigned response attribute for Physical Port Id + type: integer + state: + $ref: '#/components/schemas/PortState' + account: + $ref: '#/components/schemas/SimplifiedAccount' + interfaceSpeed: + description: Physical Port Speed in Mbps + type: integer + minimum: 0 + interfaceType: + description: Physical Port Interface Type type: string - description: Order Number - nullable: true - orderLine: + uuid: + description: Equinix assigned response attribute for physical port identifier type: string - description: Order Line Number - nullable: true - InternetAccessService: - required: - - account - - billing - - change - - changeLog - - href - - name - - project - - routingProtocol - - state - - type - - useCase - - uuid + format: uuid + tether: + $ref: '#/components/schemas/PortTether' + demarcationPoint: + $ref: '#/components/schemas/PortDemarcationPoint' + notifications: + description: Notification preferences + type: array + items: + $ref: '#/components/schemas/PortNotification' + additionalInfo: + description: Physical Port additional information + type: array + items: + $ref: '#/components/schemas/PortAdditionalInfo' + order: + $ref: '#/components/schemas/PortOrder' + operation: + $ref: '#/components/schemas/PortOperation' + loas: + description: Port Loas + type: array + items: + $ref: '#/components/schemas/PortLoa' + SimplifiedPort: + description: Port specification type: object properties: href: + description: Equinix assigned response attribute for an absolute URL that is the subject of the link's context. type: string - description: Service URL path format: uri - example: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 + readOnly: true type: - $ref: "#/components/schemas/InternetAccessServiceType" + $ref: '#/components/schemas/PortType' + id: + description: Equinix assigned response attribute for Port Id + type: integer uuid: + description: Equinix assigned response attribute for port identifier type: string - description: Unique identifier for the EIA Service format: uuid name: + description: Equinix assigned response attribute for Port name type: string - description: The name of the EIA Service - bandwidth: + description: + description: Equinix assigned response attribute for Port description + type: string + physicalPortsSpeed: + description: Physical Ports Speed in Mbps type: integer - description: Bandwidth of the service - bandwidthCommit: + minimum: 0 + connectionsCount: + description: Equinix assigned response attribute for Connection count type: integer - description: Minimum bandwidth commit for burst billing variant of the service + minimum: 0 + project: + $ref: '#/components/schemas/Project' state: - $ref: "#/components/schemas/InternetAccessServiceState" - change: - $ref: "#/components/schemas/InternetAccessChange" - locations: - type: array - description: List of locations associated with the service - items: - $ref: "#/components/schemas/InternetAccessLocation" - routingProtocol: - $ref: "#/components/schemas/InternetAccessRoutingProtocol" - billing: - $ref: "#/components/schemas/InternetAccessBilling" + $ref: '#/components/schemas/PortState' + operation: + $ref: '#/components/schemas/PortOperation' account: - $ref: "#/components/schemas/InternetAccessAccount" - project: - $ref: "#/components/schemas/Project" - order: - $ref: "#/components/schemas/InternetAccessOrder" - changeLog: - $ref: "#/components/schemas/Changelog" - useCase: - $ref: "#/components/schemas/InternetAccessUseCase" - InternetAccessServiceType: + $ref: '#/components/schemas/SimplifiedAccount' + serviceType: + description: Port service Type + deprecated: true + type: string + enum: + - EPL + - MSP + serviceCode: + $ref: '#/components/schemas/PortServiceCode' + bandwidth: + description: Equinix assigned response attribute for Port bandwidth in Mbps + type: integer + format: int64 + minimum: 0 + availableBandwidth: + description: Equinix assigned response attribute for Port available bandwidth in Mbps + type: integer + format: int64 + minimum: 0 + usedBandwidth: + description: Equinix assigned response attribute for Port used bandwidth in Mbps + type: integer + format: int64 + minimum: 0 + 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: + description: If LAG enabled + type: boolean + package: + $ref: '#/components/schemas/Package' + settings: + $ref: '#/components/schemas/PortSettings' + physicalPortQuantity: + description: Number of physical ports + type: integer + additionalInfo: + description: Port additional information + type: array + items: + $ref: '#/components/schemas/PortAdditionalInfo' + physicalPorts: + type: array + description: Physical ports that implement this port + items: + $ref: '#/components/schemas/PhysicalPort' + ServiceProfileTypeEnum: + description: Service profile type type: string - description: Type of the service, either single or dual internet access + x-eqx-api-linter-skip-rules: + - 40 enum: - - SINGLE_IA - - DUAL_IA - x-enum-varnames: - - SINGLE_IA - - DUAL_IA - InternetAccessServiceState: + - L2_PROFILE + - L3_PROFILE + - IA_PROFILE + - IX_PROFILE + - IC_PROFILE + - LMAAS_PROFILE + example: L2_PROFILE + Tags: + type: array + items: + type: string + ServiceProfileVisibilityEnum: type: string - description: Current state of the service enum: - - PROVISIONING - - PROVISIONED - - FAILED - - DEPROVISIONING - - DEPROVISIONED - x-enum-varnames: - - PROVISIONING - - PROVISIONED - - FAILED - - DEPROVISIONING - - DEPROVISIONED - InternetAccessSearchRequest: - type: object - properties: - pagination: - $ref: "#/components/schemas/PaginationRequest" - filter: - $ref: "#/components/schemas/SearchExpression" - sort: - $ref: "#/components/schemas/SearchSort" - InternetAccessServices: - required: - - data - - pagination - - sort + - PRIVATE + - PUBLIC + ServiceProfileAccessPointTypeEnum: + description: Access point type + type: string + enum: + - VD + - COLO + Bandwidth: + type: integer + example: 50 + description: speed in Mbps + Bandwidths: + type: array + items: + $ref: '#/components/schemas/Bandwidth' + ServiceProfileLinkProtocolConfig: type: object + description: Configuration for dot1q to qinq translation support properties: - pagination: - $ref: "#/components/schemas/Pagination" - sort: - $ref: "#/components/schemas/SearchSort" - data: + encapsulationStrategy: + description: was tagType - missing on wiki + type: string + enum: + - CTAGED + - BOTH + - NAMED + namedTags: type: array + maxItems: 64 items: - $ref: "#/components/schemas/InternetAccessService" - InternetAccessPatchRequest: - maxItems: 100 - minItems: 1 - type: array - description: Only one replace operation allowed for '/bandwidth' path. - items: - $ref: "#/components/schemas/InternetAccessPatchOperationUpdate" - InternetAccessPatchOperationUpdate: - required: - - op - - path + type: string + vlanCTagLabel: + description: was ctagLabel + type: string + reuseVlanSTag: + type: boolean + example: true + default: false + encapsulation: + description: Port encapsulation - Derived response attribute. Ignored on request payloads. + type: string + enum: + - QINQ + - DOT1Q + - UNTAGGED + ApiConfig: type: object + description: Configuration for API based Integration for Service Profile properties: - op: - $ref: "#/components/schemas/InternetAccessPatchOperationUpdateAllowedOp" - path: - $ref: "#/components/schemas/InternetAccessPatchOperationUpdateAllowedPath" - value: - description: New value for updated parameter. Required for add and replace. - InternetAccessPatchOperationUpdateAllowedOp: - type: string - description: Allowed patch operations. - enum: - - replace - - add - - remove - InternetAccessPatchOperationUpdateAllowedPath: - pattern: ^(\/name|\/bandwidth|\/bandwidthCommit|\/routingProtocol\/customerRoutes(?:\[@\.ipBlock\.uuid=[A-Fa-f0-9-]+\])?|\/order\/purchaseOrderNumber)$ - type: string - description: Allowed patch paths for Internet Access update. - example: /bandwidth - SubmitIpBlockRequestBody: + apiAvailable: + description: Setting indicating whether the API is available (true) or not (false). + type: boolean + example: true + default: false + integrationId: + type: string + equinixManagedPort: + description: Setting indicating that the port is managed by Equinix (true) or not (false). + type: boolean + example: true + default: false + equinixManagedVlan: + description: Setting indicating that the VLAN is managed by Equinix (true) or not (false). + type: boolean + example: true + default: false + allowOverSubscription: + 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. + type: boolean + example: false + default: false + overSubscriptionLimit: + description: A cap on oversubscription. + type: integer + example: 1 + minimum: 1 + maximum: 20 + default: 1 + bandwidthFromApi: + type: boolean + default: false + AuthenticationKey: + description: Authentication Key Support and Customization + 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 + ServiceProfileMetadata: + type: object + description: Metadata. Response attribute. Ignored on request payload. + 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 + ServiceProfileAccessPointTypeCOLO: + description: Colo Access Point Type required: - - project - type type: object properties: - location: - $ref: "#/components/schemas/IpBlockLocation" + uuid: + type: string type: - $ref: "#/components/schemas/TypeOfIpBlockProduct" - project: - $ref: "#/components/schemas/IpBlockProjectRequest" - account: - $ref: "#/components/schemas/IpBlockAccount" - order: - $ref: "#/components/schemas/IpBlockOrderRequest" - regulations: - $ref: "#/components/schemas/IpBlockRegulations" - prefixLength: - $ref: "#/components/schemas/IpBlockPrefixLength" - prefix: - $ref: "#/components/schemas/IpBlockPrefix" - IpBlock: + $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: + description: for verizon only. + type: boolean + connectionRedundancyRequired: + type: boolean + example: true + description: Mandate redundant connections + default: false + selectiveRedundancy: + type: boolean + example: true + description: Optional redundant connections + 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' + ServiceProfileAccessPointTypeVD: + description: VirtualDevice Access Point Type required: - - changeLog - - href - - ownership - - prefixLength - - project - - state - type - - uuid type: object + additionalProperties: false properties: uuid: type: string - description: Unique identifier for the IP Block - format: uuid - href: - type: string - description: Resource URL path for the IP Block - example: /fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb type: - $ref: "#/components/schemas/TypeOfIpBlockProduct" - state: - $ref: "#/components/schemas/IpBlockState" - ownership: - $ref: "#/components/schemas/IpBlockOwnership" - location: - $ref: "#/components/schemas/IpBlockLocation" - prefixLength: - $ref: "#/components/schemas/IpBlockPrefixLength" - prefix: - $ref: "#/components/schemas/IpBlockPrefix" - order: - $ref: "#/components/schemas/IpBlockOrderResponse" - account: - $ref: "#/components/schemas/IpBlockAccount" - project: - $ref: "#/components/schemas/IpBlockProject" - regulations: - $ref: "#/components/schemas/IpBlockRegulations" - assets: - type: array - description: Products using this IP Block - items: - $ref: "#/components/schemas/IpBlockAsset" - change: - $ref: "#/components/schemas/IpBlockChange" - changeLog: - $ref: "#/components/schemas/IpBlockChangeLog" - error: - $ref: "#/components/schemas/Error" - PatchIpBlockRequestBody: - maxItems: 1 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/PatchIpBlockRequestBodyItem" - IpBlocksSearchRequestBody: - properties: - pagination: - $ref: "#/components/schemas/PaginationRequest" - filter: - $ref: "#/components/schemas/IpBlockFilter" - sort: - $ref: "#/components/schemas/SearchSort" - IpBlockFilter: + $ref: '#/components/schemas/ServiceProfileAccessPointTypeEnum' + supportedBandwidths: + $ref: '#/components/schemas/Bandwidths' + allowRemoteConnections: + type: boolean + example: true + description: Allow remote connections to Service Profile + allowCustomBandwidth: + type: boolean + example: true + ServiceProfileAccessPointType: + description: Access Point Type type: object - properties: - and: - type: array - items: - $ref: "#/components/schemas/IpBlockAndQuery" - IpBlockAndQuery: + oneOf: + - $ref: '#/components/schemas/ServiceProfileAccessPointTypeCOLO' + - $ref: '#/components/schemas/ServiceProfileAccessPointTypeVD' + CustomField: + description: Define Custom Attributes required: - - operator - - property - - values - type: object + - label + - required + - dataType properties: - property: + label: type: string - operator: + example: Account Number + description: + type: string + example: Provide a valid account number + required: + type: boolean + example: true + dataType: type: string enum: - - = - values: + - STRING + - LIST + - NUMBER + options: type: array items: type: string - IpBlockSearchResponseBody: - required: - - data - - pagination + captureInEmail: + type: boolean + description: capture this field as a part of email notification + ProcessStep: + type: object + description: Definition of customized step while making connection properties: - pagination: - $ref: "#/components/schemas/Pagination" - sort: - $ref: "#/components/schemas/SearchSort" - data: - type: array - items: - $ref: "#/components/schemas/IpBlock" - SearchRequest: + 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 + MarketingInfo: type: object properties: - filter: - $ref: "#/components/schemas/Expression" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + logo: + type: string + description: Logo file name + promotion: + type: boolean + description: Profile promotion on marketplace + processSteps: type: array + maxItems: 3 items: - $ref: "#/components/schemas/SortCriteria" - description: Search requests containing criteria - Expression: + $ref: '#/components/schemas/ProcessStep' + ServiceProfileAccessPointCOLO: + description: Colo Access Point + type: object + required: + - type + - uuid + properties: + type: + type: string + enum: + - XF_PORT + - IX_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 + ServiceProfileAccessPointVD: + description: Virtual Device Point + required: + - type + - uuid type: object properties: - and: - $ref: "#/components/schemas/Expressions" - or: - $ref: "#/components/schemas/Expressions" - property: - $ref: "#/components/schemas/SearchFieldName" - operator: + type: type: string enum: - - = - - "!=" - - ">" - - ">=" - - < - - <= - - LIKE - - ILKE - - IS NOT NULL - - IS NULL - - IN - - BETWEEN - values: + - 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 + 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 - Expressions: - type: array - items: - $ref: "#/components/schemas/Expression" - SearchFieldName: + description: ibx codes + inTrail: + type: boolean + displayName: + type: string + description: service metro display name + sellerRegions: + type: object + additionalProperties: + type: string + ProviderEnvironmentTypeEnum: + description: Provider environment type 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/interconnect/uuid - - /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 - - /bandwidth - - /change/status - - /changeLog/createdBy - - /changeLog/createdDateTime - - /changeLog/deletedBy - - /changeLog/deletedDateTime - - /changeLog/lastUpdatedBy - - /operation/equinixStatus - - /operation/providerStatus - - /operation/maintenanceStatus - - /operation/lockEnabled - - /project/projectId - - /redundancy/group - - /redundancy/priority - - /redundancy/name - - /redundancy/description - - /zSide/accessPoint/account/accountName - - /zSide/accessPoint/authenticationKey - - /zSide/accessPoint/linkProtocol/vlanTagMin - - /zSide/accessPoint/linkProtocol/vlanTagMax - - /zSide/accessPoint/location/metroCode - - /zSide/accessPoint/location/metroName - - /zSide/accessPoint/sellerRegion - - /zSide/accessPoint/name - - /zSide/accessPoint/port/uuid - - /zSide/accessPoint/network/uuid - - /zSide/accessPoint/port/name - - /zSide/accessPoint/profile/uuid - - /zSide/accessPoint/type - - /zSide/accessPoint/role - - /zSide/accessPoint/virtualDevice/name - - /zSide/accessPoint/virtualDevice/uuid - - /zSide/serviceToken/uuid - - /zSide/internetAccess/uuid - - /state - 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: + - IC_ENV + ProviderEnvironment: + description: Provider Environment associated with an IC_PROFILE service profile Beta type: object properties: - and: - $ref: "#/components/schemas/SearchExpressions" - or: - $ref: "#/components/schemas/SearchExpressions" - property: + href: + description: Provider Environment URI type: string - operator: + format: uri + readOnly: true + uuid: + description: Equinix-assigned provider environment identifier type: string - enum: - - = - - "!=" - - ">" - - ">=" - - < - - <= - - BETWEEN - - NOT BETWEEN - - LIKE - - NOT LIKE - - IN - - NOT IN - - IS NOT NULL - - IS NULL - values: + format: uuid + type: + $ref: '#/components/schemas/ProviderEnvironmentTypeEnum' + name: + description: Provider environment name + type: string + example: US West 1 – Production + description: + description: Provider environment description + type: string + example: Primary production environment + sellerRegion: + description: Cloud provider region identifier + type: string + example: us-west-1 + supportedBandwidths: type: array + description: Supported bandwidths in Mbps items: - type: string - SearchExpressions: - type: array - items: - $ref: "#/components/schemas/SearchExpression" - PriceSearchResponse: - type: object - properties: - data: + type: integer + example: + - 1000 + - 10000 + - 100000 + metros: type: array + description: Derived response attribute. 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: + $ref: '#/components/schemas/ServiceMetro' + supportedFeatures: type: array + description: Supported Feature Types items: - $ref: "#/components/schemas/PriceError_additionalInfo" - description: Error with details - discriminator: - propertyName: errorCode - Statistics: + type: string + example: + - FEATURE_TYPE_L3_BASE + changeLog: + $ref: '#/components/schemas/Changelog' + ServiceProfileLastMileApiIntegration: type: object + description: Last-mile API integration details. 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: + siteValidationEnabled: + type: boolean + description: Whether site validation is enabled for the last-mile provider. + dataCenterLocationEnabled: + type: boolean + description: Whether data center location is enabled for the last-mile provider. + productOfferingEnabled: + type: boolean + description: Whether product offering is enabled for the last-mile provider. + poqEnabled: + type: boolean + description: Whether product qualification is enabled for the last-mile provider. + quoteEnabled: + type: boolean + description: Whether quote generation is enabled for the last-mile provider. + placeOrderEnabled: + type: boolean + description: Whether place order is enabled for the last-mile provider. + quoteViaAggregatorEnabled: + type: boolean + description: Whether quote via aggregator is enabled for the last-mile provider. + ServiceProfileLastMileDeliveryDateRange: type: object + description: Range details for delivery window. 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: + description: Unit for this range is DAYS. + example: USD + min: + type: integer + description: Minimum value for the range. + example: 1 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: integer + description: Maximum value for the range. + example: 10 + ServiceProfileLastMilePriceRange: type: object + description: Range details for price or delivery window. properties: - intervalEndTimestamp: + unit: type: string - description: Interval end timestamp - format: date-time - example: 2020-11-06T07:00:00Z - max: + description: Unit for this range, such as USD or DAYS. + example: USD + min: type: number - description: Max bandwidth within statistics object time interval, represented in units specified by response "units" field - format: float - mean: + format: double + description: Minimum value for the range. + example: 10 + max: 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: + format: double + description: Maximum value for the range. + example: 100 + ServiceProfileLastMileOffering: type: object + description: Last-mile offering details. properties: - data: + bandwidth: + type: integer + description: Offered bandwidth in Mbps. + example: 10 + price: + $ref: '#/components/schemas/ServiceProfileLastMilePriceRange' + ServiceProfileLastMileProductCatalog: + type: object + description: Last-mile provider catalog details. + properties: + name: + type: string + description: Last-mile provider or catalog name. + example: att fiber + id: + type: string + description: Last-mile provider or catalog identifier. + example: fc1eb018-df0a-4ee8-8dd1-e6b8ad61178d + webUrl: + type: string + description: Last-mile catalog or provider website URL. + example: att.com/lastmile + deliveryDate: + $ref: '#/components/schemas/ServiceProfileLastMileDeliveryDateRange' + billingTerms: type: array + nullable: true + description: Available billing terms in months. items: - $ref: "#/components/schemas/ServiceProfile" - pagination: - $ref: "#/components/schemas/Pagination" - description: Service Profiles - ServiceProfileRequest: - required: - - description - - name - - type + type: integer + enum: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + example: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + offerings: + type: array + description: Available last-mile offerings. + items: + $ref: '#/components/schemas/ServiceProfileLastMileOffering' + ServiceProfileLastMileConfig: type: object + description: Last-mile configuration for the service profile. properties: - project: - $ref: "#/components/schemas/Project" + apiIntegration: + type: object + description: Last-mile API integration details. + $ref: '#/components/schemas/ServiceProfileLastMileApiIntegration' + productCatalogs: + type: array + description: Last-mile provider catalogs. + items: + $ref: '#/components/schemas/ServiceProfileLastMileProductCatalog' + SimplifiedServiceProfile: 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 + type: string format: uri readOnly: true type: - $ref: "#/components/schemas/ServiceProfileTypeEnum" + $ref: '#/components/schemas/ServiceProfileTypeEnum' name: - maxLength: 50 - type: string description: Customer-assigned service profile name + type: string + maxLength: 50 example: Sample Service Profile uuid: - type: string description: Equinix-assigned service profile identifier + type: string format: uuid description: - type: string description: User-provided service description should be of maximum length 375 + type: string example: offering connectivity to my-network notifications: type: array description: Recipients of notifications on service profile change items: - $ref: "#/components/schemas/SimplifiedNotification" + $ref: '#/components/schemas/SimplifiedNotification' tags: - $ref: "#/components/schemas/Tags" + $ref: '#/components/schemas/Tags' visibility: - $ref: "#/components/schemas/ServiceProfileVisibilityEnum" + $ref: '#/components/schemas/ServiceProfileVisibilityEnum' allowedEmails: type: array items: type: string format: email accessPointTypeConfigs: - minItems: 1 type: array + minItems: 1 items: - $ref: "#/components/schemas/ServiceProfileAccessPointType" + $ref: '#/components/schemas/ServiceProfileAccessPointType' customFields: type: array items: - $ref: "#/components/schemas/CustomField" + $ref: '#/components/schemas/CustomField' marketingInfo: - $ref: "#/components/schemas/MarketingInfo" + $ref: '#/components/schemas/MarketingInfo' ports: type: array items: - $ref: "#/components/schemas/ServiceProfileAccessPointCOLO" + $ref: '#/components/schemas/ServiceProfileAccessPointCOLO' virtualDevices: type: array items: - $ref: "#/components/schemas/ServiceProfileAccessPointVD" + $ref: '#/components/schemas/ServiceProfileAccessPointVD' metros: type: array description: Derived response attribute. items: - $ref: "#/components/schemas/ServiceMetro" + $ref: '#/components/schemas/ServiceMetro' environments: type: array description: Provider environments associated with this IC_PROFILE service profile. Beta items: - $ref: "#/components/schemas/ProviderEnvironment" + $ref: '#/components/schemas/ProviderEnvironment' selfProfile: type: boolean - description: response attribute indicates whether the profile belongs to the same organization as the api-invoker. readOnly: true + description: response attribute indicates whether the profile belongs to the same organization as the api-invoker. projectId: type: string lastMileConfig: - $ref: "#/components/schemas/ServiceProfileLastMileConfig" - 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 + description: Last-mile provider catalogs and offerings available for this service profile. + $ref: '#/components/schemas/ServiceProfileLastMileConfig' + example: + - apiIntegration: + siteValidationEnabled: true + dataCenterLocationEnabled: false + productOfferingEnabled: false + poqEnabled: true + quoteEnabled: true + placeOrderEnabled: false + quoteViaAggregatorEnabled: false + contactInfo: + - type: SUPPORT_URL + url: http://www.example.com/lastmile/home + - type: DOCUMENTATION_URL + url: http://www.example.com/lastmile/home + - type: SUPPORT_EMAIL + emails: + - support@example.com + productCatalogs: + - name: att fiber + webUrl: att.com/lastmile + deliveryDate: + unit: DAYS + min: 1 + max: 10 + billingTerms: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + offerings: + - bandwidth: 10 + price: + unit: USD + min: 10 + max: 100 + - bandwidth: 50 + price: + unit: USD + min: 50 + max: 500 + - name: att fiber gold + webUrl: att.com/wireless + deliveryDate: + unit: DAYS + min: 1 + max: 5 + billingTerms: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + offerings: + - bandwidth: 10 + price: + unit: USD + min: 10 + max: 100 + - bandwidth: 50 + price: + unit: USD + min: 50 + max: 500 + SimplifiedLocationWithoutIBX: type: object properties: - uuid: + metroHref: + description: The Canonical URL at which the resource resides. 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 - selectiveRedundancy: - type: boolean - description: Optional redundant connections - example: true - default: false - apiConfig: - $ref: "#/components/schemas/ApiConfig" - connectionLabel: + example: https://api.equinix.com/fabric/v4/metros/AM + region: 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: + example: AMER, APAC, EMEA + metroName: + type: string + example: Amsterdam + metroCode: + type: string + example: AM + required: + - metroCode + CloudRouterPostRequestPackage: + description: Fabric Cloud Router Package Type type: object properties: - encapsulationStrategy: + href: + description: Fabric Cloud Router URI type: string - description: was tagType - missing on wiki - enum: - - CTAGED - - BOTH - - NAMED - namedTags: - maxItems: 64 - type: array - items: - type: string - vlanCTagLabel: + format: uri + example: https://api.equinix.com/fabric/v4/routerPackages/LAB + type: + description: Cloud Router package type type: string - description: was ctagLabel - reuseVlanSTag: - type: boolean - example: true - default: false - encapsulation: + enum: + - ROUTER_PACKAGE + example: ROUTER_PACKAGE + code: + description: Cloud Router package code 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: + - LAB + - BASIC + - STANDARD + - ADVANCED + - PREMIUM + example: LAB + required: + - code + marketplaceSubscription: + description: Equinix Fabric Entity for Marketplace Subscription 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: + href: + description: Marketplace Subscription URI type: string - limitAuthKeyConn: - type: boolean - allowSecondaryLocation: - type: boolean - redundantProfileId: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/marketplaceSubscriptions/20d32a80-0d61-4333-bc03-707b591ae2f5 + type: + description: Marketplace Subscription type type: string - allowVcMigration: - type: boolean - connectionEditable: - type: boolean - releaseVlan: - type: boolean - maxConnectionsOnPort: - type: integer - portAssignmentStrategy: + enum: + - AWS_MARKETPLACE_SUBSCRIPTION + - GCP_MARKETPLACE_SUBSCRIPTION + - AZURE_MARKETPLACE_SUBSCRIPTION + example: AWS_MARKETPLACE_SUBSCRIPTION + uuid: + description: Equinix-assigned Marketplace Subscription identifier type: string - eqxManagedPort: - type: boolean - connectionNameEditable: - type: boolean - description: Metadata. Response attribute. Ignored on request payload. - ServiceProfileAccessPointTypeVD: - required: - - type + example: 20d32a80-0d61-4333-bc03-707b591ae2f5 + CloudRouterPostRequestBase: type: object + description: Create Cloud Router 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 - - label - - required - 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: + - XF_ROUTER + name: + description: Customer-provided Cloud Router name type: string - description: Logo file name - promotion: - type: boolean - description: Profile promotion on marketplace - processSteps: - maxItems: 3 + 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: + description: Preferences for notifications on connection configuration or status changes type: array items: - $ref: "#/components/schemas/ProcessStep" - ProcessStep: + $ref: '#/components/schemas/SimplifiedNotification' + marketplaceSubscription: + $ref: '#/components/schemas/marketplaceSubscription' + CloudRouterAccessPointState: + description: Access point lifecycle state + type: string + enum: + - PROVISIONED + - PROVISIONING + - DEPROVISIONING + - DEPROVISIONED + - REPROVISIONING + - NOT_PROVISIONED + - NOT_DEPROVISIONED + CloudRouterChangeOperation: + description: Fabric Cloud Router change operation data type: object properties: - title: - type: string - description: Service profile custom step title - subTitle: + op: + description: Handy shortcut for operation name type: string - description: Service profile custom step sub title - description: + enum: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter type: string - description: Service profile custom step description - description: Definition of customized step while making connection - ServiceProfileAccessPointCOLO: + value: + description: new value for updated parameter required: - - type - - uuid + - op + - path + - value + CloudRouterChange: + description: Current state of latest CloudRouter change type: object properties: + uuid: + description: Uniquely identifies a change + type: string type: + description: Type of change type: string enum: - - XF_PORT - - IX_PORT - uuid: + - ROUTER_UPDATE + status: + description: Current outcome of the change flow type: string - format: uuid - example: 94662143-e21b-4098-bfcf-e9416f47eae1 - location: - $ref: "#/components/schemas/SimplifiedLocation" - sellerRegion: + enum: + - COMPLETED + - FAILED + - REQUESTED + createdDateTime: + description: Set when change flow starts type: string - sellerRegionDescription: + format: date-time + example: '2020-11-06T07:00:00Z' + updatedDateTime: + description: Set when change object is updated type: string - crossConnectId: + format: date-time + example: '2020-11-06T07:00:00Z' + information: + description: Additional information type: string - description: Colo Access Point - ServiceProfileAccessPointVD: + data: + type: array + items: + $ref: '#/components/schemas/CloudRouterChangeOperation' required: - type - - uuid + - updatedDateTime + CloudRouter: + description: Fabric Cloud Router object type: object + allOf: + - $ref: '#/components/schemas/CloudRouterPostRequestBase' properties: - type: + href: + description: Cloud Routers URI type: string - enum: - - VD + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/routers/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 uuid: + description: Equinix-assigned access point identifier type: string format: uuid - example: 94662143-e21b-4098-bfcf-e9416f47eae1 - location: - $ref: "#/components/schemas/SimplifiedLocation" - interfaceUuid: + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + name: + description: Customer-provided Cloud Router name type: string - format: uuid - example: 94662143-e21b-4098-bfcf-e9416f47eae1 - description: Virtual Device Point - ServiceMetro: + format: string + example: test-fg-1 + state: + $ref: '#/components/schemas/CloudRouterAccessPointState' + example: PROVISIONED + equinixAsn: + description: Equinix ASN + type: integer + format: int64 + example: 30000 + connectionsCount: + description: Number of connections associated with this Access point + type: integer + minimum: 0 + marketplaceSubscription: + $ref: '#/components/schemas/marketplaceSubscription' + changeLog: + $ref: '#/components/schemas/Changelog' + change: + $ref: '#/components/schemas/CloudRouterChange' + VirtualDevice: + description: Virtual Device AccessPoint Information type: object properties: - code: + href: + description: Virtual Device URI type: string - description: metro code + format: uri + readOnly: true + uuid: + description: Equinix-assigned Virtual Device identifier + type: string + format: uuid name: + description: Customer-assigned Virtual Device 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: + description: Virtual Device type type: string - description: service metro display name - sellerRegions: - type: object - additionalProperties: - type: string - ProviderEnvironment: + enum: + - EDGE + account: + $ref: '#/components/schemas/SimplifiedAccount' + cluster: + description: Virtual Device Cluster Information + type: string + Interface: + description: Interface Information type: object properties: href: + description: Interface URI type: string - description: Provider Environment URI format: uri readOnly: true uuid: + description: Equinix-assigned Interface identifier type: string - description: Equinix-assigned provider environment identifier format: uuid + id: + description: Interface id + type: integer type: - $ref: "#/components/schemas/ProviderEnvironmentTypeEnum" - name: - type: string - description: Provider environment name - example: US West 1 – Production - description: + description: Interface type type: string - description: Provider environment description - example: Primary production environment - sellerRegion: + enum: + - CLOUD + - NETWORK + projectId: + description: Interface Project ID type: string - description: Cloud provider region identifier - example: us-west-1 - supportedBandwidths: - type: array - description: Supported bandwidths in Mbps - example: - - 1000 - - 10000 - - 100000 - items: - type: integer - metros: - type: array - description: Derived response attribute. - items: - $ref: "#/components/schemas/ServiceMetro" - supportedFeatures: - type: array - description: Supported Feature Types - example: - - FEATURE_TYPE_L3_BASE - items: - type: string - changeLog: - $ref: "#/components/schemas/Changelog" - description: Provider Environment associated with an IC_PROFILE service profile Beta - ProviderEnvironmentTypeEnum: + NetworkState: + description: Network status type: string - description: Provider environment type + example: ACTIVE enum: - - IC_ENV - ServiceProfileLastMileConfig: + - ACTIVE + - INACTIVE + - DELETED + NetworkChangeType: + description: Type of change + type: string + enum: + - NETWORK_CREATION + - NETWORK_UPDATE + - NETWORK_DELETION + SimplifiedNetworkChange: + description: Current state of latest network change type: object properties: - apiIntegration: - $ref: "#/components/schemas/ServiceProfileLastMileApiIntegration" - productCatalogs: - type: array - description: Last-mile provider catalogs. - items: - $ref: "#/components/schemas/ServiceProfileLastMileProductCatalog" - description: Last-mile configuration for the service profile. - ServiceProfileLastMileApiIntegration: + href: + description: Network URI + type: string + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9 + uuid: + description: Uniquely identifies a change + type: string + format: uuid + example: 4b17da68-3d6b-436d-9c8f-2105f3b950d9 + type: + $ref: '#/components/schemas/NetworkChangeType' + example: NETWORK_CREATION + NetworkEquinixStatus: + description: Network status + type: string + enum: + - PROVISIONING + - PROVISIONED + - NOT_PROVISIONED + - DEPROVISIONING + - DEPROVISIONED + - NOT_DEPROVISIONED + NetworkOperation: + description: Network operational data type: object properties: - siteValidationEnabled: - type: boolean - description: Whether site validation is enabled for the last-mile provider. - dataCenterLocationEnabled: - type: boolean - description: Whether data center location is enabled for the last-mile provider. - productOfferingEnabled: - type: boolean - description: Whether product offering is enabled for the last-mile provider. - poqEnabled: - type: boolean - description: Whether product qualification is enabled for the last-mile provider. - quoteEnabled: - type: boolean - description: Whether quote generation is enabled for the last-mile provider. - placeOrderEnabled: - type: boolean - description: Whether place order is enabled for the last-mile provider. - quoteViaAggregatorEnabled: - type: boolean - description: Whether quote via aggregator is enabled for the last-mile provider. - description: Last-mile API integration details. - ServiceProfileLastMileContactInfoItem: + equinixStatus: + $ref: '#/components/schemas/NetworkEquinixStatus' + Link: type: object properties: - type: + href: + description: Resource URI type: string - description: Contact type. - enum: - - SUPPORT_URL - - DOCUMENTATION_URL - - SUPPORT_EMAIL - url: + format: uri + readOnly: true + rel: + description: OperationId from Swagger hub spec type: string - description: Contact URL. - example: https://support.example.com - emails: - type: array - description: List of contact emails. - items: - type: string - format: email - example: support@example.com - description: Last-mile provider contact information item. - ServiceProfileLastMileProductCatalog: + method: + description: Http method type + type: string + contentType: + description: Content type for the response + type: string + authenticate: + description: Authentication required or not + type: boolean + NetworkType: + description: Network type + type: string + enum: + - EVPLAN + - EPLAN + - IPWAN + - EVPTREE + - EPTREE + NetworkScope: + description: Network scope + type: string + enum: + - REGIONAL + - GLOBAL + - LOCAL + SimplifiedNetwork: + description: Network specification type: object properties: - name: + href: + description: Network URI type: string - description: Last-mile provider or catalog name. - example: att fiber - id: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784 + uuid: + description: Equinix-assigned network identifier type: string - description: Last-mile provider or catalog identifier. - example: fc1eb018-df0a-4ee8-8dd1-e6b8ad61178d - webUrl: + format: uuid + example: 92dc376a-a932-43aa-a6a2-c806dedbd784 + name: + description: Customer-assigned network name type: string - description: Last-mile catalog or provider website URL. - example: att.com/lastmile - deliveryDate: - $ref: "#/components/schemas/ServiceProfileLastMileDeliveryDateRange" - billingTerms: + 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: + description: Network sub-resources links type: array - description: Available billing terms in months. - nullable: true - example: - - 1 - - 12 - - 24 - - 36 - - 48 - - 60 - items: - type: integer - enum: - - 1 - - 12 - - 24 - - 36 - - 48 - - 60 - offerings: - type: array - description: Available last-mile offerings. + readOnly: true items: - $ref: "#/components/schemas/ServiceProfileLastMileOffering" - description: Last-mile provider catalog details. - ServiceProfileLastMileDeliveryDateRange: + $ref: '#/components/schemas/Link' + type: + $ref: '#/components/schemas/NetworkType' + name: + description: Customer-provided network name + type: string + scope: + $ref: '#/components/schemas/NetworkScope' + location: + $ref: '#/components/schemas/SimplifiedLocation' + required: + - uuid + PeeringType: + description: Access point peering type + type: string + enum: + - PRIVATE + - MICROSOFT + - PUBLIC + - MANUAL + VirtualNetwork: + description: Virtual Network Information type: object properties: - unit: + href: + description: The Canonical URL at which the resource resides. type: string - description: Unit for this range is DAYS. - example: USD - min: - type: integer - description: Minimum value for the range. - example: 1 - max: - type: integer - description: Maximum value for the range. - example: 10 - description: Range details for delivery window. - ServiceProfileLastMileOffering: + format: uri + readOnly: true + uuid: + description: Equinix-assigned Virtual Network identifier + type: string + format: uuid + MetalInterconnection: + description: Metal Interconnection type: object properties: - bandwidth: - type: integer - description: Offered bandwidth in Mbps. - example: 10 - price: - $ref: "#/components/schemas/ServiceProfileLastMilePriceRange" - description: Last-mile offering details. - ServiceProfileLastMilePriceRange: + uuid: + description: Equinix Metal Interconnection + type: string + format: uuid + ProductOffering: + description: Product offering for connection. Applicable to zSide only. type: object properties: - unit: + id: + description: Product offering identifier type: string - description: Unit for this range, such as USD or DAYS. - example: USD - min: - type: number - description: Minimum value for the range. - format: double - example: 10 - max: - type: number - description: Maximum value for the range. - format: double - example: 100 - description: Range details for price or delivery window. - ServiceProfile: + name: + description: Product offering name + type: string + billingTerm: + description: Billing term in months. + type: integer + minimum: 1 + enum: + - 1 + - 12 + - 24 + - 36 + - 48 + - 60 + example: 12 + Address: + description: Address. type: object properties: - state: - $ref: "#/components/schemas/ServiceProfileStateEnum" - account: - $ref: "#/components/schemas/SimplifiedAccount" - project: - $ref: "#/components/schemas/Project" - change: - $ref: "#/components/schemas/ServiceProfileChange" - changeLog: - $ref: "#/components/schemas/Changelog" - 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" - ServiceProfileChange: - required: - - createdDateTime - - type + id: + description: Address identifier + type: string + streetNr: + description: Street number of address + type: string + streetName: + description: Street name of address + type: string + city: + description: City of address + type: string + stateOrProvince: + description: State of address + type: string + postCode: + description: Postal code of address + type: string + country: + description: Country of address + type: string + AccessPoint: + description: Access point object type: object properties: - uuid: - type: string - description: Uniquely identifies a change 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' + environment: + $ref: '#/components/schemas/ProviderEnvironment' + sellerRegion: + description: Access point seller region type: string - description: Type of change - example: SERVICE_PROFILE_VISIBILITY_UPDATE - status: + peeringType: + $ref: '#/components/schemas/PeeringType' + authenticationKey: + description: Access point authentication key + type: string + activationKey: + description: Access point activation key + type: string + providerConnectionId: + description: Provider assigned Connection Id + type: string + virtualNetwork: + $ref: '#/components/schemas/VirtualNetwork' + interconnection: + $ref: '#/components/schemas/MetalInterconnection' + role: + description: E-Tree network connection role type: string - description: Current outcome of the change flow enum: - - APPROVED - - COMPLETED - - FAILED - - REJECTED - - REQUESTED - - SUBMITTED_FOR_APPROVAL - createdDateTime: + - LEAF + - ROOT + productOffering: + $ref: '#/components/schemas/ProductOffering' + bandwidthCommit: + description: Bandwidth commit in Mbps + type: integer + minimum: 0 + maximum: 100000 + providerIdentifier: + description: Provider identifier type: string - description: Set when change flow starts - format: date-time - example: 2020-11-06T07:00:00Z - updatedDateTime: + address: + $ref: '#/components/schemas/Address' + ConnectionSideAdditionalInfo: + description: Additional information + properties: + key: + description: Key type: string - description: Set when change object is updated - format: date-time - example: 2020-11-06T07:00:00Z - information: + value: + description: Value type: string - description: Additional information - data: - $ref: "#/components/schemas/ServiceProfileUpdateRequest" - description: Current state of latest service profile change - ServiceProfileSearchRequest: + ConnectionSide: + description: Connection configuration object for each side of multi-segment connection type: object properties: - filter: - $ref: "#/components/schemas/ServiceProfileFilter" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + serviceToken: + $ref: '#/components/schemas/ServiceToken' + accessPoint: + $ref: '#/components/schemas/AccessPoint' + additionalInfo: + description: Any additional information, which is not part of connection metadata or configuration 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: + $ref: '#/components/schemas/ConnectionSideAdditionalInfo' + ConnectionPostRequest: + required: + - type + - name + - notifications + - bandwidth + - aSide + - zSide type: object + description: Create connection post request 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: + $ref: '#/components/schemas/ConnectionType' + name: + description: Customer-provided connection name type: string - description: | - Possible operators to use on filters: - * `=` - equal - example: = - values: + order: + $ref: '#/components/schemas/Order' + notifications: + description: Preferences for notifications on connection configuration or status changes type: array items: - type: string - example: ServiceProfile-1 - ServiceProfileAndFilter: - type: object - properties: - and: + $ref: '#/components/schemas/SimplifiedNotification' + bandwidth: + description: Connection bandwidth in Mbps + type: integer + minimum: 0 + maximum: 100000 + geoScope: + description: Geographic boundary for the connection + $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: + description: Connection additional information 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 - ServiceProfileUpdateRequest: - type: array - items: - $ref: "#/components/schemas/ServiceProfileUpdateOperation" - ServiceProfileUpdateOperation: - 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 + $ref: '#/components/schemas/ConnectionSideAdditionalInfo' + marketplaceSubscription: + $ref: '#/components/schemas/marketplaceSubscription' + ConnectionChangeOperation: + description: Connection change operation data type: object properties: op: + description: Handy shortcut for operation name type: string - enum: - - add + example: add path: - $ref: "#/components/schemas/Path" + description: path inside document leading to updated parameter + type: string + example: /ipv6 value: - type: object - description: value to add - description: Add Sub-Resource to the existing model - Path: - type: string - description: A JSON Pointer path. - RemoveOperation: + description: new value for updated parameter required: - op - path + - value + Change: + description: Current state of latest connection change type: object properties: - op: + uuid: + description: Uniquely identifies a change + type: string + type: + description: Type of change type: string enum: - - remove - path: - $ref: "#/components/schemas/Path" - description: Remove sub-resource from an existing model - ReplaceOperation: - required: - - op - - path - - value - type: object - properties: - op: + - CONNECTION_CREATION + - CONNECTION_UPDATE + - CONNECTION_DELETION + - CONNECTION_PROVIDER_STATUS_REQUEST + status: + description: Current outcome of the change flow type: string enum: - - replace - path: - $ref: "#/components/schemas/Path" - value: - type: object - description: value to replace with - description: Replace attribute value or sub-resource in the existing model - ServiceProfileActionRequest: + - APPROVED + - COMPLETED + - FAILED + - REJECTED + - REQUESTED + - SUBMITTED_FOR_APPROVAL + createdDateTime: + description: Set when change flow starts + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + updatedDateTime: + description: Set when change object is updated + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + information: + description: Additional information + type: string + data: + $ref: '#/components/schemas/ConnectionChangeOperation' required: - type + - createdDateTime + ProviderStatus: + description: Connection provider readiness status + type: string + enum: + - AVAILABLE + - DEPROVISIONED + - DEPROVISIONING + - FAILED + - NOT_AVAILABLE + - PENDING_APPROVAL + - PENDING_CONFIGURATION + - PROVISIONED + - PROVISIONING + - REJECTED + - PENDING_BGP + - ERROR + - ORDERING + - DELETING + - PENDING DELETE + - N/A + - QUOTING + EquinixStatus: + description: Connection status + type: string + enum: + - REJECTED_ACK + - REJECTED + - PENDING_DELETE + - PROVISIONED + - PENDING_APPROVAL + - NOT_PROVISIONED + - DEPROVISIONING + - NOT_DEPROVISIONED + - PENDING_AUTO_APPROVAL + - PROVISIONING + - PENDING_BGP_PEERING + - PENDING_PROVIDER_VLAN + - DEPROVISIONED + - DELETED + - AUTO_APPROVAL_FAILED + - PENDING_PROVIDER_VLAN_ERROR + - DRAFT + - CANCELLED + - PENDING_INTERFACE_CONFIGURATION + ConnectionOperation: + description: Connection type-specific operational data type: object properties: - type: + providerStatus: + $ref: '#/components/schemas/ProviderStatus' + equinixStatus: + $ref: '#/components/schemas/EquinixStatus' + operationalStatus: + description: Connection operational status type: string - description: "Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION" - example: PROFILE_UPDATE_ACCEPTANCE - description: + enum: + - UP + - DOWN + errors: + type: array + items: + $ref: '#/components/schemas/Error' + opStatusChangedAt: + description: When connection transitioned into current operational status type: string - description: Action description - example: Approved to migrate to public - description: Service Profile Action Request - ServiceProfileActionResponse: + format: date-time + example: '2020-11-06T07:00:00Z' + maintenanceStatus: + allOf: + - $ref: '#/components/schemas/maintenanceState' + lockEnabled: + description: Indicates whether the connection configuration is locked due to an ongoing or scheduled maintenance. + type: boolean + example: true + ConnectionDirection: + description: Connection directionality from the requester point of view + type: string + enum: + - INTERNAL + - INCOMING + - OUTGOING + Connection: + description: Connection specification type: object properties: href: + description: Connection URI type: string - description: Service Profile Action URI format: uri readOnly: true type: - type: string - description: "Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION" - example: PROFILE_UPDATE_ACCEPTANCE + $ref: '#/components/schemas/ConnectionType' uuid: + description: Equinix-assigned connection identifier type: string - description: Equinix-assigned action identifier - format: uuid - comments: + name: + description: Customer-provided connection name type: string - description: Action comments - example: Approved to migrate to public + description: + description: Customer-provided connection description + type: string + change: + $ref: '#/components/schemas/Change' + operation: + $ref: '#/components/schemas/ConnectionOperation' + order: + $ref: '#/components/schemas/Order' + notifications: + description: Preferences for notifications on connection configuration or status changes + type: array + items: + $ref: '#/components/schemas/SimplifiedNotification' + account: + $ref: '#/components/schemas/SimplifiedAccount' changeLog: - $ref: "#/components/schemas/Changelog" - description: Service Profile Action Response - ProviderEnvironments: - type: object - properties: - data: + $ref: '#/components/schemas/Changelog' + bandwidth: + description: Connection bandwidth in Mbps + type: integer + minimum: 0 + maximum: 10000 + geoScope: + description: Geographic boundary for this connection + $ref: '#/components/schemas/GeoScopeType' + redundancy: + $ref: '#/components/schemas/ConnectionRedundancy' + isRemote: + description: Connection property derived from access point locations + type: boolean + direction: + $ref: '#/components/schemas/ConnectionDirection' + aSide: + $ref: '#/components/schemas/ConnectionSide' + zSide: + $ref: '#/components/schemas/ConnectionSide' + marketplaceSubscription: + $ref: '#/components/schemas/marketplaceSubscription' + additionalInfo: + description: Connection additional information type: array items: - $ref: "#/components/schemas/ProviderEnvironment" - pagination: - $ref: "#/components/schemas/Pagination" - description: Service Profile Provider Environments - EnvironmentId: - type: string - description: Provider Environment Reference - EnvironmentActionRequest: + $ref: '#/components/schemas/ConnectionSideAdditionalInfo' + project: + description: Project is optional for AM-CRH customers. If not provided, a default project will be assigned. + example: 30ad25e2-53dc-11ed-bdc3-0242ac120002 + $ref: '#/components/schemas/Project' required: - - keyDetails - type - type: object - properties: - type: - $ref: "#/components/schemas/EnvironmentActionTypeEnum" - keyDetails: - $ref: "#/components/schemas/ActivationKeyDetails" - description: Request payload for environment action - EnvironmentActionTypeEnum: + - name + - bandwidth + - aSide + - zSide + ConnectionUpdateRequest: + description: Connection Update Request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/ConnectionChangeOperation' + Actions: + description: Connection action type type: string - description: Environment action type - example: VALIDATE_ACTIVATION_KEY enum: - - VALIDATE_ACTIVATION_KEY - ActivationKeyDetails: + - 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 + - CONNECTION_CREATION_RETRY + - CONNECTION_DELETION_RETRY + - CONNECTION_PROVIDER_STATUS_UPDATE_REQUEST + ConnectionAcceptanceData: + description: Connection acceptance data type: object properties: - value: - type: string - description: Provider Encoded activation key - example: key_here - providerId: - type: string - description: AWS Connection identifier - accountId: - type: string - description: Account identifier - bandwidth: + zSide: + $ref: '#/components/schemas/ConnectionSide' + providerBandwidth: + description: Authorization key bandwidth in Mbps type: integer - description: Bandwidth in Mbps - region: - type: string - description: Cloud provider region identifier - description: Activation Key Details Beta - EnvironmentActionResponse: - type: object - properties: - href: - type: string - description: Environment action URI - format: uri readOnly: true - type: - $ref: "#/components/schemas/EnvironmentActionTypeEnum" - uuid: - type: string - description: Equinix-assigned action identifier - format: uuid - example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 - state: - $ref: "#/components/schemas/EnvironmentActionStateEnum" - keyDetails: - $ref: "#/components/schemas/ActivationKeyDetails" - changeLog: - $ref: "#/components/schemas/Changelog" - description: Response from environment action Beta - EnvironmentActionStateEnum: - type: string - description: Environment action state. ACTIVE - already used , INACTIVE - not used - example: ACTIVE - enum: - - ACTIVE - - INACTIVE - 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: + operation: + $ref: '#/components/schemas/ConnectionOperation' + ConnectionActionRequest: + description: Connection action request 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 + $ref: '#/components/schemas/Actions' description: + description: Connection rejection reason detail 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" - or: - $ref: "#/components/schemas/ServiceTokenSearchExpressions" - property: - $ref: "#/components/schemas/ServiceTokenSearchFieldName" - operator: - type: string - enum: - - = - - "!=" - - LIKE - - ILIKE - - < - - ">" - - <= - - ">=" - - IN - - NOT IN - - BETWEEN - - NOT BETWEEN - 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 - - /type - - /expirationDateTime - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - - /connection/aSide/accessPointSelectors/port/uuid - - /connection/zSide/accessPointSelectors/port/uuid - OpticalConnectPostRequest: + $ref: '#/components/schemas/ConnectionAcceptanceData' required: - - aSide - - bandwidth - - connectionDestinationType - - pathType - type - - zSide + ConnectionAction: + description: Connection action type: object properties: type: - type: string - description: OC - Optical Connect Type - example: OC - enum: - - OC - bandwidth: - type: integer - description: | - Connection bandwidth Mbps.
Available bandwidths depend on the IBX pair.
1000 - 1 Gbps.
10000 - 10 Gbps.
100000 - 100 Gbps.
- example: 100000 - connectionDestinationType: - type: string - description: | - Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
BMMR and REMOTE require a Letter of Authorization on the Z-side. - example: COLO - enum: - - COLO - - BMMR - - REMOTE - pathType: - type: string - description: | - Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs. - example: PROTECTED - enum: - - DUAL_DIVERSE - - PROTECTED - - UNPROTECTED - redundancy: - $ref: "#/components/schemas/OpticalConnectRedundancy" - aSide: - $ref: "#/components/schemas/OpticalConnectASideRequest" - zSide: - $ref: "#/components/schemas/OpticalConnectZSideRequest" - order: - $ref: "#/components/schemas/OpticalConnectOrder" - account: - $ref: "#/components/schemas/SimplifiedAccount" - notifications: - type: array - description: Contacts to notify about connection configuration and status changes - items: - $ref: "#/components/schemas/OpticalConnectNotification" - bmmrType: - type: string - description: | - BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR. - example: EQUINIX - enum: - - EQUINIX - - SELF - description: |- - Request to order a single connection. The A-side is always a patch panel - port in your own cage; the Z-side shape depends on - connectionDestinationType. - OpticalConnectResponse: - type: object - properties: + $ref: '#/components/schemas/Actions' href: + description: Connection action URI type: string - description: URI of this Optical Connect resource. format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 uuid: + description: Equinix-assigned connection identifier type: string - description: Unique identifier of this Optical Connect. - format: uuid - readOnly: true - example: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: - type: string - description: | - Connection Type.
OC - Optical Connect. - example: OC - enum: - - OC - name: - type: string - description: | - Equinix-assigned name, derived from the account number and the two IBX locations. - readOnly: true - example: 123456-SV1-SV2-01 state: - $ref: "#/components/schemas/OpticalConnectState" - bandwidth: - type: integer - description: Provisioned connection bandwidth in Mbps. - example: 10000 - connectionDestinationType: - type: string - description: | - Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
- enum: - - COLO - - BMMR - - REMOTE - pathType: + description: Connection action response state type: string - description: | - Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs. enum: - - DUAL_DIVERSE - - PROTECTED - - UNPROTECTED - bmmrType: + - SUCCEEDED + description: + description: Connection rejection reason detail type: string - description: | - BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR. - enum: - - EQUINIX - - SELF - redundancy: - $ref: "#/components/schemas/OpticalConnectRedundancy" - aSide: - $ref: "#/components/schemas/OpticalConnectASideResponse" - zSide: - $ref: "#/components/schemas/OpticalConnectZSideResponse" - order: - $ref: "#/components/schemas/OpticalConnectOrder" - account: - $ref: "#/components/schemas/SimplifiedAccount" - notifications: - type: array - description: Preferences for notifications on connection configuration or status changes - items: - $ref: "#/components/schemas/OpticalConnectNotification" - changeLog: - $ref: "#/components/schemas/Changelog" - description: |- - Optical Metro Connect connection with its current state and the resolved - physical termination points at both ends. - BulkOpticalConnectRequest: - type: object - properties: data: - type: array - description: | - The two connections forming the diverse pair — one PRIMARY and one - SECONDARY. - items: - $ref: "#/components/schemas/OpticalConnectPostRequest" - description: Request to create a dual diverse pair of Optical Connect connections. - OpticalConnectBulk: - type: object - properties: - data: - type: array - items: - $ref: "#/components/schemas/OpticalConnectResponse" - description: Dual diverse pair Connection - OpticalConnectId: - type: string - description: Unique identifier of an Optical Connect. - format: uuid - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - OpticalConnectSearchRequest: - type: object - properties: - filter: - $ref: "#/components/schemas/OpticalConnectFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/OpticalConnectSortCriteria" - description: |- - Search criteria for retrieving Optical Connects, with optional - filtering, pagination and sorting. - OpticalConnectFilters: - type: object - properties: - and: - maxItems: 8 - type: array - items: - $ref: "#/components/schemas/OpticalConnectFilter" - OpticalConnectFilter: - type: object - description: A single condition, or a group of conditions combined with logical OR. - anyOf: - - $ref: "#/components/schemas/OpticalConnectSimpleExpression" - - $ref: "#/components/schemas/OpticalConnectOrFilter" - OpticalConnectSimpleExpression: + $ref: '#/components/schemas/ConnectionAcceptanceData' + changeLog: + $ref: '#/components/schemas/Changelog' + required: + - type + - uuid + - data + ConnectionRouteEntrySimpleExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: - * `/name` - Connection name - * `/uuid` - Connection uuid - * `/type` - type - * `/state` - state - * `/bandwidth` - Bandwidth - example: /name - operator: + * `/type` - Route table entry type + * `/state` - Route table entry state + * `/prefix` - Route table entry prefix + * `/nextHop` - Route table entry nextHop + * `/*` - all-category search type: string + example: /type + operator: 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: = + * `~*` - case-insensitive like + type: string + example: '=' values: type: array items: type: string - example: 123456-SV1-SV2-01 - OpticalConnectOrFilter: + example: IPv4_BGP_ROUTE + ConnectionRouteEntryOrFilter: type: object properties: or: - maxItems: 3 type: array + maxItems: 3 items: - $ref: "#/components/schemas/OpticalConnectSimpleExpression" - OpticalConnectSortCriteria: + $ref: '#/components/schemas/ConnectionRouteEntrySimpleExpression' + ConnectionRouteEntryFilter: + type: object + anyOf: + - $ref: '#/components/schemas/ConnectionRouteEntrySimpleExpression' + - $ref: '#/components/schemas/ConnectionRouteEntryOrFilter' + ConnectionRouteEntryFilters: type: object properties: - direction: - $ref: "#/components/schemas/OpticalConnectSortDirection" - property: - $ref: "#/components/schemas/OpticalConnectSortBy" - description: Sorting to apply to search results. - OpticalConnectSortDirection: - type: string - description: | - Sorting direction.
ASC - ascending
DESC - descending + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/ConnectionRouteEntryFilter' + ConnectionRouteEntrySortDirection: + description: Sorting direction default: DESC + type: string enum: - DESC - ASC - OpticalConnectSortBy: - type: string + ConnectionRouteEntrySortBy: description: Possible field names to use on sorting default: /changeLog/updatedDateTime + type: string enum: - - /name - - /uuid - - /state - - /type - - /bandwidth - - /aSide/location/ibxCode - - /zSide/location/ibxCode - /changeLog/createdDateTime - /changeLog/updatedDateTime - OpticalConnectServiceSearchResponse: + - /med + - /connection/name + - /type + - /prefix + - /nextHop + ConnectionRouteSortCriteria: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/OpticalConnectResponse" - Presence: - type: string - description: Presence - enum: - - MY_PORTS - MetroResponse: + direction: + $ref: '#/components/schemas/ConnectionRouteEntrySortDirection' + property: + $ref: '#/components/schemas/ConnectionRouteEntrySortBy' + ConnectionRouteSearchRequest: type: object + description: Search requests containing criteria properties: + filter: + $ref: '#/components/schemas/ConnectionRouteEntryFilters' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: 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: + $ref: '#/components/schemas/ConnectionRouteSortCriteria' + RouteTableEntryType: + description: Route table entry type + type: string + enum: + - IPv4_BGP_ROUTE + - IPv4_STATIC_ROUTE + - IPv4_DIRECT_ROUTE + - IPv6_BGP_ROUTE + - IPv6_STATIC_ROUTE + - IPv6_DIRECT_ROUTE + RouteTableEntryProtocolType: + description: Route table entry protocol type + type: string + enum: + - BGP + - STATIC + - DIRECT + ConnectionRouteTableEntry: + description: Advertised and received route table entry object type: object properties: - href: - type: string - description: The Canonical URL at which the resource resides. type: + $ref: '#/components/schemas/RouteTableEntryType' + example: IPv4_BGP_SESSION + protocolType: + $ref: '#/components/schemas/RouteTableEntryProtocolType' + example: BGP + state: 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: + enum: + - ACTIVE + - INACTIVE + example: ACTIVE + prefix: type: string - description: Name of the region in which the data center is located. - country: + example: 192.168.10.0/24 + nextHop: type: string - description: Country code in which the data center is located. - equinixAsn: + example: 10.10.10.5 + MED: 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: + example: 5 + localPreference: 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" - services: - type: array - items: - $ref: "#/components/schemas/services" - geoScopes: + example: 200 + asPath: type: array - description: List of supported geographic boundaries of a Fabric Metro. items: - $ref: "#/components/schemas/GeoScopeType" - geoZones: + type: string + connection: + type: object + properties: + uuid: + type: string + example: 81331c52-04c0-4656-a4a7-18c52669348f + name: + type: string + example: connection_1 + href: + type: string + example: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 + changeLog: + $ref: '#/components/schemas/Changelog' + required: + - type + - changeLog + ConnectionRouteTableEntrySearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. type: array - description: List of supported geographic zones of a Fabric Metro. items: - $ref: "#/components/schemas/GeoZone" - 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: + $ref: '#/components/schemas/ConnectionRouteTableEntry' + BGPConnectionOperation: + description: BGP IPv4 or IPv6 Connection State operational data 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: + operationalStatus: + description: BGP IPv4 or IPv6 Connection State operational status + type: string + enum: + - UP + - DOWN + - UNKNOWN + opStatusChangedAt: + description: Last BGP State Update by Date and Time + type: string + format: date-time + example: '2021-10-30T07:21:39Z' + BGPConnectionIpv4: type: object properties: - href: + customerPeerIp: + description: Customer side peering ip type: string - description: The Canonical URL at which the resource resides. - code: + example: 10.1.1.2 + equinixPeerIp: + description: Equinix side peering ip 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: + example: 10.1.1.3 + enabled: + description: Admin status for the BGP session + type: boolean + outboundASPrependCount: + description: AS path prepend count 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 - services: + example: 3 + inboundMED: + description: Inbound Multi Exit Discriminator attribute + type: integer + format: int64 + example: 1000 + outboundMED: + description: Outbound Multi Exit Discriminator attribute + type: integer + format: int64 + example: 2000 + routesMax: + description: Maximum learnt prefixes limit + type: integer + format: int64 + example: 1000 + operation: + $ref: '#/components/schemas/BGPConnectionOperation' + required: + - customerPeerIp + - enabled + BGPConnectionIpv6: type: object properties: - type: + customerPeerIp: + description: Customer side peering ip type: string - description: Type of Service - description: Arrays of objects containing type of services supported in the specified metros - GeoScopeType: - type: string - description: Geographic boundary types - enum: - - CANADA - - CONUS - - JAPAN - - UK - - AUSTRALIA - - BRAZIL - - SWITZERLAND - - EU - GeoZone: + example: 2001:db8:c59b::1 + equinixPeerIp: + description: Equinix side peering ip + type: string + example: 2001:db8:c59b::1 + enabled: + description: Admin status for the BGP session + type: boolean + outboundASPrependCount: + description: AS path prepend count + type: integer + format: int64 + example: 3 + inboundMED: + description: Inbound Multi Exit Discriminator attribute + type: integer + format: int64 + example: 1000 + outboundMED: + description: Outbound Multi Exit Discriminator attribute + type: integer + format: int64 + example: 2000 + routesMax: + description: Maximum learnt prefixes limit + type: integer + format: int64 + example: 1000 + operation: + $ref: '#/components/schemas/BGPConnectionOperation' + required: + - customerPeerIp + - enabled + RoutingProtocolBFD: type: object properties: - code: - type: string - description: Code assigned to a geographic zone. - name: - type: string - description: Name of a geographic zone. - description: + enabled: + type: boolean + interval: type: string - description: Description of a geographic zone. - description: Geographic zone of a Fabric Metro - MetroErrorList: - type: array - items: - $ref: "#/components/schemas/MetroError" - MetroError: + example: '100' required: - - errorCode - - errorMessage + - enabled + RoutingProtocolOperation: type: object properties: - errorCode: + errors: + type: array + items: + $ref: '#/components/schemas/Error' + RoutingProtocolChange: + description: Current state of latest Routing Protocol change + type: object + properties: + uuid: + description: Uniquely identifies a change type: string - enum: - - EQ-3036001 - - EQ-3036013 - - EQ-3036030 - - EQ-3036100 - errorMessage: + type: + description: Type of change 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: + - ROUTING_PROTOCOL_UPDATE + - ROUTING_PROTOCOL_CREATION + - ROUTING_PROTOCOL_DELETION + href: + description: Routing Protocol Change URI 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: + format: uri + required: + - uuid + - type + RoutingProtocolProject: + description: The Routing Protocol's project 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: + projectId: + description: Uniquely identifies a project + type: string + required: + - projectId + RoutingProtocolConnection: + description: Connection specification type: object properties: - href: + uuid: + description: Equinix-assigned connection identifier type: string - description: Equinix assigned response attribute for an absolute URL that is the subject of the link's context. - format: uri - readOnly: true + platformUuid: + description: Equinix-assigned platform connection identifier + type: string + RoutingProtocolBGPData: + type: object + properties: type: - $ref: "#/components/schemas/PortType" - uuid: + description: Routing protocol type type: string - description: Equinix assigned response attribute for port identifier - format: uuid + enum: + - BGP 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 + example: My-BGP-route-1 + bgpIpv4: + $ref: '#/components/schemas/BGPConnectionIpv4' + bgpIpv6: + $ref: '#/components/schemas/BGPConnectionIpv6' + customerAsn: + description: Customer asn type: integer - description: Physical Ports Speed in Mbps - connectionsCount: - minimum: 0 + format: int64 + example: 65002 + equinixAsn: + description: Equinix asn type: integer - description: Equinix assigned response attribute for Connection count - physicalPortsType: + format: int64 + example: 65002 + bgpAuthKey: + description: BGP authorization key type: string - description: Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports - enum: - - 1000BASE_LX - - 10GBASE_LR - - 100GBASE_LR4 - - 10GBASE_ER - - 1000BASE_SX - - 10GBASE_SMF - - 400GBASE_LR4 - physicalPortsCount: - type: integer - connectivitySourceType: + example: testAuthKey + asOverrideEnabled: + description: Enable AS number override + type: boolean + bfd: + $ref: '#/components/schemas/RoutingProtocolBFD' + href: type: string - description: Port connectivity type - enum: - - COLO - - BMMR - - REMOTE - bmmrType: + format: uri + description: Routing Protocol URI + example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/69762051-85ed-4d13-b6b4-e32e93c672b5 + uuid: + description: Routing protocol identifier type: string - enum: - - SELF - - EQUINIX - project: - $ref: "#/components/schemas/Project" + format: uuid + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 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 - serviceCode: - $ref: "#/components/schemas/PortServiceCode" - 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: + - PROVISIONED + - DEPROVISIONED + - PROVISIONING + - DEPROVISIONING + - REPROVISIONING + - FAILED + operation: + $ref: '#/components/schemas/RoutingProtocolOperation' + change: + $ref: '#/components/schemas/RoutingProtocolChange' + changelog: + $ref: '#/components/schemas/Changelog' + project: + $ref: '#/components/schemas/RoutingProtocolProject' + connection: + $ref: '#/components/schemas/RoutingProtocolConnection' + DirectConnectionIpv4: + type: object + properties: + equinixIfaceIp: + description: Equinix side Interface IP address type: string - description: A-side/Equinix ibx - tetherIbx: + example: 192.168.100.0/30 + DirectConnectionIpv6: + type: object + properties: + equinixIfaceIp: + description: Equinix side Interface IP address 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: - deprecated: true - 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" - marketplaceSubscription: - $ref: "#/components/schemas/marketplaceSubscription" - description: Port specification - PhysicalPort: + example: 2001:db8:c59b::/1 + required: + - equinixIfaceIp + RoutingProtocolDirectData: type: object properties: + type: + description: Routing protocol type + type: string + enum: + - DIRECT + name: + type: string + example: My-direct-route-1 + directIpv4: + $ref: '#/components/schemas/DirectConnectionIpv4' + directIpv6: + $ref: '#/components/schemas/DirectConnectionIpv6' 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 + description: Routing Protocol URI + example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/69762051-85ed-4d13-b6b4-e32e93c672b5 uuid: + description: Routing protocol identifier 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" + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + state: + type: string + enum: + - PROVISIONED + - DEPROVISIONED + - PROVISIONING + - DEPROVISIONING + - REPROVISIONING + - FAILED operation: - $ref: "#/components/schemas/PortOperation" - loas: + $ref: '#/components/schemas/RoutingProtocolOperation' + change: + $ref: '#/components/schemas/RoutingProtocolChange' + changelog: + $ref: '#/components/schemas/Changelog' + project: + $ref: '#/components/schemas/RoutingProtocolProject' + connection: + $ref: '#/components/schemas/RoutingProtocolConnection' + RoutingProtocolData: + type: object + properties: + type: + description: Routing protocol type + type: string + enum: + - BGP + - DIRECT + oneOf: + - $ref: '#/components/schemas/RoutingProtocolBGPData' + - $ref: '#/components/schemas/RoutingProtocolDirectData' + GetResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: List of Routing Protocols type: array - description: Port Loas items: - $ref: "#/components/schemas/PortLoa" - description: Physical Port specification - PortRequest: - required: - - account - - connectivitySourceType - - encapsulation - - location - - physicalPortsSpeed - - physicalPortsType - - project - - type + $ref: '#/components/schemas/RoutingProtocolData' + RoutingProtocolBGPType: type: object properties: type: - $ref: "#/components/schemas/PortType" - physicalPortsSpeed: - minimum: 0 - type: integer - description: Physical Ports Speed in Mbps - physicalPortsType: + description: Routing protocol type type: string - description: Physical Ports Type. 10GBASE_SMF is only applicable for IX ports enum: - - 1000BASE_LX - - 10GBASE_LR - - 100GBASE_LR4 - - 10GBASE_ER - - 1000BASE_SX - - 10GBASE_SMF - - 400GBASE_LR4 - physicalPortsCount: + - BGP + name: + type: string + example: My-BGP-route-1 + bgpIpv4: + $ref: '#/components/schemas/BGPConnectionIpv4' + bgpIpv6: + $ref: '#/components/schemas/BGPConnectionIpv6' + customerAsn: + description: Customer asn type: integer - connectivitySourceType: + format: int64 + bgpAuthKey: + description: BGP authorization key type: string - description: Port connectivity type - enum: - - COLO - - BMMR - - REMOTE - bmmrType: - type: string - description: BMMR Type is mandatory when connectivitySourceType is BMMR - enum: - - SELF - - EQUINIX - project: - $ref: "#/components/schemas/Project" - order: - $ref: "#/components/schemas/PortOrder" - account: - $ref: "#/components/schemas/SimplifiedAccountRequest" - serviceType: - type: string - description: Port service Type - deprecated: true - enum: - - EPL - - MSP - serviceCode: - $ref: "#/components/schemas/PortServiceCode" - bandwidth: - minimum: 0 - type: integer - description: Equinix assigned response attribute for Port bandwidth in Mbps - deprecated: true - location: - $ref: "#/components/schemas/SimplifiedLocationRequest" - 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: + asOverrideEnabled: + description: Enable AS number override type: boolean - description: Indicates whether Link Aggregation Group (LAG) is enabled on this port - package: - $ref: "#/components/schemas/Package" - settings: - $ref: "#/components/schemas/PortSettings" - notifications: - type: array - description: Notification preferences - items: - $ref: "#/components/schemas/PortNotification" - 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: PortRequest is the Request Object for creating single and bulk fabric ports - 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" - Error: + bfd: + $ref: '#/components/schemas/RoutingProtocolBFD' required: - - errorCode - - errorMessage + - type + RoutingProtocolDirectType: type: object properties: - errorCode: - pattern: ^EQ-\d{7}$ - type: string - errorMessage: - type: string - correlationId: - type: string - details: + type: + description: Routing protocol type type: string - help: + enum: + - DIRECT + name: type: string - additionalInfo: - type: array - items: - $ref: "#/components/schemas/PriceError_additionalInfo" - description: Error Response with details - LinkProtocolGetResponse: - type: object - properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - items: - $ref: "#/components/schemas/LinkProtocolResponse" - description: List of Vlans - PortV4SearchRequest: + example: My-direct-route-1 + directIpv4: + $ref: '#/components/schemas/DirectConnectionIpv4' + directIpv6: + $ref: '#/components/schemas/DirectConnectionIpv6' required: - - filter - 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 + RoutingProtocolBase: type: object properties: - and: - $ref: "#/components/schemas/PortExpressions" - or: - $ref: "#/components/schemas/PortExpressions" - property: - $ref: "#/components/schemas/PortSearchFieldName" - operator: + type: + description: Routing protocol type type: string enum: - - = - - "!=" - - ">" - - ">=" - - < - - <= - - LIKE - - ILIKE - - IN - - NOT IN - - BETWEEN - values: - type: array - items: - type: string - description: | - Either use 'and' for AND operations, 'or' for OR operations, or specify 'property', 'operator', and 'values' for field filtering. Only one of these patterns should be used at a time. - PortExpressions: - type: array - items: - $ref: "#/components/schemas/PortExpression" - PortSearchFieldName: - type: string - description: Possible field names to use on filters - enum: - - /device/name - - /physicalPorts/tether/crossConnectId - - /physicalPorts/interface/name - - /state - - /project/projectId - - /uuid - - /name - - /account/orgId - - /account/accountNumber - - /location/metroCode - - /operation/maintenanceStatus - - /operation/lockEnabled - x-enum-deprecations: - /device/name: true - /physicalPorts/interface/name: true - PortSortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/PortSortDirection" - property: - $ref: "#/components/schemas/PortSortBy" - AllPortPackagesResponse: + - BGP + - DIRECT required: - - data - type: object - properties: - data: - type: array - description: List of Port Packages - items: - $ref: "#/components/schemas/PortPackage" - description: Port Packages response - GetAllConnectionRouteAggregationsResponse: + - type + oneOf: + - $ref: '#/components/schemas/RoutingProtocolBGPType' + - $ref: '#/components/schemas/RoutingProtocolDirectType' + ConnectionRoutingProtocolPostRequest: type: object + description: Create connection routing protocolpost request properties: - pagination: - $ref: "#/components/schemas/Pagination" data: + description: Connection routing protocol configuration type: array - description: List of Route Aggregations attached to a Connection items: - $ref: "#/components/schemas/ConnectionRouteAggregationData" - RouteAggregationId: + $ref: '#/components/schemas/RoutingProtocolBase' + ConnectionRoutingProtocolPatchRequest: + description: Patch connection routing protocol request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/ConnectionChangeOperation' + BGPActions: + description: BGP action type type: string - description: Route Aggregations UUID - example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - ConnectionRouteAggregationData: + enum: + - CLEAR_BGPIPV4 + - CLEAR_BGPIPV6 + - CLEAR_BGPIPV4_INBOUND + - CLEAR_BGPIPV6_INBOUND + - RESET_BGPIPV4 + - RESET_BGPIPV6 + BGPActionStates: + description: BGP action state + type: string + enum: + - PENDING + - FAILED + - SUCCEEDED + BGPActionData: 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 + description: Routing Protocol URI + example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/69762051-85ed-4d13-b6b4-e32e93c672b5/actions uuid: + description: Routing protocol identifier type: string - description: Route Aggregation identifier format: uuid - example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - attachmentStatus: + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + type: + $ref: '#/components/schemas/BGPActions' + description: type: string - enum: - - ATTACHING - - ATTACHED - - DETACHED - - DETACHING - - FAILED - - PENDING_BGP_CONFIGURATION - changeLog: - $ref: "#/components/schemas/Changelog" - GetAllConnectionRouteFiltersResponse: + description: BGP action description + state: + $ref: '#/components/schemas/BGPActionStates' + changelog: + $ref: '#/components/schemas/Changelog' + BGPActionsBulkData: + description: List of BGP Actions type: object properties: pagination: - $ref: "#/components/schemas/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: + $ref: '#/components/schemas/BGPActionData' + BGPActionRequest: + description: BGP action request 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 - changeLog: - $ref: "#/components/schemas/Changelog" - ConnectionRouteFiltersBase: - required: - - direction - type: object - properties: - direction: - type: string - description: Route Filter direction to attach to a connection - enum: - - INBOUND - - OUTBOUND - RouteFiltersBase: + $ref: '#/components/schemas/BGPActions' required: - - name - - project - type + RoutingProtocolChangeOperation: + description: Routing Protocol change operation data 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: + op: + description: Handy shortcut for operation name 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: + - add + - replace + - remove + path: + description: path inside document leading to updated parameter 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: + example: / + value: + $ref: '#/components/schemas/RoutingProtocolBase' + required: + - op + - path + - value + RoutingProtocolChangeData: + description: Current state of latest Routing Protocol change type: object properties: status: - type: string description: Current outcome of the change flow + type: string enum: - COMPLETED - FAILED - REQUESTED createdBy: type: string - description: Created by user key + description: Created by User Key createdDateTime: - type: string description: Set when change flow starts + type: string format: date-time updatedBy: type: string - description: Updated by user key + description: Updated by User Key updatedDateTime: - type: string description: Set when change object is updated + type: string format: date-time information: - type: string description: Additional information + type: string data: - $ref: "#/components/schemas/RouteFiltersChangeOperation" - description: Current state of latest route filter change + $ref: '#/components/schemas/RoutingProtocolChangeOperation' allOf: - - $ref: "#/components/schemas/RouteFiltersChange" - GetRouteFilterGetConnectionsResponse: + - $ref: '#/components/schemas/RoutingProtocolChange' + RoutingProtocolChangeDataResponse: + description: List of network changes type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: type: array - description: List of Connections using a Route Filter items: - $ref: "#/components/schemas/RouteFilterConnectionsData" - RouteFiltersSearchRequest: + $ref: '#/components/schemas/RoutingProtocolChangeData' + PublicPeeringConnectionRequest: type: object + description: Public Peering Connection properties: - filter: - $ref: "#/components/schemas/SearchFilter" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/RouteFilterSortCriteria" - description: Search route filters - RouteFiltersSearchResponse: + uuid: + type: string + format: uuid + description: connection id + example: b44c6e6c-2c36-4488-b3f1-47064357b5b4 + ExchangeServiceRequestBgp: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + domainName: + type: string + description: Domain name for BGP + example: gw01.sin.example.net + minLength: 1 + maxLength: 253 + asSet: + type: string + description: AS-SET used to filter the prefixes announced by the customer + example: AS-EC-SV + minLength: 2 + maxLength: 48 + mlpeEnabled: + type: boolean + description: Whether Multi-Lateral Peering Exchange (MLPE) is enabled + example: true + default: false + md5AuthKey: + type: string + description: MD5 key for BGP + example: TestAuthKey12345 + minLength: 1 + maxLength: 255 + rcMd5AuthKey: + type: string + description: RC MD5 key for BGP + example: TestAuthKey123456 + minLength: 1 + maxLength: 255 + prefixes: type: array - description: List of route filters + description: List of IP prefix items: - $ref: "#/components/schemas/RouteFiltersData" - GetRouteFilterRulesResponse: + type: string + description: IP prefix + maxPrefixLimit: + type: integer + description: Max Prefix Limit number + format: int64 + example: 300 + prependSelfEnabled: + type: boolean + description: Prepend Self Enabled + example: true + default: true + RoutingProtocolRequest: 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 + customerAsn: + type: integer + description: Customer Autonomous System Number (ASN) + example: 1100 + macAddress: + type: string + description: MAC address of the customer interface + example: '00:11:22:33:44:55' + bgpIpv4: + $ref: '#/components/schemas/ExchangeServiceRequestBgp' + bgpIpv6: + $ref: '#/components/schemas/ExchangeServiceRequestBgp' + ExchangeServiceOrder: type: object + description: Ordering and billing reference details for this Exchange Service. properties: - name: + purchaseOrderNumber: type: string - example: Private-subnet-filter - description: + description: Purchase order number reference. + example: '156576' + orderId: + description: Equinix-assigned order identifier. type: string - description: Customer-provided Route Filter Rule description - prefix: + readOnly: true + customerReferenceId: + description: Your own reference for this Exchange Service. type: string - example: 192.168.0.0/24 - prefixMatch: + orderNumber: + description: Equinix order reference number. type: string - example: orlonger, exact - default: orlonger - RouteFilterRulesData: - type: object - properties: - href: + example: 1-129105284100 + orderLineItemNumber: + description: Order Reference Number for Sales Assisted Order 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: + readOnly: true + domainOrderNumber: + description: product domain Order Number for Sales Assisted Order type: string - description: Route filter type - enum: - - BGP_IPv4_PREFIX_FILTER_RULE - - BGP_IPv6_PREFIX_FILTER_RULE + readOnly: true uuid: + description: Equinix-assigned order identifier, this is a derived response attribute type: string - description: Route Filter Rule identifier format: uuid - example: 65b025ef-022b-4180-85cf-82cfc1ab655b - name: + readOnly: true + ExchangeServiceNotification: + type: object + properties: + type: + description: Internet Exchange Service Notification Type type: string - example: Private-subnet-filter-2 + enum: + - NOTIFICATION + - TECHNICAL + - PEERING + - ESCALATION + - ORDERING + registeredUsers: + description: Array of registered users + type: array + items: + type: string + required: + - type + - registeredUsers + ExchangeServiceCreateRequest: + type: object + properties: + type: + type: string + example: IX + enum: + - IX + description: Internet Exchange Service type + name: + type: string + example: ix_exchange_service + description: Customer-provided internet exchange service name + minLength: 1 + maxLength: 50 description: type: string - description: Customer-provided Route Filter Rule description - state: - $ref: "#/components/schemas/RouteFilterRuleState" - prefixMatch: + example: ix_exchange_service + description: Customer-provided internet exchange service description + minLength: 1 + maxLength: 255 + publicPeeringConnection: + $ref: '#/components/schemas/PublicPeeringConnectionRequest' + routingProtocol: + $ref: '#/components/schemas/RoutingProtocolRequest' + order: + $ref: '#/components/schemas/ExchangeServiceOrder' + project: + $ref: '#/components/schemas/Project' + account: + $ref: '#/components/schemas/SimplifiedAccount' + notifications: + description: Preferences for notifications on Internet Exchange Service configuration or status changes + type: array + items: + $ref: '#/components/schemas/ExchangeServiceNotification' + required: + - type + - name + - publicPeeringConnection + - routingProtocol + PublicPeeringConnectionResponse: + type: object + properties: + type: type: string - description: prefix matching operator - example: exact - default: orlonger - change: - $ref: "#/components/schemas/RouteFilterRulesChange" - action: + format: enum + description: Connection type IX_VC + example: IX_VC + href: type: string - enum: - - PERMIT - - DENY - prefix: + format: string + description: URI + example: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 + uuid: 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: + format: uuid + description: uuid + example: b44c6e6c-2c36-4488-b3f1-47064357b5b4 + ExchangeServiceResponseBgp: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + customerPeerIp: + type: string + description: Customer peer IP address + example: 12.1.1.1 + domainName: + type: string + description: Domain name for BGP + example: ix-v4.gw01.sin.example.net + primaryRouteServerIp: + type: string + description: Primary route server IP address with prefix length + example: 206.126.239.251/22 + secondaryRouteServerIp: + type: string + description: Secondary route server IP address with prefix length + example: 206.126.239.252/22 + asSet: + type: string + description: AS-SET used to filter the prefixes announced by the customer + example: AS-EC-SV + mlpeEnabled: + type: boolean + description: Whether Multi-Lateral Peering Exchange (MLPE) is enabled + example: true + md5AuthKey: + type: string + description: MD5 key for BGP + example: TestAuthKey12345 + rcMd5AuthKey: + type: string + description: RC MD5 key for BGP + example: TestAuthKey123456 + prefixes: type: array + description: List of IP prefix 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: string + description: IP prefix + maxPrefixLimit: + type: integer + description: Max Prefix Limit number + format: int64 + example: 300 + prependSelfEnabled: + type: boolean + description: Prepend Self Enabled + example: true + RouteCollector: type: object + description: Route Collector properties: - status: + asn: + type: integer + format: int64 + description: Route Collector ASN + example: 1238 + ipV4: type: string - description: Current outcome of the change flow - enum: - - COMPLETED - - FAILED - - REQUESTED + description: Route Collector ipV4 address + example: 206.126.239.250/22 + ipV6: + type: string + description: Route Collector ipV6 address + example: 2001:504:0:2:0:6:5517:1/64 + RoutingProtocolResponse: + type: object + properties: + customerAsn: + type: integer + description: Customer Autonomous System Number (ASN) + example: 1100 + macAddress: + type: string + description: MAC address of the customer interface + example: '00:11:22:33:44:55' + vlan: + type: integer + format: int64 + description: VLAN ID + example: 3292 + routeServerAsn: + type: integer + format: int64 + description: Equinix Route Server ASN + example: 1100 + bgpIpv4: + $ref: '#/components/schemas/ExchangeServiceResponseBgp' + bgpIpv6: + $ref: '#/components/schemas/ExchangeServiceResponseBgp' + routeCollector: + $ref: '#/components/schemas/RouteCollector' + PlatformChangelog: + description: Change log + type: object + properties: createdBy: type: string + example: johnsmith description: Created by User Key createdDateTime: type: string - description: Set when change flow starts format: date-time + example: '2020-11-06T07:00:00Z' + description: Created by Date and Time updatedBy: type: string + example: johnsmith 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: + example: '2020-11-06T07:00:00Z' + description: Updated by Date and Time + deletedBy: + type: string + example: johnsmith + description: Deleted by User Key + deletedDateTime: + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + description: Deleted by Date and Time + ExchangeServiceAdditionalInfo: type: object + description: Additional information regarding the specified Exchange Service properties: - data: - type: array - description: Route Filter Rule configuration - items: - $ref: "#/components/schemas/RouteFilterRulesBase" - description: Create Route Filter Rule POST request - RouteFilterRulesSearchRequest: + errorCode: + type: string + description: Error code shown if an operation on the Exchange Service fails + errorMessage: + type: string + description: Generic message shown if an operation on the Exchange Service fails + ExchangeServiceResponse: type: object properties: - filter: - $ref: "#/components/schemas/RouteFilterRulesFilter" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + href: + type: string + description: Internet Exchange Service URI + example: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 + uuid: + type: string + format: uuid + description: Internet Exchange Service identifier + example: a8ba52de-faae-43b5-b0b1-6904d37ee011 + type: + type: string + description: Internet Exchange Service Type + example: IX + default: IX + enum: + - IX + name: + type: string + description: Name + example: ix_exchange_service + bandwidth: + type: integer + description: bandwidth in Mbps + example: 400000 + description: + type: string + description: Description + example: ix_exchange_service + state: + type: string + description: State + example: PROVISIONING + enum: + - PROVISIONING + - PROVISIONING_FAILED + - PENDING_ACTIVATION + - ACTIVATING + - ACTIVATING_FAILED + - PROVISIONED + - REPROVISIONING + - REPROVISIONING_FAILED + - DEPROVISIONING + - DEPROVISIONED + - DEPROVISIONING_FAILED + location: + $ref: '#/components/schemas/SimplifiedLocation' + publicPeeringConnection: + $ref: '#/components/schemas/PublicPeeringConnectionResponse' + routingProtocol: + $ref: '#/components/schemas/RoutingProtocolResponse' + order: + $ref: '#/components/schemas/ExchangeServiceOrder' + project: + $ref: '#/components/schemas/Project' + account: + $ref: '#/components/schemas/SimplifiedAccount' + notifications: + description: Preferences for notifications on Internet Exchange Service configuration or status changes type: array items: - $ref: "#/components/schemas/RouteFilterRuleSortCriteria" - description: Search route filter rules - RouteFilterRulesFilter: - description: Top-level filter that can be either an AND expression or OR expression - anyOf: - - $ref: "#/components/schemas/RouteFilterRuleAndExpression" - - $ref: "#/components/schemas/RouteFilterRuleOrExpression" - RouteFilterRuleAndExpression: + $ref: '#/components/schemas/ExchangeServiceNotification' + changelog: + $ref: '#/components/schemas/PlatformChangelog' + additionalInfo: + $ref: '#/components/schemas/ExchangeServiceAdditionalInfo' + ExchangeServiceOpEnum: + description: the operation to be performed + type: string + enum: + - replace + - add + ExchangeServicePath: + description: | + ### A JSON Pointer path. + * `/name` - Name of the Internet Exchange Service + * `/description` - Description of the Internet Exchange Service + * `routingProtocol/macAddress` - MAC Address + * `routingProtocol/bgpIpv4/domainName` - Domain Name for BGP IPv4 + * `routingProtocol/bgpIpv4/asSet` - AS Set for BGP IPv4 + * `routingProtocol/bgpIpv4/md5AuthKey` - MD5 Auth Key for BGP IPv4 + * `routingProtocol/bgpIpv4/rcMd5AuthKey` - RC MD5 Auth Key for BGP IPv4 + * `routingProtocol/bgpIpv4/ipPrefixes` - IP Prefixes for BGP IPv4 + * `routingProtocol/bgpIpv6/mlpeEnabled` - MLPE Enabled for BGP IPv4 + * `routingProtocol/bgpIpv6/domainName`- Domain Name for BGP IPv6 + * `routingProtocol/bgpIpv6/asSet`- AS Set for BGP IPv6 + * `routingProtocol/bgpIpv6/md5AuthKey` - MD5 Auth Key for BGP IPv6 + * `routingProtocol/bgpIpv6/rcMd5AuthKey` - RC MD5 Auth Key for BGP IPv6 + * `routingProtocol/bgpIpv6/ipPrefixes` - IP Prefixes for BGP IPv6 + * `routingProtocol/bgpIpv6/mlpeEnabled` - MLPE Enabled for BGP IPv6 + type: string + ExchangeServiceReplaceOperation: + description: Replace attribute value or sub-resource in the existing model + type: object + required: + - op + - path + - value + properties: + op: + $ref: '#/components/schemas/ExchangeServiceOpEnum' + path: + $ref: '#/components/schemas/ExchangeServicePath' + value: + description: value to replace with + JsonPatch: + type: array + items: + $ref: '#/components/schemas/ExchangeServiceReplaceOperation' + ExchangeServiceSearchExpression: + oneOf: + - $ref: '#/components/schemas/ExchangeServiceAndExpression' + - $ref: '#/components/schemas/ExchangeServiceOrExpression' + - $ref: '#/components/schemas/ExchangeServicePropertyExpression' + ExchangeServiceAndExpression: type: object + required: + - and properties: and: - maxItems: 8 - minItems: 1 type: array items: - $ref: "#/components/schemas/RouteFilterRuleExpression" - description: AND expression containing multiple filter expressions - RouteFilterRuleExpression: - description: Filter expression that can be AND, OR, or a simple expression - anyOf: - - $ref: "#/components/schemas/RouteFilterRuleAndExpression" - - $ref: "#/components/schemas/RouteFilterRuleOrExpression" - - $ref: "#/components/schemas/RouteFilterRuleSimpleExpression" - RouteFilterRuleOrExpression: + $ref: '#/components/schemas/ExchangeServiceSearchExpression' + ExchangeServiceOrExpression: type: object + required: + - or properties: or: - maxItems: 8 - minItems: 1 type: array items: - $ref: "#/components/schemas/RouteFilterRuleExpression" - description: OR expression containing multiple filter expressions - RouteFilterRuleSimpleExpression: + $ref: '#/components/schemas/ExchangeServiceSearchExpression' + ExchangeServicePropertyExpression: type: object + required: + - property + - operator + - values properties: property: + description: Possible field names to use on filters type: string - description: | - Possible field names to use on filters: - * `/type` - Route Filter Rules Type - * `/name` - Route Filter Rules Name - * `/uuid` - Route Filter Rules uuid - * `/state` - Route Filter Rules status - * `/prefix` - Route Filter Rule Prefix - * `/prefixMatch` - Route Filter Rule Prefix Match - example: /name + enum: + - /project/projectId + - /uuid + - /state + - /name + - /bandwidth + - /changelog/createdDateTime + - /changelog/updatedDateTime + - /changelog/deletedDateTime + - /location/metroCode operator: type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `[NOT] LIKE` - (not) like - * `[NOT] IN` - (not) in - * `ILIKE` - case-insensitive like - example: = + enum: + - '=' + - '!=' + - BETWEEN + - < + - <= + - '>' + - '>=' + - LIKE + - ILIKE + - IN values: - maxItems: 8 - minItems: 1 type: array + minItems: 1 items: type: string - example: Route_Filter_Rule_Demo - description: Simple filter expression with property, operator, and values - RouteFilterRuleSortCriteria: + ExchangeServiceSearchSortCriteria: type: object properties: direction: - $ref: "#/components/schemas/RouteFilterRuleSortDirection" + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC property: - $ref: "#/components/schemas/RouteFilterRuleSortBy" - RouteFilterRuleSortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - RouteFilterRuleSortBy: - type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime - enum: - - /type - - /uuid - - /name - - /state - - /prefix - - /prefixMatch - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - RouteFilterRulesSearchResponse: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + enum: + - /name + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + ExchangeServiceSearchRequest: type: object + description: Search requests containing criteria properties: + filter: + $ref: '#/components/schemas/ExchangeServiceSearchExpression' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array - description: List of route filter rules items: - $ref: "#/components/schemas/RouteFilterRulesData" - 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: + $ref: '#/components/schemas/ExchangeServiceSearchSortCriteria' + ExchangeServiceSearchResponse: + description: List of Internet Exchange Service type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/ExchangeServiceSearchSortCriteria' 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: + $ref: '#/components/schemas/ExchangeServiceResponse' + ExchangeServiceActionRequest: type: object + required: + - type + description: Internet Exchange Service Action Request properties: - status: + type: 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 + - EXCHANGE_SERVICE_ACTIVATE + - EXCHANGE_SERVICE_VALIDATE + - EXCHANGE_SERVICE_RETRY_PROVISION + ExchangeServiceActionResponse: 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" - RouteAggregationsSearchRequest: - type: object - properties: - filter: - $ref: "#/components/schemas/SearchFilter" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/RouteAggregationSortCriteria" - description: Search route aggregations - RouteAggregationsSearchResponse: + - $ref: '#/components/schemas/ExchangeServiceActionRequest' + - type: object + properties: + href: + type: string + description: Internet Exchange Service Action URI + example: https://api.equinix.com/fabric/v4/exchangeService/e8ba52fe-faae-43b5-b0b1-6904d37ee011/actions/a8ba52de-faae-43b5-b0b1-6904d37ee011 + uuid: + type: string + format: uuid + description: Action identifier + example: a8ba52de-faae-43b5-b0b1-6904d37ee011 + description: + type: string + description: Action description + example: Action description text + minLength: 0 + maxLength: 255 + state: + type: string + description: State + example: PENDING + enum: + - PENDING + - SUCCEEDED + - FAILED + changelog: + $ref: '#/components/schemas/PlatformChangelog' + InternetAccessServiceType: + type: string + enum: + - SINGLE_IA + - DUAL_IA + x-enum-varnames: + - SINGLE_IA + - DUAL_IA + description: Type of the service, either single or dual internet access + InternetAccessRoutingProtocolRequest: type: object + required: + - type + - customerRoutes properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + type: + $ref: '#/components/schemas/InternetAccessRoutingProtocolType' + customerRoutes: type: array - description: List of Route Aggregations + minItems: 1 + maxItems: 100 items: - $ref: "#/components/schemas/RouteAggregationsData" - GetRouteAggregationRulesResponse: + $ref: '#/components/schemas/InternetAccessCustomerRouteRequest' + discriminator: + propertyName: type + mapping: + BGP: '#/components/schemas/InternetAccessRoutingProtocolBgpRequest' + DIRECT: '#/components/schemas/InternetAccessRoutingProtocolDirectRequest' + STATIC: '#/components/schemas/InternetAccessRoutingProtocolStaticRequest' + InternetAccessConnectionBgpRequest: 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 + - uuid 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: + description: Unique identifier for the connection + InternetAccessExportPolicy: 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: + description: Denotes which routes should be advertised to the internet + example: FULL + enum: + - FULL + - DEFAULT + - FULL_DEFAULT + - PARTIAL + x-enum-varnames: + - FULL + - DEFAULT + - FULL_DEFAULT + - PARTIAL + InternetAccessCustomerAsnRange: type: string - description: Route Aggregation Rule Change UUID - format: uuid - example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 - RouteAggregationRulesChangeData: + description: Customer Autonomous System Number range. Based on the value a proper private ASN will be generated. + enum: + - BITS_16 + - BITS_32 + x-enum-varnames: + - BITS_16 + - BITS_32 + InternetAccessRoutingProtocolBgpRequest: + allOf: + - $ref: '#/components/schemas/InternetAccessRoutingProtocolRequest' + - type: object + required: + - exportPolicy + - connections + properties: + connections: + type: array + minItems: 1 + maxItems: 2 + items: + $ref: '#/components/schemas/InternetAccessConnectionBgpRequest' + exportPolicy: + $ref: '#/components/schemas/InternetAccessExportPolicy' + asn: + type: object + required: + - uuid + properties: + uuid: + type: string + format: uuid + description: Unique identifier of the ASN + example: ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91 + customerAsn: + type: integer + description: Customer ASN. Valid range is 1-64495 or 65536-4199999999. + format: int64 + example: 16220 + deprecated: true + bgpAuthKey: + type: string + description: BGP authentication key + example: SecretKey + customerAsnRange: + deprecated: true + $ref: '#/components/schemas/InternetAccessCustomerAsnRange' + InternetAccessPeeringIpv4Request: type: object properties: - status: - type: string - description: Current outcome of the change flow - enum: - - COMPLETED - - FAILED - - REQUESTED - createdBy: + equinixPeerIp: type: string - description: Created by User Key - createdDateTime: + pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + description: IPv4 address of the Equinix peering IP + equinixVrrpIp: type: string - description: Set when change flow starts - format: date-time - updatedBy: + pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + description: IPv4 address for Equinix VRRP IP + InternetAccessPeeringIpv6Request: + type: object + properties: + equinixPeerIp: type: string - description: Updated by User Key - updatedDateTime: + pattern: ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$ + description: IPv6 address of the Equinix peering IP + equinixVrrpIp: 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: + pattern: ^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$ + description: IPv6 address for Equinix VRRP IP + InternetAccessConnectionDirectRequest: type: object + required: + - uuid properties: - data: - type: array - description: Route Aggregation Rule configuration - items: - $ref: "#/components/schemas/RouteAggregationRulesBase" - description: Create Route Aggregation Rule POST request - RouteAggregationRulesSearchRequest: + uuid: + type: string + format: uuid + description: Unique identifier for the connection + peeringIpv4: + $ref: '#/components/schemas/InternetAccessPeeringIpv4Request' + peeringIpv6: + $ref: '#/components/schemas/InternetAccessPeeringIpv6Request' + InternetAccessRoutingProtocolDirectRequest: + allOf: + - $ref: '#/components/schemas/InternetAccessRoutingProtocolRequest' + - type: object + required: + - connections + properties: + connections: + type: array + minItems: 1 + maxItems: 2 + items: + $ref: '#/components/schemas/InternetAccessConnectionDirectRequest' + InternetAccessConnectionStaticRequest: type: object + required: + - uuid properties: - filter: - $ref: "#/components/schemas/RouteAggregationRulesFilter" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/RouteAggregationRuleSortCriteria" - description: Search route aggregation rules - RouteAggregationRulesFilter: - description: Top-level filter that can be either an AND expression or OR expression - anyOf: - - $ref: "#/components/schemas/RouteAggregationRuleAndExpression" - - $ref: "#/components/schemas/RouteAggregationRuleOrExpression" - RouteAggregationRuleAndExpression: + uuid: + type: string + format: uuid + description: Unique identifier for the connection + InternetAccessRoutingProtocolStaticRequest: + allOf: + - $ref: '#/components/schemas/InternetAccessRoutingProtocolRequest' + - type: object + required: + - connections + properties: + connections: + type: array + minItems: 1 + maxItems: 2 + items: + $ref: '#/components/schemas/InternetAccessConnectionStaticRequest' + InternetAccessRoutingProtocolType: + type: string + enum: + - BGP + - DIRECT + - STATIC + x-enum-varnames: + - BGP + - DIRECT + - STATIC + InternetAccessIpBlockRequest: type: object + required: + - uuid properties: - and: - maxItems: 8 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/RouteAggregationRuleExpression" - description: AND expression containing multiple filter expressions - RouteAggregationRuleExpression: - description: Filter expression that can be AND, OR, or a simple expression - anyOf: - - $ref: "#/components/schemas/RouteAggregationRuleAndExpression" - - $ref: "#/components/schemas/RouteAggregationRuleOrExpression" - - $ref: "#/components/schemas/RouteAggregationRuleSimpleExpression" - RouteAggregationRuleOrExpression: + uuid: + type: string + format: uuid + description: Unique identifier for the IP Block + InternetAccessCustomerRouteRequest: type: object + required: + - ipBlock properties: - or: - maxItems: 8 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/RouteAggregationRuleExpression" - description: OR expression containing multiple filter expressions - RouteAggregationRuleSimpleExpression: + ipBlock: + $ref: '#/components/schemas/InternetAccessIpBlockRequest' + InternetAccessOrderRequest: type: object properties: - property: + purchaseOrderNumber: type: string - description: | - Possible field names to use on filters: - * `/type` - Route Aggregation Rules Type - * `/name` - Route Aggregation Rules Name - * `/uuid` - Route Aggregation Rules uuid - * `/state` - Route Aggregation Rules status - * `/prefix` - Route Aggregation Rule Prefix - example: /name - operator: + nullable: true + description: Purchase order number + orderNumber: type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `[NOT] LIKE` - (not) like - * `[NOT] IN` - (not) in - * `ILIKE` - case-insensitive like - example: = - values: - maxItems: 8 - minItems: 1 - type: array - items: - type: string - example: Route_Aggregation_Rule_Demo - description: Simple filter expression with property, operator, and values - RouteAggregationRuleSortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/RouteAggregationRuleSortDirection" - property: - $ref: "#/components/schemas/RouteAggregationRuleSortBy" - RouteAggregationRuleSortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - RouteAggregationRuleSortBy: + nullable: true + description: Order Number + orderLine: + type: string + nullable: true + description: Order Line Number + InternetAccessBillingType: type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime enum: - - /type - - /uuid - - /name - - /state - - /prefix - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - RouteAggregationRulesSearchResponse: + - FIXED + - USAGE_BASED + - BURST_BASED + x-enum-varnames: + - FIXED + - USAGE_BASED + - BURST_BASED + InternetAccessAccount: type: object + required: + - accountNumber properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: List of route aggregation rules - items: - $ref: "#/components/schemas/RouteAggregationRulesData" - CloudRouterPostRequest: + accountNumber: + type: string + description: Account number + href: + type: string + format: uri + description: Account URL path + example: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 + InternetAccessPostRequest: + type: object required: - - location - - name - - notifications - - package - type - allOf: - - $ref: "#/components/schemas/CloudRouterPostRequestBase" - CloudRouterPostRequestBase: - type: object + - name + - routingProtocol + - billing + - project + - account properties: type: - type: string - enum: - - XF_ROUTER + $ref: '#/components/schemas/InternetAccessServiceType' name: type: string - description: Customer-provided Cloud Router name - location: - $ref: "#/components/schemas/SimplifiedLocationWithoutIBX" - package: - $ref: "#/components/schemas/CloudRouterPostRequestPackage" + description: The name of the EIA Service + bandwidth: + type: integer + description: Bandwidth of the service + bandwidthCommit: + type: integer + description: Minimum bandwidth commit for burst billing variant of the service + routingProtocol: + $ref: '#/components/schemas/InternetAccessRoutingProtocolRequest' order: - $ref: "#/components/schemas/Order" + $ref: '#/components/schemas/InternetAccessOrderRequest' + billing: + type: object + required: + - type + properties: + type: + $ref: '#/components/schemas/InternetAccessBillingType' project: - $ref: "#/components/schemas/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: + $ref: '#/components/schemas/InternetAccessAccount' + InternetAccessServiceState: + type: string + enum: + - PROVISIONING + - PROVISIONED + - FAILED + - DEPROVISIONING + - DEPROVISIONED + x-enum-varnames: + - PROVISIONING + - PROVISIONED + - FAILED + - DEPROVISIONING + - DEPROVISIONED + description: Current state of the service + InternetAccessChange: type: object + required: + - href 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/CloudRouterPostRequestBase" - RouterId: - type: string - description: Cloud Router UUID - format: uuid - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - CloudRouterReadResponse: + description: URI of the change object + InternetAccessLocation: type: object + required: + - metroHref + - metroCode + - ibx + - region properties: - type: + metroHref: type: string - enum: - - IC_ROUTER - - XF_ROUTER - name: + format: uri + description: Metro URL path for the linked resource + example: https://api.equinix.com/fabric/v4/metros/WA + metroCode: 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: + pattern: ^[A-Z]{2}$ + example: WA + description: Code representing the metro + region: + type: string + example: EMEA + enum: + - APAC + - EMEA + - AMER + description: Geographic region + ibx: + type: string + description: IBX data center code + example: WA1 + InternetAccessRoutingProtocol: + type: object + required: + - type + - customerRoutes + - connections + properties: + type: + $ref: '#/components/schemas/InternetAccessRoutingProtocolType' + customerRoutes: type: array - description: Preferences for notifications on connection configuration or status changes items: - $ref: "#/components/schemas/SimplifiedNotification" + $ref: '#/components/schemas/InternetAccessCustomerRoute' + connections: + type: array + items: + $ref: '#/components/schemas/InternetAccessConnection' + discriminator: + propertyName: type + mapping: + BGP: '#/components/schemas/InternetAccessRoutingProtocolBgp' + DIRECT: '#/components/schemas/InternetAccessRoutingProtocolDirect' + STATIC: '#/components/schemas/InternetAccessRoutingProtocolStatic' + InternetAccessBgpAuthType: + type: string + description: Indicates whether a BGP authentication key is configured. AUTH_KEY when bgpAuthKey is set, NONE otherwise. + enum: + - AUTH_KEY + - NONE + x-enum-varnames: + - AUTH_KEY + - NONE + default: NONE + example: AUTH_KEY + InternetAccessRoutingProtocolBgp: + allOf: + - $ref: '#/components/schemas/InternetAccessRoutingProtocol' + - type: object + required: + - exportPolicy + properties: + exportPolicy: + $ref: '#/components/schemas/InternetAccessExportPolicy' + asn: + type: object + required: + - uuid + properties: + href: + type: string + description: URI of the ASN resource + example: https://api.equinix.com/fabric/v4/asns/ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91 + uuid: + type: string + format: uuid + description: Unique identifier of the ASN + example: ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91 + customerAsn: + type: integer + format: int64 + description: Customer ASN. Valid range is 1-64495 or 131072-4199999999. Currently this option is only available for EIA over dedicated port. + example: 11111 + deprecated: true + bgpAuthKey: + type: string + description: BGP authentication key. This field is deprecated and will be removed in future releases. Please use bgpAuthType instead to determine if a BGP authentication key is configured. + example: SecretKey + deprecated: true + bgpAuthType: + $ref: '#/components/schemas/InternetAccessBgpAuthType' + customerAsnRange: + deprecated: true + $ref: '#/components/schemas/InternetAccessCustomerAsnRange' + InternetAccessRoutingProtocolDirect: + allOf: + - $ref: '#/components/schemas/InternetAccessRoutingProtocol' + InternetAccessRoutingProtocolStatic: + allOf: + - $ref: '#/components/schemas/InternetAccessRoutingProtocol' + InternetAccessIpBlock: + type: object + required: + - href + - uuid + 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 + description: URI of the IP block uuid: type: string - description: Equinix-assigned access point identifier format: uuid - example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 - state: - $ref: "#/components/schemas/CloudRouterAccessPointState" - equinixAsn: + description: Unique identifier for the IP block + InternetAccessCustomerRoute: + type: object + properties: + ipBlock: + $ref: '#/components/schemas/InternetAccessIpBlock' + InternetAccessPeeringIpv4: + type: object + properties: + prefix: + type: string + pattern: ^([01]?\d\d?|2[0-4]\d|25[0-5])(?:\.(?:[01]?\d\d?|2[0-4]\d|25[0-5])){3}/(?:[1-9]|[12]\d|3[0-2])$ + description: IPv4 prefix for the peering connection + prefixLength: type: integer - description: Equinix ASN - format: int64 - example: 30000 - connectionsCount: - minimum: 0 + minimum: 1 + maximum: 32 + description: Determines the size of subnet + example: 30 + equinixPeerIp: + type: string + pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + description: IPv4 peering IP address for Equinix side + customerPeerIp: + type: string + pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + description: IPv4 peering IP address for customer side + equinixVrrpIp: + type: string + pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + description: IPv4 address for Equinix VRRP IP + customerVrrpIp: + type: string + pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + description: IPv4 address for customer VRRP IP + InternetAccessPeeringIpv6: + type: object + properties: + prefix: + type: string + description: IPv6 prefix for the peering connection + prefixLength: 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 read response object - CloudRouterUpdateRequest: - minItems: 1 - type: array - description: Fabric Cloud Router Update Request - items: - $ref: "#/components/schemas/CloudRouterChangeOperation" - ActionState: - $ref: "#/components/schemas/CloudRouterActionState" - CloudRouterActionState: - type: string - description: Cloud router action state - enum: - - SUCCEEDED - - FAILED - - PENDING - CloudRouterActionsSearchResponse: + minimum: 8 + maximum: 128 + description: Determines the size of subnet + example: 64 + equinixPeerIp: + type: string + description: IPv6 peering IP address for Equinix side + customerPeerIp: + type: string + description: IPv6 peering IP address for customer side + equinixVrrpIp: + type: string + description: IPv6 address for Equinix VRRP IP + customerVrrpIp: + type: string + description: IPv6 address for customer VRRP IP + InternetAccessConnection: type: object + required: + - href + - uuid properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/CloudRouterActionResponse" - CloudRouterActionRequest: + href: + type: string + format: uri + description: URI of the connection + uuid: + type: string + format: uuid + description: Unique identifier for the connection + peeringIpv4: + $ref: '#/components/schemas/InternetAccessPeeringIpv4' + peeringIpv6: + $ref: '#/components/schemas/InternetAccessPeeringIpv6' + InternetAccessBilling: + type: object required: - type - type: object properties: type: - $ref: "#/components/schemas/CloudRouterActionType" - connection: - $ref: "#/components/schemas/RouterActionsConnection" - description: Cloud router action request - CloudRouterActionResponse: + $ref: '#/components/schemas/InternetAccessBillingType' + enabled: + type: boolean + description: Indicates whether the billing is enabled + startDate: + type: string + format: date-time + description: The start date for the billing period + InternetAccessOrder: + allOf: + - $ref: '#/components/schemas/Order' + - type: object + properties: + href: + type: string + format: uri + description: Order URI + example: https://api.equinix.com/colocations/v2/orders/100200300 + InternetAccessUseCase: + type: string + enum: + - MAIN + - MANAGEMENT_ACCESS + x-enum-varnames: + - MAIN + - MANAGEMENT_ACCESS + InternetAccessService: + type: object required: - - changeLog - - state + - href - type - uuid - type: object + - name + - state + - change + - routingProtocol + - billing + - account + - project + - changeLog + - useCase properties: + href: + type: string + format: uri + description: Service URL path + example: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 type: - $ref: "#/components/schemas/CloudRouterActionType" + $ref: '#/components/schemas/InternetAccessServiceType' uuid: type: string format: uuid - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - description: + description: Unique identifier for the EIA Service + name: type: string - example: description + description: The name of the EIA Service + bandwidth: + type: integer + description: Bandwidth of the service + bandwidthCommit: + type: integer + description: Minimum bandwidth commit for burst billing variant of the service state: - $ref: "#/components/schemas/CloudRouterActionState" + $ref: '#/components/schemas/InternetAccessServiceState' + change: + $ref: '#/components/schemas/InternetAccessChange' + locations: + type: array + items: + $ref: '#/components/schemas/InternetAccessLocation' + description: List of locations associated with the service + routingProtocol: + $ref: '#/components/schemas/InternetAccessRoutingProtocol' + billing: + $ref: '#/components/schemas/InternetAccessBilling' + account: + $ref: '#/components/schemas/InternetAccessAccount' + project: + $ref: '#/components/schemas/Project' + order: + $ref: '#/components/schemas/InternetAccessOrder' changeLog: - $ref: "#/components/schemas/Changelog" - href: + $ref: '#/components/schemas/Changelog' + useCase: + $ref: '#/components/schemas/InternetAccessUseCase' + SearchSortItem: + type: object + required: + - direction + - property + properties: + direction: 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" - router: - $ref: "#/components/schemas/RouterActionsRouter" - description: Cloud router actions response object - CloudRouterActionsSearchRequest: + enum: + - ASC + - DESC + example: ASC + property: + type: string + SearchSort: + type: array + items: + $ref: '#/components/schemas/SearchSortItem' + InternetAccessSearchRequest: type: object properties: - filter: - $ref: "#/components/schemas/CloudRouterActionsSearchFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" + $ref: '#/components/schemas/PaginationRequest' + filter: + $ref: '#/components/schemas/SearchExpression' sort: - type: array - items: - $ref: "#/components/schemas/CloudRouterActionsSearchSortCriteria" - description: Search requests containing criteria - CloudRouterActionsSearchFilters: + $ref: '#/components/schemas/SearchSort' + InternetAccessServices: type: object + required: + - pagination + - sort + - data properties: - and: - maxItems: 8 + pagination: + $ref: '#/components/schemas/Pagination' + sort: + $ref: '#/components/schemas/SearchSort' + data: type: array items: - $ref: "#/components/schemas/CloudRouterActionsSearchFilter" - CloudRouterActionsSearchFilter: + $ref: '#/components/schemas/InternetAccessService' + InternetAccessPatchOperationUpdateAllowedOp: + type: string + enum: + - replace + - add + - remove + description: Allowed patch operations. + InternetAccessPatchOperationUpdateAllowedPath: + type: string + description: Allowed patch paths for Internet Access update. + pattern: ^(\/name|\/bandwidth|\/bandwidthCommit|\/routingProtocol\/customerRoutes(?:\[@\.ipBlock\.uuid=[A-Fa-f0-9-]+\])?|\/order\/purchaseOrderNumber)$ + example: /bandwidth + InternetAccessPatchOperationUpdate: + required: + - op + - path type: object - anyOf: - - $ref: "#/components/schemas/CloudRouterActionsSearchExpression" - - $ref: "#/components/schemas/CloudRouterActionsSearchOrFilter" - CloudRouterActionsSearchExpression: + properties: + op: + $ref: '#/components/schemas/InternetAccessPatchOperationUpdateAllowedOp' + path: + $ref: '#/components/schemas/InternetAccessPatchOperationUpdateAllowedPath' + value: + description: New value for updated parameter. Required for add and replace. + InternetAccessPatchRequest: + maxItems: 100 + minItems: 1 + type: array + items: + $ref: '#/components/schemas/InternetAccessPatchOperationUpdate' + description: Only one replace operation allowed for '/bandwidth' path. + IpBlockLocation: type: object + required: + - metroCode properties: - property: + metroHref: 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: + description: Metro URL path for the linked resource + example: https://api.equinix.com/fabric/v4/metros/WA + metroCode: + pattern: ^[A-Z]{2}$ 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: + example: WA + TypeOfIpBlockProduct: type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime enum: - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - - /connection/name - - /type - ActionId_1: - type: string - description: Action UUID - format: uuid - example: 457400f8-d360-11e9-bb65-2a2ae2dbcced - GetAllCloudRouterCommands: + - IPV4_IP_BLOCK + - IPV6_IP_BLOCK + x-enum-varnames: + - IPV4_IP_BLOCK + - IPV6_IP_BLOCK + IpBlockProjectRequest: 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 + - projectId properties: - type: - $ref: "#/components/schemas/CloudRouterCommandType" - name: - type: string - description: Customer-provided Cloud Router Command name - description: + projectId: type: string - description: Customer-provided Cloud Router Command description - project: - $ref: "#/components/schemas/Project" - request: - $ref: "#/components/schemas/CloudRouterCommandRequestPayload" - description: Execute Cloud Router Command Request - CloudRouterCommand: + description: project id + IpBlockAccount: type: object + required: + - accountNumber properties: - href: + accountNumber: 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: + description: account number + IpBlockOrderRequest: + type: object + properties: + purchaseOrderNumber: type: string - format: uuid - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: + nullable: true + description: Purchase order number + orderNumber: type: string - description: Customer-provided Cloud Router name - format: string - example: test-fg-1 - description: + nullable: true + description: Order Number + orderLine: type: string - example: description - state: - $ref: "#/components/schemas/CloudRouterCommandState" - project: - $ref: "#/components/schemas/Project" - request: - $ref: "#/components/schemas/CloudRouterCommandRequestResponse" - response: - $ref: "#/components/schemas/CloudRouterCommandResponse" - changeLog: - $ref: "#/components/schemas/Changelog" - description: Get Fabric Cloud Router Command response object - CloudRouterCommandSearchRequest: + nullable: true + description: Order Line Number + IpBlockAddressingPlan: type: object + required: + - purpose + - size 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: + purpose: + type: string + description: purpose + size: + type: integer + format: int32 + description: size + IpBlockRegulations: type: object + required: + - addressingPlans + - questions properties: - and: - maxItems: 8 + addressingPlans: type: array + description: List of addressing plans items: - $ref: "#/components/schemas/CloudRouterCommandSearchFilter" - CloudRouterCommandSearchFilter: - type: object - anyOf: - - $ref: "#/components/schemas/CloudRouterCommandSearchExpression" - - $ref: "#/components/schemas/CloudRouterCommandSearchOrFilter" - CloudRouterCommandSearchExpression: + $ref: '#/components/schemas/IpBlockAddressingPlan' + questions: + type: object + required: + - privateSpaceConsidered + - refusedPreviously + - returningAddressSpace + properties: + privateSpaceConsidered: + type: boolean + refusedPreviously: + type: boolean + returningAddressSpace: + type: boolean + IpBlockPrefixLength: + type: integer + minimum: 1 + maximum: 128 + description: IpBlockPrefix length + IpBlockPrefix: + type: string + description: CIDR prefix + SubmitIpBlockRequestBody: type: object + required: + - project + - type 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: + location: + $ref: '#/components/schemas/IpBlockLocation' + type: + $ref: '#/components/schemas/TypeOfIpBlockProduct' + project: + $ref: '#/components/schemas/IpBlockProjectRequest' + account: + $ref: '#/components/schemas/IpBlockAccount' + order: + $ref: '#/components/schemas/IpBlockOrderRequest' + regulations: + $ref: '#/components/schemas/IpBlockRegulations' + prefixLength: + $ref: '#/components/schemas/IpBlockPrefixLength' + prefix: + $ref: '#/components/schemas/IpBlockPrefix' + IpBlockState: type: string - description: Sorting direction - default: DESC enum: - - DESC - - ASC - CloudRouterCommandSearchSortBy: + - PENDING + - ACTIVE + - DELETING + - DELETED + - FAILED + description: Current state of the IP Block + IpBlockOwnership: 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: + - EQUINIX + - CUSTOMER + description: IpBlockOwnership of the IP Block + IpBlockOrderResponse: type: object + required: + - href + - orderNumber properties: - property: + href: 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 - * `/MED` - Route table entry med - * `/*` - all-category search - example: /type - operator: + format: uri + description: Order URI + example: https://api.equinix.com/colocations/v2/orders/1-34834234 + orderNumber: 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: + description: Order number + IpBlockProject: type: object + required: + - projectId properties: - direction: - $ref: "#/components/schemas/RouteTableEntrySortDirection" - property: - $ref: "#/components/schemas/RouteTableEntrySortBy" - RouteTableEntrySortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - RouteTableEntrySortBy: + href: + type: string + format: uri + description: URI of the project + projectId: + type: string + description: project id + IpBlockProductType: type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime enum: - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - - /prefix - - /nextHop - - /connection/name - - /type - - /MED - 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 - CloudRouterRouteFiltersSearchBase: + - EIA + - FABRIC + - NE + IpBlockAsset: type: object + required: + - type + - uuid + - href properties: - filter: - $ref: "#/components/schemas/CloudRouterRouteFiltersFilter" - pagination: - $ref: "#/components/schemas/Pagination" - sort: - maxItems: 3 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/RfAttachmentSortItem" - CloudRouterRouteFiltersFilter: - description: Top-level filter that can be either an AND expression or OR expression - anyOf: - - $ref: "#/components/schemas/CloudRouterRouteFilterAndExpression" - - $ref: "#/components/schemas/CloudRouterRouteFilterOrExpression" - CloudRouterRouteFilterAndExpression: + type: + $ref: '#/components/schemas/IpBlockProductType' + uuid: + type: string + format: uuid + description: Unique identifier for the asset + href: + type: string + description: Resource URL path for the linked resource + example: https://api.equinix.com/fabric/v4/internetAccesses/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 + IpBlockChange: type: object + required: + - href properties: - and: - maxItems: 8 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/CloudRouterRouteFilterExpression" - description: AND expression containing multiple filter expressions - CloudRouterRouteFilterExpression: - description: Filter expression that can be AND, OR, or a simple expression - anyOf: - - $ref: "#/components/schemas/CloudRouterRouteFilterAndExpression" - - $ref: "#/components/schemas/CloudRouterRouteFilterOrExpression" - - $ref: "#/components/schemas/CloudRouterRouteFilterSimpleExpression" - CloudRouterRouteFilterOrExpression: + href: + type: string + format: uri + description: URI of the IpBlockChange object + IpBlockChangeLog: type: object + required: + - createdDateTime properties: - or: - maxItems: 8 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/CloudRouterRouteFilterExpression" - description: OR expression containing multiple filter expressions - CloudRouterRouteFilterSimpleExpression: + createdDateTime: + type: string + format: date-time + updatedDateTime: + type: string + format: date-time + deletedDateTime: + type: string + format: date-time + IpBlock: type: object + required: + - uuid + - href + - state + - type + - ownership + - prefixLength + - project + - changeLog properties: - property: + uuid: type: string - enum: - - /type - - /direction - - /attachmentStatus - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - operator: + format: uuid + description: Unique identifier for the IP Block + href: type: string - values: - maxItems: 8 - minItems: 1 + description: Resource URL path for the IP Block + example: /fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb + type: + $ref: '#/components/schemas/TypeOfIpBlockProduct' + state: + $ref: '#/components/schemas/IpBlockState' + ownership: + $ref: '#/components/schemas/IpBlockOwnership' + location: + $ref: '#/components/schemas/IpBlockLocation' + prefixLength: + $ref: '#/components/schemas/IpBlockPrefixLength' + prefix: + $ref: '#/components/schemas/IpBlockPrefix' + order: + $ref: '#/components/schemas/IpBlockOrderResponse' + account: + $ref: '#/components/schemas/IpBlockAccount' + project: + $ref: '#/components/schemas/IpBlockProject' + regulations: + $ref: '#/components/schemas/IpBlockRegulations' + assets: type: array items: - type: string - RfAttachmentSortItem: + $ref: '#/components/schemas/IpBlockAsset' + description: Products using this IP Block + change: + $ref: '#/components/schemas/IpBlockChange' + changeLog: + $ref: '#/components/schemas/IpBlockChangeLog' + error: + $ref: '#/components/schemas/Error' + PatchIpBlockRequestBodyItem: type: object + required: + - op + - path properties: - property: + op: type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime + description: operation enum: - - /type - - /uuid - - /direction - - /attachmentStatus - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - direction: + - add + - remove + path: type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - CloudRouterRouteFiltersSearchResponse: - type: object - properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: List of route filter attachments for a given cloud router - items: - $ref: "#/components/schemas/ConnectionRouteFilterData" - CloudRouterRouteAggregationsSearchBase: - type: object - properties: - filter: - $ref: "#/components/schemas/CloudRouterRouteAggregationsFilter" - pagination: - $ref: "#/components/schemas/Pagination" - sort: - maxItems: 3 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/RaAttachmentSortItem" - CloudRouterRouteAggregationsFilter: - description: Top-level filter that can be either an AND expression or OR expression - anyOf: - - $ref: "#/components/schemas/CloudRouterRouteAggregationAndExpression" - - $ref: "#/components/schemas/CloudRouterRouteAggregationOrExpression" - CloudRouterRouteAggregationAndExpression: - type: object - properties: - and: - maxItems: 8 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/CloudRouterRouteAggregationExpression" - description: AND expression containing multiple filter expressions - CloudRouterRouteAggregationExpression: - description: Filter expression that can be AND, OR, or a simple expression - anyOf: - - $ref: "#/components/schemas/CloudRouterRouteAggregationAndExpression" - - $ref: "#/components/schemas/CloudRouterRouteAggregationOrExpression" - - $ref: "#/components/schemas/CloudRouterRouteAggregationSimpleExpression" - CloudRouterRouteAggregationOrExpression: - type: object - properties: - or: - maxItems: 8 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/CloudRouterRouteAggregationExpression" - description: OR expression containing multiple filter expressions - CloudRouterRouteAggregationSimpleExpression: + description: path + value: + type: object + required: + - uuid + properties: + uuid: + type: string + format: uuid + description: new value + PatchIpBlockRequestBody: + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/PatchIpBlockRequestBodyItem' + IpBlockAndQuery: type: object + required: + - property + - operator + - values properties: property: type: string - enum: - - /type - - /attachmentStatus - - /changeLog/createdDateTime - - /changeLog/updatedDateTime operator: type: string + enum: + - '=' values: type: array items: type: string - RaAttachmentSortItem: - type: object - properties: - property: - type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime - enum: - - /type - - /uuid - - /attachmentStatus - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - direction: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - CloudRouterRouteAggregationsSearchResponse: + IpBlockFilter: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + and: type: array - description: List of route aggregation attachments for a given cloud router items: - $ref: "#/components/schemas/ConnectionRouteAggregationData" - CloudRouterSearchRequest: - type: object + $ref: '#/components/schemas/IpBlockAndQuery' + IpBlocksSearchRequestBody: properties: + pagination: + $ref: '#/components/schemas/PaginationRequest' filter: - $ref: "#/components/schemas/CloudRouterExpression" + $ref: '#/components/schemas/IpBlockFilter' + sort: + $ref: '#/components/schemas/SearchSort' + IpBlockSearchResponseBody: + required: + - pagination + - data + properties: pagination: - $ref: "#/components/schemas/PaginationRequest" + $ref: '#/components/schemas/Pagination' sort: + $ref: '#/components/schemas/SearchSort' + data: type: array items: - $ref: "#/components/schemas/CloudRouterSortCriteria" - description: Search requests containing criteria - CloudRouterExpression: + $ref: '#/components/schemas/IpBlock' + Expression: type: object properties: and: - $ref: "#/components/schemas/CloudRouterExpressions" + $ref: '#/components/schemas/Expressions' or: - $ref: "#/components/schemas/CloudRouterExpressions" + $ref: '#/components/schemas/Expressions' property: - $ref: "#/components/schemas/SearchFieldName_1" + $ref: '#/components/schemas/SearchFieldName' 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 + enum: + - '=' + - '!=' + - '>' + - '>=' + - < + - <= + - LIKE + - ILKE + - IS NOT NULL + - IS NULL + - IN + - BETWEEN values: type: array items: type: string - CloudRouterExpressions: + Expressions: type: array items: - $ref: "#/components/schemas/CloudRouterExpression" - SearchFieldName_1: - 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 - * `/type` - Fabric Cloud Router type - * `/connectionsCount` - Fabric Cloud Router attached connections count - * `/changeLog/createdDateTime` - Fabric Cloud Router creation timestamp - * `/changeLog/updatedDateTime` - Fabric Cloud Router last updated timestamp - * `/changeLog/deletedDateTime` - Fabric Cloud Router deletion timestamp - * `/*` - all-category search - example: /name - 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: + $ref: '#/components/schemas/Expression' + SearchFieldName: + description: Possible field names to use on filters type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime enum: + - /isRemote - /name - /uuid - - /state - - /location/metroCode - - /location/metroName - - /package/code - /type - - /connectionsCount - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - - /changeLog/deletedDateTime - - /order/termLength - SearchResponse: - type: object - properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/CloudRouterReadResponse" - PackageResponse: + - /geoScope + - /account/orgId + - /aSide/accessPoint/account/accountName + - /aSide/accessPoint/account/accountNumber + - /aSide/accessPoint/router/uuid + - /aSide/accessPoint/interconnect/uuid + - /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 + - /bandwidth + - /change/status + - /changeLog/createdBy + - /changeLog/createdDateTime + - /changeLog/deletedBy + - /changeLog/deletedDateTime + - /changeLog/lastUpdatedBy + - /operation/equinixStatus + - /operation/providerStatus + - /operation/maintenanceStatus + - /operation/lockEnabled + - /project/projectId + - /redundancy/group + - /redundancy/priority + - /redundancy/name + - /redundancy/description + - /zSide/accessPoint/account/accountName + - /zSide/accessPoint/authenticationKey + - /zSide/accessPoint/linkProtocol/vlanTagMin + - /zSide/accessPoint/linkProtocol/vlanTagMax + - /zSide/accessPoint/location/metroCode + - /zSide/accessPoint/location/metroName + - /zSide/accessPoint/sellerRegion + - /zSide/accessPoint/name + - /zSide/accessPoint/port/uuid + - /zSide/accessPoint/network/uuid + - /zSide/accessPoint/port/name + - /zSide/accessPoint/profile/uuid + - /zSide/accessPoint/type + - /zSide/accessPoint/role + - /zSide/accessPoint/virtualDevice/name + - /zSide/accessPoint/virtualDevice/uuid + - /zSide/serviceToken/uuid + - /zSide/internetAccess/uuid + - /state + SortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + SortBy: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + 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/role + - /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 + - /operation/maintenanceStatus + - /redundancy/priority + SortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/SortDirection' + property: + $ref: '#/components/schemas/SortBy' + SearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/Expression' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/SortCriteria' + SortCriteriaResponse: + type: object + properties: + direction: + $ref: '#/components/schemas/SortDirection' + property: + $ref: '#/components/schemas/SortBy' + ConnectionSearchResponse: + description: List of connections type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/SortCriteriaResponse' data: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/CloudRouterPackage" - RouterPackageCode: + $ref: '#/components/schemas/Connection' + FilterBody: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/SearchExpression' + ProductType: + description: Product type type: string - description: Router package code enum: - - LAB - - BASIC - - STANDARD - - ADVANCED - - PREMIUM - CloudRouterPackage: + - VIRTUAL_CONNECTION_PRODUCT + - IP_BLOCK_PRODUCT + - VIRTUAL_PORT_PRODUCT + - CLOUD_ROUTER_PRODUCT + - PRECISION_TIME_PRODUCT + - OPTICAL_CONNECT_PRODUCT + PriceCharge: + description: Price Charge 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: + description: Price charge 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: + - MONTHLY_RECURRING + - NON_RECURRING + price: + description: Offering price + type: number + format: double minimum: 0 - type: integer - description: CloudRouter package Max Bandwidth limit - example: 50 - changeLog: - $ref: "#/components/schemas/PackageChangeLog" - description: Fabric Cloud Router Package - HealthResponse: + PriceCategory: + description: Price category + type: string + enum: + - COUNTRY + - CUSTOMER + VirtualConnectionPriceConnectionType: + description: Virtual Connection type + type: string + enum: + - EVPL_VC + - EPL_VC + - EC_VC + - IP_VC + - VD_CHAIN_VC + - ACCESS_EPL_VC + - EVPLAN_VC + - EPLAN_VC + - IPWAN_VC + - EVPTREE_VC + - EPTREE_VC + - IA_VC + VirtualConnectionPriceAccessPointType: + description: Virtual Connection access point type + type: string + enum: + - VD + - SP + - COLO + - CLOUD_ROUTER + - CHAINGROUP + - NETWORK + - METAL_NETWORK + PriceLocation: type: object properties: - href: - type: string - description: The Canonical URL at which the resource resides. - version: - type: string - description: Indicator of a version - release: + metroCode: type: string - description: release details. - state: + ibx: 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 - NetworkPostRequest: - required: - - name - - notifications - - scope - - type + VirtualConnectionPriceASide: 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 + accessPoint: 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: + $ref: '#/components/schemas/VirtualConnectionPriceAccessPointType' + location: + $ref: '#/components/schemas/PriceLocation' + port: + type: object + properties: + settings: + type: object + properties: + buyout: + type: boolean + default: false + VirtualConnectionBridgePackageCode: + description: Virtual Connection bridge package code 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: + enum: + - REGIONAL + - GLOBAL + VirtualConnectionPriceZSide: 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: + accessPoint: + type: object + properties: + uuid: + type: string + format: uuid + type: + $ref: '#/components/schemas/VirtualConnectionPriceAccessPointType' + location: + $ref: '#/components/schemas/PriceLocation' + port: + type: object + properties: + settings: + type: object + properties: + buyout: + type: boolean + default: false + profile: + type: object + properties: + uuid: + type: string + format: uuid + bridge: + type: object + properties: + package: + type: object + properties: + code: + $ref: '#/components/schemas/VirtualConnectionBridgePackageCode' + VirtualConnectionPrice: + description: Virtual Connection Product configuration type: object properties: - and: - $ref: "#/components/schemas/NetworkSimpleExpression" - or: - $ref: "#/components/schemas/NetworkSimpleExpression" - property: - $ref: "#/components/schemas/NetworkSearchFieldName" - operator: + uuid: + description: Either uuid or rest of attributes are required 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: + format: uuid + type: + $ref: '#/components/schemas/VirtualConnectionPriceConnectionType' + bandwidth: + type: integer + minimum: 0 + aSide: + $ref: '#/components/schemas/VirtualConnectionPriceASide' + zSide: + $ref: '#/components/schemas/VirtualConnectionPriceZSide' + geoScope: + $ref: '#/components/schemas/GeoScopeType' + IpBlockType: + description: IP Block type type: string - description: Possible field names to use on filters - example: /name enum: - - /name - - /uuid - - /scope - - /type - - /state - - /operation/equinixStatus - - /location/region - - /location/metroCode - - /connectionsCount - - /project/projectId - - /account/globalCustId - - /account/orgId - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - - /changeLog/deletedDateTime - - /* - NetworkSortCriteria: + - IPv4 + - IPv6 + IpBlockPrice: + description: IP Block Product configuration type: object properties: - direction: - $ref: "#/components/schemas/NetworkSortDirection" - property: - $ref: "#/components/schemas/NetworkSortBy" - NetworkSortDirection: + uuid: + description: Either uuid or rest of attributes are required + type: string + format: uuid + type: + $ref: '#/components/schemas/IpBlockType' + prefixLength: + type: integer + location: + $ref: '#/components/schemas/PriceLocation' + FabricCloudRouterCode: + description: Cloud Router code type: string - description: Sorting direction - default: DESC enum: - - DESC - - ASC - NetworkSortBy: + - LAB + - BASIC + - STANDARD + - ADVANCED + - PREMIUM + FabricCloudRouterPackages: + description: Cloud Router package + type: object + properties: + code: + $ref: '#/components/schemas/FabricCloudRouterCode' + FabricCloudRouterPrice: + description: Cloud Router Product configuration + type: object + properties: + uuid: + description: Unique identifier assigned to the Cloud Router + type: string + format: uuid + location: + $ref: '#/components/schemas/PriceLocation' + package: + $ref: '#/components/schemas/FabricCloudRouterPackages' + VirtualPortType: + description: Port type. 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: + - XF_PORT + VirtualPortLocation: + description: Geographic data for the port. 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: + ibx: + 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. + type: string + LinkAggregationGroup: + description: Link aggregation group (LAG) preferences and settings. type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - items: - $ref: "#/components/schemas/Connection" - description: List of network changes - NetworkChangeResponse: + enabled: + description: Parameter showing whether LAG configuration is mandatory. The default is false. + type: boolean + default: false + VirtualPortRedundancy: + 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. type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - items: - $ref: "#/components/schemas/NetworkChange" - description: List of network changes - ChangeId_5: + enabled: + description: Parameter showing whether redundancy is mandatory. The default is false. + type: boolean + default: false + ConnectivitySourceType: + 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. type: string - description: Network Change UUID - format: uuid - example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 - NetworkChange: + enum: + - COLO + - BMMR + - REMOTE + default: COLO + ConnectivitySource: + description: Physical or virtual port that houses the connection. 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: + $ref: '#/components/schemas/ConnectivitySourceType' + VirtualPortServiceType: + description: Port service type. The default is managed-service provider (MSP). + type: string + enum: + - MSP + - EPL + default: MSP + VirtualPortConfiguration: + description: Port configuration. + type: object + properties: + buyout: + 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. + type: boolean + default: false + VirtualPortPackageCode: + description: Virtual port package code + type: string + example: STANDARD, UNLIMITED or UNLIMITED_PLUS + VirtualPortPackage: + description: Virtual Port Package + type: object + properties: + code: + $ref: '#/components/schemas/VirtualPortPackageCode' + VirtualPortServiceCode: + description: Port service code. + type: string + VirtualPortPrice: + description: Preferences and settings for a virtual port connected to an internet service provider (ISP) or other Equinix platform entity. + type: object + properties: + uuid: + description: Unique identifier assigned to the virtual port. Either the uuid or the remaining attributes must be supplied. type: string - description: Set when change flow starts - format: date-time - example: 2020-11-06T07:00:00Z - updatedDateTime: + format: uuid + type: + $ref: '#/components/schemas/VirtualPortType' + location: + $ref: '#/components/schemas/VirtualPortLocation' + lag: + $ref: '#/components/schemas/LinkAggregationGroup' + physicalPortsQuantity: + description: Number of physical ports requested. The defaults is 1. + type: integer + default: 1 + bandwidth: + 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. + type: integer + redundancy: + $ref: '#/components/schemas/VirtualPortRedundancy' + connectivitySource: + $ref: '#/components/schemas/ConnectivitySource' + serviceType: + $ref: '#/components/schemas/VirtualPortServiceType' + settings: + $ref: '#/components/schemas/VirtualPortConfiguration' + package: + $ref: '#/components/schemas/VirtualPortPackage' + serviceCode: + $ref: '#/components/schemas/VirtualPortServiceCode' + precisionTimePackageRequest: + title: precisionTimePackageRequest + type: object + example: + code: NTP_STANDARD + description: Precision Time Service Level Request + properties: + code: 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 + enum: + - NTP_STANDARD + - NTP_ENTERPRISE + - PTP_STANDARD + - PTP_ENTERPRISE + description: Precision Time Service Level required: - - connections - - ipv4 - - name - - package - - type + - code + TimeServicePriceConnectionAccessPoint: + description: Time Service Price Connection Access Point configuration + type: object + properties: + location: + $ref: '#/components/schemas/PriceLocation' + TimeServicePriceConnectionASide: + description: Time Service Price Connection ASide configuration + type: object + properties: + accessPoint: + $ref: '#/components/schemas/TimeServicePriceConnectionAccessPoint' + TimeServicePriceConnection: + description: Time Service Price Connection configuration + type: object + properties: + aSide: + $ref: '#/components/schemas/TimeServicePriceConnectionASide' + TimeServicePrice: + description: Time Service Product configuration 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. + description: Precision Time Service Type refers to the corresponding Protocol. 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 + $ref: '#/components/schemas/precisionTimePackageRequest' + connection: + $ref: '#/components/schemas/TimeServicePriceConnection' + OpticalConnectPricePortType: + description: Optical Connect type. + type: string + example: OC + OpticalConnectPricePathType: + description: Optical Connect Port Path type. + type: string + enum: + - PROTECTED + - UNPROTECTED + - DUAL_DIVERSE + OpticalConnectConnectionDestinationType: + description: Destination Port connectivity type + type: string + enum: + - COLO + - BMMR + - REMOTE + OpticalConnectPriceLocation: + description: Optical Connect Location + type: object + properties: + ibxCode: + description: IBX identifier + type: string + example: SV1 + OpticalConnectPriceASide: + description: Optical Connection ASide configuration + type: object + properties: + location: + $ref: '#/components/schemas/OpticalConnectPriceLocation' + OpticalConnectPriceZSide: + description: Optical Connection ZSide configuration + type: object + properties: + location: + $ref: '#/components/schemas/OpticalConnectPriceLocation' + OpticalConnectPrice: + description: Optical Metro Connect Port Product configuration type: object + properties: + type: + $ref: '#/components/schemas/OpticalConnectPricePortType' + bandwidth: + description: Bandwidth in Mbps + type: integer + minimum: 0 + example: 1000 + pathType: + $ref: '#/components/schemas/OpticalConnectPricePathType' + connectionDestinationType: + $ref: '#/components/schemas/OpticalConnectConnectionDestinationType' + aSide: + $ref: '#/components/schemas/OpticalConnectPriceASide' + zSide: + $ref: '#/components/schemas/OpticalConnectPriceZSide' + Price: properties: href: + description: An absolute URL that returns specified pricing data type: string - description: Precision Time Service URI. - format: uri + format: url type: + $ref: '#/components/schemas/ProductType' + code: + description: Equinix-assigned product code type: string - description: Precision Time Service type refers to the corresponding protocol. - enum: - - NTP - - PTP name: + description: Full product name type: string - description: Precision Time Service Name. - uuid: + description: + description: Product description type: string - description: Precision Time Service UUID. - format: uuid - state: + account: + $ref: '#/components/schemas/SimplifiedAccount' + charges: + type: array + items: + $ref: '#/components/schemas/PriceCharge' + currency: + description: Product offering price currency type: string - description: Precision Time Service Status. + termLength: + description: In months. No value or value of 1 means on-demand + type: integer enum: - - CANCELLED - - CANCELLING - - CONFIGURING - - CONFIGURING_FAILED - - DRAFT - - DEPROVISIONING - - DEPROVISIONING_FAILED - - DEPROVISIONED - - PROVISIONED - - PROVISIONING - - PROVISIONING_FAILED - - REPROVISIONING - - REPROVISIONING_FAILED - operation: - $ref: "#/components/schemas/timeServiceOperation" - package: - $ref: "#/components/schemas/precisionTimePackagePostResponse" - connections: - maxItems: 2 - minItems: 1 - uniqueItems: true + - 1 + - 12 + - 24 + - 36 + - 60 + 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' + opticalConnect: + allOf: + - $ref: '#/components/schemas/OpticalConnectPrice' + PriceSearchResponse: + type: object + properties: + data: 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: + $ref: '#/components/schemas/Price' + pagination: + $ref: '#/components/schemas/Pagination' + PriceError: + description: Error with details required: - - op - - path - - value + - errorCode + - errorMessage type: object + discriminator: + propertyName: errorCode properties: - op: + errorCode: type: string - description: Handy shortcut for operation name enum: - - replace - - add - - remove - path: + - EQ-3038010 + - EQ-3038022 + - EQ-3038030 + errorMessage: 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: + - Validation failure + - Invalid value + - Internal Server Error + correlationId: + type: string + details: + type: string + help: + type: string + additionalInfo: type: array items: - $ref: "#/components/schemas/TimeServiceSortCriteria" - description: Search requests containing criteria - TimeServiceFilters: + type: object + properties: + property: + type: string + reason: + type: string + PriceErrorList: + type: array + items: + $ref: '#/components/schemas/PriceError' + startDateTime: + description: startDateTime + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + endDateTime: + description: endDateTime + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + Metrics: + description: Bandwidth utilization statistics for a specified interval. 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: + intervalEndTimestamp: + description: Interval end timestamp + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + max: + description: Max bandwidth within statistics object time interval, represented in units specified by response "units" field + type: number + format: float + mean: + description: Mean bandwidth within statistics object time interval, represented in units specified by response "units" field + type: number + format: float + Direction: + description: Directional statistics 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: + max: + description: Max bandwidth within request time range, represented in units specified by response "units" field + type: number + format: float + mean: + description: Mean bandwidth within request time range, represented in units specified by response "units" field + type: number + format: float + metrics: + description: Bandwidth utilization statistics for a specified interval. type: array items: - type: string - example: FabricPrecisionTimeService-1 - TimeServiceOrFilter: + $ref: '#/components/schemas/Metrics' + BandwidthUtilization: + description: Bandwidth utilization statistics (octet counters-based) type: object properties: - or: - maxItems: 3 - type: array - items: - $ref: "#/components/schemas/TimeServiceSimpleExpression" - TimeServiceSortCriteria: + unit: + description: Aggregated data transfer capacity. Possible values- Mbps, megabits (1 million bits) per second; Gbps, gigabits (1 billion bits) per second. + type: string + enum: + - Mbps + metricInterval: + description: An interval formatted value, indicating the time-interval the metric objects within the response represent + type: string + inbound: + $ref: '#/components/schemas/Direction' + outbound: + $ref: '#/components/schemas/Direction' + Statistics: + 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. type: object properties: - direction: - $ref: "#/components/schemas/TimeServiceSortDirection" - property: - $ref: "#/components/schemas/TimeServiceSortBy" - TimeServiceSortDirection: + startDateTime: + description: Start and duration of the statistical analysis interval. + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + endDateTime: + description: End and duration of the statistical analysis interval. + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + viewPoint: + description: Point of view for connection metrics - aSide or zSide + type: string + enum: + - aSide + - zSide + bandwidthUtilization: + $ref: '#/components/schemas/BandwidthUtilization' + viewPoint: + description: viewPoint type: string - description: Sorting direction - default: DESC enum: - - DESC - - ASC - TimeServiceSortBy: + - aSide + - zSide + ServiceProfileStateEnum: + description: Equinix assigned state. 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: + - ACTIVE + - PENDING_APPROVAL + - DELETED + - REJECTED + example: ACTIVE + Path: + description: A JSON Pointer path. + type: string + AddOperation: + description: Add Sub-Resource to the existing model type: object + required: + - op + - path + - value properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/precisionTimeServiceResponse" - precisionTimeServiceConnectionsResponse: - title: precisionTimeServiceConnectionResponse + op: + type: string + enum: + - add + path: + $ref: '#/components/schemas/Path' + value: + type: object + description: value to add + RemoveOperation: + description: Remove sub-resource from an existing model type: object + required: + - op + - path 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 + op: + type: string + enum: + - remove + path: + $ref: '#/components/schemas/Path' + ReplaceOperation: + description: Replace attribute value or sub-resource in the existing model 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 + - op + - path + - value + properties: + op: + type: string + enum: + - replace + path: + $ref: '#/components/schemas/Path' + value: + type: object + description: value to replace with + ServiceProfileUpdateOperation: + description: Service Profile Access Points + type: object + oneOf: + - $ref: '#/components/schemas/AddOperation' + - $ref: '#/components/schemas/RemoveOperation' + - $ref: '#/components/schemas/ReplaceOperation' + ServiceProfileUpdateRequest: + type: array + items: + $ref: '#/components/schemas/ServiceProfileUpdateOperation' + ServiceProfileChange: type: object + description: Current state of latest service profile change properties: - href: + uuid: + description: Uniquely identifies a change type: string - format: uri type: + description: Type of change 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: + example: SERVICE_PROFILE_VISIBILITY_UPDATE + status: + description: Current outcome of the change flow 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: + - APPROVED + - COMPLETED + - FAILED + - REJECTED + - REQUESTED + - SUBMITTED_FOR_APPROVAL + createdDateTime: + description: Set when change flow starts 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: + example: '2020-11-06T07:00:00Z' + updatedDateTime: + description: Set when change object is updated 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: + format: date-time + example: '2020-11-06T07:00:00Z' + information: + description: Additional information type: string - description: Cloud Router package code - 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: + $ref: '#/components/schemas/ServiceProfileUpdateRequest' required: - - name - - project - type + - createdDateTime + ServiceProfile: + 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. 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" + state: + $ref: '#/components/schemas/ServiceProfileStateEnum' account: - $ref: "#/components/schemas/SimplifiedAccount" - notifications: - maxItems: 1 - type: array - description: Preferences for stream notifications. Optional; at most one entry, of type ALL, with up to 12 emails. Set at creation only. - items: - $ref: "#/components/schemas/SimplifiedNotification" - 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 - type: - type: string - description: type - enum: - - TELEMETRY_STREAM - name: - type: string - description: Customer-provided stream name - description: - type: string - description: Customer-provided stream description + description: Seller Account for Service Profile. + $ref: '#/components/schemas/SimplifiedAccount' project: - $ref: "#/components/schemas/Project" - account: - $ref: "#/components/schemas/SimplifiedAccount" - notifications: - type: array - description: Preferences for stream notifications, set at creation - items: - $ref: "#/components/schemas/SimplifiedNotification" - 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 - alertRulesCount: - type: integer - description: Stream alert rules count - example: 3 + $ref: '#/components/schemas/Project' + change: + $ref: '#/components/schemas/ServiceProfileChange' changeLog: - $ref: "#/components/schemas/Changelog" - description: Stream object - StreamSearchRequest: + description: Seller Account for Service Profile. + $ref: '#/components/schemas/Changelog' + allOf: + - $ref: '#/components/schemas/SimplifiedServiceProfile' + ServiceProfiles: type: object + description: Service Profiles properties: - filter: - $ref: "#/components/schemas/StreamSearchFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + data: type: array items: - $ref: "#/components/schemas/StreamSearchSortCriteria" - description: Search requests containing criteria - StreamSearchFilters: - required: - - and + $ref: '#/components/schemas/ServiceProfile' + pagination: + $ref: '#/components/schemas/Pagination' + ServiceProfileRequest: + 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. type: object + allOf: + - $ref: '#/components/schemas/SimplifiedServiceProfile' properties: - and: - maxItems: 10 - minItems: 1 - type: array - items: - $ref: "#/components/schemas/StreamSearchFilter" - StreamSearchFilter: - type: object - anyOf: - - $ref: "#/components/schemas/StreamSearchSimpleExpression" - - $ref: "#/components/schemas/StreamSearchOrFilter" - StreamSearchSimpleExpression: + project: + $ref: '#/components/schemas/Project' + required: + - name + - description + - type + ServiceProfileSimpleExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: - * `/uuid` - Stream uuid - * `/name` - Stream name - * `/state` - Stream state (`DEPROVISIONED` returned only when explicitly requested) - * `/type` - Stream type - * `/description` - Stream description - * `/project/projectId` - Stream project id - * `/changeLog/createdDateTime` - Stream created date time - * `/changeLog/updatedDateTime` - Stream updated date time + * `/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 + type: string 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 - * `BETWEEN` - between - * `NOT BETWEEN` - not between - * `LIKE` - like - * `ILIKE` - like case-insensitive - * `IN` - in - * `NOT IN` - not in - example: = + type: string + example: '=' values: - maxItems: 100 - minItems: 1 type: array items: type: string - example: stream-dev-01 - StreamSearchOrFilter: + example: ServiceProfile-1 + ServiceProfileAndFilter: type: object properties: - or: - maxItems: 10 + and: type: array items: - $ref: "#/components/schemas/StreamSearchSimpleExpression" - StreamSearchSortCriteria: - required: - - direction - - property + $ref: '#/components/schemas/ServiceProfileSimpleExpression' + ServiceProfileFilter: type: object - properties: - direction: - $ref: "#/components/schemas/StreamSearchSortDirection" - property: - $ref: "#/components/schemas/StreamSearchSortBy" - StreamSearchSortDirection: - type: string + anyOf: + - $ref: '#/components/schemas/ServiceProfileSimpleExpression' + - $ref: '#/components/schemas/ServiceProfileAndFilter' + ServiceProfileSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - StreamSearchSortBy: - type: string + ServiceProfileSortBy: description: Possible field names to use on sorting - default: /changeLog/createdDateTime + default: /changeLog/updatedDateTime + type: string enum: + - /name + - /state - /changeLog/createdDateTime - /changeLog/updatedDateTime - SearchStreamResponse: - type: object - properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/Stream" - StreamId: - type: string - description: Stream UUID - format: uuid - example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - StreamPutRequest: - required: - - name + ServiceProfileSortCriteria: type: object properties: - name: - type: string - description: Customer-provided stream name - description: - type: string - description: Customer-provided stream description - description: Update Stream - StreamAssetSearchRequest: + direction: + $ref: '#/components/schemas/ServiceProfileSortDirection' + property: + $ref: '#/components/schemas/ServiceProfileSortBy' + ServiceProfileSearchRequest: type: object + description: Search requests containing criteria properties: filter: - $ref: "#/components/schemas/StreamAssetFilters" + $ref: '#/components/schemas/ServiceProfileFilter' pagination: - $ref: "#/components/schemas/PaginationRequest" + $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: + $ref: '#/components/schemas/ServiceProfileSortCriteria' + ServiceProfileActionRequest: + description: Service Profile Action Request type: object properties: - property: + type: + description: 'Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION' type: string - description: | - Possible field names to use on filters: - * `/uuid` - Asset uuid (`=` and `IN` only) - * `/streamUuid` - Stream uuid (`=` and `IN` only) - * `/attachmentStatus` - Asset attachment status (`=`, `IN`, and `NOT IN`) - example: /streamUuid - operator: + example: PROFILE_UPDATE_ACCEPTANCE + description: + description: Action description type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `IN` - in - * `NOT IN` - not in - example: = - values: - minItems: 1 - type: array - items: - type: string - example: 4719e319-65ae-4001-aabf-ca5f107b9b29 - StreamAssetOrFilter: - type: object - properties: - or: - maxItems: 3 - type: array - items: - $ref: "#/components/schemas/StreamAssetSimpleExpression" - StreamAssetSortCriteria: + example: Approved to migrate to public required: - - direction - - property + - type + ServiceProfileActionResponse: + description: Service Profile Action Response 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 - - /streamUuid - SearchStreamAssetResponse: + href: + description: Service Profile Action URI + type: string + format: uri + readOnly: true + type: + description: 'Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION' + type: string + example: PROFILE_UPDATE_ACCEPTANCE + uuid: + description: Equinix-assigned action identifier + type: string + format: uuid + comments: + description: Action comments + type: string + example: Approved to migrate to public + changeLog: + $ref: '#/components/schemas/Changelog' + ProviderEnvironments: type: object + description: Service Profile Provider Environments properties: - pagination: - $ref: "#/components/schemas/Pagination" data: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/StreamSearchAsset" - AssetId_1: - type: string - description: Stream Asset UUID - format: uuid - example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - Asset: + $ref: '#/components/schemas/ProviderEnvironment' + pagination: + $ref: '#/components/schemas/Pagination' + EnvironmentActionTypeEnum: + description: Environment action type type: string enum: - - ports - - connections - - routers - - metros - - organizations - - projects - - companyProfiles - StreamAsset: + - VALIDATE_ACTIVATION_KEY + example: VALIDATE_ACTIVATION_KEY + ActivationKeyDetails: + description: Activation Key Details Beta type: object properties: - href: + value: + description: Provider Encoded activation key type: string - description: Stream Asset URI - format: uri - readOnly: true - uuid: + example: key_here + providerId: + description: AWS Connection identifier type: string - description: Equinix-assigned access point identifier - format: uuid - example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 - type: + accountId: + description: Account identifier type: string - description: Asset types - enum: - - XF_PORT - - IP_VC - - EVPLAN_VC - - EVPL_VC - - XF_METRO - - XF_ROUTER - - ORGANIZATION - - PROJECT - - VIRTUAL_DEVICE - - DATA - - MGMT - - SSH - - FAB - - CTRL - metricsEnabled: - type: boolean - description: enable metric - example: false - attachmentStatus: + bandwidth: + description: Bandwidth in Mbps + type: integer + region: + description: Cloud provider region identifier type: string - description: asset status - enum: - - ATTACHING - - ATTACHED - - DETACHED - - DETACHING - - FAILED - description: Stream object - StreamAssetPutRequest: + EnvironmentActionRequest: + description: Request payload for environment action type: object + required: + - type + - keyDetails properties: - metricsEnabled: - type: boolean - description: enable metric - example: false - default: false - description: Update Stream Asset - DeviceId: + type: + $ref: '#/components/schemas/EnvironmentActionTypeEnum' + keyDetails: + $ref: '#/components/schemas/ActivationKeyDetails' + EnvironmentActionStateEnum: + description: Environment action state. ACTIVE - already used , INACTIVE - not used type: string - description: Network Edge Device UUID - format: uuid - example: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d - StreamDevicePutRequest: - type: object - properties: - metricsEnabled: - type: boolean - description: enable metric. Must be true when interfaces are provided - example: true - default: false - interfaces: - type: array - description: | - Complete desired set of Network Edge Device interfaces attached to the stream. Interfaces not in the list are detached; an empty or absent list detaches all interfaces. - items: - $ref: "#/components/schemas/StreamDeviceInterfaceRequest" - description: Attach Network Edge Device interfaces to a Stream - StreamDeviceInterfaceRequest: - required: - - id + enum: + - ACTIVE + - INACTIVE + example: ACTIVE + EnvironmentActionResponse: + description: Response from environment action Beta type: object properties: - id: - type: integer - description: Network Edge Device interface identifier - format: int32 - example: 5 - description: Network Edge Device interface - GetAllStreamSubscriptionResponse: + href: + description: Environment action URI + type: string + format: uri + readOnly: true + type: + $ref: '#/components/schemas/EnvironmentActionTypeEnum' + uuid: + description: Equinix-assigned action identifier + type: string + format: uuid + example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 + state: + $ref: '#/components/schemas/EnvironmentActionStateEnum' + keyDetails: + $ref: '#/components/schemas/ActivationKeyDetails' + changeLog: + $ref: '#/components/schemas/Changelog' + ServiceMetros: type: object + description: Service Profile Metros properties: - pagination: - $ref: "#/components/schemas/Pagination" data: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/StreamSubscription" - StreamSubscriptionPostRequest: - required: - - name - - sink - - type + $ref: '#/components/schemas/ServiceMetro' + pagination: + $ref: '#/components/schemas/Pagination' + ServiceTokenChangeOperation: + description: Service Token change operation data type: object properties: - type: + op: + description: Handy shortcut for operation name type: string enum: - - STREAM_SUBSCRIPTION - name: - type: string - description: Customer-provided stream subscription name - description: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter type: string - description: Customer-provided stream subscription description - enabled: - type: boolean - description: Stream subscription enabled status - example: true - default: true - metricSelector: - $ref: "#/components/schemas/StreamSubscriptionSelector" - eventSelector: - $ref: "#/components/schemas/StreamSubscriptionSelector" - sink: - $ref: "#/components/schemas/StreamSubscriptionSink" - description: Create Stream Subscription - StreamSubscriptionSelector: + example: /expirationDateTime + value: + description: new value for updated parameter + required: + - op + - path + - value + ServiceTokenUpdateRequest: + description: Service Token Update Request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/ServiceTokenChangeOperation' + ServiceTokens: type: object + 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. properties: - include: - maxItems: 8 - type: array - items: - $ref: "#/components/schemas/StreamSubscriptionSelectorExpression" - except: - maxItems: 8 + data: + description: List of Service Tokens type: array items: - $ref: "#/components/schemas/StreamSubscriptionSelectorExpression" - StreamSubscriptionSelectorExpression: + $ref: '#/components/schemas/ServiceToken' + pagination: + $ref: '#/components/schemas/Pagination' + ServiceTokenActions: + description: Service Token action type type: string - description: | - Supported event or metric types to use on event and metric selectors: - * `*` - all events or metrics - * `equinix.fabric.company_profile.*` - company profile events - * `equinix.fabric.connection.*` - connection events, metrics, or alerts - * `equinix.fabric.connection_bgpipv4_session.*` - connection BGP IPv4 session events - * `equinix.fabric.connection_bgpipv6_session.*` - connection BGP IPv6 session events - * `equinix.fabric.connection_maintenance.*` - connection maintenance events - * `equinix.fabric.connection_route_aggregation.*` - connection route aggregation events - * `equinix.fabric.connection_route_filter.*` - connection route filter events - * `equinix.fabric.connection_routing_protocol.*` - connection routing protocol events - * `equinix.fabric.internet_access.*` - internet access service events - * `equinix.fabric.ip_block.*` - IP block events - * `equinix.fabric.metric` - metric collection events - * `equinix.fabric.metro.*` - metro metrics or alerts - * `equinix.fabric.network.*` - network events - * `equinix.fabric.physical_port.*` - physical port events - * `equinix.fabric.port.*` - virtual port events, metrics, or alerts - * `equinix.fabric.port_maintenance.*` - port maintenance events - * `equinix.fabric.route_aggregation.*` - route aggregation events - * `equinix.fabric.route_aggregation_rule.*` - route aggregation rule events - * `equinix.fabric.route_filter.*` - route filter events - * `equinix.fabric.route_filter_rule.*` - route filter rule events - * `equinix.fabric.router.*` - cloud router events or alerts - * `equinix.fabric.router_action.*` - cloud router action events - * `equinix.fabric.router_command.*` - cloud router command events - * `equinix.fabric.routing_protocol_action.*` - routing protocol action events - * `equinix.fabric.service_profile_connection.*` - service profile connection events - * `equinix.fabric.service_token.*` - service token events - * `equinix.fabric.time_service.*` - precision time service events - * `equinix.network.maintenance.*` - network maintenance events - * `equinix.network.repair.*` - network repair events - * `equinix.network_edge.*` - network edge events, metrics, or alerts - * `equinix.network_edge.acl.*` - network edge acl events - * `equinix.network_edge.device.*` - network edge device events - * `equinix.network_edge.device_interface.*` - network edge device interface metrics or alerts - * `equinix.network_edge.devicelinkgroup.*` - network edge device link group events - * `equinix.access_manager.*` - identity access manager events - * `equinix.access_manager.user.role.*` - identity access manager user role events - * `equinix.iam.principal.*` - IAM principal authorization and token events - * `equinix.identity.user.*` - identity user events - * `equinix.identity.organization.*` - identity organization membership events - * `equinix.resource_manager.organization.*` - resource manager organization events - * `equinix.resource_manager.project.*` - resource manager project events - example: equinix.fabric.connection.* - StreamSubscriptionSink: + enum: + - RESEND_EMAIL_NOTIFICATION + ServiceTokenActionRequest: + description: Service Token action request + type: object + properties: + type: + $ref: '#/components/schemas/ServiceTokenActions' required: - type + ServiceTokenSearchExpression: type: object properties: - uri: - type: string - description: any publicly reachable http endpoint - type: + and: + $ref: '#/components/schemas/ServiceTokenSearchExpressions' + or: + $ref: '#/components/schemas/ServiceTokenSearchExpressions' + property: + $ref: '#/components/schemas/ServiceTokenSearchFieldName' + operator: type: string - description: destination type enum: - - DATADOG - - DYNATRACE - - GOOGLE_PUBSUB - - PAGERDUTY - - SERVICENOW - - SLACK - - SPLUNK_HEC - - TEAMS - - WEBHOOK - 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: + - '=' + - '!=' + - LIKE + - ILIKE + - < + - '>' + - <= + - '>=' + - IN + - NOT IN + - BETWEEN + - NOT BETWEEN + values: + type: array + items: + type: string + ServiceTokenSearchExpressions: + type: array + items: + $ref: '#/components/schemas/ServiceTokenSearchExpression' + ServiceTokenSearchFieldName: + description: Possible field names to use on filters + type: string + enum: + - /uuid + - /state + - /name + - /project/projectId + - /type + - /expirationDateTime + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + - /connection/aSide/accessPointSelectors/port/uuid + - /connection/zSide/accessPointSelectors/port/uuid + ServiceTokenSearchRequest: type: object + description: Search requests containing criteria properties: - type: + filter: + $ref: '#/components/schemas/ServiceTokenSearchExpression' + pagination: + $ref: '#/components/schemas/PaginationRequest' + OpticalConnectRedundancy: + description: | + Optical Connect redundancy configuration.
Required only for DUAL_DIVERSE connection. + type: object + properties: + priority: + description: | + Role within the diverse pair.
PRIMARY - first connection of the pair.
SECONDARY - the diverse connection on a separate path. type: string - description: credential type + example: PRIMARY enum: - - ACCESS_TOKEN - - INTEGRATION_KEY - - API_KEY - - USERNAME_PASSWORD - - API_TOKEN - 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 - apiToken: + - PRIMARY + - SECONDARY + group: + description: Redundancy group identifier type: string - description: passed as Authorization header value - description: Stream subscription sink credentials - StreamSubscriptionSinkSetting: + format: uuid + OpticalConnectDemarcationPoint: + description: | + Specifies the demarcation point: the patch panel and ports at this side. type: object properties: - eventIndex: - type: string - description: event index - metricIndex: - type: string - description: metric index - source: - type: string - description: source - applicationKey: + patchPanelId: + description: Unique identifier of the patch panel. type: string - description: Application key - eventUri: + example: CP:Demarc:1259684 + patchPanelPortA: + description: | + Specify the desired port number for Port A.
When ports are not provided, next available ports will be used. type: string - description: event uri - metricUri: + example: '10' + patchPanelPortB: + description: | + Specify the desired port number for Port B.
When ports are not provided, next available ports will be used.
Required for Connector type FC, SC and ST only. type: string - description: metric uri - format: + example: '11' + connectorType: + description: Type of Connector type: string - description: webhook message format - default: CLOUDEVENT enum: - - CLOUDEVENT - - OPENTELEMETRY - description: Stream subscription sink settings - StreamSubscription: + - FC + - SC + - LC + - ST + example: SC + OpticalConnectASideRequest: + description: | + A-Side configuration. Always a patch panel port from your cage. type: object properties: - href: + demarcationPoint: + $ref: '#/components/schemas/OpticalConnectDemarcationPoint' + OpticalConnectLocation: + description: Destination location for BMMR and REMOTE connections. + type: object + properties: + ibxCode: + description: Equinix IBX data centre code. 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 + example: SV1 + OpticalConnectLOA: + description: | + Letter of Authorization granting the right to terminate at the Z-side location.
Required for BMMR and REMOTE. + type: object + properties: uuid: + description: Identifier of the Letter of Authorization 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: + example: 64de7e5-7fe7-41e6-b984-80d5aa159a0e + OpticalConnectZSideRequest: + description: | + Z-Side configuration.
For COLO, specify the destination patch panel and ports.
For BMMR and REMOTE, specify the location and Letter of Authorization. + type: object + properties: + demarcationPoint: + $ref: '#/components/schemas/OpticalConnectDemarcationPoint' + location: + $ref: '#/components/schemas/OpticalConnectLocation' + loa: + $ref: '#/components/schemas/OpticalConnectLOA' + OpticalConnectOrder: + type: object + description: Ordering and billing reference details for this connection. + properties: + purchaseOrderNumber: type: string - description: Customer-provided subscription name - description: + description: Purchase order number reference. + example: PO-156576 + customerReferenceId: + description: Your own reference for this connection. type: string - description: Customer-provided subscription description - state: + orderNumber: + description: Equinix order reference number. 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/StreamSubscriptionSinkResponse" - operation: - $ref: "#/components/schemas/StreamSubscriptionOperation" - changeLog: - $ref: "#/components/schemas/Changelog" - description: Stream Subscription object - StreamSubscriptionId: - type: string - description: Stream Subscription UUID - format: uuid - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - StreamSubscriptionPutRequest: - required: - - name - - sink - - type + example: 1-129105284100 + OpticalConnectNotification: + description: Notification preferences for this connection. type: object properties: type: + description: | + Notification category.
NOTIFICATION - states and configuration updates.
ORDERING - order and fulfilment correspondence.
TECHNICAL - maintenance and technical advisories. 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 - filters: - $ref: "#/components/schemas/StreamSubscriptionFilter" - metricSelector: - $ref: "#/components/schemas/StreamSubscriptionSelector" - eventSelector: - $ref: "#/components/schemas/StreamSubscriptionSelector" - sink: - $ref: "#/components/schemas/StreamSubscriptionSink" - description: Update Stream Subscription - StreamSubscriptionSearchRequest: - required: - - filter - type: object - properties: - filter: - $ref: "#/components/schemas/StreamSubscriptionSearchFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + - NOTIFICATION + - ORDERING + - TECHNICAL + example: NOTIFICATION + emails: + description: Email addresses to notify. type: array items: - $ref: "#/components/schemas/StreamSubscriptionSearchSortCriteria" - description: Search requests containing criteria - StreamSubscriptionSearchFilters: - required: - - and - type: object - properties: - and: - minItems: 1 + type: string + format: email + registeredUsers: + description: Usernames of registered Equinix Portal users to notify. type: array items: - $ref: "#/components/schemas/StreamSubscriptionSearchFilter" - StreamSubscriptionSearchFilter: - type: object - anyOf: - - $ref: "#/components/schemas/StreamSubscriptionSearchSimpleExpression" - - $ref: "#/components/schemas/StreamSubscriptionSearchOrFilter" - StreamSubscriptionSearchSimpleExpression: + type: string + required: + - type + - emails + OpticalConnectPostRequest: type: object + description: |- + Request to order a single connection. The A-side is always a patch panel + port in your own cage; the Z-side shape depends on + connectionDestinationType. properties: - property: + type: type: string + description: OC - Optical Connect Type + enum: + - OC + example: OC + bandwidth: description: | - Possible field names to use on filters: - * `/uuid` - Subscription uuid - * `/streamUuid` - Stream uuid the subscription belongs to - * `/state` - Subscription state (`DEPROVISIONED` returned only when explicitly requested) - * `/name` - Subscription name - * `/project/projectId` - Subscription project id - * `/description` - Subscription description - * `/changeLog/createdDateTime` - Subscription created date time - * `/changeLog/updatedDateTime` - Subscription updated date time - example: /streamUuid - operator: - type: string + Connection bandwidth Mbps.
Available bandwidths depend on the IBX pair.
1000 - 1 Gbps.
10000 - 10 Gbps.
100000 - 100 Gbps.
+ type: integer + example: 100000 + connectionDestinationType: + description: | + Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
BMMR and REMOTE require a Letter of Authorization on the Z-side. + type: string + enum: + - COLO + - BMMR + - REMOTE + example: COLO + pathType: + type: string + description: | + Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs. + enum: + - DUAL_DIVERSE + - PROTECTED + - UNPROTECTED + example: PROTECTED + redundancy: + $ref: '#/components/schemas/OpticalConnectRedundancy' + aSide: + $ref: '#/components/schemas/OpticalConnectASideRequest' + zSide: + $ref: '#/components/schemas/OpticalConnectZSideRequest' + order: + $ref: '#/components/schemas/OpticalConnectOrder' + account: + $ref: '#/components/schemas/SimplifiedAccount' + notifications: + type: array + description: Contacts to notify about connection configuration and status changes + items: + $ref: '#/components/schemas/OpticalConnectNotification' + bmmrType: + type: string + description: | + BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR. + enum: + - EQUINIX + - SELF + example: EQUINIX + required: + - type + - bandwidth + - connectionDestinationType + - pathType + - aSide + - zSide + OpticalConnectState: + description: Optical Connect lifecycle states. + type: string + example: PROVISIONED + readOnly: true + enum: + - PROVISIONING + - PROVISIONED + - PROVISIONING_FAILED + - REPROVISIONING + - REPROVISIONING_FAILED + - DEPROVISIONING + - DEPROVISIONED + OpticalConnectResponseDemarcationPoint: + description: | + Demarcation point as provisioned, with the cage and cabinet it belongs to. + allOf: + - $ref: '#/components/schemas/OpticalConnectDemarcationPoint' + - type: object + properties: + cageUniqueSpaceId: + description: Unique identifier of the cage. + type: string + example: SV1:01:002174 + cabinetUniqueSpaceId: + description: Unique identifier of the cabinet. + type: string + example: Demarc + OpticalConnectASideResponse: + description: Originating end as provisioned, with the demarcation point and IBX location. + type: object + properties: + demarcationPoint: + $ref: '#/components/schemas/OpticalConnectResponseDemarcationPoint' + location: + $ref: '#/components/schemas/OpticalConnectLocation' + OpticalConnectZSideResponse: + description: Terminating end as provisioned, with the demarcation point and IBX location. + type: object + properties: + demarcationPoint: + $ref: '#/components/schemas/OpticalConnectResponseDemarcationPoint' + location: + $ref: '#/components/schemas/OpticalConnectLocation' + loa: + $ref: '#/components/schemas/OpticalConnectLOA' + OpticalConnectResponse: + description: |- + Optical Metro Connect connection with its current state and the resolved + physical termination points at both ends. + type: object + properties: + href: + type: string + description: URI of this Optical Connect resource. + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 + uuid: + type: string + description: Unique identifier of this Optical Connect. + format: uuid + readOnly: true + example: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 + type: + type: string + description: | + Connection Type.
OC - Optical Connect. + enum: + - OC + example: OC + name: + type: string + description: | + Equinix-assigned name, derived from the account number and the two IBX locations. + readOnly: true + example: 123456-SV1-SV2-01 + state: + $ref: '#/components/schemas/OpticalConnectState' + bandwidth: + type: integer + description: Provisioned connection bandwidth in Mbps. + example: 10000 + connectionDestinationType: + description: | + Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
+ type: string + enum: + - COLO + - BMMR + - REMOTE + pathType: + type: string + description: | + Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs. + enum: + - DUAL_DIVERSE + - PROTECTED + - UNPROTECTED + bmmrType: + type: string + description: | + BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR. + enum: + - EQUINIX + - SELF + redundancy: + $ref: '#/components/schemas/OpticalConnectRedundancy' + aSide: + $ref: '#/components/schemas/OpticalConnectASideResponse' + zSide: + $ref: '#/components/schemas/OpticalConnectZSideResponse' + order: + $ref: '#/components/schemas/OpticalConnectOrder' + account: + $ref: '#/components/schemas/SimplifiedAccount' + notifications: + description: Preferences for notifications on connection configuration or status changes + type: array + items: + $ref: '#/components/schemas/OpticalConnectNotification' + changeLog: + $ref: '#/components/schemas/Changelog' + BulkOpticalConnectRequest: + type: object + description: Request to create a dual diverse pair of Optical Connect connections. + properties: + data: + type: array + description: | + The two connections forming the diverse pair — one PRIMARY and one + SECONDARY. + items: + $ref: '#/components/schemas/OpticalConnectPostRequest' + OpticalConnectBulk: + description: Dual diverse pair Connection + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/OpticalConnectResponse' + OpticalConnectSimpleExpression: + type: object + properties: + property: + description: | + Possible field names to use on filters: + * `/name` - Connection name + * `/uuid` - Connection uuid + * `/type` - type + * `/state` - state + * `/bandwidth` - Bandwidth + type: string + example: /name + operator: description: | Possible operators to use on filters: * `=` - equal * `!=` - not equal - * `>` - greater than - * `>=` - greater than or equal to - * `<` - less than - * `<=` - less than or equal to - * `BETWEEN` - between - * `NOT BETWEEN` - not between - * `LIKE` - like - * `ILIKE` - like case-insensitive - * `IN` - in - * `NOT IN` - not in - example: = + * `[NOT] BETWEEN` - (not) between + * `[NOT] LIKE` - (not) like + * `[NOT] IN` - (not) in + * `ILIKE` - case-insensitive like + type: string + example: '=' values: - minItems: 1 type: array items: type: string - example: 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 - StreamSubscriptionSearchOrFilter: + example: 123456-SV1-SV2-01 + OpticalConnectOrFilter: type: object properties: or: type: array + maxItems: 3 items: - $ref: "#/components/schemas/StreamSubscriptionSearchSimpleExpression" - StreamSubscriptionSearchSortCriteria: - required: - - direction - - property + $ref: '#/components/schemas/OpticalConnectSimpleExpression' + OpticalConnectFilter: + type: object + description: A single condition, or a group of conditions combined with logical OR. + anyOf: + - $ref: '#/components/schemas/OpticalConnectSimpleExpression' + - $ref: '#/components/schemas/OpticalConnectOrFilter' + OpticalConnectFilters: type: object properties: - direction: - $ref: "#/components/schemas/StreamSubscriptionSearchSortDirection" - property: - $ref: "#/components/schemas/StreamSubscriptionSearchSortBy" - StreamSubscriptionSearchSortDirection: - type: string - description: Sorting direction + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/OpticalConnectFilter' + OpticalConnectSortDirection: + description: | + Sorting direction.
ASC - ascending
DESC - descending default: DESC + type: string enum: - DESC - ASC - StreamSubscriptionSearchSortBy: - type: string + OpticalConnectSortBy: description: Possible field names to use on sorting - default: /changeLog/createdDateTime + default: /changeLog/updatedDateTime + type: string enum: + - /name + - /uuid + - /state + - /type + - /bandwidth + - /aSide/location/ibxCode + - /zSide/location/ibxCode - /changeLog/createdDateTime - /changeLog/updatedDateTime - SearchStreamSubscriptionResponse: + OpticalConnectSortCriteria: + type: object + description: Sorting to apply to search results. + properties: + direction: + $ref: '#/components/schemas/OpticalConnectSortDirection' + property: + $ref: '#/components/schemas/OpticalConnectSortBy' + OpticalConnectSearchRequest: type: object + description: |- + Search criteria for retrieving Optical Connects, with optional + filtering, pagination and sorting. properties: + filter: + $ref: '#/components/schemas/OpticalConnectFilters' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/StreamSubscription" - GetAllStreamAlertRuleResponse: + $ref: '#/components/schemas/OpticalConnectSortCriteria' + OpticalConnectServiceSearchResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: - type: array description: Data returned from the API call. + type: array items: - $ref: "#/components/schemas/StreamAlertRule" - AlertRulePostRequest: - required: - - detectionMethod - - metricSelector - - name - - resourceSelector - - type + $ref: '#/components/schemas/OpticalConnectResponse' + Presence: + description: Presence + type: string + enum: + - MY_PORTS + GeoCoordinates: + description: Geographic location data of Fabric Metro + type: object + properties: + latitude: + description: Latitude of a Fabric Metro + type: number + format: double + longitude: + description: Longitude of a Fabric Metro + type: number + format: double + ConnectedMetro: + description: Arrays of objects containing latency data for the specified metros + type: object + properties: + href: + description: The Canonical URL at which the resource resides. + type: string + code: + description: Code assigned to an Equinix International Business Exchange (IBX) data center in a specified metropolitan area. + type: string + avgLatency: + description: Average latency (in milliseconds[ms]) between two specified metros. + type: number + remoteVCBandwidthMax: + description: This field holds the Max Connection speed with connected metros + type: integer + format: int64 + services: + description: Arrays of objects containing type of services supported in the specified metros type: object properties: type: + description: Type of Service + type: string + GeoZone: + description: Geographic zone of a Fabric Metro + type: object + properties: + code: + description: Code assigned to a geographic zone. type: string - enum: - - METRIC_ALERT name: + description: Name of a geographic zone. type: string - description: Customer-provided stream name description: + description: Description of a geographic zone. type: string - description: Customer-provided stream description - enabled: - type: boolean - description: Stream alert rule enabled status - example: true - default: true - metricSelector: - $ref: "#/components/schemas/MetricSelector" - resourceSelector: - $ref: "#/components/schemas/ResourceSelector" - detectionMethod: - $ref: "#/components/schemas/DetectionMethod" - description: Create Stream Alert Rules - MetricSelector: - required: - - include + 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. type: object properties: - include: + href: + description: The Canonical URL at which the resource resides. + type: string + type: + description: Indicator of a Fabric Metro + type: string + code: + description: Code Assigned to an Equinix IBX data center in a specified metropolitan area. + type: string + region: + description: Board geographic area in which the data center is located + type: string + name: + description: Name of the region in which the data center is located. + type: string + country: + description: Country code in which the data center is located. + type: string + equinixAsn: + 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. + type: integer + format: int64 + localVCBandwidthMax: + description: This field holds Max Connection speed with in the metro + type: integer + format: int64 + geoCoordinates: + $ref: '#/components/schemas/GeoCoordinates' + connectedMetros: type: array - description: Stream alert rule filtered by metric name items: - type: string - example: equinix.fabric.metro.sv_da.latency - ResourceSelector: - required: - - include + $ref: '#/components/schemas/ConnectedMetro' + services: + type: array + items: + $ref: '#/components/schemas/services' + geoScopes: + description: List of supported geographic boundaries of a Fabric Metro. + type: array + items: + $ref: '#/components/schemas/GeoScopeType' + geoZones: + description: List of supported geographic zones of a Fabric Metro. + type: array + items: + $ref: '#/components/schemas/GeoZone' + MetroResponse: + 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. type: object properties: - include: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: List of Fabric Metros. type: array - description: | - ### Supported metric names to use on filters with property /subject: - * `/fabric/v4/ports/` - port metrics - * `/fabric/v4/connections/` - connection metrics - * `/fabric/v4/metros/` - metro latency metrics items: - type: string - DetectionMethod: + $ref: '#/components/schemas/Metro' + MetroError: + description: Error with details required: - - type + - errorCode + - errorMessage type: object + discriminator: + propertyName: errorCode properties: - type: + errorCode: type: string - description: | - * THRESHOLD - Alert when a metric crosses a defined threshold by user. - * OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric. enum: - - THRESHOLD - - OUTLIER - windowSize: - type: string - description: Stream alert rule metric window size - example: PT15M - operand: + - EQ-3036001 + - EQ-3036013 + - EQ-3036030 + - EQ-3036100 + errorMessage: type: string - description: Stream alert rule metric operand enum: - - ABOVE - - BELOW - warningThreshold: + - Unauthorized + - Invalid Query Parameter + - Invalid Path Parameter + - Invalid Query or Path Parameter + - Internal Server Error + - Metro Not Found + correlationId: type: string - description: Stream alert rule metric warning threshold - criticalThreshold: + details: type: string - description: Stream alert rule metric critical threshold - StreamAlertRule: + help: + type: string + additionalInfo: + type: array + items: + type: object + properties: + property: + type: string + reason: + type: string + MetroErrorList: + type: array + items: + $ref: '#/components/schemas/MetroError' + PortChangeOperation: + description: Port change operation data type: object properties: - href: + op: + description: Handy shortcut for operation name type: string - description: Stream Alert Rule URI - format: uri - readOnly: true + example: replace + path: + description: path inside document leading to updated parameter + type: string + example: /name + value: + description: new value for updated parameter + required: + - op + - path + - value + PortChange: + description: Current state of latest port change + type: object + properties: uuid: + description: Uniquely identifies a change type: string - description: Equinix-assigned access point identifier - format: uuid - example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: + description: Type of change type: string - description: Stream subscription type enum: - - METRIC_ALERT - name: + - PORT_CREATION + - PORT_UPDATE + - PORT_DELETION + status: + description: Current outcome of the change flow type: string - description: Customer-provided stream alert rule name - description: + enum: + - COMPLETED + - FAILED + - REQUESTED + information: + description: Additional information type: string - description: Customer-provided stream alert rule description - state: + data: + $ref: '#/components/schemas/PortChangeOperation' + createdDateTime: + description: Set when change flow starts + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + updatedDateTime: + description: Set when change object is updated + type: string + format: date-time + example: '2020-11-06T07:00:00Z' + PortLag: + description: Port Lag + type: object + properties: + id: + description: id type: string - description: Steam subscription provision state - enum: - - ACTIVE - - INACTIVE enabled: + deprecated: true + description: enabled type: boolean - description: Stream alert rule enabled status - default: true - metricSelector: - $ref: "#/components/schemas/MetricSelectorResponse" - resourceSelector: - $ref: "#/components/schemas/ResourceSelectorResponse" - detectionMethod: - $ref: "#/components/schemas/DetectionMethodResponse" - changeLog: - $ref: "#/components/schemas/Changelog" - description: Stream object - AlertRuleId: - type: string - description: Stream Alert Rule UUID - format: uuid - example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 - AlertRulePutRequest: - required: - - detectionMethod - - metricSelector - - name - - resourceSelector - - type - type: object - properties: name: + description: name type: string - description: Customer-provided stream name - type: - type: string - enum: - - METRIC_ALERT - description: + memberStatus: + description: member status type: string - description: Customer-provided stream description - enabled: - type: boolean - description: Stream alert rule enabled status - default: true - metricSelector: - $ref: "#/components/schemas/MetricSelector" - resourceSelector: - $ref: "#/components/schemas/ResourceSelector" - detectionMethod: - $ref: "#/components/schemas/DetectionMethod" - description: Create Stream Alert Rules - CompanyProfileRequest: - required: - - description - - name - - summary - - type - - webUrl + Port: + description: Port specification type: object properties: + href: + description: Equinix assigned response attribute for an absolute URL that is the subject of the link's context. + type: string + format: uri + readOnly: true type: + $ref: '#/components/schemas/PortType' + uuid: + description: Equinix assigned response attribute for port identifier type: string - example: COMPANY_PROFILE + format: uuid name: - maxLength: 50 - minLength: 1 - type: string - example: Equinix - summary: - maxLength: 125 - minLength: 1 + description: Equinix assigned response attribute for Port name type: string - example: Global interconnection and data center company description: - maxLength: 450 - minLength: 1 - type: string - example: Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers. - pointOfContacts: - type: array - example: - - type: SUPPORT - contacts: - - name: Peter Griffin - role: Vice President of Sales - email: example1@example.com - - name: Taylor Swift - role: Director of Marketing - email: example2@example.com - - name: Darth Vader - role: Head of Engineering - email: example3@example.com - items: - $ref: "#/components/schemas/CompanyProfileContact" - notifications: - type: array - example: - - type: NOTIFICATION - emails: - - example1@example.com - - example2@example.com - items: - $ref: "#/components/schemas/SimplifiedNotification" - overview: - type: string - example: About Initech Corp

lorem ipsum

- webUrl: - type: string - example: https://www.equinix.com - contactUrl: + description: Equinix assigned response attribute for Port description type: string - example: https://www.equinix.com/contact-us - CompanyProfileResponse: - type: object - properties: - href: + physicalPortsSpeed: + description: Physical Ports Speed in Mbps + type: integer + minimum: 0 + connectionsCount: + description: Equinix assigned response attribute for Connection count + type: integer + minimum: 0 + physicalPortsType: + description: Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports type: string - example: https://api.equinix.com/fabric/v4/companyProfiles/123e4567-e89b-12d3-a456-426614174000 - uuid: + enum: + - 1000BASE_LX + - 10GBASE_LR + - 100GBASE_LR4 + - 10GBASE_ER + - 1000BASE_SX + - 10GBASE_SMF + - 400GBASE_LR4 + physicalPortsCount: + type: integer + connectivitySourceType: + description: Port connectivity type type: string - example: 123e4567-e89b-12d3-a456-426614174000 - type: + enum: + - COLO + - BMMR + - REMOTE + bmmrType: type: string - example: COMPANY_PROFILE - name: - maxLength: 50 - minLength: 1 + 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: + deprecated: true + description: Port service Type type: string - example: Equinix - summary: - maxLength: 125 - minLength: 1 + enum: + - EPL + - MSP + serviceCode: + $ref: '#/components/schemas/PortServiceCode' + bandwidth: + deprecated: true + description: Equinix assigned response attribute for Port bandwidth in Mbps + type: integer + minimum: 0 + availableBandwidth: + description: Equinix assigned response attribute for Port available bandwidth in Mbps + type: integer + minimum: 0 + usedBandwidth: + description: Equinix assigned response attribute for Port used bandwidth in Mbps + type: integer + minimum: 0 + location: + $ref: '#/components/schemas/SimplifiedLocation' + device: + $ref: '#/components/schemas/PortDevice' + interface: + $ref: '#/components/schemas/PortInterface' + demarcationPointIbx: + description: A-side/Equinix ibx type: string - example: Global interconnection and data center company - description: - maxLength: 450 - minLength: 1 + tetherIbx: + description: z-side/Equinix ibx type: string - example: Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers. - state: - $ref: "#/components/schemas/CompanyProfileState" - account: - $ref: "#/components/schemas/CompanyProfileResponse_account" - metros: - type: array - example: - - href: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - items: - $ref: "#/components/schemas/CompanyMetro" - logo: - $ref: "#/components/schemas/CompanyLogo" - tags: - type: array - example: - - href: https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387 - uuid: 260af68b-42f0-4f2e-9c5c-2fbd44b4b387 - type: RESOURCE_TAG - name: environment - displayName: Environment - weight: 30000 - items: - $ref: "#/components/schemas/TagResponse" - serviceProfiles: + demarcationPoint: + $ref: '#/components/schemas/PortDemarcationPoint' + redundancy: + $ref: '#/components/schemas/PortRedundancy' + encapsulation: + $ref: '#/components/schemas/PortEncapsulation' + lagEnabled: + description: If LAG enabled + type: boolean + lag: + allOf: + - $ref: '#/components/schemas/PortLag' + deprecated: true + asn: + description: Port ASN + type: integer + package: + $ref: '#/components/schemas/Package' + settings: + $ref: '#/components/schemas/PortSettings' + physicalPortQuantity: + description: Number of physical ports + type: integer + notifications: + description: Notification preferences type: array - example: - - href: https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387 - uuid: 423af68b-42f0-4f2e-9c5c-2fbd44b4b387 - type: L2_PROFILE items: - $ref: "#/components/schemas/CompanyServiceProfile" - privateServices: + $ref: '#/components/schemas/PortNotification' + additionalInfo: + description: Port additional information type: array - example: - - href: https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387 - uuid: 460af68b-42f0-4f2e-9c5c-2fbd44b4b387 - - href: https://api.equinix.com/fabric/v4/privateServices/8a5685a6-063d-41ac-9279-d32431e8d8f6 - uuid: 8a5685a6-063d-41ac-9279-d32431e8d8f6 items: - $ref: "#/components/schemas/PrivateService" - pointOfContacts: + $ref: '#/components/schemas/PortAdditionalInfo' + physicalPorts: type: array - example: - - type: SUPPORT - contacts: - - name: Peter Griffin - role: Vice President of Sales - email: example1@example.com - - name: Taylor Swift - role: Director of Marketing - email: example2@example.com - - name: Darth Vader - role: Head of Engineering - email: example3@example.com + description: Physical ports that implement this port items: - $ref: "#/components/schemas/CompanyProfileContact" - notifications: + $ref: '#/components/schemas/PhysicalPort' + loas: + description: Port Loas type: array - example: - - type: NOTIFICATION - emails: - - example1@example.com - - example2@example.com items: - $ref: "#/components/schemas/SimplifiedNotification" - overview: - type: string - example: About Initech Corp

lorem ipsum

- webUrl: - type: string - example: https://www.equinix.com - contactUrl: - type: string - example: https://www.equinix.com/contact-us - change: - $ref: "#/components/schemas/CompanyProfileChange" - changeLog: - $ref: "#/components/schemas/Changelog" - CompanyProfileSearchRequest: + $ref: '#/components/schemas/PortLoa' + marketplaceSubscription: + $ref: '#/components/schemas/marketplaceSubscription' + AllPortsResponse: + description: GET All User Port Across Fabric Metros type: object properties: - filter: - $ref: "#/components/schemas/CompanyProfileSearchFilters" - pagination: - $ref: "#/components/schemas/Pagination" - sort: - $ref: "#/components/schemas/Sort" - example: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONED - - or: - - property: /name - operator: ILIKE - values: - - equinix - - property: /tags/name - operator: = - values: - - environment pagination: - offset: 0 - limit: 20 - total: 0 - sort: - property: /changeLog/updatedDateTime - direction: DESC - CompanyProfileSearchFilters: - type: object - properties: - and: + $ref: '#/components/schemas/Pagination' + data: + description: GET All User Port Across Fabric Metros type: array items: - $ref: "#/components/schemas/CompanyProfileSearchFilter" - description: | - Filter criteria for company profile search. The `and` array combines conditions where all must match. Each item in `and` is either a simple expression (property/operator/values) or an `or` group. At most one `or` group is allowed per request. - CompanyProfileSearchFilter: - type: object - oneOf: - - $ref: "#/components/schemas/CompanyProfileSearchSimpleExpression" - - $ref: "#/components/schemas/CompanyProfileSearchOrFilter" - CompanyProfileSearchSimpleExpression: - required: - - operator - - property - - values + $ref: '#/components/schemas/Port' + SimplifiedAccountRequest: type: object properties: - property: - description: | - Searchable field name. Properties are grouped by their supported operators: - String properties (support all operators): - * `/name` - Company profile name - * `/uuid` - Company profile UUID - * `/tags/name` - Tag name - * `/tags/uuid` - Tag UUID - * `/tags/displayName` - Tag display name - - Discrete value properties (only support `=`, `!=`, `IN`, `NOT IN`): - * `/state` - Company profile state (`PENDING`, `PROVISIONED`, `DEPROVISIONED`, `REJECTED`) - * `/metros/metroCode` - Metro code (e.g. `SV`, `NY`, `DC`) - * `/change/status` - Change status (`PENDING`, `COMPLETED`, `REJECTED`) — seller and admin users only - example: /state - allOf: - - $ref: "#/components/schemas/CompanyProfileSearchFieldName" - operator: - description: | - Comparison operator. `LIKE`, `NOT LIKE`, `ILIKE`, and `NOT ILIKE` require exactly one value. All other operators accept one or more values. - * `=` - equal; equivalent to `IN` when multiple values are provided - * `!=` - not equal; equivalent to `NOT IN` when multiple values are provided - * `LIKE` - case-sensitive partial match (single value) - * `NOT LIKE` - case-sensitive partial non-match (single value) - * `ILIKE` - case-insensitive partial match (single value) - * `NOT ILIKE` - case-insensitive partial non-match (single value) - * `IN` - matches any of the provided values - * `NOT IN` - does not match any of the provided values - example: IN - allOf: - - $ref: "#/components/schemas/OperatorEnum" - values: - minItems: 1 - type: array - example: - - PROVISIONED - - PENDING - items: - type: string - CompanyProfileSearchFieldName: - type: string - description: Searchable field names in company profile - example: /tags/name - enum: - - /name - - /uuid - - /tags/name - - /tags/uuid - - /tags/displayName - - /state - - /metros/metroCode - - /change/status - OperatorEnum: - type: string - description: Comparison operators for filtering - example: = - enum: - - = - - "!=" - - LIKE - - NOT LIKE - - ILIKE - - NOT ILIKE - - IN - - NOT IN - CompanyProfileSearchOrFilter: + accountNumber: + description: Account number + type: integer + format: int64 required: - - or - type: object - properties: - or: - minItems: 1 - type: array - items: - $ref: "#/components/schemas/CompanyProfileSearchSimpleExpression" - description: | - Groups multiple simple expressions with OR logic. At most one `or` group is allowed within the top-level `and` array. - Sort: + - accountNumber + SimplifiedLocationRequest: type: object properties: - property: + metroCode: type: string - description: | - Property to sort by. Supported values: - * `/name` - Company profile name - * `/state` - Company profile state - * `/changeLog/updatedDateTime` - Date and time the profile was last updated - * `/changeLog/createdDateTime` - Date and time the profile was created - example: /changeLog/updatedDateTime - direction: - $ref: "#/components/schemas/CompanyProfileSortDirection" - CompanyProfileSearchResponse: + example: AM required: - - data - - pagination + - metroCode + PortRequest: + description: PortRequest is the Request Object for creating single and bulk fabric ports type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + type: + $ref: '#/components/schemas/PortType' + physicalPortsSpeed: + description: Physical Ports Speed in Mbps + type: integer + minimum: 0 + physicalPortsType: + description: Physical Ports Type. 10GBASE_SMF is only applicable for IX ports + type: string + enum: + - 1000BASE_LX + - 10GBASE_LR + - 100GBASE_LR4 + - 10GBASE_ER + - 1000BASE_SX + - 10GBASE_SMF + - 400GBASE_LR4 + physicalPortsCount: + type: integer + connectivitySourceType: + description: Port connectivity type + type: string + enum: + - COLO + - BMMR + - REMOTE + bmmrType: + description: BMMR Type is mandatory when connectivitySourceType is BMMR + type: string + enum: + - SELF + - EQUINIX + project: + $ref: '#/components/schemas/Project' + order: + $ref: '#/components/schemas/PortOrder' + account: + $ref: '#/components/schemas/SimplifiedAccountRequest' + serviceType: + deprecated: true + description: Port service Type + type: string + enum: + - EPL + - MSP + serviceCode: + $ref: '#/components/schemas/PortServiceCode' + bandwidth: + deprecated: true + description: Equinix assigned response attribute for Port bandwidth in Mbps + type: integer + minimum: 0 + location: + $ref: '#/components/schemas/SimplifiedLocationRequest' + demarcationPointIbx: + description: A-side/Equinix ibx + type: string + tetherIbx: + description: z-side/Equinix ibx + type: string + demarcationPoint: + $ref: '#/components/schemas/PortDemarcationPoint' + redundancy: + $ref: '#/components/schemas/PortRedundancy' + encapsulation: + $ref: '#/components/schemas/PortEncapsulation' + lagEnabled: + description: Indicates whether Link Aggregation Group (LAG) is enabled on this port + type: boolean + package: + $ref: '#/components/schemas/Package' + notifications: + description: Notification preferences type: array items: - $ref: "#/components/schemas/CompanyProfileResponse" - ServiceProfileListResponse: - type: object - properties: - data: + $ref: '#/components/schemas/PortNotification' + physicalPorts: type: array - description: List of service profiles - example: - - href: https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387 - uuid: 423af68b-42f0-4f2e-9c5c-2fbd44b4b387 + description: Physical ports that implement this port items: - $ref: "#/components/schemas/CompanyServiceProfile" - AttachServiceProfileResponse: + $ref: '#/components/schemas/PhysicalPort' + loas: + description: Port Loas + type: array + items: + $ref: '#/components/schemas/PortLoa' required: - type - - uuid - type: object - properties: - href: - type: string - description: URL to the attached service profile - example: https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387 - type: - type: string - description: Type of the service or attachment - example: SERVICE_PROFILE - uuid: - type: string - description: Unique identifier for the service profile - example: 423af68b-42f0-4f2e-9c5c-2fbd44b4b387 - attachmentStatus: - type: string - description: Status of the attachment operation - example: ATTACHED - TagListResponse: + - physicalPortsSpeed + - physicalPortsType + - connectivitySourceType + - location + - encapsulation + - account + - project + BulkPhysicalPort: type: object + description: Add to Lag request properties: data: + description: add physical ports to virtual port type: array items: - $ref: "#/components/schemas/TagResponse" + $ref: '#/components/schemas/PhysicalPort' + AllPhysicalPortsResponse: + description: GET All Physical Ports + type: object + properties: pagination: - $ref: "#/components/schemas/Pagination" - description: Equinix Fabric Tag List Response Object - TagResponse: - type: object - properties: - href: - type: string - format: uri - example: https://api.equinix.com/fabric/v4/tags/18a127ad-9d0c-46e2-a66d-8ed85d1858b0 - uuid: - type: string - format: uuid - example: 18a127ad-9d0c-46e2-a66d-8ed85d1858b0 - type: - type: string - example: PREDEFINED_TAG - name: - type: string - example: equinix.fabric.spotlight.ai.llm - displayName: - type: string - example: LLM - state: - type: string - description: Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT - example: PENDING_APPROVAL - enum: - - APPROVED - - PENDING_APPROVAL - - REJECTED - notifications: - type: array - example: - - type: NOTIFICATION - emails: - - example1@example.com - - example2@example.com - items: - $ref: "#/components/schemas/SimplifiedNotification" - changeLog: - $ref: "#/components/schemas/Changelog" - weight: - type: integer - example: 30000 - description: Equinix Fabric Tag Response Object - AttachTagResponse: - required: - - type - - uuid - type: object - properties: - href: - type: string - description: URL to the attached tag - example: https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387 - type: - type: string - description: Type of the tag or attachment - example: TAG - uuid: - type: string - description: Unique identifier for the tag - example: 260af68b-42f0-4f2e-9c5c-2fbd44b4b387 - attachmentStatus: - type: string - description: Status of the attachment operation - example: ATTACHED - PrivateServiceListResponse: - type: object - properties: + $ref: '#/components/schemas/Pagination' data: + description: GET All Physical Ports type: array - description: List of private services - example: - - href: https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387 - uuid: 460af68b-42f0-4f2e-9c5c-2fbd44b4b387 items: - $ref: "#/components/schemas/PrivateService" - AttachPrivateServiceResponse: - required: - - type - - uuid - type: object - properties: - href: - type: string - description: URL to the attached private service - example: https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387 - type: - type: string - description: Type of the private service or attachment - example: PRIVATE_SERVICE - uuid: - type: string - description: Unique identifier for the private service - example: 460af68b-42f0-4f2e-9c5c-2fbd44b4b387 - attachmentStatus: - type: string - description: Status of the attachment operation - example: ATTACHED - LogoRequest: - required: - - description - - logo - - name - - type + $ref: '#/components/schemas/PhysicalPort' + PortUpdateRequest: + description: Port Update Request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/PortChangeOperation' + LinkProtocolState: + description: Network status + type: string + enum: + - RESERVED + - RELEASED + LinkProtocolRequestType: + description: Type of Link Protocol + type: string + enum: + - UNTAGGED + - DOT1Q + - QINQ + - VXLAN + SubInterface: + description: Sub Interface information type: object properties: - logo: - type: string - description: Logo image file - format: binary name: - maxLength: 24 - minLength: 1 - type: string - description: Name of the Logo - example: Equinix Logo - description: - maxLength: 125 - minLength: 1 - type: string - description: Description of the logo - example: Company branding logo - type: + deprecated: true + description: name of subInterface of a port type: string - description: Type of logo - example: COMPANY_LOGO - description: Equinix Fabric Logo Request Object - LogoResponse: + unit: + type: integer + example: 200 + LinkProtocolConnection: + description: Connection details of Link Protocol type: object properties: href: + description: Connection URI type: string format: uri - example: https://api.equinix.com/fabric/v4/logos/18a127ad-9d0c-46e2-a66d-8ed85d1858b0 + readOnly: true uuid: type: string - format: uuid - example: 18a127ad-9d0c-46e2-a66d-8ed85d1858b0 + format: string + example: cd67f685-41b0-1b07-6de0-320a5c00abe type: type: string - description: Type of logo - example: COMPANY_LOGO - name: - type: string - example: Equinix Logo - description: - type: string - example: Company branding logo - status: - type: string - example: CREATED - extensionType: - type: string - example: .png - changelog: - $ref: "#/components/schemas/Changelog" - description: Equinix Fabric Logo Response Object - CreateLoa: - description: Create Loa - oneOf: - - $ref: "#/components/schemas/IssueLoa" - - $ref: "#/components/schemas/RequestLoa" - LoaResponse: + example: EVPL_VC + bandwidth: + type: integer + format: int64 + example: 100 + LinkProtocolServiceToken: + description: Service Token details of Link Protocol type: object properties: href: + description: Service Token URI type: string - description: URI of this LOA resource. format: uri - example: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 + readOnly: true uuid: type: string - description: Unique identifier of this LOA. format: uuid - example: 29cc7878-54e3-4e1a-8651-87a61354bac2 + example: cd67f685-41b0-1b07-6de0-320a5c00eabe type: - $ref: "#/components/schemas/LoaType" - name: - type: string - description: A short, descriptive name for this LOA - example: LOA-Equinix-SV1-2026 - description: type: string - description: Additional context about this LOA - example: Authorization for patch panel port access to Equinix at SV1 - authorizedProductType: - $ref: "#/components/schemas/LoaProductType" - state: - $ref: "#/components/schemas/LoaState" - operation: - $ref: "#/components/schemas/LoaResponse_operation" - requestor: - $ref: "#/components/schemas/LoaRequestor" - issuer: - $ref: "#/components/schemas/LoaIssuer" - demarcationPoint: - $ref: "#/components/schemas/LoaDemarcationPoint" - location: - $ref: "#/components/schemas/LoaLocation" - expirationDateTime: - $ref: "#/components/schemas/LoaExpiration" - changeLog: - $ref: "#/components/schemas/LoaChangelog" - description: Loa Response - LoaId: - type: string - description: Loa UUID - format: uuid - example: 29cc7878-54e3-4e1a-8651-87a61354bac2 - LoaUpdate: - type: array - items: - $ref: "#/components/schemas/LoaReplaceOperation" - LoaReplaceOperation: - required: - - op - - path - - value - type: object - properties: - op: - $ref: "#/components/schemas/LoaOpEnum" - path: - $ref: "#/components/schemas/LoaPath" - value: - description: New value for updated parameter - description: Replace attribute value or sub-resource in the existing model - LoaOpEnum: - type: string - description: Operation to be performed - enum: - - replace - - add - - remove - LoaPath: - type: string - description: | - ### A JSON Pointer path. - * `/name` - Name of the Loa - * `/description` - Description of the Loa - * `/requestor/email` - Email of the requestor contact - * `/requestor/orgName` - Organization name of the requestor - * `/issuer/email` - Email of the issuer contact - * `/issuer/orgName` - Organization name of the issuer - * `/demarcationPoint/patchPanelId` - Patch Panel Identifier - * `/demarcationPoint/patchPanelPortA` - Patch Panel Port A - * `/demarcationPoint/patchPanelPortB` - Patch Panel Port B - * `/demarcationPoint/connectorType` - Connector Type - * `/demarcationPoint/cageUniqueSpaceId` - Cage Unique Space Identifier - * `/expirationDateTime` - Expiration date and time of the Loa - * `/location/ibxCode` - IBX code of the Eligible location - LoaActionRequest: - title: AuthorizeLoa - required: - - type - type: object - properties: - type: - $ref: "#/components/schemas/LoaActionType" - data: - $ref: "#/components/schemas/LoaActionData" - description: Action Request - LoaActionResponse: + example: TOKEN + bandwidth: + type: integer + format: int64 + example: 1000 + LinkProtocolResponse: + description: Link Protocol response type: object properties: href: + description: LinkProtocol URI type: string - description: Action URI format: uri - example: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + readOnly: true uuid: + description: Equinix-assigned network identifier type: string - description: Action Identifier format: uuid - example: 30cc7878-54e3-4e1a-8651-87a61354bad4 + example: 92dc376a-a932-43aa-a6a2-c806dedbd784 state: - $ref: "#/components/schemas/LoaActionState" + $ref: '#/components/schemas/LinkProtocolState' + example: ACTIVE type: - $ref: "#/components/schemas/LoaActionType" - data: - $ref: "#/components/schemas/LoaActionData" + $ref: '#/components/schemas/LinkProtocolRequestType' + example: DOT1Q + 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/LoaChangelog" - description: Action Response - ActionId_2: - type: string - description: Action UUID - format: uuid - example: 30cc7878-54e3-4e1a-8651-87a61354bad4 - LoaSearchRequest: + $ref: '#/components/schemas/Changelog' + LinkProtocolGetResponse: + description: List of Vlans type: object properties: - filter: - $ref: "#/components/schemas/LoaSearchFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + $ref: '#/components/schemas/Pagination' + data: type: array items: - $ref: "#/components/schemas/LoaSortCriteria" - description: Search loas based on filter criteria - LoaSearchFilters: + $ref: '#/components/schemas/LinkProtocolResponse' + PortExpression: type: object properties: and: - maxItems: 8 - type: array - items: - $ref: "#/components/schemas/LoaFilter" - LoaFilter: - type: object - anyOf: - - $ref: "#/components/schemas/LoaSimpleExpression" - - $ref: "#/components/schemas/LoaOrFilter" - LoaSimpleExpression: - type: object - properties: + $ref: '#/components/schemas/PortExpressions' + or: + $ref: '#/components/schemas/PortExpressions' property: - $ref: "#/components/schemas/LoaFieldName" + description: | + Possible field names to use on filters: + * `/project/projectId` - project id + * `/settings/productCode` - Product Type CX + * `/state` - Port Status ACTIVE + $ref: '#/components/schemas/PortSearchFieldName' operator: type: string - example: = enum: - - = - - "!=" + - '=' + - '!=' + - '>' + - '>=' + - < + - <= - LIKE - ILIKE - - BETWEEN - - NOT BETWEEN - IN - NOT IN - - ">" - - < - - ">=" - - <= + - BETWEEN values: type: array - example: - - Loa-2026 items: type: string - LoaFieldName: - type: string + description: | + Either use 'and' for AND operations, 'or' for OR operations, or specify 'property', 'operator', and 'values' for field filtering. Only one of these patterns should be used at a time. + PortExpressions: + type: array + items: + $ref: '#/components/schemas/PortExpression' + PortSearchFieldName: description: Possible field names to use on filters - example: /name + type: string enum: - - /uuid + - /device/name + - /physicalPorts/tether/crossConnectId + - /physicalPorts/interface/name - /state - - /type + - /project/projectId + - /uuid - /name - - /authorizedProductType - - /expirationDateTime - - /requestor/email - - /requestor/orgId - - /requestor/orgName - - /issuer/email - - /issuer/orgId - - /issuer/orgName - - /demarcationPoint/patchPanelId - - /demarcationPoint/patchPanelPortA - - /demarcationPoint/patchPanelPortB - - /demarcationPoint/connectorType - - /demarcationPoint/cageUniqueSpaceId - - /location/ibxCode - - /changeLog/createdDateTime + - /account/orgId + - /account/accountNumber + - /location/metroCode + - /operation/maintenanceStatus + - /operation/lockEnabled + x-enum-deprecations: + /device/name: true + /physicalPorts/interface/name: true + PortSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + PortSortBy: + description: Possible field names to use on sorting + default: /device/name + type: string + enum: + - /device/name + - /name + - /state + - /location/metroName + - /demarcationPointIbx + - /device/redundancy/priority + - /lagEnabled + - /physicalPortsSpeed + - /encapsulation/type + - /physicalPorts/tether/crossConnectId + - /package/code - /changeLog/updatedDateTime - LoaOrFilter: + - /changeLog/createdDateTime + - /bandwidth + - /serviceCode + - /operation/maintenanceStatus + PortSortCriteria: type: object properties: - or: + direction: + $ref: '#/components/schemas/PortSortDirection' + property: + $ref: '#/components/schemas/PortSortBy' + PortV4SearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/PortExpression' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array items: - $ref: "#/components/schemas/LoaSimpleExpression" - LoaSortCriteria: + $ref: '#/components/schemas/PortSortCriteria' + required: + - filter + PortPackageSourceType: + type: string + description: Port Package Source Type + enum: + - COLO + - REMOTE + - BMMR + PortPackage: type: object + description: Port Package details properties: - direction: + href: type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - property: + description: Port Package URI + readOnly: true + type: type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime + description: Port Package Type enum: - - /name - - /expirationDateTime - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - LoaSearchResponse: - type: object - properties: - pagination: - $ref: "#/components/schemas/Pagination" - sort: + - PORT_PACKAGE + code: + type: string + description: Port Package code + vcBandwidthMax: + type: integer + description: Maximum virtual connection bandwidth in Mbps + vcRemoteSupported: + type: boolean + description: Indicates if remote virtual connections are supported + supportedServiceTypes: type: array + description: List of supported service types items: - $ref: "#/components/schemas/LoaSortCriteria" - data: + type: string + description: Port Package Service Type + enum: + - MSP + supportedSourceTypes: type: array + description: List of supported source types items: - $ref: "#/components/schemas/LoaResponse" - description: List of LOAs - LoaActionSearchRequest: - type: object - properties: - filter: - $ref: "#/components/schemas/LoaActionSearchFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + $ref: '#/components/schemas/PortPackageSourceType' + supportedMetros: type: array + description: List of supported metros items: - $ref: "#/components/schemas/LoaActionSortCriteria" - description: Search loa actions based on filter criteria - LoaActionSearchFilters: + type: string + required: + - type + - code + AllPortPackagesResponse: type: object + description: Port Packages response properties: - and: - maxItems: 8 + data: type: array + description: List of Port Packages items: - $ref: "#/components/schemas/LoaActionFilter" - LoaActionFilter: - type: object - anyOf: - - $ref: "#/components/schemas/LoaActionSearchSimpleExpressions" - - $ref: "#/components/schemas/LoaActionOrFilter" - LoaActionSearchSimpleExpressions: + $ref: '#/components/schemas/PortPackage' + required: + - data + ConnectionRouteAggregationData: type: object properties: - property: - $ref: "#/components/schemas/LoaActionFieldName" - operator: + href: + type: string + format: uri + description: Route Aggregation URI + example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d + type: + description: Route Aggregation type type: string enum: - - = - - "!=" - - LIKE - - ILIKE - - BETWEEN - - NOT BETWEEN - - IN - - NOT IN - - ">" - - < - - ">=" - - <= - values: - type: array - items: - type: string - example: LOA_ACCEPTANCE - LoaActionFieldName: - type: string - description: Possible field names to use on filters - enum: - - /type - - /state - - /uuid - LoaActionOrFilter: - type: object - properties: - or: - type: array - items: - $ref: "#/components/schemas/LoaActionSearchSimpleExpressions" - LoaActionSortCriteria: - type: object - properties: - direction: + - BGP_IPv4_PREFIX_AGGREGATION + uuid: + description: Route Aggregation identifier type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - property: + format: uuid + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d + attachmentStatus: type: string - description: Possible field names to use on sorting - default: /changeLog/createdDateTime enum: - - /changeLog/createdDateTime - LoaActionSearchResponse: + - ATTACHING + - ATTACHED + - DETACHED + - DETACHING + - FAILED + - PENDING_BGP_CONFIGURATION + changeLog: + $ref: '#/components/schemas/Changelog' + GetAllConnectionRouteAggregationsResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" - sort: - type: array - items: - $ref: "#/components/schemas/LoaActionSortCriteria" + $ref: '#/components/schemas/Pagination' data: + description: List of Route Aggregations attached to a Connection type: array items: - $ref: "#/components/schemas/LoaActionResponse" - description: List of LOA Actions - LoaConsumersResponse: + $ref: '#/components/schemas/ConnectionRouteAggregationData' + ConnectionRouteFilterData: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - items: - $ref: "#/components/schemas/LoaConsumer" - description: List of Consumers associated with a LOA - LoaNotesResponse: + href: + type: string + format: uri + description: Route filter URI + example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d + type: + description: Route filter type + type: string + enum: + - BGP_IPv4_PREFIX_FILTER + - BGP_IPv6_PREFIX_FILTER + uuid: + description: Route Filter identifier + type: string + 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 + changeLog: + $ref: '#/components/schemas/Changelog' + GetAllConnectionRouteFiltersResponse: type: object properties: + pagination: + $ref: '#/components/schemas/Pagination' data: + description: List of Route Filters attached to a Connection type: array items: - $ref: "#/components/schemas/LoaNoteDetails" - description: List of Loa note details - CreateLoaNote: - required: - - comments + $ref: '#/components/schemas/ConnectionRouteFilterData' + ConnectionRouteFiltersBase: type: object properties: - comments: - maxLength: 4000 - minLength: 0 + direction: + description: Route Filter direction to attach to a connection type: string - description: | - The note content to add to this LOA. Notes are visible to both the issuer and requestor organizations. Use notes to communicate updates, clarifications, or additional context about the LOA. - example: LOA under review by our team. Expected response within 2 business days - description: Create Loa Note - LoaNoteDetails: + enum: + - INBOUND + - OUTBOUND + required: + - direction + RouteFiltersBase: type: object properties: type: + description: Route Filter type type: string - description: | - Indicates which party added the note.
ISSUER — note was added by a user from the issuer organization.
REQUESTOR — note was added by a user from the requestor organization. - example: ISSUER enum: - - ISSUER - - REQUESTOR - href: - type: string - description: URI to note resource. - format: uri - example: https://api.equinix.com/fabric/v4/loas/b7e14c2d-93f8-4a61-8d5b-c29f71e4a306/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: - type: string - description: Unique identifier of this note. - format: uuid - example: e41f485e-3094-42de-8797-0ef19a51df79 - comments: + - BGP_IPv4_PREFIX_FILTER + - BGP_IPv6_PREFIX_FILTER + name: type: string - description: Content of the note as submitted by the user. - example: LOA under review by our team. Expected response within 2 business days - createdDateTime: + example: My-direct-route-1 + description: + description: Customer-provided connection description type: string - description: Date and time when the note was created. - format: date-time - example: 2023-08-01T12:34:56Z - description: | - Represents a note added to a LOA by an authorized user from either the issuer or requestor organization - CreateCrossConnect: - title: CreateCrossConnect + project: + $ref: '#/components/schemas/Project' required: - - aSide - - name - type - - zSide + - name + - project + RouteFiltersChange: + description: Current state of latest route filter change type: object properties: + uuid: + description: Uniquely identifies a change + type: string type: - $ref: "#/components/schemas/CrossConnectType" - name: - maxLength: 50 - minLength: 3 + description: Type of change type: string - description: A short, descriptive name for this Cross Connect. - example: My-CC-service - bmmrType: - description: | - Required when connecting to a BMMR.
Use EQUINIX when BMMR Extension is required and Equinix installs it, or SELF when you install it yourself. - allOf: - - $ref: "#/components/schemas/BmmrType" - circuitId: + 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: + description: Route filter change URI type: string - description: Circuit identifier of the Cross Connect. - redundancy: - description: | - Provide it to place a diverse Cross Connect against an existing one - set group to the redundancy group id or the serial number of the existing Cross Connect, and priority to SECONDARY. - allOf: - - $ref: "#/components/schemas/CrossConnectRedundancy" - aSide: - description: A-Side connection details. - allOf: - - $ref: "#/components/schemas/CrossConnectASideRequest" - zSide: - description: | - Z-Side connection details.
Provide the DemarcationPoint, the LOA reference or the BMMR location depending on the Cross Connect being requested. - allOf: - - $ref: "#/components/schemas/CrossConnectZSideRequest" - schedule: - description: | - Preferred installation schedule. When omitted, the Cross Connect is scheduled with the STANDARD schedule code. - allOf: - - $ref: "#/components/schemas/ScheduleRequest" - services: - type: array - description: Cross Connect Services. - items: - $ref: "#/components/schemas/CrossConnectServiceRequest" - notifications: - type: array - description: | - Preferences for notifications on Cross Connect configuration or status changes. - items: - $ref: "#/components/schemas/CrossConnectNotification" - order: - $ref: "#/components/schemas/OrderRequest" - notes: - maxItems: 1 - type: array - description: Additional Note. - items: - $ref: "#/components/schemas/CrossConnectNoteRequest" - attachments: - maxItems: 5 - type: array - description: Additional Attachments. - items: - $ref: "#/components/schemas/CrossConnectAttachment" - description: | - Create Cross Connect request. A single request body supports all Cross Connect connection types - patch panel to patch panel, connection with LOA and connection to a BMMR (by Equinix or by Self). Refer to the request examples for each use case. - CrossConnectResponse: + format: uri + required: + - uuid + - type + RouteFiltersData: type: object properties: href: type: string - description: Cross Connect URI. format: uri - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + description: Route filter URI + example: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: - $ref: "#/components/schemas/CrossConnectType" + description: Route Filter type + type: string + enum: + - BGP_IPv4_PREFIX_FILTER + - BGP_IPv6_PREFIX_FILTER uuid: + description: Route filter identifier type: string - description: Cross Connect Identifier. format: uuid - example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: type: string - description: A short, descriptive name for this Cross Connect. - example: My-CC-service - state: - $ref: "#/components/schemas/CrossConnectState" - allowedActions: - type: array - description: | - List of actions that can be performed on the Cross Connect based on its current state. Use these values to determine which action types are valid to submit to the actions endpoint. - readOnly: true - items: - $ref: "#/components/schemas/CrossConnectResponse_allowedActions" - bmmrType: - $ref: "#/components/schemas/BmmrType" - mediaType: + example: My-direct-route-1 + description: + description: Customer-provided connection description type: string - description: Media type of the Cross Connect. - example: SINGLE_MODE_FIBER - mediaSubType: + change: + $ref: '#/components/schemas/RouteFiltersChange' + notMatchedRuleAction: type: string - description: Media sub-type of the Cross Connect. - example: SINGLE_MODE_FIBER - circuitId: + enum: + - ALLOW + - DENY + connectionsCount: + type: integer + example: 0 + rulesCount: + type: integer + example: 0 + project: + type: object + properties: + projectId: + description: Subscriber-assigned project ID + type: string + example: 44f4c4f8-2f39-494e-838c-d8e640591be5 + href: + type: string + format: uri + description: Project URI + example: https://api.equinix.com/resourceManager/v1/projects/567 + required: + - projectId + changelog: + $ref: '#/components/schemas/Changelog' + RouteFiltersPatchRequestItem: + description: Route filter change operation data + type: object + properties: + op: + description: Handy shortcut for operation name type: string - description: Circuit identifier of the Cross Connect. - serialNumber: + example: replace + path: + description: path to change type: string - description: Serial number of the Cross Connect. - readOnly: true - example: "234567890" - redundancy: - $ref: "#/components/schemas/CrossConnectRedundancy" - aSide: - $ref: "#/components/schemas/CrossConnectASideResponse" - zSide: - $ref: "#/components/schemas/CrossConnectZSideResponse" - account: - $ref: "#/components/schemas/CrossConnectAccount" - notifications: - type: array - description: | - Preferences for notifications on Cross Connect configuration or status changes. - items: - $ref: "#/components/schemas/CrossConnectNotification" - order: - $ref: "#/components/schemas/OrderResponse" - links: - type: array - description: | - Links to the Cross Connect sub-resources - schedules, services, notes and attachments. - readOnly: true - items: - $ref: "#/components/schemas/CrossConnectLink" - changeLog: - $ref: "#/components/schemas/CrossConnectChangelog" - description: Cross Connect Response. - DiverseCrossConnectRequest: - title: DiverseCrossConnectRequest + example: /name + value: + description: new value for updated parameter required: - - data + - op + - path + - value + RouteFiltersPatchRequest: + description: Patch Route Filters request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/RouteFiltersPatchRequestItem' + RouteFiltersChangeOperation: + description: Route filter change operation data + type: object + properties: + op: + description: Handy shortcut for operation name + type: string + enum: + - add + - replace + - remove + path: + description: path inside document leading to updated parameter + type: string + example: / + value: + $ref: '#/components/schemas/RouteFiltersBase' + required: + - op + - path + - value + RouteFilterChangeData: + description: Current state of latest route filter change type: object properties: + status: + description: Current outcome of the change flow + type: string + enum: + - COMPLETED + - FAILED + - REQUESTED + createdBy: + type: string + description: Created by user key + createdDateTime: + description: Set when change flow starts + type: string + format: date-time + updatedBy: + type: string + description: Updated by user key + updatedDateTime: + description: Set when change object is updated + type: string + format: date-time + information: + description: Additional information + type: string data: - minItems: 1 - type: array - description: | - For a diverse pair, send two entries - one with redundancy.priority PRIMARY and one with SECONDARY - and omit redundancy.group, which Equinix assigns. - items: - $ref: "#/components/schemas/CreateCrossConnect" - description: | - Request to create several Cross Connects in a single order. Use it to order a diverse pair - one PRIMARY and one SECONDARY entry provisioned at the same time on separate paths - or to order multiple Cross Connects at once by sending one entry per Cross Connect. - CrossConnectDiverse: - title: CrossConnectDiverse + $ref: '#/components/schemas/RouteFiltersChangeOperation' + allOf: + - $ref: '#/components/schemas/RouteFiltersChange' + RouteFilterChangeDataResponse: + description: List of route filter changes type: object properties: + pagination: + $ref: '#/components/schemas/Pagination' data: type: array - description: The Cross Connects the diverse order applies to. items: - $ref: "#/components/schemas/CrossConnectResponse" - description: | - Cross Connects returned by a diverse order. One item is returned per Cross Connect requested; a diverse pair returns the PRIMARY and the SECONDARY Cross Connect sharing one redundancy group. - CrossConnectSearchRequest: + $ref: '#/components/schemas/RouteFilterChangeData' + RouteFilterConnectionsData: + type: object + properties: + href: + type: string + format: uri + description: Connection URI + example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f + type: + $ref: '#/components/schemas/ConnectionType' + uuid: + description: Route filter identifier + type: string + format: uuid + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d + name: + type: string + example: connection-1 + GetRouteFilterGetConnectionsResponse: type: object properties: - filter: - $ref: "#/components/schemas/CrossConnectSearchFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + $ref: '#/components/schemas/Pagination' + data: + description: List of Connections using a Route Filter type: array items: - $ref: "#/components/schemas/CrossConnectSortCriteria" - description: Search Cross Connects based on filter criteria. - CrossConnectSearchFilters: + $ref: '#/components/schemas/RouteFilterConnectionsData' + SearchAndExpression: type: object + required: + - and properties: and: - maxItems: 8 type: array + minItems: 1 + maxItems: 8 items: - $ref: "#/components/schemas/CrossConnectFilter" - CrossConnectFilter: + $ref: '#/components/schemas/SearchFilterExpression' + SearchFilterExpression: + description: Filter expression that can be AND, OR, or a simple expression + oneOf: + - $ref: '#/components/schemas/SearchAndExpression' + - $ref: '#/components/schemas/SearchOrExpression' + - $ref: '#/components/schemas/SearchSimpleExpression' + SearchOrExpression: type: object - anyOf: - - $ref: "#/components/schemas/CrossConnectSearchSimpleExpressions" - - $ref: "#/components/schemas/CrossConnectOrFilter" - CrossConnectSearchSimpleExpressions: + required: + - or + properties: + or: + type: array + minItems: 1 + maxItems: 8 + items: + $ref: '#/components/schemas/SearchFilterExpression' + SearchSimpleExpression: type: object + description: Simple filter expression with property, operator, and values + required: + - property + - operator + - values properties: property: - $ref: "#/components/schemas/CrossConnectFieldName" + type: string operator: type: string - example: = + description: | + "~*" is a case-insensitive glob match, equivalent to ILIKE - the same single "*" wildcard, not POSIX regex - kept as its own operator only because existing callers already send it. + example: '=' enum: - - = - - "!=" + - '=' + - '!=' + - IN + - NOT IN - LIKE - ILIKE - BETWEEN - - NOT BETWEEN - - IN - - NOT IN - - ">" + - '>' + - '>=' - < - - ">=" - <= + - ~* + x-enum-varnames: + - EQUAL + - NOT_EQUAL + - IN + - NOT_IN + - LIKE + - ILIKE + - BETWEEN + - GREATER_THAN + - GREATER_THAN_OR_EQUAL_TO + - LESS_THAN + - LESS_THAN_OR_EQUAL_TO + - CASE_INSENSITIVE_REGEX values: type: array - example: - - My-CC-service + minItems: 1 + maxItems: 8 items: type: string - CrossConnectFieldName: + SearchFilter: + description: Top-level filter that can be either an AND expression or OR expression + oneOf: + - $ref: '#/components/schemas/SearchAndExpression' + - $ref: '#/components/schemas/SearchOrExpression' + RouteFilterSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + RouteFilterSortBy: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime type: string - description: Possible field names to use on filters. - example: /name enum: + - /type - /uuid - /name - - /type + - /project/projectId - /state - - /bmmrType - - /circuitId - - /serialNumber - - /redundancy/group - - /redundancy/priority - - /aSide/demarcationPoint/patchPanelId - - /aSide/demarcationPoint/patchPanelPortA - - /aSide/demarcationPoint/patchPanelPortB - - /aSide/location/ibxCode - - /zSide/demarcationPoint/patchPanelId - - /zSide/demarcationPoint/patchPanelPortA - - /zSide/demarcationPoint/patchPanelPortB - - /zSide/location/ibxCode - - /zSide/loa/uuid - - /account/accountNumber - - /order/orderNumber - - /order/customerReferenceId - /changeLog/createdDateTime - /changeLog/updatedDateTime - CrossConnectOrFilter: + - /changeLog/deletedDateTime + RouteFilterSortCriteria: type: object properties: - or: + direction: + $ref: '#/components/schemas/RouteFilterSortDirection' + property: + $ref: '#/components/schemas/RouteFilterSortBy' + RouteFiltersSearchRequest: + type: object + description: Search route filters + properties: + filter: + $ref: '#/components/schemas/SearchFilter' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array items: - $ref: "#/components/schemas/CrossConnectSearchSimpleExpressions" - CrossConnectSortCriteria: - type: object - properties: - direction: - type: string - description: Sorting direction. - default: DESC - enum: - - DESC - - ASC - property: - type: string - description: Possible field names to use on sorting. - default: /changeLog/updatedDateTime - enum: - - /name - - /state - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - CrossConnectSearchResponse: + $ref: '#/components/schemas/RouteFilterSortCriteria' + RouteFiltersSearchResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" - sort: - type: array - items: - $ref: "#/components/schemas/CrossConnectSortCriteria" + $ref: '#/components/schemas/Pagination' data: + description: List of route filters type: array items: - $ref: "#/components/schemas/CrossConnectResponse" - description: List of Cross Connects. - CrossConnectId: + $ref: '#/components/schemas/RouteFiltersData' + RouteFilterRuleState: + description: Route filter rule status type: string - description: Cross Connect UUID. - format: uuid - example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - DeleteCrossConnect: - title: DeleteCrossConnect - required: - - schedule - type: object - properties: - schedule: - description: | - Removal schedule. The requestedDateTime is mandatory. Only the STANDARD schedule type is supported for a removal. - allOf: - - $ref: "#/components/schemas/DeinstallScheduleRequest" - notifications: - type: array - description: | - Optional. The contacts are appended to the ones already held on the Cross Connect. - items: - $ref: "#/components/schemas/CrossConnectNotification" - order: - description: | - Optional. The purchase order and the customer reference identifier replace the ones already held on the Cross Connect. - allOf: - - $ref: "#/components/schemas/OrderRequest" - description: | - Delete Cross Connect request. Carries the removal schedule together with the notification and order details to apply to the removal order. - SchedulesResponse: - type: object - properties: - data: - type: array - readOnly: true - items: - $ref: "#/components/schemas/CrossConnectScheduleResponse" - description: Schedules of the Cross Connect. - CrossConnectServicesResponse: - type: object - properties: - data: - type: array - readOnly: true - items: - $ref: "#/components/schemas/CrossConnectServiceResponse" - description: List of services ordered alongside the Cross Connect. - CrossConnectAttachmentsResponse: - type: object - properties: - data: - type: array - readOnly: true - items: - $ref: "#/components/schemas/CrossConnectAttachmentResponse" - description: List of documents attached to the Cross Connect. - CrossConnectAttachment: - required: - - attachmentId + enum: + - PROVISIONING + - REPROVISIONING + - DEPROVISIONING + - PROVISIONED + - DEPROVISIONED + - NOT_PROVISIONED + - NOT_DEPROVISIONED + RouteFilterRulesChange: + description: Current state of latest route filter rule change type: object properties: - attachmentId: + uuid: + description: Uniquely identifies a change type: string - description: Attachment Identifier. - format: uuid - example: a11f485e-3094-42de-8797-0ef19a51df79 - description: Cross Connect Attachment. - CrossConnectAttachmentResponse: + type: + description: Type of change + type: string + 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: + description: Route Filter Change URI + type: string + format: uri + required: + - uuid + - type + RouteFilterRulesData: type: object properties: href: type: string - description: URI to the attachment resource. format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79 + description: Route Filter Rules URI + example: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/65b025ef-022b-4180-85cf-82cfc1ab655b + type: + description: Route filter type + type: string + enum: + - BGP_IPv4_PREFIX_FILTER_RULE + - BGP_IPv6_PREFIX_FILTER_RULE uuid: + description: Route Filter Rule identifier type: string - description: Attachment resource Identifier. format: uuid - readOnly: true - example: e41f485e-3094-42de-8797-0ef19a51df79 - type: + example: 65b025ef-022b-4180-85cf-82cfc1ab655b + name: type: string - description: Sub-resource type. - readOnly: true - example: ATTACHMENT - enum: - - ATTACHMENT - source: + example: Private-subnet-filter-2 + description: + description: Customer-provided Route Filter Rule description type: string - description: Attachment Source. - readOnly: true - example: CUSTOMER - enum: - - CUSTOMER - - EQUINIX - attachmentId: + state: + $ref: '#/components/schemas/RouteFilterRuleState' + prefixMatch: + description: prefix matching operator + default: orlonger type: string - description: Attachment Identifier. - format: uuid - readOnly: true - example: a11f485e-3094-42de-8797-0ef19a51df79 - downloadHref: + example: exact + change: + $ref: '#/components/schemas/RouteFilterRulesChange' + action: type: string - description: | - URI to download the attachment file content from the Equinix attachment service. - format: uri - readOnly: true - example: https://api.equinix.com/ecp/attachments/a11f485e-3094-42de-8797-0ef19a51df79 - changeLog: - $ref: "#/components/schemas/CrossConnectChangelog" - description: Document attached to a Cross Connect. - CrossConnectNotesResponse: + enum: + - PERMIT + - DENY + prefix: + type: string + example: 192.168.0.0/24 + changelog: + $ref: '#/components/schemas/Changelog' + GetRouteFilterRulesResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: + description: List of Route Filter Rules type: array - readOnly: true items: - $ref: "#/components/schemas/CrossConnectNoteResponse" - description: List of notes added to the Cross Connect. - CrossConnectNoteRequest: - required: - - comments - type: object - properties: - comments: - maxLength: 4000 - type: string - description: Note comments. - example: test note - description: Cross Connect Note. - CrossConnectNoteResponse: + $ref: '#/components/schemas/RouteFilterRulesData' + RouteFilterRulesBase: type: object properties: - href: - type: string - description: Note URI. - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: + name: type: string - description: Note Identifier. - format: uuid - readOnly: true - example: e41f485e-3094-42de-8797-0ef19a51df79 - type: + example: Private-subnet-filter + description: + description: Customer-provided Route Filter Rule description type: string - description: Sub-resource type. - readOnly: true - example: NOTE - enum: - - NOTE - source: + prefix: type: string - description: Party that added the note. - readOnly: true - example: CUSTOMER - enum: - - CUSTOMER - - EQUINIX - comments: - maxLength: 4000 + example: 192.168.0.0/24 + prefixMatch: type: string - description: Note comments. - readOnly: true - example: this is reply to the technician note. - parentNote: - description: | - The note this note is responding to. Returned when the note was added in response to an Equinix note. - readOnly: true - allOf: - - $ref: "#/components/schemas/CrossConnectParentNote" - changeLog: - $ref: "#/components/schemas/CrossConnectChangelog" - description: Cross Connect Note. - CrossConnectActionRequest: + default: orlonger + example: orlonger, exact required: - - type - type: object - properties: - type: - $ref: "#/components/schemas/CrossConnectActionType" - data: - $ref: "#/components/schemas/CrossConnectActionData" - description: Cross Connect Action Request. - CrossConnectActionResponse: + - prefix + RouteFilterRulesPatchRequestItem: + description: Route filter rule change operation data type: object properties: - href: + op: + description: Handy shortcut for operation name type: string - description: Action URI. - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: + example: replace + path: + description: path to change type: string - description: Action Identifier. - format: uuid - readOnly: true - example: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: - readOnly: true - allOf: - - $ref: "#/components/schemas/CrossConnectActionType" - state: - readOnly: true - allOf: - - $ref: "#/components/schemas/CrossConnectActionState" - data: - readOnly: true - allOf: - - $ref: "#/components/schemas/CrossConnectActionResponseData" - changeLog: - readOnly: true - allOf: - - $ref: "#/components/schemas/CrossConnectChangelog" - description: Cross Connect Action Response. - ActionId_3: - type: string - description: Cross Connect Action UUID. - format: uuid - example: 30cc7878-54e3-4e1a-8651-87a61354bad4 - CrossConnectActionSearchRequest: - type: object - properties: - filter: - $ref: "#/components/schemas/CrossConnectActionSearchFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/CrossConnectActionSortCriteria" - description: Search Cross Connect actions based on filter criteria. - CrossConnectActionSearchFilters: - type: object - properties: - and: - maxItems: 8 - type: array - items: - $ref: "#/components/schemas/CrossConnectActionFilter" - CrossConnectActionFilter: - type: object - anyOf: - - $ref: "#/components/schemas/CrossConnectActionSearchSimpleExpressions" - - $ref: "#/components/schemas/CrossConnectActionOrFilter" - CrossConnectActionSearchSimpleExpressions: + example: /prefixMatch + value: + description: new value for updated parameter + required: + - op + - path + - value + RouteFilterRulesPatchRequest: + description: Patch Route Filters Rule request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/RouteFilterRulesPatchRequestItem' + RouteFilterRulesChangeOperation: + description: Route filter rule change operation data type: object properties: - property: - $ref: "#/components/schemas/CrossConnectActionFieldName" - operator: + op: + description: Handy shortcut for operation name type: string enum: - - = - - "!=" - - LIKE - - ILIKE - - BETWEEN - - NOT BETWEEN - - IN - - NOT IN - - ">" - - < - - ">=" - - <= - values: - type: array - items: - type: string - example: XC_SIGNATURE_SUBMISSION - CrossConnectActionFieldName: - type: string - description: Possible field names to use on filters. - enum: - - /type - - /state - - /uuid - CrossConnectActionOrFilter: - type: object - properties: - or: - type: array - items: - $ref: "#/components/schemas/CrossConnectActionSearchSimpleExpressions" - CrossConnectActionSortCriteria: + - add + - replace + - remove + path: + description: path inside document leading to updated parameter + type: string + example: / + value: + $ref: '#/components/schemas/RouteFilterRulesBase' + required: + - op + - path + - value + RouteFilterRulesChangeData: + description: Current state of latest route filter rules change type: object properties: - direction: + status: + description: Current outcome of the change flow type: string - description: Sorting direction. - default: DESC enum: - - DESC - - ASC - property: + - COMPLETED + - FAILED + - REQUESTED + createdBy: type: string - description: Possible field names to use on sorting. - default: /changeLog/createdDateTime - enum: - - /changeLog/createdDateTime - CrossConnectActionSearchResponse: + description: Created by User Key + createdDateTime: + description: Set when change flow starts + type: string + format: date-time + updatedBy: + type: string + description: Updated by User Key + updatedDateTime: + description: Set when change object is updated + type: string + format: date-time + data: + $ref: '#/components/schemas/RouteFilterRulesChangeOperation' + allOf: + - $ref: '#/components/schemas/RouteFilterRulesChange' + RouteFilterRulesChangeDataResponse: + description: List of route filter rule changes type: object properties: pagination: - $ref: "#/components/schemas/Pagination" - sort: - type: array - items: - $ref: "#/components/schemas/CrossConnectActionSortCriteria" + $ref: '#/components/schemas/Pagination' data: type: array items: - $ref: "#/components/schemas/CrossConnectActionResponse" - description: List of Cross Connect Actions. - CrossConnectScheduleSearchRequest: + $ref: '#/components/schemas/RouteFilterRulesChangeData' + RouteFilterRulesPostRequest: type: object + description: Create Route Filter Rule POST request properties: - filter: - $ref: "#/components/schemas/CrossConnectScheduleSearchFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + data: + description: Route Filter Rule configuration type: array items: - $ref: "#/components/schemas/CrossConnectScheduleSortCriteria" - description: Search Cross Connect schedules based on filter criteria. - CrossConnectScheduleSearchFilters: + $ref: '#/components/schemas/RouteFilterRulesBase' + RouteFilterRuleAndExpression: type: object + description: AND expression containing multiple filter expressions properties: and: + type: array + minItems: 1 maxItems: 8 + items: + $ref: '#/components/schemas/RouteFilterRuleExpression' + RouteFilterRuleExpression: + description: Filter expression that can be AND, OR, or a simple expression + anyOf: + - $ref: '#/components/schemas/RouteFilterRuleAndExpression' + - $ref: '#/components/schemas/RouteFilterRuleOrExpression' + - $ref: '#/components/schemas/RouteFilterRuleSimpleExpression' + RouteFilterRuleOrExpression: + type: object + description: OR expression containing multiple filter expressions + properties: + or: type: array + minItems: 1 + maxItems: 8 items: - $ref: "#/components/schemas/CrossConnectScheduleSearchSimpleExpressions" - CrossConnectScheduleSearchSimpleExpressions: + $ref: '#/components/schemas/RouteFilterRuleExpression' + RouteFilterRuleSimpleExpression: type: object + description: Simple filter expression with property, operator, and values properties: property: - $ref: "#/components/schemas/CrossConnectScheduleFieldName" + description: | + Possible field names to use on filters: + * `/type` - Route Filter Rules Type + * `/name` - Route Filter Rules Name + * `/uuid` - Route Filter Rules uuid + * `/state` - Route Filter Rules status + * `/prefix` - Route Filter Rule Prefix + * `/prefixMatch` - Route Filter Rule Prefix Match + type: string + example: /name operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `[NOT] LIKE` - (not) like + * `[NOT] IN` - (not) in + * `ILIKE` - case-insensitive like type: string - example: = - enum: - - = - - "!=" - - IN - - NOT IN + example: '=' values: type: array - example: - - SV11 + minItems: 1 + maxItems: 8 items: type: string - CrossConnectScheduleFieldName: + example: Route_Filter_Rule_Demo + RouteFilterRulesFilter: + description: Top-level filter that can be either an AND expression or OR expression + anyOf: + - $ref: '#/components/schemas/RouteFilterRuleAndExpression' + - $ref: '#/components/schemas/RouteFilterRuleOrExpression' + RouteFilterRuleSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + RouteFilterRuleSortBy: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime type: string - description: Possible field names to use on filters. - example: /aSide/location/ibxCode enum: - /type - - /code - - /aSide/location/ibxCode - - /zSide/location/ibxCode - CrossConnectScheduleSortCriteria: + - /uuid + - /name + - /state + - /prefix + - /prefixMatch + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + RouteFilterRuleSortCriteria: type: object properties: direction: - type: string - description: Sorting direction. - default: DESC - enum: - - DESC - - ASC + $ref: '#/components/schemas/RouteFilterRuleSortDirection' property: - type: string - description: Possible field names to use on sorting. - default: /startDateTime - enum: - - /code - - /startDateTime - - /endDateTime - SearchSchedulesResponse: + $ref: '#/components/schemas/RouteFilterRuleSortBy' + RouteFilterRulesSearchRequest: type: object + description: Search route filter rules properties: + filter: + $ref: '#/components/schemas/RouteFilterRulesFilter' pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/PaginationRequest' sort: type: array items: - $ref: "#/components/schemas/CrossConnectScheduleSortCriteria" + $ref: '#/components/schemas/RouteFilterRuleSortCriteria' + RouteFilterRulesSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' data: + description: List of route filter rules type: array - readOnly: true items: - $ref: "#/components/schemas/CrossConnectScheduleAvailability" - description: List of Cross Connect schedule windows offered at an IBX. - TagRequest: + $ref: '#/components/schemas/RouteFilterRulesData' + RouteAggregationsBase: + type: object + properties: + type: + description: Route Aggregation type + type: string + enum: + - BGP_IPv4_PREFIX_AGGREGATION + - BGP_IPv6_PREFIX_AGGREGATION + name: + type: string + example: My-direct-route-1 + description: + description: Customer-provided connection description + type: string + project: + $ref: '#/components/schemas/Project' required: - - displayName - type + - name + - project + RouteAggregationsChange: + description: Current state of latest Route Aggregation change type: object properties: + uuid: + description: Uniquely identifies a change + type: string type: + description: Type of change type: string - description: Type of tag - example: PREDEFINED_TAG - displayName: - maxLength: 24 - minLength: 1 - type: string - description: Display name of the Tag - example: LLM - notifications: - type: array - example: - - type: NOTIFICATION - emails: - - example1@example.com - - example2@example.com - items: - $ref: "#/components/schemas/SimplifiedNotification" - description: Equinix Fabric Tag Request Object - AppDomainPostRequest: - required: - - name - - project - - type - type: object - properties: - type: - $ref: "#/components/schemas/AppDomainType" - name: - maxLength: 50 - minLength: 1 - type: string - description: Customer-provided App Domain name - format: string - example: atlassian.net - description: + 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: + description: Route AGGREGATION Change URI type: string - description: Customer-provided App Domain description - format: string - example: Atlassian Domain - project: - $ref: "#/components/schemas/Project" - description: Create App Domain - AppDomain: + format: uri required: - - name - - project + - uuid - type + RouteAggregationsData: type: object properties: href: type: string - description: Resource URI format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - x-order: 1 + description: Route Aggregation URI + example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: - $ref: "#/components/schemas/AppDomainType" + description: Route Aggregation type + type: string + enum: + - BGP_IPv4_PREFIX_AGGREGATION + - BGP_IPv6_PREFIX_AGGREGATION uuid: + description: Route Aggregation identifier type: string - description: Equinix-assigned access point identifier format: uuid - example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - x-order: 3 + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: type: string - description: Customer-provided App Domain name - format: string - example: atlassian.net - x-order: 4 + example: My-direct-route-1 description: + description: Customer-provided connection description type: string - description: Customer-provided App Domain description - format: string - example: Atlassian Domain - x-order: 5 - state: - $ref: "#/components/schemas/AppDomainState" + change: + $ref: '#/components/schemas/RouteAggregationsChange' + connectionsCount: + type: integer + example: 0 + rulesCount: + type: integer + example: 0 project: - $ref: "#/components/schemas/Project" + type: object + properties: + projectId: + description: Subscriber-assigned project ID + type: string + example: 44f4c4f8-2f39-494e-838c-d8e640591be5 + href: + type: string + format: uri + description: Project URI + required: + - projectId changeLog: - $ref: "#/components/schemas/Changelog" - change: - $ref: "#/components/schemas/AppDomainChange" - description: App Domain object - AppDomainId: - type: string - description: App Domain UUID - format: uuid - example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - AppDomainUpdateRequest: - maxItems: 1 - minItems: 1 + $ref: '#/components/schemas/Changelog' + RouteAggregationsPatchRequestItem: + description: Route Aggregation change operation data + type: object + properties: + op: + description: Handy shortcut for operation name + type: string + example: replace + path: + description: path to change + type: string + example: /name + value: + description: new value for updated parameter + required: + - op + - path + - value + RouteAggregationsPatchRequest: + description: Patch Route Aggregations request type: array - description: App Domain Update Request + minItems: 1 items: - $ref: "#/components/schemas/AppDomainChangeOperation" - AppDomainSearchRequest: + $ref: '#/components/schemas/RouteAggregationsPatchRequestItem' + RouteAggregationsChangeOperation: + description: Route Aggregation change operation data type: object properties: - filter: - $ref: "#/components/schemas/AppDomainFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/AppDomainSortCriteria" - description: Search requests containing criteria - AppDomainFilters: + op: + description: Handy shortcut for operation name + type: string + enum: + - add + - replace + - remove + path: + description: path inside document leading to updated parameter + type: string + example: / + value: + $ref: '#/components/schemas/RouteAggregationsBase' + required: + - op + - path + - value + RouteAggregationChangeData: + description: Current state of latest Route Aggregation change type: object properties: - and: - maxItems: 8 + status: + description: Current outcome of the change flow + type: string + enum: + - COMPLETED + - FAILED + - REQUESTED + createdBy: + type: string + description: Created by User Key + createdDateTime: + description: Set when change flow starts + type: string + format: date-time + updatedBy: + type: string + description: Updated by User Key + updatedDateTime: + description: Set when change object is updated + type: string + format: date-time + information: + description: Additional information + type: string + data: + $ref: '#/components/schemas/RouteAggregationsChangeOperation' + allOf: + - $ref: '#/components/schemas/RouteAggregationsChange' + RouteAggregationChangeDataResponse: + description: List of Route Aggregation changes + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: type: array items: - $ref: "#/components/schemas/AppDomainFilter" - AppDomainFilter: - type: object - anyOf: - - $ref: "#/components/schemas/AppDomainSimpleExpression" - - $ref: "#/components/schemas/AppDomainOrFilter" - AppDomainSimpleExpression: + $ref: '#/components/schemas/RouteAggregationChangeData' + RouteAggregationConnectionsData: type: object properties: - property: + href: type: string - description: | - Possible field names to use on filters: - * `/project/projectId` - project id - * `/uuid` - App Domain uuid - * `/name` - App Domain name - * `/description` - App Domain description - * `/state` - App Domain status - * `/changeLog/createdDateTime` - App Domain creation timestamp - * `/changeLog/updatedDateTime` - App Domain last updated timestamp - * `/changeLog/deletedDateTime` - App Domain deletion timestamp - example: /name - operator: + format: uri + description: Connection URI + example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f + type: + $ref: '#/components/schemas/ConnectionType' + uuid: + description: Route Aggregation identifier type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `>` - greater than - * `<` - less than - * `IN` - in - * `NOT IN` - not in - * `LIKE` - like - * `ILIKE` - case-insensitive like - * `BETWEEN` - between - * `NOT BETWEEN` - not between - example: = - values: - type: array - items: - type: string - example: Gateway - AppDomainOrFilter: + format: uuid + example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d + name: + type: string + example: connection-1 + GetRouteAggregationGetConnectionsResponse: type: object properties: - or: - maxItems: 3 + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: List of Connections using a Route Aggregation type: array items: - $ref: "#/components/schemas/AppDomainSimpleExpression" - AppDomainSortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/AppDomainSortDirection" - property: - $ref: "#/components/schemas/AppDomainSortBy" - AppDomainSortDirection: - type: string + $ref: '#/components/schemas/RouteAggregationConnectionsData' + RouteAggregationSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - AppDomainSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/name` - App Domain name - * `/uuid` - App Domain uuid - * `/state` - App Domain status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime + RouteAggregationSortBy: + description: Possible field names to use on sorting default: /changeLog/updatedDateTime - AppDomainSearchResponse: + type: string + enum: + - /type + - /uuid + - /name + - /project/projectId + - /state + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + - /changeLog/deletedDateTime + RouteAggregationSortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/RouteAggregationSortDirection' + property: + $ref: '#/components/schemas/RouteAggregationSortBy' + RouteAggregationsSearchRequest: type: object + description: Search route aggregations properties: + filter: + $ref: '#/components/schemas/SearchFilter' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppDomain" - AttachedAppLinkState: - type: array - description: Filter attached App Links by lifecycle state. - example: - - PROVISIONED - - PROVISIONING - items: - $ref: "#/components/schemas/AppLinkState" - AttachedAppLinkOrder: - type: string - description: Sort order for attached App Links. - example: DESC - default: DESC - enum: - - DESC - - ASC - Style: - type: string - description: Detail level of the response. - example: MEDIUM - default: MEDIUM - enum: - - MIN - - MEDIUM - - FULL - AppDomainAttachedAppLinks: + $ref: '#/components/schemas/RouteAggregationSortCriteria' + RouteAggregationsSearchResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: + description: List of Route Aggregations type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppDomainAttachedAppLink" - AppLinkPostRequest: - required: - - bandwidth - - ipv4Subnet - - name - - project - - router - - type + $ref: '#/components/schemas/RouteAggregationsData' + RouteAggregationRuleState: + description: Route Aggregation Rule status + type: string + enum: + - PROVISIONING + - REPROVISIONING + - DEPROVISIONING + - PROVISIONED + - DEPROVISIONED + - NOT_PROVISIONED + - NOT_DEPROVISIONED + RouteAggregationRulesChange: + description: Current state of latest Route Aggregation Rule change type: object properties: - type: - $ref: "#/components/schemas/AppLinkType" - name: - maxLength: 50 - minLength: 1 + uuid: + description: Uniquely identifies a change type: string - description: Customer-provided App Link name - format: string - example: Atlassian App Link - description: + type: + description: Type of change type: string - description: Customer-provided App Link description - format: string - example: Atlassian App Link in SV - router: - $ref: "#/components/schemas/AppLinkPostRequestRouter" - ipv4Subnet: + enum: + - BGP_IPv4_PREFIX_AGGREGATION_RULE_UPDATE + - BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION + - BGP_IPv4_PREFIX_AGGREGATION_RULE_DELETION + href: + description: Route Aggregation Change URI type: string - description: Customer-provided IP subnet for AppLink setup (/29 or larger subnet) - example: 192.168.10.0/29 - bandwidth: - type: integer - description: App Link aggregated data transfer capacity in Mbps - example: 1000 - project: - $ref: "#/components/schemas/Project" - description: Create App Link - AppLink: + format: uri required: - - bandwidth - - ipv4Subnet - - name - - project - - router + - uuid - type + RouteAggregationRulesData: type: object properties: href: type: string - description: Resource URI format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - x-order: 1 + description: Route Aggregation Rules URI + example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b type: - $ref: "#/components/schemas/AppLinkType" + description: Route Aggregation type + type: string + enum: + - BGP_IPv4_PREFIX_AGGREGATION_RULE uuid: + description: Route Aggregation Rule identifier type: string - description: Equinix-assigned access point identifier format: uuid - example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - x-order: 3 + example: 65b025ef-022b-4180-85cf-82cfc1ab655b name: type: string - description: Customer-provided App Link name - format: string - example: Atlassian App Link - x-order: 4 + example: Private-subnet-aggregation-2 description: + description: Customer-provided Route Aggregation Rule description type: string - description: Customer-provided App Link description - format: string - example: Atlassian App Link in SV - x-order: 5 state: - $ref: "#/components/schemas/AppLinkState" - router: - $ref: "#/components/schemas/AppLinkCloudRouter" - ipv4Subnet: - type: string - description: Customer-provided IP subnet for AppLink setup (/29 or larger subnet) - example: 192.168.10.0/29 - x-order: 8 - ipv4Address: + $ref: '#/components/schemas/RouteAggregationRuleState' + change: + $ref: '#/components/schemas/RouteAggregationRulesChange' + prefix: type: string - description: App Link IP address - format: ipv4 - example: 192.168.10.1 - x-order: 9 - bandwidth: - type: integer - description: App Link aggregated data transfer capacity in Mbps - example: 1000 - x-order: 10 - project: - $ref: "#/components/schemas/Project" + example: 192.168.0.0/24 changeLog: - $ref: "#/components/schemas/Changelog" - change: - $ref: "#/components/schemas/AppLinkChange" - description: App Link object - AppLinkId: - type: string - description: App Link UUID - format: uuid - example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - AppLinkUpdateRequest: - maxItems: 1 - minItems: 1 - type: array - description: App Link Update Request - items: - $ref: "#/components/schemas/AppLinkChangeOperation" - AppLinkSearchRequest: + $ref: '#/components/schemas/Changelog' + GetRouteAggregationRulesResponse: type: object properties: - filter: - $ref: "#/components/schemas/AppLinkFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/AppLinkSortCriteria" - description: Search requests containing criteria - AppLinkFilters: - type: object - properties: - and: - maxItems: 8 + $ref: '#/components/schemas/Pagination' + data: + description: List of Route Aggregation Rules type: array items: - $ref: "#/components/schemas/AppLinkFilter" - AppLinkFilter: - type: object - anyOf: - - $ref: "#/components/schemas/AppLinkSimpleExpression" - - $ref: "#/components/schemas/AppLinkOrFilter" - AppLinkSimpleExpression: + $ref: '#/components/schemas/RouteAggregationRulesData' + RouteAggregationRulesBase: type: object properties: - property: + name: type: string - description: | - Possible field names to use on filters: - * `/project/projectId` - project id - * `/uuid` - App Link uuid - * `/name` - App Link name - * `/description` - App Link description - * `/state` - App Link status - * `/ipv4Subnet` - App Link ipv4 subnet - * `/bandwidth` - App Link bandwidth - * `/changeLog/createdDateTime` - App Link creation timestamp - * `/changeLog/updatedDateTime` - App Link last updated timestamp - * `/changeLog/deletedDateTime` - App Link deletion timestamp - example: /name - operator: + example: Private-subnet-Aggregation + description: + description: Customer-provided Route Aggregation Rule description type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `>` - greater than - * `<` - less than - * `IN` - in - * `NOT IN` - not in - * `LIKE` - like - * `ILIKE` - case-insensitive like - * `BETWEEN` - between - * `NOT BETWEEN` - not between - example: = - values: - type: array - items: - type: string - example: Gateway - AppLinkOrFilter: + prefix: + type: string + example: 192.168.0.0/24 + required: + - prefix + RouteAggregationRulesPatchRequestItem: + description: Route Aggregation Rule change operation data type: object properties: - or: - maxItems: 3 - type: array - items: - $ref: "#/components/schemas/AppLinkSimpleExpression" - AppLinkSortCriteria: + op: + description: Handy shortcut for operation name + type: string + example: replace + path: + description: path to change + type: string + example: /prefix + value: + description: new value for updated parameter + required: + - op + - path + - value + RouteAggregationRulesPatchRequest: + description: Patch Route Aggregations Rule request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/RouteAggregationRulesPatchRequestItem' + RouteAggregationRulesChangeOperation: + description: Route Aggregation Rule change operation data type: object properties: - direction: - $ref: "#/components/schemas/AppLinkSortDirection" - property: - $ref: "#/components/schemas/AppLinkSortBy" - AppLinkSortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - AppLinkSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/name` - App Link name - * `/uuid` - App Link uuid - * `/state` - App Link status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime - default: /changeLog/updatedDateTime - AppLinkSearchResponse: - type: object - properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/AppLink" - AppLinkAppDomainAttachment: + op: + description: Handy shortcut for operation name + type: string + enum: + - add + - replace + - remove + path: + description: path inside document leading to updated parameter + type: string + example: / + value: + $ref: '#/components/schemas/RouteAggregationRulesBase' required: - - uuid + - op + - path + - value + RouteAggregationRulesChangeData: + description: Current state of latest Route Aggregation Rules change type: object properties: - href: + status: + description: Current outcome of the change flow type: string - description: Resource URI - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - x-order: 1 - type: - $ref: "#/components/schemas/AppDomainType" - uuid: + enum: + - COMPLETED + - FAILED + - REQUESTED + createdBy: type: string - description: Equinix-assigned access point identifier - format: uuid - example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - x-order: 3 - name: + description: Created by User Key + createdDateTime: + description: Set when change flow starts type: string - description: Customer-provided App Domain name - example: atlassian.net - x-order: 4 - attachmentStatus: - $ref: "#/components/schemas/AppLinkAttachState" - changeLog: - $ref: "#/components/schemas/Changelog" - description: App Link Attached App Domain object - AppLinkAttachDomainSearchRequest: + format: date-time + updatedBy: + type: string + description: Updated by User Key + updatedDateTime: + description: Set when change object is updated + type: string + format: date-time + data: + $ref: '#/components/schemas/RouteAggregationRulesChangeOperation' + allOf: + - $ref: '#/components/schemas/RouteAggregationRulesChange' + RouteAggregationRulesChangeDataResponse: + description: List of Route Aggregation Rule changes type: object properties: - filter: - $ref: "#/components/schemas/AppLinkAttachDomainFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + $ref: '#/components/schemas/Pagination' + data: type: array items: - $ref: "#/components/schemas/AppLinkAttachDomainSortCriteria" - description: Search requests containing criteria - AppLinkAttachDomainFilters: + $ref: '#/components/schemas/RouteAggregationRulesChangeData' + RouteAggregationRulesPostRequest: type: object + description: Create Route Aggregation Rule POST request properties: - and: - maxItems: 8 + data: + description: Route Aggregation Rule configuration type: array items: - $ref: "#/components/schemas/AppLinkAttachDomainFilter" - AppLinkAttachDomainFilter: + $ref: '#/components/schemas/RouteAggregationRulesBase' + RouteAggregationRuleAndExpression: type: object + description: AND expression containing multiple filter expressions + properties: + and: + type: array + minItems: 1 + maxItems: 8 + items: + $ref: '#/components/schemas/RouteAggregationRuleExpression' + RouteAggregationRuleExpression: + description: Filter expression that can be AND, OR, or a simple expression anyOf: - - $ref: "#/components/schemas/AppLinkAttachDomainSimpleExpression" - - $ref: "#/components/schemas/AppLinkAttachDomainOrFilter" - AppLinkAttachDomainSimpleExpression: + - $ref: '#/components/schemas/RouteAggregationRuleAndExpression' + - $ref: '#/components/schemas/RouteAggregationRuleOrExpression' + - $ref: '#/components/schemas/RouteAggregationRuleSimpleExpression' + RouteAggregationRuleOrExpression: + type: object + description: OR expression containing multiple filter expressions + properties: + or: + type: array + minItems: 1 + maxItems: 8 + items: + $ref: '#/components/schemas/RouteAggregationRuleExpression' + RouteAggregationRuleSimpleExpression: type: object + description: Simple filter expression with property, operator, and values properties: property: - type: string description: | Possible field names to use on filters: - * `/uuid` - App Domain attach to App Link uuid - * `/attachmentStatus` - App Domain attach to App Link status - example: /attachmentStatus - operator: + * `/type` - Route Aggregation Rules Type + * `/name` - Route Aggregation Rules Name + * `/uuid` - Route Aggregation Rules uuid + * `/state` - Route Aggregation Rules status + * `/prefix` - Route Aggregation Rule Prefix type: string + example: /name + operator: description: | Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `IN` - in - * `NOT IN` - not in - example: = + * `=` - equal + * `!=` - not equal + * `[NOT] LIKE` - (not) like + * `[NOT] IN` - (not) in + * `ILIKE` - case-insensitive like + type: string + example: '=' values: type: array + minItems: 1 + maxItems: 8 items: type: string - example: Gateway - AppLinkAttachDomainOrFilter: - type: object - properties: - or: - maxItems: 3 - type: array - items: - $ref: "#/components/schemas/AppLinkAttachDomainSimpleExpression" - AppLinkAttachDomainSortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/AppLinkAttachDomainSortDirection" - property: - $ref: "#/components/schemas/AppLinkAttachDomainSortBy" - AppLinkAttachDomainSortDirection: - type: string + example: Route_Aggregation_Rule_Demo + RouteAggregationRulesFilter: + description: Top-level filter that can be either an AND expression or OR expression + anyOf: + - $ref: '#/components/schemas/RouteAggregationRuleAndExpression' + - $ref: '#/components/schemas/RouteAggregationRuleOrExpression' + RouteAggregationRuleSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - AppLinkAttachDomainSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/uuid` - App Domain attach to App Link uuid - * `/attachmentStatus` - App Domain attach to App Link status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime + RouteAggregationRuleSortBy: + description: Possible field names to use on sorting default: /changeLog/updatedDateTime - AppLinkAttachDomainSearchResponse: + type: string + enum: + - /type + - /uuid + - /name + - /state + - /prefix + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + RouteAggregationRuleSortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/RouteAggregationRuleSortDirection' + property: + $ref: '#/components/schemas/RouteAggregationRuleSortBy' + RouteAggregationRulesSearchRequest: type: object + description: Search route aggregation rules properties: + filter: + $ref: '#/components/schemas/RouteAggregationRulesFilter' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppLinkAppDomainAttachment" - AttachedAppDomainAttachmentStatus: - type: array - description: Filter attached App Domains by attachment lifecycle state. - example: - - ATTACHED - - ATTACHING - items: - $ref: "#/components/schemas/AppLinkAttachState" - AttachedAppDomainOrder: - type: string - description: Sort order for attached App Domains. - example: DESC - default: DESC - enum: - - DESC - - ASC - AppLinkAttachedAppDomains: + $ref: '#/components/schemas/RouteAggregationRuleSortCriteria' + RouteAggregationRulesSearchResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: + description: List of route aggregation rules type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppLinkAttachedAppDomain" - AppServiceId: - type: string - description: App Service UUID - format: uuid - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - AppLinkAppServiceAttachment: + $ref: '#/components/schemas/RouteAggregationRulesData' + CloudRouterPostRequest: + allOf: + - $ref: '#/components/schemas/CloudRouterPostRequestBase' required: - - destinationIp - - geoScope - - uuid + - type + - name + - location + - package + - notifications + CloudRouterReadResponse: + description: Fabric Cloud Router read response object type: object properties: + type: + type: string + enum: + - IC_ROUTER + - XF_ROUTER + name: + description: Customer-provided Cloud Router name + type: string + 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: + description: Preferences for notifications on connection configuration or status changes + type: array + items: + $ref: '#/components/schemas/SimplifiedNotification' href: + description: Cloud Routers URI type: string - description: Resource URI format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - x-order: 1 - type: - $ref: "#/components/schemas/AppServiceType" + 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: 5008a109-9d1c-485c-b0ba-de9736f283c2 - x-order: 3 - geoScope: - type: string - description: Geo scope for the App Service - example: GLOBAL - x-order: 4 - destinationIp: type: string - description: Target IP for forwarding API requests - format: ipv4 - example: 10.10.1.110 - x-order: 5 - attachmentStatus: - $ref: "#/components/schemas/AppLinkAttachState" + format: uuid + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + state: + $ref: '#/components/schemas/CloudRouterAccessPointState' + example: PROVISIONED + equinixAsn: + description: Equinix ASN + type: integer + format: int64 + example: 30000 + connectionsCount: + description: Number of connections associated with this Access point + type: integer + minimum: 0 + marketplaceSubscription: + $ref: '#/components/schemas/marketplaceSubscription' changeLog: - $ref: "#/components/schemas/Changelog" + $ref: '#/components/schemas/Changelog' change: - $ref: "#/components/schemas/AppLinkAppServiceAttachmentChange" - description: App Link Attached App Service object - AppLinkAttachServiceRequest: - required: - - destinationIp - - geoScope + $ref: '#/components/schemas/CloudRouterChange' + CloudRouterUpdateRequest: + description: Fabric Cloud Router Update Request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/CloudRouterChangeOperation' + CloudRouterActionState: + description: Cloud router action state + type: string + enum: + - SUCCEEDED + - FAILED + - PENDING + CloudRouterActionType: + description: Cloud router action type + type: string + enum: + - BGP_SESSION_STATUS_UPDATE + - ROUTE_TABLE_ENTRY_UPDATE + - RECEIVED_ROUTE_ENTRY_UPDATE + - ADVERTISED_ROUTE_ENTRY_UPDATE + Operation: + description: Operation object for router actions type: object properties: - geoScope: + bgpIpv4RoutesCount: + description: IPV4 route count + type: integer + example: 6 + bgpIpv6RoutesCount: + description: IPV6 route count + type: integer + example: 6 + distinctIpv4PrefixesCount: + description: distinct IPV4 prefixes count + type: integer + example: 4 + distinctIpv6PrefixesCount: + description: distinct IPV6 prefixes count + type: integer + example: 4 + RouterActionsConnection: + description: Connection object for router actions + type: object + properties: + uuid: + description: Connection UUID type: string - description: Geo scope for the App Service - example: GLOBAL - destinationIp: + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 + href: type: string - description: Target IP for forwarding API requests - format: ipv4 - example: 10.10.1.110 - description: Attach App Service to App Link - AppLinkAttachServiceUpdateRequest: - maxItems: 1 - minItems: 1 - type: array - description: App Service attachment Update Request - items: - $ref: "#/components/schemas/AppLinkAppServiceAttachmentChangeOperation" - AppLinkAttachServiceSearchRequest: + example: https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4 + type: + $ref: '#/components/schemas/ConnectionType' + operation: + $ref: '#/components/schemas/Operation' + RouterActionsRouter: + description: Router object for router actions type: object properties: - filter: - $ref: "#/components/schemas/AppLinkAttachServiceFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/AppLinkAttachServiceSortCriteria" - description: Search requests containing criteria - AppLinkAttachServiceFilters: + uuid: + description: Router UUID + type: string + example: a1c6b7fd-aead-410a-96b4-b1dfa1071700 + href: + type: string + example: https://api.equinix.com/fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700 + type: + type: string + enum: + - XF_ROUTER + operation: + $ref: '#/components/schemas/Operation' + CloudRouterActionResponse: + description: Cloud router actions response object type: object properties: - and: - maxItems: 8 + 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' + router: + $ref: '#/components/schemas/RouterActionsRouter' + required: + - type + - uuid + - state + - changeLog + CloudRouterActionsSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. type: array items: - $ref: "#/components/schemas/AppLinkAttachServiceFilter" - AppLinkAttachServiceFilter: + $ref: '#/components/schemas/CloudRouterActionResponse' + CloudRouterActionRequest: + description: Cloud router action request type: object - anyOf: - - $ref: "#/components/schemas/AppLinkAttachServiceSimpleExpression" - - $ref: "#/components/schemas/AppLinkAttachServiceOrFilter" - AppLinkAttachServiceSimpleExpression: + properties: + type: + $ref: '#/components/schemas/CloudRouterActionType' + connection: + $ref: '#/components/schemas/RouterActionsConnection' + required: + - type + CloudRouterActionsSearchExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: - * `/uuid` - App Service attach to App Link uuid - * `/attachmentStatus` - App Service attach to App Link status - example: /attachmentStatus - operator: + * `/type` - type of update + * `/state` - action state + * `/connection/uuid` - connection uuid associated + * `/*` - all-category search type: string + example: /type + operator: description: | Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `IN` - in - * `NOT IN` - not in - example: = + * `=` - 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 + type: string + example: '=' values: type: array items: type: string - example: Gateway - AppLinkAttachServiceOrFilter: + example: ROUTE_TABLE_ENTRY_UPDATE + CloudRouterActionsSearchOrFilter: type: object properties: or: - maxItems: 3 type: array + maxItems: 3 items: - $ref: "#/components/schemas/AppLinkAttachServiceSimpleExpression" - AppLinkAttachServiceSortCriteria: + $ref: '#/components/schemas/CloudRouterActionsSearchExpression' + CloudRouterActionsSearchFilter: + type: object + anyOf: + - $ref: '#/components/schemas/CloudRouterActionsSearchExpression' + - $ref: '#/components/schemas/CloudRouterActionsSearchOrFilter' + CloudRouterActionsSearchFilters: type: object properties: - direction: - $ref: "#/components/schemas/AppLinkAttachServiceSortDirection" - property: - $ref: "#/components/schemas/AppLinkAttachServiceSortBy" - AppLinkAttachServiceSortDirection: - type: string + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/CloudRouterActionsSearchFilter' + CloudRouterActionsSearchSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - AppLinkAttachServiceSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/uuid` - App Service attach to App Link uuid - * `/attachmentStatus` - App Service attach to App Link status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime + CloudRouterActionsSearchSortBy: + description: Possible field names to use on sorting default: /changeLog/updatedDateTime - AppLinkAttachServiceSearchResponse: - type: object - properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/AppLinkAppServiceAttachment" - AttachedAppServiceAttachmentStatus: - type: array - description: Filter attached App Services by attachment lifecycle state. - example: - - ATTACHED - - ATTACHING - items: - $ref: "#/components/schemas/AppLinkAttachState" - AttachedAppServiceOrder: type: string - description: Sort order for attached App Services. - example: DESC - default: DESC enum: - - DESC - - ASC - AppLinkAttachedAppServices: + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + - /connection/name + - /type + CloudRouterActionsSearchSortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/CloudRouterActionsSearchSortDirection' + property: + $ref: '#/components/schemas/CloudRouterActionsSearchSortBy' + CloudRouterActionsSearchRequest: type: object + description: Search requests containing criteria properties: + filter: + $ref: '#/components/schemas/CloudRouterActionsSearchFilters' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppLinkAttachedAppService" - AppProcessorId: + $ref: '#/components/schemas/CloudRouterActionsSearchSortCriteria' + CloudRouterCommandType: + description: Fabric Cloud Router Command Type type: string - description: App Processor UUID - format: uuid - example: 90ee425c-9988-454c-96d9-1128bc16350f - AppLinkAppProcessorAttachment: - required: - - uuid + enum: + - PING_COMMAND + - TRACEROUTE_COMMAND + example: PING_COMMAND + CloudRouterCommandState: + description: Fabric Cloud Router Command State + type: string + enum: + - PENDING + - SUCCEEDED + - FAILED + - DELETED + example: SUCCEEDED + CloudRouterCommandRequestConnection: + description: Connection object for Cloud Router Command type: object properties: - href: - type: string - description: Resource URI - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - x-order: 1 - type: - $ref: "#/components/schemas/AppProcessorType" uuid: + description: Connection UUID type: string - description: App Processor UUID - format: uuid - example: 90ee425c-9988-454c-96d9-1128bc16350f - x-order: 3 - config: - type: string - description: Base64-encoded configuration for the processor attachment - format: byte - example: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... - x-order: 4 - endpoint: - type: string - description: Endpoint DNS name assigned to the attached App Processor - example: 123456.privateai.link - x-order: 5 - attachmentStatus: - $ref: "#/components/schemas/AppLinkAttachState" - changeLog: - $ref: "#/components/schemas/Changelog" - description: App Link Attached App Processor object - AppLinkAttachProcessorRequest: + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 required: - - config + - uuid + CloudRouterCommandRequestResponse: + description: Fabric Cloud Router Command Request type: object properties: - config: + destination: + description: Fabric Cloud Router Ping or Traceroute Command Destination type: string - description: Base64-encoded configuration for the processor attachment - format: byte - description: Attach App Processor to App Link - AppLinkAttachProcessorSearchRequest: + example: 8.8.8.8 + sourceConnection: + $ref: '#/components/schemas/CloudRouterCommandRequestConnection' + timeout: + description: | + Timeout in seconds for Fabric Cloud Router Command: + - For `PING_COMMAND`: Packet timeout duration. The default value is 5. + - For `TRACEROUTE_COMMAND`: Probe timeout duration. + The default value is 2 and it is not configurable. + type: integer + example: 2 + dataBytes: + description: | + Ping Command DataBytes. + This field is only applicable for commands of type `PING_COMMAND`. + type: integer + default: 64 + minimum: 16 + maximum: 9000 + example: 100 + interval: + description: | + Time in milliseconds between sending each packet. + This field is only applicable for commands of type `PING_COMMAND`. + type: integer + default: 1000 + example: 1000 + count: + description: | + Total number of ping requests. + This field is only applicable for commands of type `PING_COMMAND`. + type: integer + default: 5 + example: 5 + probes: + description: | + Number of probes for Fabric Cloud Router Traceroute Command. + This field is only applicable for commands of type `TRACEROUTE_COMMAND` and is not configurable. + type: integer + default: 3 + example: 3 + hopsMax: + description: | + Maximum number of hops for the traceroute command. + This field is only applicable for commands of type `TRACEROUTE_COMMAND`. + type: integer + default: 20 + maximum: 30 + example: 20 + OutputStructuredPingResponseItem: type: object properties: - filter: - $ref: "#/components/schemas/AppLinkAttachProcessorFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/AppLinkAttachProcessorSortCriteria" - description: Search requests containing criteria - AppLinkAttachProcessorFilters: + 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 + OutputStructuredPing: type: object properties: - and: - maxItems: 8 + 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/AppLinkAttachProcessorFilter" - AppLinkAttachProcessorFilter: - type: object - anyOf: - - $ref: "#/components/schemas/AppLinkAttachProcessorSimpleExpression" - - $ref: "#/components/schemas/AppLinkAttachProcessorOrFilter" - AppLinkAttachProcessorSimpleExpression: + $ref: '#/components/schemas/OutputStructuredPingResponseItem' + CloudRouterCommandPingResponse: type: object properties: - property: - type: string - description: | - Possible field names to use on filters: - * `/uuid` - App Processor attach to App Link uuid - * `/attachmentStatus` - App Processor attach to App Link status - example: /attachmentStatus - operator: + output: type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `IN` - in - * `NOT IN` - not in - example: = - values: + outputStructuredPing: + $ref: '#/components/schemas/OutputStructuredPing' + errors: type: array items: - type: string - example: ATTACHED - AppLinkAttachProcessorOrFilter: + $ref: '#/components/schemas/Error' + Hop: type: object properties: - or: - maxItems: 3 + hop: + type: integer + example: 1 + probes: type: array items: - $ref: "#/components/schemas/AppLinkAttachProcessorSimpleExpression" - AppLinkAttachProcessorSortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/AppLinkAttachProcessorSortDirection" - property: - $ref: "#/components/schemas/AppLinkAttachProcessorSortBy" - AppLinkAttachProcessorSortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - AppLinkAttachProcessorSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/uuid` - App Processor attach to App Link uuid - * `/attachmentStatus` - App Processor attach to App Link status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime - default: /changeLog/updatedDateTime - AppLinkAttachProcessorSearchResponse: + type: object + properties: + name: + type: string + example: dns.google + ip: + type: string + example: 8.8.8.8 + asn: + type: integer + example: 15169 + rtt: + type: string + example: 11.764 + annotation: + type: string + example: null + OutputStructuredTraceroute: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + destinationIp: + type: string + example: 8.8.8.8 + destinationName: + type: string + example: 8.8.8.8 + packetBytes: + type: integer + example: 60 + hopsMax: + type: integer + example: 10 + hops: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppLinkAppProcessorAttachment" - AttachedAppProcessorAttachmentStatus: - type: array - description: Filter attached App Processors by attachment lifecycle state. - example: - - ATTACHED - - ATTACHING - items: - $ref: "#/components/schemas/AppLinkAttachState" - AttachedAppProcessorOrder: - type: string - description: Sort order for attached App Processors. - example: DESC - default: DESC - enum: - - DESC - - ASC - AppLinkAttachedAppProcessors: + $ref: '#/components/schemas/Hop' + CloudRouterCommandTracerouteResponse: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: + output: + type: string + outputStructuredTraceroute: + $ref: '#/components/schemas/OutputStructuredTraceroute' + errors: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppLinkAppProcessorAttachment" - AppProcessor: - required: - - marketplace - - name - - project - - registryId - - type + $ref: '#/components/schemas/Error' + CloudRouterCommandResponse: + type: object + oneOf: + - $ref: '#/components/schemas/CloudRouterCommandPingResponse' + - $ref: '#/components/schemas/CloudRouterCommandTracerouteResponse' + CloudRouterCommand: + description: Get Fabric Cloud Router Command response object type: object properties: href: type: string - description: Resource URI - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - x-order: 1 + example: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/commands/1e9414f1-763e-4c0a-86c6-0bc8336048d9 type: - $ref: "#/components/schemas/AppProcessorType" + $ref: '#/components/schemas/CloudRouterCommandType' uuid: type: string - description: Equinix-assigned access point identifier format: uuid - example: 90ee425c-9988-454c-96d9-1128bc16350f - x-order: 3 + example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 name: - maxLength: 50 - minLength: 1 + description: Customer-provided Cloud Router name type: string - description: Customer-provided App Processor name format: string - example: agent-gateway - x-order: 4 + example: test-fg-1 description: - maxLength: 255 - minLength: 1 type: string - description: Customer-provided App Processor description - format: string - example: llm-routing, a2a-routing, mcp-routing - x-order: 5 + example: description state: - $ref: "#/components/schemas/AppProcessorState" - registryId: - maxLength: 255 - minLength: 1 - type: string - description: Container image reference for the processor runtime - format: string - example: agentgateway/agentgateway:1.3.0 - x-order: 7 - marketplace: - $ref: "#/components/schemas/AppProcessorMarketplace" + $ref: '#/components/schemas/CloudRouterCommandState' project: - $ref: "#/components/schemas/Project" + $ref: '#/components/schemas/Project' + request: + $ref: '#/components/schemas/CloudRouterCommandRequestResponse' + response: + $ref: '#/components/schemas/CloudRouterCommandResponse' changeLog: - $ref: "#/components/schemas/Changelog" - change: - $ref: "#/components/schemas/AppProcessorChange" - description: App Processor object - AppProcessorSearchRequest: + $ref: '#/components/schemas/Changelog' + GetAllCloudRouterCommands: + description: List of Fabric Cloud Router Command type: object properties: - filter: - $ref: "#/components/schemas/AppProcessorFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + $ref: '#/components/schemas/Pagination' + data: type: array items: - $ref: "#/components/schemas/AppProcessorSortCriteria" - description: Search requests containing criteria - AppProcessorFilters: + $ref: '#/components/schemas/CloudRouterCommand' + CloudRouterCommandRequestPayload: + description: Fabric Cloud Router Command Request type: object properties: - and: - maxItems: 8 - type: array - items: - $ref: "#/components/schemas/AppProcessorFilter" - AppProcessorFilter: + destination: + description: Fabric Cloud Router Ping or Traceroute Command Destination + type: string + example: 8.8.8.8 + sourceConnection: + $ref: '#/components/schemas/CloudRouterCommandRequestConnection' + timeout: + description: | + Timeout in seconds for Fabric Cloud Router Command: + - For `PING_COMMAND`: Packet timeout duration. The default value is 5. + - For `TRACEROUTE_COMMAND`: Probe timeout duration. + The default value is 2 and it is not configurable. + type: integer + example: 2 + dataBytes: + description: | + Ping Command DataBytes. + This field is only applicable for commands of type `PING_COMMAND`. + type: integer + default: 64 + minimum: 16 + maximum: 9000 + example: 100 + probes: + description: | + Number of probes for Fabric Cloud Router Traceroute Command. + This field is only applicable for commands of type `TRACEROUTE_COMMAND` and is not configurable. + type: integer + default: 3 + example: 3 + hopsMax: + description: | + Maximum number of hops for the traceroute command. + This field is only applicable for commands of type `TRACEROUTE_COMMAND`. + type: integer + default: 20 + maximum: 30 + example: 20 + required: + - destination + - sourceConnection + CloudRouterCommandPostRequest: type: object - anyOf: - - $ref: "#/components/schemas/AppProcessorSimpleExpression" - - $ref: "#/components/schemas/AppProcessorOrFilter" - AppProcessorSimpleExpression: + description: Execute Cloud Router Command Request + properties: + type: + $ref: '#/components/schemas/CloudRouterCommandType' + name: + description: Customer-provided Cloud Router Command name + type: string + description: + description: Customer-provided Cloud Router Command description + type: string + project: + $ref: '#/components/schemas/Project' + request: + $ref: '#/components/schemas/CloudRouterCommandRequestPayload' + required: + - type + - project + - request + CloudRouterCommandSearchExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: - * `/project/projectId` - project id - * `/uuid` - App Processor uuid - * `/name` - App Processor name - * `/description` - App Processor description - * `/state` - App Processor status - * `/ipv4Subnet` - App Processor ipv4 subnet - * `/bandwidth` - App Processor bandwidth - * `/changeLog/createdDateTime` - App Processor creation timestamp - * `/changeLog/updatedDateTime` - App Processor last updated timestamp - * `/changeLog/deletedDateTime` - App Processor deletion timestamp - example: /name - operator: + * `/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 type: string + example: /state + operator: description: | Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `>` - greater than - * `<` - less than - * `IN` - in - * `NOT IN` - not in - * `LIKE` - like - * `ILIKE` - case-insensitive like - * `BETWEEN` - between - * `NOT BETWEEN` - not between - example: = + * `=` - 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 + type: string + example: '=' values: type: array items: type: string - example: Gateway - AppProcessorOrFilter: + example: PING_COMMAND + CloudRouterCommandSearchOrFilter: type: object properties: or: - maxItems: 3 type: array + maxItems: 3 items: - $ref: "#/components/schemas/AppProcessorSimpleExpression" - AppProcessorSortCriteria: + $ref: '#/components/schemas/CloudRouterCommandSearchExpression' + CloudRouterCommandSearchFilter: + type: object + anyOf: + - $ref: '#/components/schemas/CloudRouterCommandSearchExpression' + - $ref: '#/components/schemas/CloudRouterCommandSearchOrFilter' + CloudRouterCommandSearchFilters: type: object properties: - direction: - $ref: "#/components/schemas/AppProcessorSortDirection" - property: - $ref: "#/components/schemas/AppProcessorSortBy" - AppProcessorSortDirection: - type: string + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/CloudRouterCommandSearchFilter' + CloudRouterCommandSearchSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - AppProcessorSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/name` - App Processor name - * `/uuid` - App Processor uuid - * `/state` - App Processor status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime + CloudRouterCommandSearchSortBy: + description: Possible field names to use on sorting default: /changeLog/updatedDateTime - AppProcessorSearchResponse: + type: string + enum: + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + - /name + - /type + CloudRouterCommandSearchSortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/CloudRouterCommandSearchSortDirection' + property: + $ref: '#/components/schemas/CloudRouterCommandSearchSortBy' + CloudRouterCommandSearchRequest: type: object + description: Search requests containing criteria properties: + filter: + $ref: '#/components/schemas/CloudRouterCommandSearchFilters' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array + items: + $ref: '#/components/schemas/CloudRouterCommandSearchSortCriteria' + CloudRouterCommandSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: description: Data returned from the API call. + type: array items: - $ref: "#/components/schemas/AppProcessor" - AppServicePostRequest: - required: - - endpoint - - name - - project - - type - type: object - properties: - type: - $ref: "#/components/schemas/AppServiceType" - name: - maxLength: 50 - minLength: 1 - type: string - description: Customer-provided App Service name - format: string - example: Atlassian App Service - description: - type: string - description: Customer-provided App Service description - format: string - example: Atlassian App Service in SV - endpoint: - type: string - description: Accessible endpoint through this service - example: equinixjira.atlassian.net - sourceDomains: - type: array - description: List of source domains from where traffic is allowed - items: - type: string - example: equinix.com - project: - $ref: "#/components/schemas/Project" - description: Create App Service - AppService: - required: - - name - - type - type: object - properties: - href: - type: string - description: Resource URI - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - x-order: 1 - type: - $ref: "#/components/schemas/AppServiceType" - uuid: - type: string - description: Equinix-assigned access point identifier - format: uuid - example: 5008a109-9d1c-485c-b0ba-de9736f283c2 - x-order: 3 - name: - type: string - description: Customer-provided App Service name - format: string - example: Atlassian App Service - x-order: 4 - description: - type: string - description: Customer-provided App Service description - format: string - example: Atlassian App Service in SV - x-order: 5 - state: - $ref: "#/components/schemas/AppServiceState" - endpoint: - type: string - description: Accessible endpoint through this service - example: equinixjira.atlassian.net - x-order: 7 - sourceDomains: - type: array - description: List of source domains from where traffic is allowed - items: - type: string - example: equinix.com - x-order: 8 - account: - $ref: "#/components/schemas/SimplifiedAccount" - project: - $ref: "#/components/schemas/Project" - changeLog: - $ref: "#/components/schemas/Changelog" - change: - $ref: "#/components/schemas/AppServiceChange" - description: App Service object - AppServiceUpdateRequest: - maxItems: 1 - minItems: 1 - type: array - description: App Service Update Request - items: - $ref: "#/components/schemas/AppServiceChangeOperation" - AppServiceSearchRequest: - type: object - properties: - filter: - $ref: "#/components/schemas/AppServiceFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: - type: array - items: - $ref: "#/components/schemas/AppServiceSortCriteria" - description: Search requests containing criteria - AppServiceFilters: - type: object - properties: - and: - maxItems: 8 - type: array - items: - $ref: "#/components/schemas/AppServiceFilter" - AppServiceFilter: - type: object - anyOf: - - $ref: "#/components/schemas/AppServiceSimpleExpression" - - $ref: "#/components/schemas/AppServiceOrFilter" - AppServiceSimpleExpression: + $ref: '#/components/schemas/CloudRouterCommand' + RouteTableEntrySimpleExpression: type: object properties: property: - type: string description: | Possible field names to use on filters: - * `/project/projectId` - project id - * `/uuid` - App Service uuid - * `/name` - App Service name - * `/description` - App Service description - * `/state` - App Service status - * `/endpoint` - App Service endpoint - * `/sourceDomains` - App Service source domains - * `/changeLog/createdDateTime` - App Service creation timestamp - * `/changeLog/updatedDateTime` - App Service last updated timestamp - * `/changeLog/deletedDateTime` - App Service deletion timestamp - example: /name - operator: + * `/type` - Route table entry type + * `/prefix` - Route table entry prefix + * `/nextHop` - Route table entry nextHop + * `/state` - Route table entry state + * `/MED` - Route table entry med + * `/*` - all-category search type: string + example: /type + operator: description: | Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `>` - greater than - * `<` - less than - * `IN` - in - * `NOT IN` - not in - * `LIKE` - like - * `ILIKE` - case-insensitive like - * `BETWEEN` - between - * `NOT BETWEEN` - not between - example: = + * `=` - 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 + type: string + example: '=' values: type: array items: type: string - example: Gateway - AppServiceOrFilter: + example: IPv4_BGP_ROUTE + RouteTableEntryOrFilter: type: object properties: or: - maxItems: 3 type: array + maxItems: 3 items: - $ref: "#/components/schemas/AppServiceSimpleExpression" - AppServiceSortCriteria: + $ref: '#/components/schemas/RouteTableEntrySimpleExpression' + RouteTableEntryFilter: + type: object + anyOf: + - $ref: '#/components/schemas/RouteTableEntrySimpleExpression' + - $ref: '#/components/schemas/RouteTableEntryOrFilter' + RouteTableEntryFilters: type: object properties: - direction: - $ref: "#/components/schemas/AppServiceSortDirection" - property: - $ref: "#/components/schemas/AppServiceSortBy" - AppServiceSortDirection: - type: string + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/RouteTableEntryFilter' + RouteTableEntrySortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - AppServiceSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/name` - App Service name - * `/uuid` - App Service uuid - * `/state` - App Service status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime + RouteTableEntrySortBy: + description: Possible field names to use on sorting default: /changeLog/updatedDateTime - AppServiceSearchResponse: + type: string + enum: + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + - /prefix + - /nextHop + - /connection/name + - /type + - /MED + RouteTableEntrySortCriteria: type: object properties: - pagination: - $ref: "#/components/schemas/Pagination" - data: - type: array - description: Data returned from the API call. - items: - $ref: "#/components/schemas/AppService" - AttachedAppLinkState_1: - type: array - description: Filter attached App Links by lifecycle state. - example: - - PROVISIONED - - PROVISIONING - items: - $ref: "#/components/schemas/AppLinkState" - AppServiceAttachedAppLinks: + direction: + $ref: '#/components/schemas/RouteTableEntrySortDirection' + property: + $ref: '#/components/schemas/RouteTableEntrySortBy' + RouteTableEntrySearchRequest: type: object + description: Search requests containing criteria properties: + filter: + $ref: '#/components/schemas/RouteTableEntryFilters' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppServiceAttachedAppLink" - AttachedAppSubscriptionState: - type: array - description: Filter attached App Subscriptions by lifecycle state. - example: - - PROVISIONED - - PROVISIONING - items: - $ref: "#/components/schemas/AppSubscriptionState" - AttachedAppSubscriptionOrder: + $ref: '#/components/schemas/RouteTableEntrySortCriteria' + RouteTableEntryState: + description: Route table entry state type: string - description: Sort order for attached App Subscriptions. - example: DESC - default: DESC enum: - - DESC - - ASC - AppServiceAttachedAppSubscriptions: + - ACTIVE + RouteTableEntry: + description: Route table entry object + type: object + properties: + type: + $ref: '#/components/schemas/RouteTableEntryType' + example: IPv4_BGP_SESSION + protocolType: + $ref: '#/components/schemas/RouteTableEntryProtocolType' + example: BGP + state: + $ref: '#/components/schemas/RouteTableEntryState' + example: ACTIVE + 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 + example: '20100' + connection: + type: object + properties: + uuid: + type: string + example: 81331c52-04c0-4656-a4a7-18c52669348f + name: + type: string + example: connection_1 + href: + type: string + format: uri + changeLog: + $ref: '#/components/schemas/Changelog' + required: + - type + - state + - changeLog + RouteTableEntrySearchResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: - type: array description: Data returned from the API call. + type: array items: - $ref: "#/components/schemas/AppServiceAttachedAppSubscription" - AppServiceAttachedAppSubscriptionSearchRequest: + $ref: '#/components/schemas/RouteTableEntry' + ValidateRequest: type: object + description: Validate connection auth api key or vlan properties: filter: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionFilters" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + type: object + description: Filters + properties: + and: + type: array + items: + type: object + properties: + property: + description: Path to property + type: string + operator: + description: Type of operation + type: string + values: + description: Values for the given property + type: array + items: + type: string + ValidateSubnetResponse: + description: ValidateResponse + type: object + properties: + additionalInfo: + description: Additional information type: array items: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionSortCriteria" - description: Search requests containing criteria - AppServiceAttachedAppSubscriptionFilters: + $ref: '#/components/schemas/ConnectionSideAdditionalInfo' + CloudRouterRouteFilterAndExpression: type: object + description: AND expression containing multiple filter expressions properties: and: - maxItems: 8 type: array + minItems: 1 + maxItems: 8 items: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionFilter" - AppServiceAttachedAppSubscriptionFilter: - type: object + $ref: '#/components/schemas/CloudRouterRouteFilterExpression' + CloudRouterRouteFilterExpression: + description: Filter expression that can be AND, OR, or a simple expression anyOf: - - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionSimpleExpression" - - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionOrFilter" - AppServiceAttachedAppSubscriptionSimpleExpression: + - $ref: '#/components/schemas/CloudRouterRouteFilterAndExpression' + - $ref: '#/components/schemas/CloudRouterRouteFilterOrExpression' + - $ref: '#/components/schemas/CloudRouterRouteFilterSimpleExpression' + CloudRouterRouteFilterOrExpression: + type: object + description: OR expression containing multiple filter expressions + properties: + or: + type: array + minItems: 1 + maxItems: 8 + items: + $ref: '#/components/schemas/CloudRouterRouteFilterExpression' + CloudRouterRouteFilterSimpleExpression: type: object properties: property: type: string - description: | - Possible field names to use on filters: - * `/uuid` - App Subscription UUID - * `/state` - App Subscription lifecycle state - example: /state + enum: + - /type + - /direction + - /attachmentStatus + - /changeLog/createdDateTime + - /changeLog/updatedDateTime operator: type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `IN` - in - * `NOT IN` - not in - example: IN values: type: array + minItems: 1 + maxItems: 8 items: type: string - example: PROVISIONED - AppServiceAttachedAppSubscriptionOrFilter: - type: object - properties: - or: - maxItems: 3 - type: array - items: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionSimpleExpression" - AppServiceAttachedAppSubscriptionSortCriteria: + CloudRouterRouteFiltersFilter: + description: Top-level filter that can be either an AND expression or OR expression + anyOf: + - $ref: '#/components/schemas/CloudRouterRouteFilterAndExpression' + - $ref: '#/components/schemas/CloudRouterRouteFilterOrExpression' + RfAttachmentSortItem: type: object properties: - direction: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionSortDirection" property: - $ref: "#/components/schemas/AppServiceAttachedAppSubscriptionSortBy" - AppServiceAttachedAppSubscriptionSortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - AppServiceAttachedAppSubscriptionSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/uuid` - App Subscription UUID - * `/state` - App Subscription lifecycle state - format: string - example: /uuid - default: /uuid - AppServiceAttachedAppSubscriptionSearchResponse: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + enum: + - /type + - /uuid + - /direction + - /attachmentStatus + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + direction: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + CloudRouterRouteFiltersSearchBase: type: object properties: + filter: + $ref: '#/components/schemas/CloudRouterRouteFiltersFilter' pagination: - $ref: "#/components/schemas/Pagination" - data: + $ref: '#/components/schemas/Pagination' + sort: type: array - description: Data returned from the API call. + minItems: 1 + maxItems: 3 items: - $ref: "#/components/schemas/AppServiceAttachedAppSubscription" - AppSubscriptionPostRequest: - required: - - project - - type - type: object - properties: - type: - $ref: "#/components/schemas/AppSubscriptionType" - source: - $ref: "#/components/schemas/AppSubscriptionSourceRequest" - target: - $ref: "#/components/schemas/AppSubscriptionTargetRequest" - project: - $ref: "#/components/schemas/Project" - description: Create App Subscription - AppSubscription: - required: - - project - - source - - target - - type - type: object - properties: - href: - type: string - description: Resource URI - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - x-order: 1 - type: - $ref: "#/components/schemas/AppSubscriptionType" - uuid: - type: string - description: Equinix-assigned access point identifier - format: uuid - example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - x-order: 3 - source: - $ref: "#/components/schemas/AppSubscriptionSource" - target: - $ref: "#/components/schemas/AppSubscriptionTarget" - state: - $ref: "#/components/schemas/AppSubscriptionState" - project: - $ref: "#/components/schemas/Project" - changeLog: - $ref: "#/components/schemas/Changelog" - change: - $ref: "#/components/schemas/AppSubscriptionChange" - description: App Subscription object - AppSubscriptionId: - type: string - description: App Subscription UUID - format: uuid - example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - AppSubscriptionUpdateRequest: - minItems: 1 - type: array - description: App Subscription Update Request - items: - $ref: "#/components/schemas/AppSubscriptionChangeOperation" - AppSubscriptionSearchRequest: + $ref: '#/components/schemas/RfAttachmentSortItem' + CloudRouterRouteFiltersSearchResponse: type: object properties: - filter: - $ref: "#/components/schemas/AppSubscriptionFilters" pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + $ref: '#/components/schemas/Pagination' + data: + description: List of route filter attachments for a given cloud router type: array items: - $ref: "#/components/schemas/AppSubscriptionSortCriteria" - description: Search requests containing criteria - AppSubscriptionFilters: + $ref: '#/components/schemas/ConnectionRouteFilterData' + CloudRouterRouteAggregationAndExpression: type: object + description: AND expression containing multiple filter expressions properties: and: - maxItems: 8 type: array + minItems: 1 + maxItems: 8 items: - $ref: "#/components/schemas/AppSubscriptionFilter" - AppSubscriptionFilter: - type: object + $ref: '#/components/schemas/CloudRouterRouteAggregationExpression' + CloudRouterRouteAggregationExpression: + description: Filter expression that can be AND, OR, or a simple expression anyOf: - - $ref: "#/components/schemas/AppSubscriptionSimpleExpression" - - $ref: "#/components/schemas/AppSubscriptionOrFilter" - AppSubscriptionSimpleExpression: + - $ref: '#/components/schemas/CloudRouterRouteAggregationAndExpression' + - $ref: '#/components/schemas/CloudRouterRouteAggregationOrExpression' + - $ref: '#/components/schemas/CloudRouterRouteAggregationSimpleExpression' + CloudRouterRouteAggregationOrExpression: + type: object + description: OR expression containing multiple filter expressions + properties: + or: + type: array + minItems: 1 + maxItems: 8 + items: + $ref: '#/components/schemas/CloudRouterRouteAggregationExpression' + CloudRouterRouteAggregationSimpleExpression: type: object properties: property: type: string - description: | - Possible field names to use on filters: - * `/project/projectId` - project id - * `/uuid` - App Subscription uuid - * `/state` - App Subscription status - * `/source/appLink/uuid` - Source App Link uuid - * `/source/ipSubnets` - Source App Link ip subnets - * `/target/appService/uuid` - Target App Service uuid - * `/target/geoScope` - Target App Service geo scope - * `/target/prioritization` - Target App Service prioritization - * `/changeLog/createdDateTime` - App Subscription creation timestamp - * `/changeLog/updatedDateTime` - App Subscription last updated timestamp - * `/changeLog/deletedDateTime` - App Subscription deletion timestamp - example: /name + enum: + - /type + - /attachmentStatus + - /changeLog/createdDateTime + - /changeLog/updatedDateTime operator: type: string - description: | - Possible operators to use on filters: - * `=` - equal - * `!=` - not equal - * `>` - greater than - * `<` - less than - * `IN` - in - * `NOT IN` - not in - * `LIKE` - like - * `ILIKE` - case-insensitive like - * `BETWEEN` - between - * `NOT BETWEEN` - not between - example: = values: type: array items: type: string - example: Gateway - AppSubscriptionOrFilter: + CloudRouterRouteAggregationsFilter: + description: Top-level filter that can be either an AND expression or OR expression + anyOf: + - $ref: '#/components/schemas/CloudRouterRouteAggregationAndExpression' + - $ref: '#/components/schemas/CloudRouterRouteAggregationOrExpression' + RaAttachmentSortItem: type: object properties: - or: - maxItems: 3 + property: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + enum: + - /type + - /uuid + - /attachmentStatus + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + direction: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + CloudRouterRouteAggregationsSearchBase: + type: object + properties: + filter: + $ref: '#/components/schemas/CloudRouterRouteAggregationsFilter' + pagination: + $ref: '#/components/schemas/Pagination' + sort: type: array + minItems: 1 + maxItems: 3 items: - $ref: "#/components/schemas/AppSubscriptionSimpleExpression" - AppSubscriptionSortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/AppSubscriptionSortDirection" - property: - $ref: "#/components/schemas/AppSubscriptionSortBy" - AppSubscriptionSortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - AppSubscriptionSortBy: - type: string - description: | - Possible field names to use on '400_InvalidSorting': - * `/uuid` - App Subscription uuid - * `/state` - App Subscription status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime - default: /changeLog/updatedDateTime - AppSubscriptionSearchResponse: + $ref: '#/components/schemas/RaAttachmentSortItem' + CloudRouterRouteAggregationsSearchResponse: type: object properties: pagination: - $ref: "#/components/schemas/Pagination" + $ref: '#/components/schemas/Pagination' data: + description: List of route aggregation attachments for a given cloud router type: array - description: Data returned from the API call. items: - $ref: "#/components/schemas/AppSubscription" - GatewaySearchRequest: + $ref: '#/components/schemas/ConnectionRouteAggregationData' + CloudRouterExpression: type: object properties: - filter: - $ref: "#/components/schemas/SearchFilter" - pagination: - $ref: "#/components/schemas/PaginationRequest" - sort: + and: + $ref: '#/components/schemas/CloudRouterExpressions' + or: + $ref: '#/components/schemas/CloudRouterExpressions' + property: + $ref: '#/components/schemas/SearchField' + operator: + 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 + type: string + values: type: array items: - $ref: "#/components/schemas/GatewaySortCriteria" - description: Search gateways - GatewaySortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/GatewaySortDirection" - property: - $ref: "#/components/schemas/GatewaySortBy" - GatewaySortDirection: + type: string + CloudRouterExpressions: + type: array + items: + $ref: '#/components/schemas/CloudRouterExpression' + SearchField: + 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 + * `/type` - Fabric Cloud Router type + * `/connectionsCount` - Fabric Cloud Router attached connections count + * `/changeLog/createdDateTime` - Fabric Cloud Router creation timestamp + * `/changeLog/updatedDateTime` - Fabric Cloud Router last updated timestamp + * `/changeLog/deletedDateTime` - Fabric Cloud Router deletion timestamp + * `/*` - all-category search type: string + example: /name + CloudRouterSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - GatewaySortBy: - type: string - description: | - Possible field names to use on sorting: - * `/name` - Gateway name - * `/uuid` - Gateway uuid - * `/state` - Gateway status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - example: /changeLog/updatedDateTime + CloudRouterSortBy: + description: Possible field names to use on sorting default: /changeLog/updatedDateTime - GatewayId: type: string - description: Gateway UUID - format: uuid - example: 6658cc3b-18e0-437c-b972-62b51a419a1e - GatewayPackageCode: - type: string - description: Gateway package code enum: - - LAB - GatewayTunnelSearchRequest: + - /name + - /uuid + - /state + - /location/metroCode + - /location/metroName + - /package/code + - /type + - /connectionsCount + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + - /changeLog/deletedDateTime + - /order/termLength + CloudRouterSortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/CloudRouterSortDirection' + property: + $ref: '#/components/schemas/CloudRouterSortBy' + CloudRouterSearchRequest: type: object + description: Search requests containing criteria properties: filter: - $ref: "#/components/schemas/SearchFilter" + $ref: '#/components/schemas/CloudRouterExpression' pagination: - $ref: "#/components/schemas/PaginationRequest" + $ref: '#/components/schemas/PaginationRequest' sort: type: array items: - $ref: "#/components/schemas/GatewayTunnelSortCriteria" - description: Search Gateway Tunnels - GatewayTunnelSortCriteria: + $ref: '#/components/schemas/CloudRouterSortCriteria' + SearchResponse: type: object properties: - direction: - $ref: "#/components/schemas/GatewayTunnelSortDirection" - property: - $ref: "#/components/schemas/GatewayTunnelSortBy" - GatewayTunnelSortDirection: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/CloudRouterReadResponse' + code: + description: Cloud Router package code type: string - description: Sorting direction - default: DESC enum: - - DESC - - ASC - GatewayTunnelSortBy: - type: string - description: | - Possible field names to use on sorting: - * `/name` - Gateway Tunnel name - * `/uuid` - Gateway Tunnel uuid - * `/state` - Gateway Tunnel status - * `/changeLog/createdDateTime` - Date and time when change flow starts - * `/changeLog/updatedDateTime` - Date and time when change object is updated - format: string - example: /changeLog/updatedDateTime - default: /changeLog/updatedDateTime - 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 - Changelog: + - LAB + - BASIC + - STANDARD + - ADVANCED + - PREMIUM + example: LAB + PackageChangeLog: + description: Cloud Router package change log 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 + example: '2020-11-06T07:00:00Z' 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: + example: '2020-11-06T07:00:00Z' + CloudRouterPackage: + description: Fabric Cloud Router Package + type: object + properties: + href: + description: Cloud Router package URI type: string - description: Deleted by User Full Name - example: John Smith - deletedByEmail: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/routerPackages/LAB + type: + description: Type of Router package type: string - description: Deleted by User Email Address - example: john.smith@example.com - deletedDateTime: + enum: + - ROUTER_PACKAGE + example: ROUTER_PACKAGE + code: + $ref: '#/components/schemas/code' + description: + description: Fabric Cloud Router Package description type: string - description: Deleted by Date and Time - format: date-time - example: 2020-11-06T07:00:00Z - description: Change log - PaginationRequest: - type: object - properties: - offset: + totalIPv4RoutesMax: + description: Cloud Router package BGP IPv4 routes limit + type: integer minimum: 0 + example: 50 + totalIPv6RoutesMax: + description: Cloud Router package BGP IPv6 routes limit type: integer - description: Index of the first element. - default: 0 - limit: - minimum: 1 + minimum: 0 + example: 50 + routeFilterSupported: + description: CloudRouter package route filter support + type: boolean + vcCountMax: + description: CloudRouter package Max Connection limit 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 - Project: - required: - - projectId - type: object - properties: - projectId: - type: string - description: Subscriber-assigned project ID - example: 44f4c4f8-2f39-494e-838c-d8e640591be5 - AsnOwnershipChallengeDetails: - required: - - type + minimum: 0 + example: 10 + crCountMax: + description: CloudRouter package Max CloudRouter limit + type: integer + minimum: 0 + example: 3 + vcBandwidthMax: + description: CloudRouter package Max Bandwidth limit + type: integer + minimum: 0 + example: 50 + changeLog: + $ref: '#/components/schemas/PackageChangeLog' + PackageResponse: type: object properties: - type: - $ref: "#/components/schemas/AsnOwnershipChallengeType" - description: Ownership challenge details for public ASN verification - discriminator: - propertyName: type - mapping: - RPKI: "#/components/schemas/AsnOwnershipChallengeRpki" - LOA: "#/components/schemas/AsnOwnershipChallengeLoa" - AsnOwnershipChallengeType: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/CloudRouterPackage' + RouterPackageCode: + description: Router package code type: string - description: Type of ownership challenge enum: - - RPKI - - LOA - x-enum-varnames: - - RPKI - - LOA - AsnOwnershipChallengeRpki: - allOf: - - $ref: "#/components/schemas/AsnOwnershipChallengeDetails" - - type: object - properties: - message: - type: string - description: Challenge message to sign - example: eqx-rpki-challenge-2026-04-21T11:20:00Z-64497 - signature: - type: string - description: Signed challenge value - example: MEUCIQCrExampleBase64SignatureValue7h4Yg== - AsnOwnershipChallengeLoa: - allOf: - - $ref: "#/components/schemas/AsnOwnershipChallengeDetails" - - type: object - properties: - contentFormat: - type: string - description: Document content format - example: pdf - documentReference: - type: string - description: Document reference identifier - example: loa-2026-00019 - SimplifiedLocation: + - LAB + - BASIC + - STANDARD + - ADVANCED + - PREMIUM + ApiServices: + description: Available services details 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: + route: + description: service routes type: string - example: AM - ibx: + status: + description: service status type: string - example: AM1 - deprecated: true - CloudEventData: - type: object - properties: - message: + changedDateTime: + description: service status change date type: string - description: Cloud Event message - resource: - $ref: "#/components/schemas/ResourceData" - auth: - $ref: "#/components/schemas/AuthContext" - ResourceData: + HealthResponse: + description: GET Services Health type: object properties: href: + description: The Canonical URL at which the resource resides. type: string - description: Cloud Event asset href - uuid: - type: string - description: Cloud Event asset uuid - type: + version: + description: Indicator of a version type: string - description: Cloud Event asset type - name: + release: + description: release details. type: string - description: Cloud Event asset name state: + description: status of a service type: string - description: Cloud Event asset state - operation: - $ref: "#/components/schemas/OperationalStatus" - OperationalStatus: - type: object - properties: - operationalStatus: - type: string - description: Operational status for the resource target of the event - AuthContext: + apiServices: + $ref: '#/components/schemas/ApiServices' + ValidateConnectionResponse: + description: Validate Connection specification 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: + uuid: + description: Equinix-assigned connection identifier type: string - description: Cloud Event email - Metric: + bandwidth: + description: Connection bandwidth in Mbps + type: integer + minimum: 0 + maximum: 100000 + redundancy: + $ref: '#/components/schemas/ConnectionRedundancy' + aSide: + $ref: '#/components/schemas/ConnectionSide' + zSide: + $ref: '#/components/schemas/ConnectionSide' + ConnectionResponse: + description: ValidateResponse type: object properties: - type: - type: string - description: Equinix supported metric type - name: - type: string - description: Metric name - unit: - type: string - description: Metric unit - interval: - type: string - description: Metric interval (set automatically based on search range) - resource: - $ref: "#/components/schemas/Metric_resource" - summary: - type: string - description: Metric summary - datapoints: + additionalInfo: + description: Additional information type: array - description: Metric data points items: - $ref: "#/components/schemas/Metric_datapoints" - description: Metric object - maintenanceState: - type: string - description: Maintenance lifecycle state - example: SCHEDULED - enum: - - SCHEDULED - - IN_PROGRESS - - COMPLETED - - CANCELLED - - POSTPONED - SearchFilter: - description: Top-level filter that can be either an AND expression or OR expression - oneOf: - - $ref: "#/components/schemas/SearchAndExpression" - - $ref: "#/components/schemas/SearchOrExpression" - SearchAndExpression: - required: - - and - type: object - properties: - and: - maxItems: 8 - minItems: 1 + $ref: '#/components/schemas/ConnectionSideAdditionalInfo' + data: + description: Connection response data type: array items: - $ref: "#/components/schemas/SearchFilterExpression" - SearchFilterExpression: - description: Filter expression that can be AND, OR, or a simple expression - oneOf: - - $ref: "#/components/schemas/SearchAndExpression" - - $ref: "#/components/schemas/SearchOrExpression" - - $ref: "#/components/schemas/SearchSimpleExpression" - SearchOrExpression: - required: - - or + $ref: '#/components/schemas/ValidateConnectionResponse' + NetworkPostRequest: type: object + description: Create Network properties: - or: - maxItems: 8 - minItems: 1 + type: + $ref: '#/components/schemas/NetworkType' + name: + description: Customer-provided network name + type: string + scope: + $ref: '#/components/schemas/NetworkScope' + location: + $ref: '#/components/schemas/SimplifiedLocation' + project: + $ref: '#/components/schemas/Project' + notifications: + description: Preferences for notifications on network configuration or status changes type: array items: - $ref: "#/components/schemas/SearchFilterExpression" - SearchSimpleExpression: + $ref: '#/components/schemas/SimplifiedNotification' required: - - operator - - property - - values + - type + - name + - scope + - notifications + Network: + description: Network specification + type: object + allOf: + - type: object + properties: + href: + description: Network URI + type: string + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784 + uuid: + description: Equinix-assigned network identifier + type: string + format: uuid + example: 92dc376a-a932-43aa-a6a2-c806dedbd784 + state: + $ref: '#/components/schemas/NetworkState' + example: ACTIVE + 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: + description: Network sub-resources links + type: array + readOnly: true + items: + $ref: '#/components/schemas/Link' + required: + - href + - uuid + - state + - changeLog + - $ref: '#/components/schemas/NetworkPostRequest' + NetworkChangeOperation: + description: Network change operation data type: object properties: - property: + op: + description: Handy shortcut for operation name type: string - operator: + enum: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter + type: string + example: /name + value: + description: new value for updated parameter + required: + - op + - path + - value + NetworkUpdateRequest: + description: Fabric Network Update Request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/NetworkChangeOperation' + NetworkFilter: + type: object + properties: + and: + $ref: '#/components/schemas/NetworkSimpleExpression' + or: + $ref: '#/components/schemas/NetworkSimpleExpression' + property: + $ref: '#/components/schemas/NetworkSearchFieldName' + operator: type: string - description: | - "~*" is a case-insensitive glob match, equivalent to ILIKE - the same single "*" wildcard, not POSIX regex - kept as its own operator only because existing callers already send it. - example: = enum: - - = - - "!=" - - IN - - NOT IN - - LIKE - - ILIKE - - BETWEEN - - ">" - - ">=" + - '=' + - '!=' + - '>' + - '>=' - < - <= - - ~* - x-enum-varnames: - - EQUAL - - NOT_EQUAL - - IN - - NOT_IN + - BETWEEN + - NOT BETWEEN - LIKE + - NOT LIKE - ILIKE - - BETWEEN - - GREATER_THAN - - GREATER_THAN_OR_EQUAL_TO - - LESS_THAN - - LESS_THAN_OR_EQUAL_TO - - CASE_INSENSITIVE_REGEX + - NOT ILIKE + - IN + - NOT IN + example: '=' values: - maxItems: 8 - minItems: 1 type: array items: type: string - description: Simple filter expression with property, operator, and values - ConnectionType: + example: Network-1 + NetworkSimpleExpression: + type: array + items: + $ref: '#/components/schemas/NetworkFilter' + NetworkSearchFieldName: + description: Possible field names to use on filters type: string - description: Connection type enum: - - EVPL_VC - - EPL_VC - - EC_VC - - IP_VC - - ACCESS_EPL_VC - - EIA_VC - - EVPLAN_VC - - EPLAN_VC - - EVPTREE_VC - - EPTREE_VC - - IPWAN_VC - - IA_VC - - MC_VC - - IX_VC - - GW_VC - - IPX_VC - Order: + - /name + - /uuid + - /scope + - /type + - /state + - /operation/equinixStatus + - /location/region + - /location/metroCode + - /connectionsCount + - /project/projectId + - /account/globalCustId + - /account/orgId + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + - /changeLog/deletedDateTime + - /* + example: /name + NetworkSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + NetworkSortBy: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + enum: + - /name + - /uuid + - /scope + - /operation/equinixStatus + - /location/region + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + NetworkSortCriteria: 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: 60 - minimum: 1 - type: integer - description: Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case). - default: 1 - contractedBandwidth: - type: integer - description: Contracted bandwidth - SimplifiedNotification: - required: - - emails - - type + direction: + $ref: '#/components/schemas/NetworkSortDirection' + property: + $ref: '#/components/schemas/NetworkSortBy' + NetworkSearchRequest: type: object + description: Search requests containing criteria properties: - type: - type: string - description: Notification Type - example: BANDWIDTH_ALERT - enum: - - NOTIFICATION - - BANDWIDTH_ALERT - - CONNECTION_APPROVAL - - PROFILE_LIFECYCLE - - ALL - - SALES_REP_NOTIFICATIONS - - TECHNICAL - - ORDERING - - QUOTE_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 - phone: + filter: + $ref: '#/components/schemas/NetworkFilter' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array - description: Array of contact phone numbers items: - $ref: "#/components/schemas/Phone" - ConnectionRedundancy: + $ref: '#/components/schemas/NetworkSortCriteria' + NetworkSortDirectionResponse: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + NetworkSortByResponse: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + enum: + - /name + - /type + - /uuid + - /state + - /scope + - /location/region + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + NetworkSortCriteriaResponse: type: object properties: - group: - type: string - description: Redundancy group identifier (UUID of primary connection) - priority: - $ref: "#/components/schemas/ConnectionPriority" - name: - type: string - description: Customer-provided name for the redundancy group - description: - type: string - description: Customer-provided description for the redundancy group - description: Connection redundancy configuration - ConnectionSide: + direction: + $ref: '#/components/schemas/NetworkSortDirectionResponse' + property: + $ref: '#/components/schemas/NetworkSortByResponse' + NetworkSearchResponse: + description: List of networks type: object properties: - serviceToken: - $ref: "#/components/schemas/ServiceToken" - accessPoint: - $ref: "#/components/schemas/AccessPoint" - additionalInfo: + pagination: + $ref: '#/components/schemas/Pagination' + sort: 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 - ConnectionSideAdditionalInfo: + $ref: '#/components/schemas/NetworkSortCriteriaResponse' + data: + type: array + items: + $ref: '#/components/schemas/Network' + NetworkConnections: + description: List of network changes type: object properties: - key: - type: string - description: Key - value: - type: string - description: Value - description: Additional information - marketplaceSubscription: + pagination: + $ref: '#/components/schemas/Pagination' + data: + type: array + items: + $ref: '#/components/schemas/Connection' + NetworkChangeStatus: + description: Current outcome of the change flow + type: string + enum: + - APPROVED + - COMPLETED + - FAILED + - REJECTED + - REQUESTED + - SUBMITTED_FOR_APPROVAL + NetworkChange: + description: Current state of latest network change type: object properties: href: + description: Network URI 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 - - PROVISIONING - - "" - Change: - required: - - createdDateTime - - type - type: object - properties: + 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 - type: type: string - description: Type of change - enum: - - CONNECTION_CREATION - - CONNECTION_UPDATE - - CONNECTION_DELETION - - CONNECTION_PROVIDER_STATUS_REQUEST + format: uuid + example: 4b17da68-3d6b-436d-9c8f-2105f3b950d9 + type: + $ref: '#/components/schemas/NetworkChangeType' + example: NETWORK_CREATION status: - type: string - description: Current outcome of the change flow - enum: - - APPROVED - - COMPLETED - - FAILED - - REJECTED - - REQUESTED - - SUBMITTED_FOR_APPROVAL + $ref: '#/components/schemas/NetworkChangeStatus' + example: COMPLETED createdDateTime: - type: string description: Set when change flow starts + type: string format: date-time - example: 2020-11-06T07:00:00Z + 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 + format: date-time + example: '2020-11-06T07:00:00Z' data: - $ref: "#/components/schemas/ConnectionChangeOperation" - description: Current state of latest connection change - ConnectionOperation: + type: array + items: + $ref: '#/components/schemas/NetworkChangeOperation' + NetworkChangeResponse: + description: List of network changes type: object properties: - providerStatus: - $ref: "#/components/schemas/ProviderStatus" - equinixStatus: - $ref: "#/components/schemas/EquinixStatus" - operationalStatus: - type: string - description: Connection operational status - enum: - - UP - - DOWN - errors: + pagination: + $ref: '#/components/schemas/Pagination' + data: 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 - maintenanceStatus: - allOf: - - $ref: "#/components/schemas/maintenanceState" - lockEnabled: - type: boolean - description: Indicates whether the connection configuration is locked due to an ongoing or scheduled maintenance. - example: true - description: Connection type-specific operational data - SimplifiedAccount: + $ref: '#/components/schemas/NetworkChange' + virtualConnectionUuid: + title: fabricConnectionUuid type: object + description: UUID of the Fabric Connection Instance + example: + uuid: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f 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: + href: + description: Connection URI type: string - description: Account name - deprecated: true - resellerAccountNumber: - type: integer - description: Reseller account number - format: int64 - resellerAccountName: + format: uri + readOnly: true + type: type: string - description: Reseller account name - resellerUcmId: + description: Connection Type + uuid: type: string - description: Reseller account ucmId - resellerOrgId: - type: integer - description: Reseller customer organization identifier - format: int64 - ConnectionChangeOperation: + format: uuid + description: Connection UUID. required: - - op - - path - - value + - uuid + ipv4: type: object + description: EPT service network information + title: ipv4 properties: - op: + primary: type: string - description: Handy shortcut for operation name - example: add - path: + format: ipv4 + description: Primary Timing Server IP Address + secondary: 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 - - CONNECTION_CREATION_RETRY - - CONNECTION_DELETION_RETRY - - CONNECTION_PROVIDER_STATUS_UPDATE_REQUEST - ConnectionAcceptanceData: - type: object - properties: - zSide: - $ref: "#/components/schemas/ConnectionSide" - providerBandwidth: - type: integer - description: Authorization key bandwidth in Mbps - readOnly: true - operation: - $ref: "#/components/schemas/ConnectionOperation" - description: Connection acceptance data - ConnectionRouteTableEntry: + format: ipv4 + description: Secondary Timing Server IP Address + networkMask: + type: string + format: ipv4 + description: Network Mask + defaultGateway: + type: string + format: ipv4 + description: Gateway Interface IP address + example: + primary: 10.0.0.1 + secondary: 10.0.0.2 + networkMask: 255.255.255.240 + defaultGateway: 10.0.0.3 required: - - changeLog - - type + - primary + - secondary + - networkMask + md5: type: object properties: type: - $ref: "#/components/schemas/RouteTableEntryType" - protocolType: - $ref: "#/components/schemas/RouteTableEntryProtocolType" - state: type: string - example: ACTIVE enum: - - ACTIVE - - INACTIVE - prefix: + - ASCII + - HEX + keyNumber: + type: integer + minimum: 1 + maximum: 65535 + example: 10 + description: The authentication Key ID. + key: type: string - example: 192.168.10.0/24 - nextHop: + format: byte + pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ + description: The plaintext authentication key. Must be Base64 encoded. For ASCII type, the key must contain printable ASCII characters, range 10-20 characters. For HEX type, range should be 10-40 characters. + ntpAdvanceConfiguration: + type: array + description: NTP Advanced configuration - MD5 Authentication. + items: + $ref: '#/components/schemas/md5' + ptpAdvanceConfiguration: + type: object + description: PTP Advanced Configuration. + properties: + timeScale: 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: + enum: + - ARB + - PTP + example: ARB + description: Time Scale value, ARB denotes Arbitrary and PTP denotes Precision Time Protocol. + domain: type: integer - description: Inbound Multi Exit Discriminator attribute - format: int64 - example: 1000 - outboundMED: + minimum: 0 + maximum: 127 + example: 0 + description: The PTP domain value. + priority1: type: integer - description: Outbound Multi Exit Discriminator attribute - format: int64 - example: 2000 - routesMax: + minimum: 0 + maximum: 248 + example: 128 + description: The priority1 value determines the best primary clock, Lower value indicates higher priority. + priority2: 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: + minimum: 0 + maximum: 248 + example: 128 + 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. + logAnnounceInterval: type: integer - description: AS path prepend count - format: int64 - example: 3 - inboundMED: + 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: Inbound Multi Exit Discriminator attribute - format: int64 - example: 1000 - outboundMED: + 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: Outbound Multi Exit Discriminator attribute - format: int64 - example: 2000 - routesMax: + example: -4 + description: Logarithmic value that controls the rate of PTP DelayReq packets. Default is -4 (16 packets per second), Unit packets/second.. + enum: + - -5 + - -4 + - -3 + - -2 + - -1 + - 0 + - 1 + transportMode: + type: string + enum: + - MULTICAST + - UNICAST + - HYBRID + grantTime: type: integer - description: Maximum learnt prefixes limit - format: int64 - example: 1000 - operation: - $ref: "#/components/schemas/BGPConnectionOperation" - RoutingProtocolBFD: - required: - - enabled + 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. + minimum: 30 + maximum: 7200 + example: 300 + precisionTimeOrder: + title: precisionTimeOrder type: object + description: Precision Time Order properties: - enabled: - type: boolean - interval: + purchaseOrderNumber: + description: Purchase order number type: string - example: "100" - DirectConnectionIpv4: + customerReferenceNumber: + description: Customer reference number + type: string + orderNumber: + description: Order Reference Number + type: string + precisionTimeServiceRequest: + title: precisionTimeServiceRequest type: object + description: Create Precision Time Service Request Schema. properties: - equinixIfaceIp: + type: type: string - description: Equinix side Interface IP address - example: 192.168.100.0/30 - DirectConnectionIpv6: + enum: + - NTP + - PTP + description: Precision Time Service Type refers to the corresponding Protocol. + 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' required: - - equinixIfaceIp + - name + - type + - package + - connections + - ipv4 + timeServiceOperation: + description: time service operational data type: object properties: - equinixIfaceIp: + operationalStatus: + description: time service operational status type: string - description: Equinix side Interface IP address - example: 2001:db8:c59b::/1 - RoutingProtocolBGPData: + enum: + - UP + - DOWN + - DEGRADED + precisionTimePackagePostResponse: + title: precisionTimePackagePostResponse type: object + example: + href: https://api.equinix.com/fabric/v4/timeServicePackage/NTP_STANDARD + code: NTP_STANDARD properties: - type: - type: string - description: Routing protocol type - enum: - - BGP - name: + href: 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: + format: uri + code: type: string - description: BGP authorization key - example: testAuthKey - asOverrideEnabled: - type: boolean - description: Enable AS number override - bfd: - $ref: "#/components/schemas/RoutingProtocolBFD" + enum: + - NTP_STANDARD + - NTP_ENTERPRISE + - PTP_STANDARD + - PTP_ENTERPRISE + required: + - code + virtualConnectionSide: + title: fabricConnectionAccessPoint + type: object + description: Fabric Connection access point object. + properties: + accessPoint: + $ref: '#/components/schemas/AccessPoint' + virtualConnectionTimeServiceResponse: + title: fabricConnectionResponse + type: object + description: Fabric Connection Precision Time Service Response Object + properties: href: + description: Connection URI 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 + readOnly: true + type: + type: string + description: Connection Type. 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" - project: - $ref: "#/components/schemas/RoutingProtocolProject" - connection: - $ref: "#/components/schemas/RoutingProtocolConnection" - RoutingProtocolDirectData: + description: Connection UUID. + aSide: + $ref: '#/components/schemas/virtualConnectionSide' + zSide: + $ref: '#/components/schemas/virtualConnectionSide' + precisionTimeServiceResponse: + title: precisionTimeServiceResponse type: object + description: Precision Time Service Response Schema. properties: + href: + type: string + format: uri + description: Precision Time Service URI. type: type: string - description: Routing protocol type + description: Precision Time Service type refers to the corresponding protocol. enum: - - DIRECT + - NTP + - PTP 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 + description: Precision Time Service Name. uuid: type: string - description: Routing protocol identifier format: uuid - example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + description: Precision Time Service UUID. state: + description: Precision Time Service Status. type: string enum: - - PROVISIONED + - CANCELLED + - CANCELLING + - CONFIGURING + - CONFIGURING_FAILED + - DRAFT + - DEPROVISIONING + - DEPROVISIONING_FAILED - DEPROVISIONED + - PROVISIONED - PROVISIONING - - DEPROVISIONING + - PROVISIONING_FAILED - REPROVISIONING - - FAILED + - REPROVISIONING_FAILED operation: - $ref: "#/components/schemas/RoutingProtocolOperation" - change: - $ref: "#/components/schemas/RoutingProtocolChange" - changelog: - $ref: "#/components/schemas/Changelog" + $ref: '#/components/schemas/timeServiceOperation' + package: + $ref: '#/components/schemas/precisionTimePackagePostResponse' + connections: + type: array + description: Fabric Connections associated with Precision Time Service. + minItems: 1 + maxItems: 2 + uniqueItems: true + items: + $ref: '#/components/schemas/virtualConnectionTimeServiceResponse' + ipv4: + $ref: '#/components/schemas/ipv4' + ntpAdvancedConfiguration: + $ref: '#/components/schemas/ntpAdvanceConfiguration' + ptpAdvancedConfiguration: + $ref: '#/components/schemas/ptpAdvanceConfiguration' project: - $ref: "#/components/schemas/RoutingProtocolProject" - connection: - $ref: "#/components/schemas/RoutingProtocolConnection" - 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: + $ref: '#/components/schemas/Project' + account: + $ref: '#/components/schemas/SimplifiedAccount' + order: + $ref: '#/components/schemas/precisionTimeOrder' + changeLog: + $ref: '#/components/schemas/Changelog' required: - - type - uuid + - href + - type + - state + - package + precisionTimeChangeOperation: 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 + description: Fabric Precision Timing change operation data properties: op: type: string description: Handy shortcut for operation name enum: - - add - replace + - add - remove path: type: string description: path inside document leading to updated parameter - example: / + enum: + - /name + - /package/code + - /ipv4 + - /ntpAdvancedConfiguration + - /ptpAdvancedConfiguration value: - $ref: "#/components/schemas/RoutingProtocolBase" - description: Routing Protocol change operation data - PublicPeeringConnectionRequest: - type: object - properties: - uuid: - type: string - description: connection id - format: uuid - example: b44c6e6c-2c36-4488-b3f1-47064357b5b4 - description: Public Peering Connection - RoutingProtocolRequest: - type: object - properties: - customerAsn: - type: integer - description: Customer Autonomous System Number (ASN) - example: 1100 - macAddress: - type: string - description: MAC address of the customer interface - example: 00:11:22:33:44:55 - bgpIpv4: - $ref: "#/components/schemas/ExchangeServiceRequestBgp" - bgpIpv6: - $ref: "#/components/schemas/ExchangeServiceRequestBgp" - ExchangeServiceOrder: - type: object - properties: - purchaseOrderNumber: - type: string - description: Purchase order number reference. - example: "156576" - orderId: - type: string - description: Equinix-assigned order identifier. - readOnly: true - customerReferenceId: - type: string - description: Your own reference for this Exchange Service. - orderNumber: - type: string - description: Equinix order reference number. - example: 1-129105284100 - orderLineItemNumber: - type: string - description: Order Reference Number for Sales Assisted Order - readOnly: true - domainOrderNumber: - type: string - description: product domain Order Number for Sales Assisted Order - readOnly: true - uuid: - type: string - description: Equinix-assigned order identifier, this is a derived response attribute - format: uuid - readOnly: true - description: Ordering and billing reference details for this Exchange Service. - ExchangeServiceNotification: + description: new value for updated parameter required: - - registeredUsers - - type + - op + - path + - value + TimeServiceSimpleExpression: type: object properties: - type: + property: + 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 type: string - description: Internet Exchange Service Notification Type - enum: - - NOTIFICATION - - TECHNICAL - - PEERING - - ESCALATION - - ORDERING - registeredUsers: + example: /name + operator: + 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 + type: string + example: '=' + values: type: array - description: Array of registered users items: type: string - PublicPeeringConnectionResponse: + example: FabricPrecisionTimeService-1 + TimeServiceOrFilter: type: object properties: - type: - type: string - description: Connection type IX_VC - format: enum - example: IX_VC - href: - type: string - description: URI - format: string - example: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 - uuid: - type: string - description: uuid - format: uuid - example: b44c6e6c-2c36-4488-b3f1-47064357b5b4 - RoutingProtocolResponse: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/TimeServiceSimpleExpression' + TimeServiceFilter: + type: object + anyOf: + - $ref: '#/components/schemas/TimeServiceSimpleExpression' + - $ref: '#/components/schemas/TimeServiceOrFilter' + TimeServiceFilters: type: object properties: - customerAsn: - type: integer - description: Customer Autonomous System Number (ASN) - example: 1100 - macAddress: - type: string - description: MAC address of the customer interface - example: 00:11:22:33:44:55 - vlan: - type: integer - description: VLAN ID - format: int64 - example: 3292 - routeServerAsn: - type: integer - description: Equinix Route Server ASN - format: int64 - example: 1100 - bgpIpv4: - $ref: "#/components/schemas/ExchangeServiceResponseBgp" - bgpIpv6: - $ref: "#/components/schemas/ExchangeServiceResponseBgp" - routeCollector: - $ref: "#/components/schemas/RouteCollector" - PlatformChangelog: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/TimeServiceFilter' + TimeServiceSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + TimeServiceSortBy: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime + type: string + enum: + - /name + - /uuid + - /state + - /type + - /package/code + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + TimeServiceSortCriteria: type: object properties: - createdBy: - type: string - description: Created by User Key - example: johnsmith - 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 - 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 - deletedDateTime: - type: string - description: Deleted by Date and Time - format: date-time - example: 2020-11-06T07:00:00Z - description: Change log - ExchangeServiceAdditionalInfo: + direction: + $ref: '#/components/schemas/TimeServiceSortDirection' + property: + $ref: '#/components/schemas/TimeServiceSortBy' + TimeServicesSearchRequest: type: object + description: Search requests containing criteria properties: - errorCode: - type: string - description: Error code shown if an operation on the Exchange Service fails - errorMessage: - type: string - description: Generic message shown if an operation on the Exchange Service fails - description: Additional information regarding the specified Exchange Service - InternetAccessBillingType: - type: string - enum: - - FIXED - - USAGE_BASED - - BURST_BASED - x-enum-varnames: - - FIXED - - USAGE_BASED - - BURST_BASED - InternetAccessAccount: - required: - - accountNumber + filter: + $ref: '#/components/schemas/TimeServiceFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/TimeServiceSortCriteria' + ServiceSearchResponse: type: object properties: - accountNumber: - type: string - description: Account number - href: - type: string - description: Account URL path - format: uri - example: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 - InternetAccessRoutingProtocolType: - type: string - enum: - - BGP - - DIRECT - - STATIC - x-enum-varnames: - - BGP - - DIRECT - - STATIC - InternetAccessExportPolicy: - type: string - description: Denotes which routes should be advertised to the internet - example: FULL - enum: - - FULL - - DEFAULT - - FULL_DEFAULT - - PARTIAL - x-enum-varnames: - - FULL - - DEFAULT - - FULL_DEFAULT - - PARTIAL - InternetAccessCustomerAsnRange: - type: string - description: Customer Autonomous System Number range. Based on the value a proper private ASN will be generated. - enum: - - BITS_16 - - BITS_32 - x-enum-varnames: - - BITS_16 - - BITS_32 - InternetAccessChange: - required: - - href + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/precisionTimeServiceResponse' + connectionLink: type: object properties: href: type: string - description: URI of the change object format: uri - InternetAccessLocation: - required: - - ibx - - metroCode - - metroHref - - region + 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 + precisionTimeServiceConnectionsResponse: + title: precisionTimeServiceConnectionResponse type: object + description: EPT service instance's L2 connections properties: - metroHref: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call + type: array + items: + $ref: '#/components/schemas/connectionLink' + precisionTimePackageResponse: + title: precisionTimePackageRespose + type: object + 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' + description: EPT Service Package Information + properties: + href: type: string - description: Metro URL path for the linked resource format: uri - example: https://api.equinix.com/fabric/v4/metros/WA - metroCode: - pattern: ^[A-Z]{2}$ + type: type: string - description: Code representing the metro - example: WA - region: + enum: + - TIME_SERVICE_PACKAGE + code: type: string - description: Geographic region - example: EMEA enum: - - APAC - - EMEA - - AMER - ibx: + - NTP_STANDARD + - NTP_ENTERPRISE + - PTP_STANDARD + - PTP_ENTERPRISE + bandwidth: + type: integer + example: 10 + description: Connection bandwidth in Mbps. + clientsPerSecondMax: + type: integer + minimum: 0 + example: 100 + description: Max. number of clients that can be synchronized per second at a packet rate of 1 per second. + redundancySupported: + type: boolean + example: false + description: Is Redundant virtual connection supported for the package code. + multiSubnetSupported: + type: boolean + example: true + description: Is Multiple subnet supported for the package code. + accuracySlaUnit: type: string - description: IBX data center code - example: WA1 - InternetAccessRoutingProtocol: + example: microseconds + description: Accuracy SLA unit. + accuracySla: + type: integer + example: 50 + description: Accuracy SLA for the package code, -1 value denotes the accuracySla is not published. + accuracySlaMin: + type: integer + example: 1 + minimum: 1 + description: Typical minimum Accuracy for the package code. + accuracySlaMax: + type: integer + minimum: 1 + example: 10 + description: Typical maximum Accuracy for the package code. + changelog: + $ref: '#/components/schemas/Changelog' required: - - connections - - customerRoutes - type + - code + - bandwidth + precisionTimeServicePackagesResponse: + title: precisionTimeServicePackagesResponse type: object + description: Precision Packages properties: - type: - $ref: "#/components/schemas/InternetAccessRoutingProtocolType" - customerRoutes: - type: array - items: - $ref: "#/components/schemas/InternetAccessCustomerRoute" - connections: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call type: array items: - $ref: "#/components/schemas/InternetAccessConnection" - discriminator: - propertyName: type - mapping: - BGP: "#/components/schemas/InternetAccessRoutingProtocolBgp" - DIRECT: "#/components/schemas/InternetAccessRoutingProtocolDirect" - STATIC: "#/components/schemas/InternetAccessRoutingProtocolStatic" - InternetAccessCustomerRoute: - type: object - properties: - ipBlock: - $ref: "#/components/schemas/InternetAccessIpBlock" - InternetAccessRoutingProtocolBgp: - allOf: - - $ref: "#/components/schemas/InternetAccessRoutingProtocol" - - required: - - exportPolicy - type: object - properties: - exportPolicy: - $ref: "#/components/schemas/InternetAccessExportPolicy" - asn: - $ref: "#/components/schemas/InternetAccessRoutingProtocolBgp_asn" - customerAsn: - type: integer - description: Customer ASN. Valid range is 1-64495 or 131072-4199999999. Currently this option is only available for EIA over dedicated port. - format: int64 - example: 11111 - deprecated: true - bgpAuthKey: - type: string - description: BGP authentication key. This field is deprecated and will be removed in future releases. Please use bgpAuthType instead to determine if a BGP authentication key is configured. - example: SecretKey - deprecated: true - bgpAuthType: - $ref: "#/components/schemas/InternetAccessBgpAuthType" - customerAsnRange: - $ref: "#/components/schemas/InternetAccessCustomerAsnRange" - InternetAccessBgpAuthType: + $ref: '#/components/schemas/precisionTimePackageResponse' + SubscriptionState: type: string - description: Indicates whether a BGP authentication key is configured. AUTH_KEY when bgpAuthKey is set, NONE otherwise. - example: AUTH_KEY - default: NONE + description: Subscription State enum: - - AUTH_KEY - - NONE - x-enum-varnames: - - AUTH_KEY - - NONE - InternetAccessRoutingProtocolDirect: - allOf: - - $ref: "#/components/schemas/InternetAccessRoutingProtocol" - InternetAccessRoutingProtocolStatic: - allOf: - - $ref: "#/components/schemas/InternetAccessRoutingProtocol" - InternetAccessBilling: - required: - - type + - ACTIVE + - EXPIRED + - CANCELLED + - GRACE_PERIOD + SubscriptionTrial: type: object + description: Free Trial Subscription properties: - type: - $ref: "#/components/schemas/InternetAccessBillingType" enabled: type: boolean - description: Indicates whether the billing is enabled - startDate: + description: Free Trial Enabled + expiryDateTime: type: string - description: The start date for the billing period format: date-time - InternetAccessOrder: - allOf: - - $ref: "#/components/schemas/Order" - - type: object - properties: - href: - type: string - description: Order URI - format: uri - example: https://api.equinix.com/colocations/v2/orders/100200300 - InternetAccessUseCase: - type: string - enum: - - MAIN - - MANAGEMENT_ACCESS - x-enum-varnames: - - MAIN - - MANAGEMENT_ACCESS - SearchSort: - type: array - items: - $ref: "#/components/schemas/SearchSortItem" - SearchSortItem: - required: - - direction - - property + description: Free Trial Expiry Date + SubscriptionRouterPackageType: type: object + description: Cloud Router Package Type properties: - direction: - type: string - example: ASC - enum: - - ASC - - DESC - property: + code: type: string - IpBlockLocation: - required: - - metroCode + description: Cloud Router package code + SubscriptionAsset: type: object + description: Asset information properties: - metroHref: - type: string - description: Metro URL path for the linked resource - example: https://api.equinix.com/fabric/v4/metros/WA - metroCode: - pattern: ^[A-Z]{2}$ + type: type: string - example: WA - TypeOfIpBlockProduct: - type: string - enum: - - IPV4_IP_BLOCK - - IPV6_IP_BLOCK - x-enum-varnames: - - IPV4_IP_BLOCK - - IPV6_IP_BLOCK - IpBlockProjectRequest: - required: - - projectId + 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 + SubscriptionEntitlementResponse: type: object + description: Subscription entitlement properties: - projectId: + uuid: type: string - description: project id - IpBlockAccount: - required: - - accountNumber + description: Subscription Entitlement Id + format: uuid + quantityEntitled: + type: integer + minimum: 0 + description: Quantity entitled for the subscription + quantityConsumed: + type: integer + minimum: 0 + description: Quantity consumed from the entitlement + quantityAvailable: + type: integer + minimum: 0 + description: Quantity available from the entitlement + asset: + $ref: '#/components/schemas/SubscriptionAsset' + SubscriptionResponse: type: object + description: Subscription Response properties: - accountNumber: + href: type: string - description: account number - IpBlockOrderRequest: - type: object - properties: - purchaseOrderNumber: + format: uri + description: Subscription URL + uuid: type: string - description: Purchase order number - nullable: true - orderNumber: + format: uuid + description: Unique identifier of the Subscription + state: + $ref: '#/components/schemas/SubscriptionState' + marketplace: type: string - description: Order Number - nullable: true - orderLine: + description: Marketplace Type + enum: + - AWS + - GCP + - AZURE + - REDHAT + offerType: type: string - description: Order Line Number - nullable: true - IpBlockRegulations: - required: - - addressingPlans - - questions - type: object - properties: - addressingPlans: + 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 addressing plans items: - $ref: "#/components/schemas/IpBlockAddressingPlan" - questions: - $ref: "#/components/schemas/IpBlockRegulations_questions" - IpBlockAddressingPlan: + type: string + description: List of available metro + entitlements: + type: array + items: + $ref: '#/components/schemas/SubscriptionEntitlementResponse' + description: List of entitlements associated with the subscription + changelog: + $ref: '#/components/schemas/Changelog' required: - - purpose - - size + - state + - marketplace + - entitlements + Stream: + description: Stream object type: object properties: - purpose: + href: + description: Stream URI type: string - description: purpose - size: - type: integer - description: size - format: int32 - IpBlockPrefixLength: - maximum: 128 - minimum: 1 - type: integer - description: IpBlockPrefix length - IpBlockPrefix: - type: string - description: CIDR prefix - IpBlockState: - type: string - description: Current state of the IP Block - enum: - - PENDING - - ACTIVE - - DELETING - - DELETED - - FAILED - IpBlockOwnership: - type: string - description: IpBlockOwnership of the IP Block - enum: - - EQUINIX - - CUSTOMER - IpBlockOrderResponse: - required: - - href - - orderNumber - type: object - properties: - href: - type: string - description: Order URI format: uri - example: https://api.equinix.com/colocations/v2/orders/1-34834234 - orderNumber: + readOnly: true + example: https://api.equinix.com/fabric/v4/streams/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + uuid: + description: Equinix-assigned access point identifier type: string - description: Order number - IpBlockProject: - required: - - projectId - type: object - properties: - href: + format: uuid + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + type: + description: type type: string - description: URI of the project - format: uri - projectId: + enum: + - TELEMETRY_STREAM + name: + description: Customer-provided stream name type: string - description: project id - IpBlockAsset: - required: - - href - - type - - uuid - type: object - properties: - type: - $ref: "#/components/schemas/IpBlockProductType" - uuid: + description: + description: Customer-provided stream description type: string - description: Unique identifier for the asset - format: uuid - href: + project: + $ref: '#/components/schemas/Project' + account: + $ref: '#/components/schemas/SimplifiedAccount' + notifications: + description: Preferences for stream notifications, set at creation + type: array + items: + $ref: '#/components/schemas/SimplifiedNotification' + state: + description: Stream provision state type: string - description: Resource URL path for the linked resource - example: https://api.equinix.com/fabric/v4/internetAccesses/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - IpBlockChange: - required: - - href + enum: + - PROVISIONING + - PROVISIONED + - REPROVISIONING + - DEPROVISIONING + - DEPROVISIONED + - FAILED + assetsCount: + description: Stream assets count + type: integer + example: 1 + streamSubscriptionsCount: + description: Stream subscriptions count + type: integer + example: 2 + alertRulesCount: + description: Stream alert rules count + type: integer + example: 3 + changeLog: + $ref: '#/components/schemas/Changelog' + GetAllStreamResponse: type: object properties: - href: - type: string - description: URI of the IpBlockChange object - format: uri - IpBlockChangeLog: - required: - - createdDateTime + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/Stream' + StreamPostRequest: type: object + description: Create Stream + required: + - type + - name + - project properties: - createdDateTime: + type: type: string - format: date-time - updatedDateTime: + enum: + - TELEMETRY_STREAM + name: + description: Customer-provided stream name type: string - format: date-time - deletedDateTime: + description: + description: Customer-provided stream description type: string - format: date-time - PatchIpBlockRequestBodyItem: - required: - - op - - path + project: + $ref: '#/components/schemas/Project' + account: + $ref: '#/components/schemas/SimplifiedAccount' + notifications: + description: Preferences for stream notifications. Optional; at most one entry, of type ALL, with up to 12 emails. Set at creation only. + type: array + maxItems: 1 + items: + $ref: '#/components/schemas/SimplifiedNotification' + StreamSearchSimpleExpression: type: object properties: - op: + property: + description: | + Possible field names to use on filters: + * `/uuid` - Stream uuid + * `/name` - Stream name + * `/state` - Stream state (`DEPROVISIONED` returned only when explicitly requested) + * `/type` - Stream type + * `/description` - Stream description + * `/project/projectId` - Stream project id + * `/changeLog/createdDateTime` - Stream created date time + * `/changeLog/updatedDateTime` - Stream updated date time type: string - description: operation - enum: - - add - - remove - path: + example: /name + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `>` - greater than + * `>=` - greater than or equal to + * `<` - less than + * `<=` - less than or equal to + * `BETWEEN` - between + * `NOT BETWEEN` - not between + * `LIKE` - like + * `ILIKE` - like case-insensitive + * `IN` - in + * `NOT IN` - not in type: string - description: path - value: - $ref: "#/components/schemas/PatchIpBlockRequestBodyItem_value" - SortDirection: - type: string + example: '=' + values: + type: array + minItems: 1 + maxItems: 100 + items: + type: string + example: stream-dev-01 + StreamSearchOrFilter: + type: object + properties: + or: + type: array + maxItems: 10 + items: + $ref: '#/components/schemas/StreamSearchSimpleExpression' + StreamSearchFilter: + type: object + anyOf: + - $ref: '#/components/schemas/StreamSearchSimpleExpression' + - $ref: '#/components/schemas/StreamSearchOrFilter' + StreamSearchFilters: + type: object + required: + - and + properties: + and: + type: array + minItems: 1 + maxItems: 10 + items: + $ref: '#/components/schemas/StreamSearchFilter' + StreamSearchSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - SortBy: - type: string + StreamSearchSortBy: description: Possible field names to use on sorting - default: /changeLog/updatedDateTime + default: /changeLog/createdDateTime + type: string 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/role - - /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 - - /operation/maintenanceStatus - - /redundancy/priority - SortCriteriaResponse: + StreamSearchSortCriteria: type: object + required: + - direction + - property properties: direction: - $ref: "#/components/schemas/SortDirection" + $ref: '#/components/schemas/StreamSearchSortDirection' property: - $ref: "#/components/schemas/SortBy" - Price: + $ref: '#/components/schemas/StreamSearchSortBy' + StreamSearchRequest: type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/StreamSearchFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/StreamSearchSortCriteria' + SearchStreamResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/Stream' + StreamPutRequest: + type: object + description: Update Stream + required: + - name 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: + description: Customer-provided stream name type: string - description: Full product name description: + description: Customer-provided stream description type: string - description: Product description - account: - $ref: "#/components/schemas/SimplifiedAccount" - charges: + StreamAssetSimpleExpression: + type: object + properties: + property: + description: | + Possible field names to use on filters: + * `/uuid` - Asset uuid (`=` and `IN` only) + * `/streamUuid` - Stream uuid (`=` and `IN` only) + * `/attachmentStatus` - Asset attachment status (`=`, `IN`, and `NOT IN`) + type: string + example: /streamUuid + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `IN` - in + * `NOT IN` - not in + type: string + example: '=' + values: type: array + minItems: 1 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 - - 60 - 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" - opticalConnect: - allOf: - - $ref: "#/components/schemas/OpticalConnectPrice" - ServiceProfileTypeEnum: - type: string - description: Service profile type - example: L2_PROFILE - enum: - - L2_PROFILE - - L3_PROFILE - - IA_PROFILE - - IX_PROFILE - - IC_PROFILE - - LMAAS_PROFILE - x-eqx-api-linter-skip-rules: - - 40 - ServiceProfileVisibilityEnum: - type: string - enum: - - PRIVATE - - PUBLIC - ServiceProfileStateEnum: + type: string + example: 4719e319-65ae-4001-aabf-ca5f107b9b29 + StreamAssetOrFilter: + type: object + properties: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/StreamAssetSimpleExpression' + StreamAssetFilter: + type: object + anyOf: + - $ref: '#/components/schemas/StreamAssetSimpleExpression' + - $ref: '#/components/schemas/StreamAssetOrFilter' + StreamAssetFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/StreamAssetFilter' + StreamAssetSortDirection: + description: Sorting direction + default: DESC type: string - description: Equinix assigned state. - example: ACTIVE enum: - - ACTIVE - - PENDING_APPROVAL - - DELETED - - REJECTED - ServiceTokenType: + - DESC + - ASC + StreamAssetSortBy: + description: Possible field names to use on sorting + default: /uuid type: string - description: Type of Service Token enum: - - VC_TOKEN - - EPL_TOKEN - ServiceTokenConnection: + - /uuid + - /streamUuid + StreamAssetSortCriteria: + type: object + required: + - direction + - property + properties: + direction: + $ref: '#/components/schemas/StreamAssetSortDirection' + property: + $ref: '#/components/schemas/StreamAssetSortBy' + StreamAssetSearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/StreamAssetFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/StreamAssetSortCriteria' + StreamSearchAsset: + description: Stream object type: object properties: - type: - type: string - description: Type of Connection - enum: - - EVPL_VC - - EPL_VC - - EVPLAN_VC - - EPLAN_VC - - IPWAN_VC - - IP_VC - - EVPTREE_VC - - EPTREE_VC href: + description: Stream Asset URI type: string - description: An absolute URL that is the subject of the link's context. format: uri readOnly: true uuid: + description: Equinix-assigned access point identifier type: string - description: Equinix-assigned connection identifier format: uuid - allowRemoteConnection: - type: boolean - description: Authorization to connect remotely - default: false - allowCustomBandwidth: + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + streamUuid: + description: Equinix-assigned access point identifier + type: string + format: uuid + example: d4b8e7a2-f3b1-4576-a4a9-1366a63df171 + type: + description: Asset type + type: string + example: XF_PORT + metricsEnabled: + description: enable metric 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: + example: true + attachmentStatus: + description: asset status type: string - description: Handy shortcut for operation name enum: - - replace - - add - - remove - path: + - ATTACHING + - ATTACHED + - DETACHED + - DETACHING + - FAILED + projectId: + description: project ic 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 + example: 123 + SearchStreamAssetResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/StreamSearchAsset' + Asset: enum: - - RESEND_EMAIL_NOTIFICATION - OpticalConnectRedundancy: + - ports + - connections + - routers + - metros + - organizations + - projects + - companyProfiles + type: string + StreamAsset: + description: Stream object type: object properties: - priority: + href: + description: Stream Asset URI type: string - description: | - Role within the diverse pair.
PRIMARY - first connection of the pair.
SECONDARY - the diverse connection on a separate path. - example: PRIMARY - enum: - - PRIMARY - - SECONDARY - group: + format: uri + readOnly: true + uuid: + description: Equinix-assigned access point identifier type: string - description: Redundancy group identifier format: uuid - description: | - Optical Connect redundancy configuration.
Required only for DUAL_DIVERSE connection. - OpticalConnectASideRequest: - type: object - properties: - demarcationPoint: - $ref: "#/components/schemas/OpticalConnectDemarcationPoint" - description: | - A-Side configuration. Always a patch panel port from your cage. - OpticalConnectZSideRequest: + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + type: + description: Asset types + type: string + enum: + - XF_PORT + - IP_VC + - EVPLAN_VC + - EVPL_VC + - XF_METRO + - XF_ROUTER + - ORGANIZATION + - PROJECT + - VIRTUAL_DEVICE + - DATA + - MGMT + - SSH + - FAB + - CTRL + metricsEnabled: + description: enable metric + type: boolean + example: false + attachmentStatus: + description: asset status + type: string + enum: + - ATTACHING + - ATTACHED + - DETACHED + - DETACHING + - FAILED + StreamAssetPutRequest: type: object + description: Update Stream Asset properties: - demarcationPoint: - $ref: "#/components/schemas/OpticalConnectDemarcationPoint" - location: - $ref: "#/components/schemas/OpticalConnectLocation" - loa: - $ref: "#/components/schemas/OpticalConnectLOA" - description: | - Z-Side configuration.
For COLO, specify the destination patch panel and ports.
For BMMR and REMOTE, specify the location and Letter of Authorization. - OpticalConnectOrder: + metricsEnabled: + description: enable metric + type: boolean + default: false + example: false + StreamDeviceInterfaceRequest: type: object - properties: - purchaseOrderNumber: - type: string - description: Purchase order number reference. - example: PO-156576 - customerReferenceId: - type: string - description: Your own reference for this connection. - orderNumber: - type: string - description: Equinix order reference number. - example: 1-129105284100 - description: Ordering and billing reference details for this connection. - OpticalConnectNotification: + description: Network Edge Device interface required: - - emails - - type + - id + properties: + id: + description: Network Edge Device interface identifier + type: integer + format: int32 + example: 5 + StreamDevicePutRequest: type: object + description: Attach Network Edge Device interfaces to a Stream properties: - type: - type: string + metricsEnabled: + description: enable metric. Must be true when interfaces are provided + type: boolean + default: false + example: true + interfaces: description: | - Notification category.
NOTIFICATION - states and configuration updates.
ORDERING - order and fulfilment correspondence.
TECHNICAL - maintenance and technical advisories. - example: NOTIFICATION - enum: - - NOTIFICATION - - ORDERING - - TECHNICAL - emails: - type: array - description: Email addresses to notify. - items: - type: string - format: email - registeredUsers: + Complete desired set of Network Edge Device interfaces attached to the stream. Interfaces not in the list are detached; an empty or absent list detaches all interfaces. type: array - description: Usernames of registered Equinix Portal users to notify. items: - type: string - description: Notification preferences for this connection. - OpticalConnectState: - type: string - description: Optical Connect lifecycle states. - readOnly: true - example: PROVISIONED - enum: - - PROVISIONING - - PROVISIONED - - PROVISIONING_FAILED - - REPROVISIONING - - REPROVISIONING_FAILED - - DEPROVISIONING - - DEPROVISIONED - OpticalConnectASideResponse: - type: object - properties: - demarcationPoint: - $ref: "#/components/schemas/OpticalConnectResponseDemarcationPoint" - location: - $ref: "#/components/schemas/OpticalConnectLocation" - description: Originating end as provisioned, with the demarcation point and IBX location. - OpticalConnectZSideResponse: - type: object - properties: - demarcationPoint: - $ref: "#/components/schemas/OpticalConnectResponseDemarcationPoint" - location: - $ref: "#/components/schemas/OpticalConnectLocation" - loa: - $ref: "#/components/schemas/OpticalConnectLOA" - description: Terminating end as provisioned, with the demarcation point and IBX location. - PortType: - type: string - description: Type of Port - enum: - - XF_PORT - PortState: + $ref: '#/components/schemas/StreamDeviceInterfaceRequest' + StreamSubscriptionSelectorExpression: type: string - description: Port lifecycle state - enum: - - PENDING - - PROVISIONING - - REPROVISIONING - - PENDING_CROSS_CONNECT - - PROVISIONED - - ACTIVE - - DEPROVISIONING - - DEPROVISIONED - - INACTIVE - - FAILED - - ADDED - - DELETED - - TO_BE_ADDED - - TO_BE_DELETED - PortOrder: - type: object - properties: - purchaseOrder: - $ref: "#/components/schemas/PortOrderPurchaseOrder" - customerReferenceId: - type: string - description: Customer order reference Id - signature: - $ref: "#/components/schemas/PortOrderSignature" - PortOperation: + description: | + Supported event or metric types to use on event and metric selectors: + * `*` - all events or metrics + * `equinix.fabric.company_profile.*` - company profile events + * `equinix.fabric.connection.*` - connection events, metrics, or alerts + * `equinix.fabric.connection_bgpipv4_session.*` - connection BGP IPv4 session events + * `equinix.fabric.connection_bgpipv6_session.*` - connection BGP IPv6 session events + * `equinix.fabric.connection_maintenance.*` - connection maintenance events + * `equinix.fabric.connection_route_aggregation.*` - connection route aggregation events + * `equinix.fabric.connection_route_filter.*` - connection route filter events + * `equinix.fabric.connection_routing_protocol.*` - connection routing protocol events + * `equinix.fabric.internet_access.*` - internet access service events + * `equinix.fabric.ip_block.*` - IP block events + * `equinix.fabric.metric` - metric collection events + * `equinix.fabric.metro.*` - metro metrics or alerts + * `equinix.fabric.network.*` - network events + * `equinix.fabric.physical_port.*` - physical port events + * `equinix.fabric.port.*` - virtual port events, metrics, or alerts + * `equinix.fabric.port_maintenance.*` - port maintenance events + * `equinix.fabric.route_aggregation.*` - route aggregation events + * `equinix.fabric.route_aggregation_rule.*` - route aggregation rule events + * `equinix.fabric.route_filter.*` - route filter events + * `equinix.fabric.route_filter_rule.*` - route filter rule events + * `equinix.fabric.router.*` - cloud router events or alerts + * `equinix.fabric.router_action.*` - cloud router action events + * `equinix.fabric.router_command.*` - cloud router command events + * `equinix.fabric.routing_protocol_action.*` - routing protocol action events + * `equinix.fabric.service_profile_connection.*` - service profile connection events + * `equinix.fabric.service_token.*` - service token events + * `equinix.fabric.time_service.*` - precision time service events + * `equinix.network.maintenance.*` - network maintenance events + * `equinix.network.repair.*` - network repair events + * `equinix.network_edge.*` - network edge events, metrics, or alerts + * `equinix.network_edge.acl.*` - network edge acl events + * `equinix.network_edge.device.*` - network edge device events + * `equinix.network_edge.device_interface.*` - network edge device interface metrics or alerts + * `equinix.network_edge.devicelinkgroup.*` - network edge device link group events + * `equinix.access_manager.*` - identity access manager events + * `equinix.access_manager.user.role.*` - identity access manager user role events + * `equinix.iam.principal.*` - IAM principal authorization and token events + * `equinix.identity.user.*` - identity user events + * `equinix.identity.organization.*` - identity organization membership events + * `equinix.resource_manager.organization.*` - resource manager organization events + * `equinix.resource_manager.project.*` - resource manager project events + example: equinix.fabric.connection.* + StreamSubscriptionSelector: 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 - maintenanceStatus: - allOf: - - $ref: "#/components/schemas/maintenanceState" - lockEnabled: - type: boolean - description: Indicates whether the port configuration is locked due to an ongoing or scheduled maintenance. - example: true - description: Operational specifications for ports. - PortChange: + include: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/StreamSubscriptionSelectorExpression' + except: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/StreamSubscriptionSelectorExpression' + StreamSubscriptionSinkCredential: type: object + description: Stream subscription sink credentials properties: - uuid: - type: string - description: Uniquely identifies a change type: type: string - description: Type of change + description: credential type enum: - - PORT_CREATION - - PORT_UPDATE - - PORT_DELETION - status: + - ACCESS_TOKEN + - INTEGRATION_KEY + - API_KEY + - USERNAME_PASSWORD + - API_TOKEN + accessToken: type: string - description: Current outcome of the change flow - enum: - - COMPLETED - - FAILED - - REQUESTED - information: + description: passed as Authorization header value + integrationKey: type: string - description: Additional information - data: - $ref: "#/components/schemas/PortChangeOperation" - createdDateTime: + description: passed as Authorization header value + apiKey: type: string - description: Set when change flow starts - format: date-time - example: 2020-11-06T07:00:00Z - updatedDateTime: + description: passed as Authorization header value + username: 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 - PortServiceCode: - type: string - description: Identifies the service type associated with this port - enum: - - CX - - IX - - IA - - MC - PortDevice: - type: object - properties: - name: + description: passed as Authorization header value + password: type: string - description: Device name - deprecated: true - redundancy: - $ref: "#/components/schemas/PortDeviceRedundancy" - vcBandwidthMax: - type: integer - description: Maximum bandwidth allowed for connection. - format: int64 - description: Port device - PortInterface: - type: object - properties: - type: + description: passed as Authorization header value + apiToken: type: string - description: Port interface type - description: Port interface - PortDemarcationPoint: + description: passed as Authorization header value + StreamSubscriptionSinkSetting: type: object + description: Stream subscription sink settings properties: - cabinetUniqueSpaceId: - type: string - description: Port cabinet unique space id - cageUniqueSpaceId: + eventIndex: type: string - description: Port cage unique space id - patchPanel: + description: event index + metricIndex: type: string - description: Port patch panel - patchPanelName: + description: metric index + source: type: string - description: Port patch panel - deprecated: true - patchPanelPortA: + description: source + applicationKey: type: string - description: Port patch panel port A - patchPanelPortB: + description: Application key + eventUri: type: string - description: Port patch panel port B - connectorType: + description: event uri + metricUri: type: string - description: Port connector type - ibx: + description: metric uri + format: type: string - description: Port ibx identifier - description: Customer physical Port - PortRedundancy: + description: webhook message format + default: CLOUDEVENT + enum: + - CLOUDEVENT + - OPENTELEMETRY + StreamSubscriptionSinkResponse: type: object + description: Create Stream destination properties: - enabled: - type: boolean - description: Access point redundancy - group: + uri: + description: any publicly reachable http endpoint 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 + description: destination type enum: - - DOT1Q - - QINQ - - UNTAGGED - tagProtocolId: + - DATADOG + - DYNATRACE + - GOOGLE_PUBSUB + - PAGERDUTY + - SERVICENOW + - SLACK + - SPLUNK_HEC + - TEAMS + - WEBHOOK + 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: + description: sink host type: string - description: Port encapsulation tag protocol identifier - description: Port encapsulation configuration - PortLag: + StreamSubscriptionOperationAdditionalInfo: type: object + description: External error information from subscription sink properties: - id: + property: + description: Additional attribute for error information type: string - description: id - enabled: - type: boolean - description: enabled - deprecated: true - name: + statusCode: + description: HTTP error status code response from sink type if error occurred type: string - description: name - memberStatus: + reason: + description: HTTP error message response from sink type if error occurred type: string - description: member status - description: Port Lag - Package: + StreamSubscriptionOperationErrors: type: object + description: Error information for stream subscription delivery properties: - code: + errorCode: + description: Equinix Observability error code type: string - description: Type of Port Package - enum: - - STANDARD - - UNLIMITED - - UNLIMITED_PLUS - 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 - packageType: + errorMessage: + description: Equinix Observability error message type: string - description: Type of Port Package - deprecated: true - enum: - - STANDARD - - UNLIMITED - - UNLIMITED_PLUS - description: Port configuration settings - PortNotification: - required: - - registeredUsers - - type + dateTime: + description: Equinix Observability error date time + format: date-time + type: string + additionalInfo: + $ref: '#/components/schemas/StreamSubscriptionOperationAdditionalInfo' + StreamSubscriptionOperation: type: object + description: Stream subscription operational information properties: - type: + eventsDeliveredCount: + type: integer + description: count of delivered events + metricsDeliveredCount: + type: integer + description: count of delivered metrics + alertsDeliveredCount: + type: integer + description: count of delivered alerts + lastSuccessfulDeliveryDateTime: type: string - description: Notification Type - enum: - - NOTIFICATION - - TECHNICAL - - PEERING - - ESCALATION - registeredUsers: + format: date-time + description: last successful date time of delivered event, metric, or alert + suspendedDateTime: + type: string + format: date-time + description: suspended date time of stream subscription delivery for event, metric, or alert + errors: type: array - description: Array of registered users + description: List of error information for stream subscription delivery items: - type: string - PortAdditionalInfo: + $ref: '#/components/schemas/StreamSubscriptionOperationErrors' + StreamSubscription: + description: Stream Subscription object type: object properties: - key: + href: + description: Stream Subscription URI type: string - description: Key - value: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + uuid: + description: Equinix-assigned access point identifier type: string - description: Value - description: Additional information - PortLoa: - type: object - properties: - uuid: - type: string - description: uuid + format: uuid + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: + description: type type: string - description: Loa type - example: DIGITAL_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: + enum: + - STREAM_SUBSCRIPTION + name: + description: Customer-provided subscription name type: string - description: z-side/Equinix IBX - description: Port physical connection - PhysicalPortSettings: - type: object - properties: - errorMessage: + description: + description: Customer-provided subscription description type: string - packageType: + state: + description: Steam subscription provision state type: string - deprecated: true - description: Physical Port configuration settings - SimplifiedAccountRequest: - required: - - accountNumber + enum: + - PROVISIONING + - PROVISIONED + - REPROVISIONING + - DEPROVISIONING + - DEPROVISIONED + - FAILED + enabled: + description: Stream subscription enabled status + type: boolean + metricSelector: + $ref: '#/components/schemas/StreamSubscriptionSelector' + eventSelector: + $ref: '#/components/schemas/StreamSubscriptionSelector' + sink: + $ref: '#/components/schemas/StreamSubscriptionSinkResponse' + operation: + $ref: '#/components/schemas/StreamSubscriptionOperation' + changeLog: + $ref: '#/components/schemas/Changelog' + GetAllStreamSubscriptionResponse: type: object properties: - accountNumber: - type: integer - description: Account number - format: int64 - SimplifiedLocationRequest: - required: - - metroCode + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/StreamSubscription' + StreamSubscriptionSink: type: object - properties: - metroCode: - type: string - example: AM - PortChangeOperation: + description: Create Stream destination 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 + - type properties: - href: - type: string - description: LinkProtocol URI - format: uri - readOnly: true - uuid: + uri: + description: any publicly reachable http endpoint 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: string + description: destination type + enum: + - DATADOG + - DYNATRACE + - GOOGLE_PUBSUB + - PAGERDUTY + - SERVICENOW + - SLACK + - SPLUNK_HEC + - TEAMS + - WEBHOOK + batchEnabled: + type: boolean + description: batch mode on/off + example: false + batchSizeMax: type: integer - example: 20 - vlanCTagMax: + description: maximum batch size + batchWaitTimeMax: 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 - - /name - - /state - - /location/metroName - - /demarcationPointIbx - - /device/redundancy/priority - - /lagEnabled - - /physicalPortsSpeed - - /encapsulation/type - - /physicalPorts/tether/crossConnectId - - /package/code - - /changeLog/updatedDateTime - - /changeLog/createdDateTime - - /bandwidth - - /serviceCode - - /operation/maintenanceStatus - PortPackage: + description: maximum batch waiting time + credential: + $ref: '#/components/schemas/StreamSubscriptionSinkCredential' + settings: + $ref: '#/components/schemas/StreamSubscriptionSinkSetting' + host: + description: sink host + type: string + StreamSubscriptionPostRequest: + type: object + description: Create Stream Subscription required: - - code - type - type: object + - name + - sink properties: - href: - type: string - description: Port Package URI - readOnly: true type: type: string - description: Port Package Type enum: - - PORT_PACKAGE - code: + - STREAM_SUBSCRIPTION + name: + description: Customer-provided stream subscription name type: string - description: Port Package code - vcBandwidthMax: - type: integer - description: Maximum virtual connection bandwidth in Mbps - vcRemoteSupported: + description: + description: Customer-provided stream subscription description + type: string + enabled: + description: Stream subscription enabled status type: boolean - description: Indicates if remote virtual connections are supported - supportedServiceTypes: + default: true + example: true + metricSelector: + $ref: '#/components/schemas/StreamSubscriptionSelector' + eventSelector: + $ref: '#/components/schemas/StreamSubscriptionSelector' + sink: + $ref: '#/components/schemas/StreamSubscriptionSink' + StreamFilterSimpleExpression: + type: object + properties: + property: + description: | + Possible field names to use on filters: + * `/subject` - subject + * `/type` - type + type: string + example: /type + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `in` - in + * `LIKE` - case-sensitive like + * `ILIKE` - case-insensitive like + type: string + example: '=' + values: + description: | + ### Supported event or metric names to use on filters with property /type: + * `*` - all events or metrics + * `equinix.fabric.company_profile.*` - company profile events + * `equinix.fabric.connection.*` - connection events, metrics, or alerts + * `equinix.fabric.connection_bgpipv4_session.*` - connection BGP IPv4 session events + * `equinix.fabric.connection_bgpipv6_session.*` - connection BGP IPv6 session events + * `equinix.fabric.connection_maintenance.*` - connection maintenance events + * `equinix.fabric.connection_route_aggregation.*` - connection route aggregation events + * `equinix.fabric.connection_route_filter.*` - connection route filter events + * `equinix.fabric.connection_routing_protocol.*` - connection routing protocol events + * `equinix.fabric.internet_access.*` - internet access service events + * `equinix.fabric.ip_block.*` - IP block events + * `equinix.fabric.metric` - metric collection events + * `equinix.fabric.metro.*` - metro metrics or alerts + * `equinix.fabric.network.*` - network events + * `equinix.fabric.physical_port.*` - physical port events + * `equinix.fabric.port.*` - virtual port events, metrics, or alerts + * `equinix.fabric.port_maintenance.*` - port maintenance events + * `equinix.fabric.route_aggregation.*` - route aggregation events + * `equinix.fabric.route_aggregation_rule.*` - route aggregation rule events + * `equinix.fabric.route_filter.*` - route filter events + * `equinix.fabric.route_filter_rule.*` - route filter rule events + * `equinix.fabric.router.*` - cloud router events or alerts + * `equinix.fabric.router_action.*` - cloud router action events + * `equinix.fabric.router_command.*` - cloud router command events + * `equinix.fabric.routing_protocol_action.*` - routing protocol action events + * `equinix.fabric.service_profile_connection.*` - service profile connection events + * `equinix.fabric.service_token.*` - service token events + * `equinix.fabric.time_service.*` - precision time service events + * `equinix.network.maintenance.*` - network maintenance events + * `equinix.network.repair.*` - network repair events + * `equinix.network_edge.*` - network edge events, metrics, or alerts + * `equinix.network_edge.acl.*` - network edge acl events + * `equinix.network_edge.device.*` - network edge device events + * `equinix.network_edge.device_interface.*` - network edge device interface metrics or alerts + * `equinix.network_edge.devicelinkgroup.*` - network edge device link group events + * `equinix.access_manager.*` - identity access manager events + * `equinix.access_manager.user.role.*` - identity access manager user role events + * `equinix.iam.principal.*` - IAM principal authorization and token events + * `equinix.identity.user.*` - identity user events + * `equinix.identity.organization.*` - identity organization membership events + * `equinix.resource_manager.organization.*` - resource manager organization events + * `equinix.resource_manager.project.*` - resource manager project 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/ports//maintenances/` - port maintenance events + * `/fabric/v4/connections/` - connection events or metrics + * `/fabric/v4/connections//maintenances/` - connection maintenance events + * `/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 type: array - description: List of supported service types items: type: string - description: Port Package Service Type - enum: - - MSP - supportedSourceTypes: + StreamFilterOrFilter: + type: object + properties: + or: type: array - description: List of supported source types + maxItems: 3 items: - $ref: "#/components/schemas/PortPackageSourceType" - supportedMetros: + $ref: '#/components/schemas/StreamFilterSimpleExpression' + StreamFilter: + type: object + anyOf: + - $ref: '#/components/schemas/StreamFilterSimpleExpression' + - $ref: '#/components/schemas/StreamFilterOrFilter' + StreamSubscriptionFilter: + type: object + properties: + and: type: array - description: List of supported metros + maxItems: 8 items: - type: string - description: Port Package details - RouteFilterState: - type: string - description: Route Filter status - enum: - - PROVISIONING - - REPROVISIONING - - DEPROVISIONING - - PROVISIONED - - DEPROVISIONED - - NOT_PROVISIONED - - NOT_DEPROVISIONED - RouteFiltersChange: + $ref: '#/components/schemas/StreamFilter' + StreamSubscriptionPutRequest: + type: object + description: Update Stream Subscription required: - type - - uuid - type: object + - name + - sink 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: + - STREAM_SUBSCRIPTION + name: + description: Customer-provided stream subscription name type: string - description: Handy shortcut for operation name - example: replace - path: + description: + description: Customer-provided stream subscription description 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 + enabled: + description: Stream subscription enabled status + type: boolean + example: true + filters: + $ref: '#/components/schemas/StreamSubscriptionFilter' + metricSelector: + $ref: '#/components/schemas/StreamSubscriptionSelector' + eventSelector: + $ref: '#/components/schemas/StreamSubscriptionSelector' + sink: + $ref: '#/components/schemas/StreamSubscriptionSink' + StreamSubscriptionSearchSimpleExpression: type: object properties: - op: + property: + description: | + Possible field names to use on filters: + * `/uuid` - Subscription uuid + * `/streamUuid` - Stream uuid the subscription belongs to + * `/state` - Subscription state (`DEPROVISIONED` returned only when explicitly requested) + * `/name` - Subscription name + * `/project/projectId` - Subscription project id + * `/description` - Subscription description + * `/changeLog/createdDateTime` - Subscription created date time + * `/changeLog/updatedDateTime` - Subscription updated date time type: string - description: Handy shortcut for operation name - enum: - - add - - replace - - remove - path: + example: /streamUuid + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `>` - greater than + * `>=` - greater than or equal to + * `<` - less than + * `<=` - less than or equal to + * `BETWEEN` - between + * `NOT BETWEEN` - not between + * `LIKE` - like + * `ILIKE` - like case-insensitive + * `IN` - in + * `NOT IN` - not in type: string - description: path inside document leading to updated parameter - example: / - value: - $ref: "#/components/schemas/RouteFiltersBase" - description: Route filter change operation data - RouteFilterConnectionsData: + example: '=' + values: + type: array + minItems: 1 + items: + type: string + example: 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 + StreamSubscriptionSearchOrFilter: 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 - RouteFilterSortCriteria: + or: + type: array + items: + $ref: '#/components/schemas/StreamSubscriptionSearchSimpleExpression' + StreamSubscriptionSearchFilter: + type: object + anyOf: + - $ref: '#/components/schemas/StreamSubscriptionSearchSimpleExpression' + - $ref: '#/components/schemas/StreamSubscriptionSearchOrFilter' + StreamSubscriptionSearchFilters: type: object + required: + - and properties: - direction: - $ref: "#/components/schemas/RouteFilterSortDirection" - property: - $ref: "#/components/schemas/RouteFilterSortBy" - RouteFilterSortDirection: - type: string + and: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/StreamSubscriptionSearchFilter' + StreamSubscriptionSearchSortDirection: description: Sorting direction default: DESC + type: string enum: - DESC - ASC - RouteFilterSortBy: - type: string + StreamSubscriptionSearchSortBy: description: Possible field names to use on sorting - default: /changeLog/updatedDateTime + default: /changeLog/createdDateTime + type: string enum: - - /type - - /uuid - - /name - - /project/projectId - - /state - /changeLog/createdDateTime - /changeLog/updatedDateTime - - /changeLog/deletedDateTime - RouteFilterRuleState: - type: string - description: Route filter rule status - enum: - - PROVISIONING - - REPROVISIONING - - DEPROVISIONING - - PROVISIONED - - DEPROVISIONED - - NOT_PROVISIONED - - NOT_DEPROVISIONED - RouteFilterRulesChange: + StreamSubscriptionSearchSortCriteria: + type: object required: - - type - - uuid + - direction + - property + properties: + direction: + $ref: '#/components/schemas/StreamSubscriptionSearchSortDirection' + property: + $ref: '#/components/schemas/StreamSubscriptionSearchSortBy' + StreamSubscriptionSearchRequest: + type: object + description: Search requests containing criteria + required: + - filter + properties: + filter: + $ref: '#/components/schemas/StreamSubscriptionSearchFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/StreamSubscriptionSearchSortCriteria' + SearchStreamSubscriptionResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/StreamSubscription' + MetricSelectorResponse: + type: object + properties: + include: + description: Stream alert rule filtered by metric name + type: array + items: + type: string + example: equinix.fabric.metro.sv_da.latency + ResourceSelectorResponse: + type: object + properties: + include: + description: | + ### Supported metric names to use on filters with property /subject: + * `/fabric/v4/ports/` - port metrics + * `/fabric/v4/connections/` - connection metrics + * `/fabric/v4/metros/` - metro latency metrics + type: array + items: + type: string + DetectionMethodResponse: type: object properties: - uuid: - type: string - description: Uniquely identifies a change type: + description: | + * THRESHOLD - Alert when a metric crosses a defined threshold by user. + * OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric. 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 + - THRESHOLD + - OUTLIER + windowSize: + description: Stream alert rule metric window size + type: string + example: PT15M + operand: + description: Stream alert rule metric operand + type: string + enum: + - ABOVE + - BELOW + warningThreshold: + description: Stream alert rule metric warning threshold + type: string + criticalThreshold: + description: Stream alert rule metric critical threshold + type: string + StreamAlertRule: + description: Stream object + type: object + properties: href: + description: Stream Alert Rule URI type: string - description: Route Filter Change URI format: uri - description: Current state of latest route filter rule change - RouteFilterRulesPatchRequestItem: + readOnly: true + uuid: + description: Equinix-assigned access point identifier + type: string + format: uuid + example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 + type: + description: Stream subscription type + type: string + enum: + - METRIC_ALERT + name: + description: Customer-provided stream alert rule name + type: string + description: + description: Customer-provided stream alert rule description + type: string + state: + description: Steam subscription provision state + type: string + enum: + - ACTIVE + - INACTIVE + enabled: + description: Stream alert rule enabled status + type: boolean + default: true + metricSelector: + $ref: '#/components/schemas/MetricSelectorResponse' + resourceSelector: + $ref: '#/components/schemas/ResourceSelectorResponse' + detectionMethod: + $ref: '#/components/schemas/DetectionMethodResponse' + changeLog: + $ref: '#/components/schemas/Changelog' + GetAllStreamAlertRuleResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/StreamAlertRule' + MetricSelector: + type: object required: - - op - - path - - value + - include + properties: + include: + description: Stream alert rule filtered by metric name + type: array + items: + type: string + example: equinix.fabric.metro.sv_da.latency + ResourceSelector: type: object + required: + - include properties: - op: + include: + description: | + ### Supported metric names to use on filters with property /subject: + * `/fabric/v4/ports/` - port metrics + * `/fabric/v4/connections/` - connection metrics + * `/fabric/v4/metros/` - metro latency metrics + type: array + items: + type: string + DetectionMethod: + type: object + required: + - type + properties: + type: + description: | + * THRESHOLD - Alert when a metric crosses a defined threshold by user. + * OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric. type: string - description: Handy shortcut for operation name - example: replace - path: + enum: + - THRESHOLD + - OUTLIER + windowSize: + description: Stream alert rule metric window size 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 + example: PT15M + operand: + description: Stream alert rule metric operand + type: string + enum: + - ABOVE + - BELOW + warningThreshold: + description: Stream alert rule metric warning threshold + type: string + criticalThreshold: + description: Stream alert rule metric critical threshold + type: string + AlertRulePostRequest: type: object + description: Create Stream Alert Rules + required: + - type + - name + - metricSelector + - resourceSelector + - detectionMethod properties: - op: + type: type: string - description: Handy shortcut for operation name enum: - - add - - replace - - remove - path: + - METRIC_ALERT + name: + description: Customer-provided stream name 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: + description: + description: Customer-provided stream description + type: string + enabled: + description: Stream alert rule enabled status + type: boolean + default: true + example: true + metricSelector: + $ref: '#/components/schemas/MetricSelector' + resourceSelector: + $ref: '#/components/schemas/ResourceSelector' + detectionMethod: + $ref: '#/components/schemas/DetectionMethod' + AlertRulePutRequest: + type: object + description: Create Stream Alert Rules required: - type - - uuid - type: object + - name + - metricSelector + - resourceSelector + - detectionMethod properties: - uuid: + name: + description: Customer-provided stream name 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: + - METRIC_ALERT + description: + description: Customer-provided stream description type: string - description: Route AGGREGATION Change URI - format: uri - description: Current state of latest Route Aggregation change - RouteAggregationsPatchRequestItem: - required: - - op - - path - - value + enabled: + description: Stream alert rule enabled status + type: boolean + default: true + metricSelector: + $ref: '#/components/schemas/MetricSelector' + resourceSelector: + $ref: '#/components/schemas/ResourceSelector' + detectionMethod: + $ref: '#/components/schemas/DetectionMethod' + CompanyProfileContact: type: object properties: - op: + type: + description: Contact Type + example: SUPPORT type: string - description: Handy shortcut for operation name - example: replace - path: + enum: + - SUPPORT + contacts: + type: array + items: + properties: + name: + type: string + role: + type: string + email: + type: string + required: + - email + CompanyProfileRequest: + type: object + properties: + type: type: string - description: path to change - example: /name - value: - type: object - description: new value for updated parameter - description: Route Aggregation change operation data - RouteAggregationsChangeOperation: + example: COMPANY_PROFILE + name: + type: string + minLength: 1 + maxLength: 50 + example: Equinix + summary: + type: string + minLength: 1 + maxLength: 125 + example: Global interconnection and data center company + description: + type: string + minLength: 1 + maxLength: 450 + example: Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers. + pointOfContacts: + type: array + items: + $ref: '#/components/schemas/CompanyProfileContact' + example: + - type: SUPPORT + contacts: + - name: Peter Griffin + role: Vice President of Sales + email: example1@example.com + - name: Taylor Swift + role: Director of Marketing + email: example2@example.com + - name: Darth Vader + role: Head of Engineering + email: example3@example.com + notifications: + type: array + items: + $ref: '#/components/schemas/SimplifiedNotification' + example: + - type: NOTIFICATION + emails: + - example1@example.com + - example2@example.com + overview: + type: string + example: About Initech Corp

lorem ipsum

+ webUrl: + type: string + example: https://www.equinix.com + contactUrl: + type: string + example: https://www.equinix.com/contact-us required: - - op - - path - - value + - type + - name + - summary + - description + - webUrl + CompanyProfileState: + type: string + description: Company Profile State + CompanyMetro: type: object properties: - op: + href: type: string - description: Handy shortcut for operation name - enum: - - add - - replace - - remove - path: + metroCode: type: string - description: path inside document leading to updated parameter - example: / - value: - $ref: "#/components/schemas/RouteAggregationsBase" - description: Route Aggregation change operation data - RouteAggregationConnectionsData: + CompanyLogo: + type: object + properties: + href: + type: string + uuid: + type: string + extensionType: + type: string + TagResponse: + description: Equinix Fabric Tag Response Object 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" + example: https://api.equinix.com/fabric/v4/tags/18a127ad-9d0c-46e2-a66d-8ed85d1858b0 uuid: type: string - description: Route Aggregation identifier format: uuid - example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d + example: 18a127ad-9d0c-46e2-a66d-8ed85d1858b0 + type: + type: string + example: PREDEFINED_TAG name: type: string - example: connection-1 - RouteAggregationSortCriteria: - type: object - properties: - direction: - $ref: "#/components/schemas/RouteAggregationSortDirection" - property: - $ref: "#/components/schemas/RouteAggregationSortBy" - RouteAggregationSortDirection: - type: string - description: Sorting direction - default: DESC - enum: - - DESC - - ASC - RouteAggregationSortBy: - type: string - description: Possible field names to use on sorting - default: /changeLog/updatedDateTime - enum: - - /type - - /uuid - - /name - - /project/projectId - - /state - - /changeLog/createdDateTime - - /changeLog/updatedDateTime - - /changeLog/deletedDateTime - RouteAggregationRuleState: - type: string - description: Route Aggregation Rule status - enum: - - PROVISIONING - - REPROVISIONING - - DEPROVISIONING - - PROVISIONED - - DEPROVISIONED - - NOT_PROVISIONED - - NOT_DEPROVISIONED - RouteAggregationRulesChange: - required: - - type - - uuid + example: equinix.fabric.spotlight.ai.llm + displayName: + type: string + example: LLM + state: + type: string + enum: + - APPROVED + - PENDING_APPROVAL + - REJECTED + description: Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT + example: PENDING_APPROVAL + notifications: + example: + - type: NOTIFICATION + emails: + - example1@example.com + - example2@example.com + type: array + items: + $ref: '#/components/schemas/SimplifiedNotification' + changeLog: + $ref: '#/components/schemas/Changelog' + weight: + type: integer + example: 30000 + CompanyServiceProfile: type: object properties: + href: + type: string 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 + $ref: '#/components/schemas/ServiceProfileTypeEnum' + PrivateService: + type: object + properties: href: type: string - description: Route Aggregation Change URI - format: uri - description: Current state of latest Route Aggregation Rule change - RouteAggregationRulesPatchRequestItem: - required: - - op - - path - - value + uuid: + type: string + CompanyProfileChangeItem: type: object properties: op: - type: string description: Handy shortcut for operation name + type: string example: replace path: + description: path inside document leading to updated parameter type: string - description: path to change - example: /prefix + example: /name value: - type: object description: new value for updated parameter - description: Route Aggregation Rule change operation data - RouteAggregationRulesChangeOperation: required: - op - path - value + CompanyProfileChange: type: object properties: - op: + uuid: type: string - description: Handy shortcut for operation name - enum: - - add - - replace - - remove - path: + type: 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: + status: type: string - example: AMER, APAC, EMEA - metroName: + createdDateTime: type: string - example: Amsterdam - metroCode: + format: date-time + updatedDateTime: type: string - example: AM - CloudRouterPostRequestPackage: - required: - - code + format: date-time + data: + type: array + default: [] + items: + $ref: '#/components/schemas/CompanyProfileChangeItem' + CompanyProfileResponse: type: object properties: href: type: string - description: Fabric Cloud Router URI - format: uri - example: https://api.equinix.com/fabric/v4/routerPackages/LAB + example: https://api.equinix.com/fabric/v4/companyProfiles/123e4567-e89b-12d3-a456-426614174000 + uuid: + type: string + example: 123e4567-e89b-12d3-a456-426614174000 type: type: string - description: Cloud Router package type - example: ROUTER_PACKAGE - enum: - - ROUTER_PACKAGE - code: + example: COMPANY_PROFILE + name: type: string - description: Cloud Router package code - example: LAB - enum: - - LAB - - BASIC - - STANDARD - - ADVANCED - - PREMIUM - description: Fabric Cloud Router Package Type - CloudRouterAccessPointState: + example: Equinix + minLength: 1 + maxLength: 50 + summary: + example: Global interconnection and data center company + type: string + minLength: 1 + maxLength: 125 + description: + example: Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers. + type: string + minLength: 1 + maxLength: 450 + state: + $ref: '#/components/schemas/CompanyProfileState' + metros: + type: array + items: + $ref: '#/components/schemas/CompanyMetro' + example: + - href: https://api.equinix.com/fabric/v4/metros/SV + metroCode: SV + logo: + $ref: '#/components/schemas/CompanyLogo' + tags: + type: array + items: + $ref: '#/components/schemas/TagResponse' + example: + - href: https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387 + uuid: 260af68b-42f0-4f2e-9c5c-2fbd44b4b387 + type: RESOURCE_TAG + name: environment + displayName: Environment + weight: 30000 + serviceProfiles: + type: array + items: + $ref: '#/components/schemas/CompanyServiceProfile' + example: + - href: https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387 + uuid: 423af68b-42f0-4f2e-9c5c-2fbd44b4b387 + type: L2_PROFILE + privateServices: + type: array + items: + $ref: '#/components/schemas/PrivateService' + example: + - href: https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387 + uuid: 460af68b-42f0-4f2e-9c5c-2fbd44b4b387 + - href: https://api.equinix.com/fabric/v4/privateServices/8a5685a6-063d-41ac-9279-d32431e8d8f6 + uuid: 8a5685a6-063d-41ac-9279-d32431e8d8f6 + pointOfContacts: + type: array + items: + $ref: '#/components/schemas/CompanyProfileContact' + example: + - type: SUPPORT + contacts: + - name: Peter Griffin + role: Vice President of Sales + email: example1@example.com + - name: Taylor Swift + role: Director of Marketing + email: example2@example.com + - name: Darth Vader + role: Head of Engineering + email: example3@example.com + notifications: + type: array + items: + $ref: '#/components/schemas/SimplifiedNotification' + example: + - type: NOTIFICATION + emails: + - example1@example.com + - example2@example.com + overview: + type: string + example: About Initech Corp

lorem ipsum

+ webUrl: + type: string + example: https://www.equinix.com + contactUrl: + type: string + example: https://www.equinix.com/contact-us + change: + $ref: '#/components/schemas/CompanyProfileChange' + changeLog: + $ref: '#/components/schemas/Changelog' + CompanyProfileSearchFieldName: type: string - description: Access point lifecycle state + description: Searchable field names in company profile enum: - - PROVISIONED - - PROVISIONING - - DEPROVISIONING - - DEPROVISIONED - - REPROVISIONING - - NOT_PROVISIONED - - NOT_DEPROVISIONED - CloudRouterChange: + - /name + - /uuid + - /tags/name + - /tags/uuid + - /tags/displayName + - /state + - /metros/metroCode + - /change/status + example: /tags/name + OperatorEnum: + type: string + description: Comparison operators for filtering + enum: + - '=' + - '!=' + - LIKE + - NOT LIKE + - ILIKE + - NOT ILIKE + - IN + - NOT IN + example: '=' + CompanyProfileSearchSimpleExpression: + type: object required: - - type - - updatedDateTime + - property + - operator + - values + properties: + property: + allOf: + - $ref: '#/components/schemas/CompanyProfileSearchFieldName' + description: | + Searchable field name. Properties are grouped by their supported operators: + String properties (support all operators): + * `/name` - Company profile name + * `/uuid` - Company profile UUID + * `/tags/name` - Tag name + * `/tags/uuid` - Tag UUID + * `/tags/displayName` - Tag display name + + Discrete value properties (only support `=`, `!=`, `IN`, `NOT IN`): + * `/state` - Company profile state (`PENDING`, `PROVISIONED`, `DEPROVISIONED`, `REJECTED`) + * `/metros/metroCode` - Metro code (e.g. `SV`, `NY`, `DC`) + * `/change/status` - Change status (`PENDING`, `COMPLETED`, `REJECTED`) — seller and admin users only + example: /state + operator: + allOf: + - $ref: '#/components/schemas/OperatorEnum' + description: | + Comparison operator. `LIKE`, `NOT LIKE`, `ILIKE`, and `NOT ILIKE` require exactly one value. All other operators accept one or more values. + * `=` - equal; equivalent to `IN` when multiple values are provided + * `!=` - not equal; equivalent to `NOT IN` when multiple values are provided + * `LIKE` - case-sensitive partial match (single value) + * `NOT LIKE` - case-sensitive partial non-match (single value) + * `ILIKE` - case-insensitive partial match (single value) + * `NOT ILIKE` - case-insensitive partial non-match (single value) + * `IN` - matches any of the provided values + * `NOT IN` - does not match any of the provided values + example: IN + values: + type: array + minItems: 1 + example: + - PROVISIONED + - PENDING + items: + type: string + CompanyProfileSearchOrFilter: + type: object + description: | + Groups multiple simple expressions with OR logic. At most one `or` group is allowed within the top-level `and` array. + required: + - or + properties: + or: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/CompanyProfileSearchSimpleExpression' + CompanyProfileSearchFilter: + type: object + oneOf: + - $ref: '#/components/schemas/CompanyProfileSearchSimpleExpression' + - $ref: '#/components/schemas/CompanyProfileSearchOrFilter' + CompanyProfileSearchFilters: type: object + description: | + Filter criteria for company profile search. The `and` array combines conditions where all must match. Each item in `and` is either a simple expression (property/operator/values) or an `or` group. At most one `or` group is allowed per request. properties: - uuid: + and: + type: array + items: + $ref: '#/components/schemas/CompanyProfileSearchFilter' + CompanyProfileSortDirection: + description: Sorting direction + default: ASC + type: string + enum: + - DESC + - ASC + Sort: + type: object + properties: + property: type: string - description: Uniquely identifies a change + description: | + Property to sort by. Supported values: + * `/name` - Company profile name + * `/state` - Company profile state + * `/changeLog/updatedDateTime` - Date and time the profile was last updated + * `/changeLog/createdDateTime` - Date and time the profile was created + example: /changeLog/updatedDateTime + direction: + $ref: '#/components/schemas/CompanyProfileSortDirection' + CompanyProfileSearchRequest: + type: object + properties: + filter: + $ref: '#/components/schemas/CompanyProfileSearchFilters' + pagination: + $ref: '#/components/schemas/Pagination' + sort: + $ref: '#/components/schemas/Sort' + example: + filter: + and: + - property: /state + operator: '=' + values: + - PROVISIONED + - or: + - property: /name + operator: ILIKE + values: + - equinix + - property: /tags/name + operator: '=' + values: + - environment + pagination: + offset: 0 + limit: 20 + total: 0 + sort: + property: /changeLog/updatedDateTime + direction: DESC + CompanyProfileSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + type: array + items: + $ref: '#/components/schemas/CompanyProfileResponse' + required: + - pagination + - data + ServiceProfileListResponse: + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/CompanyServiceProfile' + description: List of service profiles + example: + - href: https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387 + uuid: 423af68b-42f0-4f2e-9c5c-2fbd44b4b387 + AttachServiceProfileResponse: + type: object + properties: + href: + type: string + description: URL to the attached service profile + example: https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387 type: type: string - description: Type of change - enum: - - ROUTER_UPDATE - status: + description: Type of the service or attachment + example: SERVICE_PROFILE + uuid: type: string - description: Current outcome of the change flow - enum: - - COMPLETED - - FAILED - - REQUESTED - createdDateTime: + description: Unique identifier for the service profile + example: 423af68b-42f0-4f2e-9c5c-2fbd44b4b387 + attachmentStatus: type: string - description: Set when change flow starts - format: date-time - example: 2020-11-06T07:00:00Z - updatedDateTime: + description: Status of the attachment operation + example: ATTACHED + required: + - type + - uuid + TagListResponse: + description: Equinix Fabric Tag List Response Object + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/TagResponse' + pagination: + $ref: '#/components/schemas/Pagination' + AttachTagResponse: + type: object + properties: + href: type: string - description: Set when change object is updated - format: date-time - example: 2020-11-06T07:00:00Z - information: + description: URL to the attached tag + example: https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387 + type: type: string - description: Additional information + description: Type of the tag or attachment + example: TAG + uuid: + type: string + description: Unique identifier for the tag + example: 260af68b-42f0-4f2e-9c5c-2fbd44b4b387 + attachmentStatus: + type: string + description: Status of the attachment operation + example: ATTACHED + required: + - type + - uuid + PrivateServiceListResponse: + type: object + properties: data: type: array items: - $ref: "#/components/schemas/CloudRouterChangeOperation" - description: Current state of latest CloudRouter change - CloudRouterChangeOperation: - required: - - op - - path - - value + $ref: '#/components/schemas/PrivateService' + description: List of private services + example: + - href: https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387 + uuid: 460af68b-42f0-4f2e-9c5c-2fbd44b4b387 + AttachPrivateServiceResponse: type: object properties: - op: + href: type: string - description: Handy shortcut for operation name - enum: - - replace - - add - - remove - path: + description: URL to the attached private service + example: https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387 + type: 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: + description: Type of the private service or attachment + example: PRIVATE_SERVICE + uuid: + type: string + description: Unique identifier for the private service + example: 460af68b-42f0-4f2e-9c5c-2fbd44b4b387 + attachmentStatus: + type: string + description: Status of the attachment operation + example: ATTACHED + required: + - type + - uuid + LogoRequest: + description: Equinix Fabric Logo Request Object type: object + required: + - logo + - name + - type + - description properties: - uuid: + logo: type: string - description: Connection UUID - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - href: + format: binary + description: Logo image file + name: type: string - example: https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4 + minLength: 1 + maxLength: 24 + description: Name of the Logo + example: Equinix Logo + description: + type: string + minLength: 1 + maxLength: 125 + description: Description of the logo + example: Company branding logo type: - $ref: "#/components/schemas/ConnectionType" - operation: - $ref: "#/components/schemas/Operation" - description: Connection object for router actions - RouterActionsRouter: + type: string + description: Type of logo + example: COMPANY_LOGO + LogoResponse: + description: Equinix Fabric Logo Response Object type: object properties: - uuid: - type: string - description: Router UUID - example: a1c6b7fd-aead-410a-96b4-b1dfa1071700 href: type: string - example: https://api.equinix.com/fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700 + format: uri + example: https://api.equinix.com/fabric/v4/logos/18a127ad-9d0c-46e2-a66d-8ed85d1858b0 + uuid: + type: string + format: uuid + example: 18a127ad-9d0c-46e2-a66d-8ed85d1858b0 type: type: string - enum: - - XF_ROUTER - operation: - $ref: "#/components/schemas/Operation" - description: Router object for router actions - CloudRouterCommandType: + description: Type of logo + example: COMPANY_LOGO + name: + type: string + example: Equinix Logo + description: + type: string + example: Company branding logo + status: + type: string + example: CREATED + extensionType: + type: string + example: .png + changelog: + $ref: '#/components/schemas/Changelog' + LoaType: type: string - description: Fabric Cloud Router Command Type - example: PING_COMMAND + description: | + Type of Letter of Authorization enum: - - PING_COMMAND - - TRACEROUTE_COMMAND - CloudRouterCommandRequestPayload: - required: - - destination - - sourceConnection + - CAGE_LOA + - PATCH_PANEL_LOA + - PATCH_PANEL_PORT_LOA + example: PATCH_PANEL_PORT_LOA + LoaProductType: + type: string + description: | + Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge + enum: + - XC + - XF_PORT + - VD + example: XC + LoaRequest: + description: Create Loa type: object properties: - destination: + type: + $ref: '#/components/schemas/LoaType' + name: type: string - description: Fabric Cloud Router Ping or Traceroute Command Destination - example: 8.8.8.8 - sourceConnection: - $ref: "#/components/schemas/CloudRouterCommandRequestConnection" - timeout: - type: integer - description: | - Timeout in seconds for Fabric Cloud Router Command: - - For `PING_COMMAND`: Packet timeout duration. The default value is 5. - - For `TRACEROUTE_COMMAND`: Probe timeout duration. - The default value is 2 and it is not configurable. - example: 2 - dataBytes: - maximum: 9000 - minimum: 16 - type: integer - description: | - Ping Command DataBytes. - This field is only applicable for commands of type `PING_COMMAND`. - example: 100 - default: 64 - probes: - type: integer - description: | - Number of probes for Fabric Cloud Router Traceroute Command. - This field is only applicable for commands of type `TRACEROUTE_COMMAND` and is not configurable. - example: 3 - default: 3 - hopsMax: - maximum: 30 + description: A short, descriptive name for this LOA. + minLength: 3 + maxLength: 50 + example: LOA-Equinix-SV1-2026 + description: + type: string + description: Additional context about this LOA. + minLength: 0 + maxLength: 450 + example: Authorization for patch panel port access to Equinix at SV1 + authorizedProductType: + $ref: '#/components/schemas/LoaProductType' + required: + - type + - name + - authorizedProductType + LoaExpiration: + description: | + Date and time when this LOA expires.
Default to 3 months from the creation date + type: string + format: date-time + example: '2026-11-06T07:00:00Z' + LoaRequestor: + description: Requestor + type: object + properties: + email: + type: string + format: email + description: Email address of the requestor contact. + example: user@org1.com + orgId: type: integer - description: | - Maximum number of hops for the traceroute command. - This field is only applicable for commands of type `TRACEROUTE_COMMAND`. - example: 20 - default: 20 - description: Fabric Cloud Router Command Request - CloudRouterCommandState: + description: Organization ID of the requestor. + example: 9257 + orgName: + type: string + description: Organization name of the requestor. + example: ABC Inc. + LoaPatchPanelConnectorType: type: string - description: Fabric Cloud Router Command State - example: SUCCEEDED + description: Connector Type enum: - - PENDING - - SUCCEEDED - - FAILED - - DELETED - CloudRouterCommandRequestResponse: + - FC + - SC + - LC + - ST + example: SC + LoaDemarcationPoint: + description: | + Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB + and connectorType is required. type: object properties: - destination: + cageUniqueSpaceId: + type: string + description: Unique identifier of the Cage. + example: SV1:00:000000 + cabinetUniqueSpaceId: + type: string + description: Unique identifier of the Cabinet. + example: SV1:00:000000:0105 + patchPanelId: type: string - description: Fabric Cloud Router Ping or Traceroute Command Destination - example: 8.8.8.8 - sourceConnection: - $ref: "#/components/schemas/CloudRouterCommandRequestConnection" - timeout: - type: integer - description: | - Timeout in seconds for Fabric Cloud Router Command: - - For `PING_COMMAND`: Packet timeout duration. The default value is 5. - - For `TRACEROUTE_COMMAND`: Probe timeout duration. - The default value is 2 and it is not configurable. - example: 2 - dataBytes: - maximum: 9000 - minimum: 16 - type: integer - description: | - Ping Command DataBytes. - This field is only applicable for commands of type `PING_COMMAND`. - example: 100 - default: 64 - interval: - type: integer - description: | - Time in milliseconds between sending each packet. - This field is only applicable for commands of type `PING_COMMAND`. - example: 1000 - default: 1000 - count: - type: integer description: | - Total number of ping requests. - This field is only applicable for commands of type `PING_COMMAND`. - example: 5 - default: 5 - probes: + Unique identifier of the Patch Panel. + example: CP:Demarc:1259684 + patchPanelPortA: type: integer description: | - Number of probes for Fabric Cloud Router Traceroute Command. - This field is only applicable for commands of type `TRACEROUTE_COMMAND` and is not configurable. - example: 3 - default: 3 - hopsMax: - maximum: 30 + Specify the desired port number.
When ports are not provided, next available ports will be used. + example: 23 + patchPanelPortB: type: integer description: | - Maximum number of hops for the traceroute command. - This field is only applicable for commands of type `TRACEROUTE_COMMAND`. - example: 20 - default: 20 - description: Fabric Cloud Router Command Request - CloudRouterCommandResponse: + Specify the desired port number.
When ports are not provided, next available ports will be used.
Required for Connector type FC and ST only. + example: 24 + connectorType: + $ref: '#/components/schemas/LoaPatchPanelConnectorType' + IssueLoa: + title: IssueLoa + description: Issue Loa type: object - oneOf: - - $ref: "#/components/schemas/CloudRouterCommandPingResponse" - - $ref: "#/components/schemas/CloudRouterCommandTracerouteResponse" - RouteTableEntry: - required: - - changeLog - - state - - type + allOf: + - $ref: '#/components/schemas/LoaRequest' + - type: object + properties: + expirationDateTime: + $ref: '#/components/schemas/LoaExpiration' + requestor: + $ref: '#/components/schemas/LoaRequestor' + demarcationPoint: + $ref: '#/components/schemas/LoaDemarcationPoint' + required: + - type + - demarcationPoint + LoaIssuer: + description: Issuer type: object properties: - type: - $ref: "#/components/schemas/RouteTableEntryType" - protocolType: - $ref: "#/components/schemas/RouteTableEntryProtocolType" - state: - $ref: "#/components/schemas/RouteTableEntryState" - prefix: - type: string - example: 192.168.10.0/24 - nextHop: + email: type: string - example: 10.10.10.5 - MED: - type: integer - example: 5 - localPreference: + format: email + description: Email address of the issuer contact. + example: user@org1.com + orgId: type: integer - example: 200 - asPath: - type: array - items: - type: string - example: "20100" - connection: - $ref: "#/components/schemas/RouteTableEntry_connection" - changeLog: - $ref: "#/components/schemas/Changelog" - description: Route table entry object - code: + description: Organization ID of the issuer. + example: 9257 + orgName: + type: string + description: Organization name of the issuer. + example: ABC Inc. + LoaLocation: + description: Eligible location where LOA can be issued. + type: object + properties: + ibxCode: + type: string + description: IBX Code + example: AM1 + RequestLoa: + title: RequestLoa + description: Request Loa + allOf: + - $ref: '#/components/schemas/LoaRequest' + - type: object + properties: + issuer: + $ref: '#/components/schemas/LoaIssuer' + location: + $ref: '#/components/schemas/LoaLocation' + required: + - type + - location + CreateLoa: + description: Create Loa + oneOf: + - $ref: '#/components/schemas/IssueLoa' + - $ref: '#/components/schemas/RequestLoa' + LoaState: type: string - description: Cloud Router package code - example: LAB + description: Current lifecycle state of the LOA. enum: - - LAB - - BASIC - - STANDARD - - ADVANCED - - PREMIUM - PackageChangeLog: + - PENDING + - FAILED + - PENDING_AUTHORIZATION + - PENDING_ACCEPTANCE + - CANCELLED + - INACTIVE + - ACTIVE + - EXPIRED + example: ACTIVE + LoaChangelog: + description: Change log type: object properties: - createdDateTime: + createdBy: type: string - format: date-time - example: 2020-11-06T07:00:00Z - updatedDateTime: + example: johnsmith + description: Created by User Key + createdByFullName: + type: string + example: John Smith + description: Created by User Full Name + createdByEmail: + type: string + example: john.smith@example.com + description: Created by User Email Address + createdDateTime: type: string format: date-time - example: 2020-11-06T07:00:00Z - description: Cloud Router package change log - ApiServices: - type: object - properties: - route: + example: '2020-11-06T07:00:00Z' + description: Created by Date and Time + updatedBy: type: string - description: service routes - status: + example: johnsmith + description: Updated by User Key + updatedByFullName: type: string - description: service status - changedDateTime: + example: John Smith + description: Updated by User Full Name + updatedByEmail: type: string - description: service status change date - description: Available services details - ValidateConnectionResponse: - type: object - properties: - uuid: + example: john.smith@example.com + description: Updated by User Email Address + updatedDateTime: type: string - description: Equinix-assigned connection identifier - bandwidth: - maximum: 100000 - 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: + format: date-time + example: '2020-11-06T07:00:00Z' + description: Updated by Date and Time + LoaResponse: + description: Loa Response type: object properties: href: type: string - description: Network URI + description: URI of this LOA resource. format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9 + example: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 uuid: type: string - description: Uniquely identifies a change + description: Unique identifier of this LOA. format: uuid - example: 4b17da68-3d6b-436d-9c8f-2105f3b950d9 + example: 29cc7878-54e3-4e1a-8651-87a61354bac2 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: + $ref: '#/components/schemas/LoaType' + name: type: string - description: Http method type - contentType: + description: A short, descriptive name for this LOA + example: LOA-Equinix-SV1-2026 + description: type: string - description: Content type for the response - authenticate: - type: boolean - description: Authentication required or not - NetworkChangeOperation: + description: Additional context about this LOA + example: Authorization for patch panel port access to Equinix at SV1 + authorizedProductType: + $ref: '#/components/schemas/LoaProductType' + state: + $ref: '#/components/schemas/LoaState' + operation: + type: object + properties: + consumersCount: + type: integer + description: Number of consumers associated with this LOA. + example: 10 + requestor: + $ref: '#/components/schemas/LoaRequestor' + issuer: + $ref: '#/components/schemas/LoaIssuer' + demarcationPoint: + $ref: '#/components/schemas/LoaDemarcationPoint' + location: + $ref: '#/components/schemas/LoaLocation' + expirationDateTime: + $ref: '#/components/schemas/LoaExpiration' + changeLog: + $ref: '#/components/schemas/LoaChangelog' + LoaOpEnum: + description: Operation to be performed + type: string + enum: + - replace + - add + - remove + LoaPath: + description: | + ### A JSON Pointer path. + * `/name` - Name of the Loa + * `/description` - Description of the Loa + * `/requestor/email` - Email of the requestor contact + * `/requestor/orgName` - Organization name of the requestor + * `/issuer/email` - Email of the issuer contact + * `/issuer/orgName` - Organization name of the issuer + * `/demarcationPoint/patchPanelId` - Patch Panel Identifier + * `/demarcationPoint/patchPanelPortA` - Patch Panel Port A + * `/demarcationPoint/patchPanelPortB` - Patch Panel Port B + * `/demarcationPoint/connectorType` - Connector Type + * `/demarcationPoint/cageUniqueSpaceId` - Cage Unique Space Identifier + * `/expirationDateTime` - Expiration date and time of the Loa + * `/location/ibxCode` - IBX code of the Eligible location + type: string + LoaReplaceOperation: + description: Replace attribute value or sub-resource in the existing model + type: object required: - op - path - value - type: object properties: op: - type: string - description: Handy shortcut for operation name - enum: - - replace - - add - - remove + $ref: '#/components/schemas/LoaOpEnum' path: - type: string - description: path inside document leading to updated parameter - example: /name + $ref: '#/components/schemas/LoaPath' 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: + description: New value for updated parameter + LoaUpdate: + type: array + items: + $ref: '#/components/schemas/LoaReplaceOperation' + LoaActionType: type: string - description: Type of change + description: Action to perform on the LOA. enum: - - NETWORK_CREATION - - NETWORK_UPDATE - - NETWORK_DELETION - NetworkChangeStatus: + - LOA_ISSUER_AUTHORIZATION + - LOA_REQUESTOR_ACCEPTANCE + - LOA_COPY_LINK + - LOA_SEND_EMAIL_NOTIFICATION + - LOA_CANCEL + example: LOA_ISSUER_AUTHORIZATION + LoaMagicLink: + description: | + Portal URL for the LOA to either accept from requestor
or authorize from the issuer. type: string - description: Current outcome of the change flow - enum: - - APPROVED - - COMPLETED - - FAILED - - REJECTED - - REQUESTED - - SUBMITTED_FOR_APPROVAL - precisionTimePackageRequest: - title: precisionTimePackageRequest - required: - - code + readOnly: true + example: https://portal.equinix.com/fabric/loa/inventory/issuer/29cc7878-54e3-4e1a-8651-87a61354bac2/authorize + LoaActionData: + description: | + Action Data.
For LOA_ISSUER_AUTHORIZATION — always required. 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 + demarcationPoint: + $ref: '#/components/schemas/LoaDemarcationPoint' + expirationDateTime: + $ref: '#/components/schemas/LoaExpiration' + portalUrl: + $ref: '#/components/schemas/LoaMagicLink' + LoaActionRequest: + description: Action Request + title: AuthorizeLoa + properties: + type: + $ref: '#/components/schemas/LoaActionType' + data: + $ref: '#/components/schemas/LoaActionData' required: - - uuid + - type + LoaActionState: + description: Action State + type: string + enum: + - COMPLETED + - FAILED + - PENDING + LoaActionResponse: + description: Action Response type: object properties: href: type: string - description: Connection URI + description: Action URI format: uri - readOnly: true - type: - type: string - description: Connection Type + example: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 uuid: type: string - description: Connection UUID. + description: Action Identifier 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: + example: 30cc7878-54e3-4e1a-8651-87a61354bad4 + state: + $ref: '#/components/schemas/LoaActionState' + type: + $ref: '#/components/schemas/LoaActionType' + data: + $ref: '#/components/schemas/LoaActionData' + changeLog: + $ref: '#/components/schemas/LoaChangelog' + LoaFieldName: + description: Possible field names to use on filters + type: string + enum: + - /uuid + - /state + - /type + - /name + - /authorizedProductType + - /expirationDateTime + - /requestor/email + - /requestor/orgId + - /requestor/orgName + - /issuer/email + - /issuer/orgId + - /issuer/orgName + - /demarcationPoint/patchPanelId + - /demarcationPoint/patchPanelPortA + - /demarcationPoint/patchPanelPortB + - /demarcationPoint/connectorType + - /demarcationPoint/cageUniqueSpaceId + - /location/ibxCode + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + example: /name + LoaSimpleExpression: type: object properties: - timeScale: + property: + $ref: '#/components/schemas/LoaFieldName' + operator: 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 + - '=' + - '!=' + - LIKE + - ILIKE + - BETWEEN + - NOT BETWEEN + - IN + - NOT IN + - '>' + - < + - '>=' + - <= + example: '=' + values: + type: array + items: + type: string + example: + - Loa-2026 + LoaOrFilter: + type: object + properties: + or: + type: array + items: + $ref: '#/components/schemas/LoaSimpleExpression' + LoaFilter: + type: object + anyOf: + - $ref: '#/components/schemas/LoaSimpleExpression' + - $ref: '#/components/schemas/LoaOrFilter' + LoaSearchFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/LoaFilter' + LoaSortCriteria: + type: object + properties: + direction: + description: Sorting direction + default: DESC + type: string enum: - - -5 - - -4 - - -3 - - -2 - - -1 - - 0 - - 1 - transportMode: + - DESC + - ASC + property: + description: Possible field names to use on sorting + default: /changeLog/updatedDateTime 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 + - /name + - /expirationDateTime + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + LoaSearchRequest: type: object + description: Search loas based on filter criteria 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 - timeServiceOperation: + filter: + $ref: '#/components/schemas/LoaSearchFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/LoaSortCriteria' + LoaSearchResponse: + description: List of LOAs type: object properties: - operationalStatus: + pagination: + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/LoaSortCriteria' + data: + type: array + items: + $ref: '#/components/schemas/LoaResponse' + LoaActionFieldName: + description: Possible field names to use on filters + type: string + enum: + - /type + - /state + - /uuid + LoaActionSearchSimpleExpressions: + type: object + properties: + property: + $ref: '#/components/schemas/LoaActionFieldName' + operator: type: string - description: time service operational status enum: - - UP - - DOWN - - DEGRADED - description: time service operational data - precisionTimePackagePostResponse: - title: precisionTimePackagePostResponse - required: - - code + - '=' + - '!=' + - LIKE + - ILIKE + - BETWEEN + - NOT BETWEEN + - IN + - NOT IN + - '>' + - < + - '>=' + - <= + values: + type: array + items: + type: string + example: LOA_ACCEPTANCE + LoaActionOrFilter: type: object properties: - href: + or: + type: array + items: + $ref: '#/components/schemas/LoaActionSearchSimpleExpressions' + LoaActionFilter: + type: object + anyOf: + - $ref: '#/components/schemas/LoaActionSearchSimpleExpressions' + - $ref: '#/components/schemas/LoaActionOrFilter' + LoaActionSearchFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/LoaActionFilter' + LoaActionSortCriteria: + type: object + properties: + direction: + description: Sorting direction + default: DESC type: string - format: uri - code: + enum: + - DESC + - ASC + property: + description: Possible field names to use on sorting + default: /changeLog/createdDateTime 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 + - /changeLog/createdDateTime + LoaActionSearchRequest: + type: object + description: Search loa actions based on filter criteria + properties: + filter: + $ref: '#/components/schemas/LoaActionSearchFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/LoaActionSortCriteria' + LoaActionSearchResponse: + description: List of LOA Actions + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/LoaActionSortCriteria' + data: + type: array + items: + $ref: '#/components/schemas/LoaActionResponse' + LoaConsumer: + description: Associated consumer response type: object properties: href: type: string - description: Connection URI + description: Consumer URI format: uri - readOnly: true - type: - type: string - description: Connection Type. + example: https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2 uuid: type: string - description: Connection UUID. + description: Consumer Identifier format: uuid - aSide: - $ref: "#/components/schemas/virtualConnectionSide" - zSide: - $ref: "#/components/schemas/virtualConnectionSide" - description: Fabric Connection Precision Time Service Response Object - precisionTimePrice: - title: precisionTimePrice + example: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: + $ref: '#/components/schemas/LoaProductType' + changeLog: + $ref: '#/components/schemas/LoaChangelog' + LoaConsumersResponse: + description: List of Consumers associated with a LOA type: object properties: - currency: - type: string - description: offering price currency - charges: + pagination: + $ref: '#/components/schemas/Pagination' + data: type: array items: - $ref: "#/components/schemas/PriceCharge" - description: Precision Time Price - connectionLink: + $ref: '#/components/schemas/LoaConsumer' + LoaNoteDetails: + description: | + Represents a note added to a LOA by an authorized user from either the issuer or requestor organization 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 - StreamSearchAsset: - type: object - properties: + - ISSUER + - REQUESTOR + description: | + Indicates which party added the note.
ISSUER — note was added by a user from the issuer organization.
REQUESTOR — note was added by a user from the requestor organization. + example: ISSUER href: type: string - description: Stream Asset URI format: uri - readOnly: true + description: URI to note resource. + example: https://api.equinix.com/fabric/v4/loas/b7e14c2d-93f8-4a61-8d5b-c29f71e4a306/notes/e41f485e-3094-42de-8797-0ef19a51df79 uuid: type: string - description: Equinix-assigned access point identifier format: uuid - example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 - streamUuid: + description: Unique identifier of this note. + example: e41f485e-3094-42de-8797-0ef19a51df79 + comments: type: string - description: Equinix-assigned access point identifier - format: uuid - example: d4b8e7a2-f3b1-4576-a4a9-1366a63df171 - type: + description: Content of the note as submitted by the user. + example: LOA under review by our team. Expected response within 2 business days + createdDateTime: type: string - description: Asset type - example: XF_PORT - metricsEnabled: - type: boolean - description: enable metric - example: true - attachmentStatus: + format: date-time + description: Date and time when the note was created. + example: '2023-08-01T12:34:56Z' + LoaNotesResponse: + description: List of Loa note details + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/LoaNoteDetails' + CreateLoaNote: + description: Create Loa Note + type: object + properties: + comments: + type: string + description: | + The note content to add to this LOA. Notes are visible to both the issuer and requestor organizations. Use notes to communicate updates, clarifications, or additional context about the LOA. + minLength: 0 + maxLength: 4000 + example: LOA under review by our team. Expected response within 2 business days + required: + - comments + CrossConnectType: + description: Type of Cross Connect. + type: string + enum: + - XC + example: XC + BmmrType: + description: Cross Connect BMMR Type. + type: string + enum: + - EQUINIX + - SELF + example: EQUINIX + CrossConnectRedundancy: + description: Cross Connect Redundancy. + type: object + properties: + group: + type: string + description: | + Redundancy group identifier. When placing a diverse Cross Connect against an existing one, provide either this identifier or the serial number of the existing Cross Connect. + example: 7cf39156-9dec-40f7-a254-9bb401342e83 + priority: type: string - description: asset status enum: - - ATTACHING - - ATTACHED - - DETACHED - - DETACHING - - FAILED - projectId: + - PRIMARY + - SECONDARY + description: Priority within the redundancy group. + example: PRIMARY + CrossConnectConnectorType: + description: Connector Type. + type: string + example: SC + CrossConnectDemarcationPoint: + description: Cross Connect Demarcation Point - patch panel and port details. + type: object + properties: + patchPanelId: type: string - description: project ic - example: "123" - description: Stream object - StreamAssetInterface: + description: Patch Panel Identifier. + example: CP:Demarc:1259684 + patchPanelPortA: + type: integer + description: | + Specify the desired port number. When ports are not provided, next available ports will be used. + example: 35 + patchPanelPortB: + type: integer + description: | + Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only. + example: 32 + connectorType: + $ref: '#/components/schemas/CrossConnectConnectorType' + CrossConnectASideRequest: + title: CrossConnectASideRequest + description: A-Side connection details. + type: object + properties: + demarcationPoint: + allOf: + - $ref: '#/components/schemas/CrossConnectDemarcationPoint' + - required: + - patchPanelId + - connectorType + CrossConnectZSideRequestDemarcationPoint: + description: | + Z-Side demarcation point.
Specify the destination patch panel and ports.
Specify cageUniqueSpaceId and cabinetUniqueSpaceId to identify the destination space. + allOf: + - $ref: '#/components/schemas/CrossConnectDemarcationPoint' + - type: object + properties: + cageUniqueSpaceId: + type: string + description: Unique identifier of the Cage. + example: SV2:00:000000 + cabinetUniqueSpaceId: + type: string + description: Unique identifier of the Cabinet. + example: SV2:00:000000:0100 + CrossConnectLocation: + description: Cross Connect Location details. + type: object + properties: + ibxCode: + type: string + description: IBX Code. + example: SV1 + CrossConnectLoaRef: + description: | + LOA Reference for Cross Connect. Provide either uuid or digitalLoaId. type: object properties: href: type: string - description: Network Edge Device interface URI format: uri readOnly: true - example: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5 - id: - type: integer - description: Network Edge Device interface identifier - format: int32 - example: 5 + description: LOA URI. + example: https://api.equinix.com/fabric/v4/loas/c61f485e-3094-42de-8797-0ef19a51df79 uuid: type: string - description: Network Edge Device interface UUID format: uuid - example: 4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d + description: LOA Identifier - Attachment UUID or LOA UUID. + example: c61f485e-3094-42de-8797-0ef19a51df79 + CrossConnectZSideRequest: + title: CrossConnectZSideRequest + description: | + Z-Side connection details. Provide the demarcationPoint for a patch panel to patch panel Cross Connect, or location when connecting to a BMMR. loa is mandatory for a Cross Connect with LOA and when bmmrType is EQUINIX - provide either loa.uuid or loa.digitalLoaId. + type: object + properties: + demarcationPoint: + allOf: + - $ref: '#/components/schemas/CrossConnectZSideRequestDemarcationPoint' + description: Required for a patch panel to patch panel Cross Connect. + location: + allOf: + - $ref: '#/components/schemas/CrossConnectLocation' + description: Required when connecting to a BMMR. + loa: + allOf: + - $ref: '#/components/schemas/CrossConnectLoaRef' + description: Required for a Cross Connect with LOA and when bmmrType is EQUINIX. + ScheduleType: + description: Schedule Code. + type: string + enum: + - STANDARD + - FLEXIBLE + - EXPEDITE + example: STANDARD + ScheduleRequest: + description: Cross Connect Installation Schedule. + type: object + properties: type: type: string - description: Network Edge Device interface type + description: Schedule type. enum: - - DATA - - MGMT - - SSH - - FAB - - CTRL - state: + - XC_INSTALL_SCHEDULE + example: XC_INSTALL_SCHEDULE + code: + $ref: '#/components/schemas/ScheduleType' + autoConvertToStandard: + type: boolean + description: | + Applicable only when the code is EXPEDITE. When true, Equinix schedules the Cross Connect as STANDARD when no EXPEDITE scheduling is available. + example: true + readinessDateTime: type: string - description: Network Edge Device interface usage status - example: ASSIGNED - attachmentStatus: + format: date-time + description: | + Carrier Circuit delivery date is the date when the Carrier commits to enable the circuit. Your order will be placed on hold, pending the date you enter. Equinix will wait for the Carrier to deliver the service and then will complete the installation. + example: '2026-02-26T07:21:39Z' + requestedDateTime: type: string - description: interface attachment status - enum: - - ATTACHING - - ATTACHED - - DETACHED - - DETACHING - - FAILED - description: Network Edge Device interface attached to a stream - StreamSubscriptionSinkResponse: + format: date-time + description: Requested Installation Date and Time. + example: '2026-02-27T07:21:39Z' + required: + - code + CrossConnectServiceType: + description: | + Type of service ordered alongside the Cross Connect.
XC_LINK_LIGHT_VERIFICATION - To verify transmit and receive alignment after the Cross Connect is Provisioned.
XC_PATCH_EQUIPMENT - Equinix will install the Cross Connect from the demarcation panel to your equipment device. + type: string + enum: + - XC_LINK_LIGHT_VERIFICATION + - XC_PATCH_EQUIPMENT + example: XC_LINK_LIGHT_VERIFICATION + PatchEquipmentRequest: + description: Patch equipment installed for the Cross Connect. type: object properties: - uri: - type: string - description: any publicly reachable http endpoint - type: + cabinetUniqueSpaceId: type: string - description: destination type - enum: - - DATADOG - - DYNATRACE - - GOOGLE_PUBSUB - - PAGERDUTY - - SERVICENOW - - SLACK - - SPLUNK_HEC - - TEAMS - - WEBHOOK - batchEnabled: - type: boolean - description: batch mode on/off - example: false - batchSizeMax: - type: integer - description: maximum batch size - batchWaitTimeMax: + description: Unique identifier of the Cabinet. + example: SV2:00:000000:0100 + port: 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 - StreamSubscriptionOperation: + description: Port number. + example: 32 + connectorType: + $ref: '#/components/schemas/CrossConnectConnectorType' + required: + - cabinetUniqueSpaceId + - port + - connectorType + CrossConnectServiceRequest: + description: | + Service to order alongside the Cross Connect.
Send one entry per service.
device and description apply to the XC_PATCH_EQUIPMENT service only. type: object properties: - eventsDeliveredCount: - type: integer - description: count of delivered events - metricsDeliveredCount: - type: integer - description: count of delivered metrics - alertsDeliveredCount: - type: integer - description: count of delivered alerts - lastSuccessfulDeliveryDateTime: - type: string - description: last successful date time of delivered event, metric, or alert - format: date-time - suspendedDateTime: + type: + $ref: '#/components/schemas/CrossConnectServiceType' + device: + allOf: + - $ref: '#/components/schemas/PatchEquipmentRequest' + description: | + Patch equipment device details. Required for the XC_PATCH_EQUIPMENT service. + description: type: string - description: suspended date time of stream subscription delivery for event, metric, or alert - format: date-time - errors: - type: array - description: List of error information for stream subscription delivery - items: - $ref: "#/components/schemas/StreamSubscriptionOperationErrors" - description: Stream subscription operational information - StreamSubscriptionOperationErrors: + description: | + Additional notes for the service. Required for the XC_PATCH_EQUIPMENT service. + example: additional notes for patch equipment + maxLength: 100 + required: + - type + NotificationType: + description: Notification Type. + type: string + enum: + - ORDERING + - TECHNICAL + - NOTIFICATION + - PROVIDER_NOTIFICATION + - TECHNICAL_UNREGISTERED + example: TECHNICAL + CrossConnectContactAvailability: + description: Availability preference. + type: string + enum: + - ANYTIME + - NEVER + - WORK_HOURS + - IBX_HOURS + example: ANYTIME + CrossConnectContactPreference: + description: Cross Connect Contact Preference. type: object properties: - errorCode: - type: string - description: Equinix Observability error code - errorMessage: - type: string - description: Equinix Observability error message - dateTime: + timezone: type: string - description: Equinix Observability error date time - format: date-time - additionalInfo: - $ref: "#/components/schemas/StreamSubscriptionOperationAdditionalInfo" - description: Error information for stream subscription delivery - StreamSubscriptionOperationAdditionalInfo: + description: Timezone. + example: PST + availability: + $ref: '#/components/schemas/CrossConnectContactAvailability' + CrossConnectPhone: + description: Contact phone number. type: object properties: - property: - type: string - description: Additional attribute for error information - statusCode: + type: type: string - description: HTTP error status code response from sink type if error occurred - reason: + description: Phone number type. + enum: + - MOBILE + - OFFICE + example: MOBILE + number: type: string - description: HTTP error message response from sink type if error occurred - description: External error information from subscription sink - 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: + description: Phone number. + pattern: ^\+[1-9]\d{1,14}$ + example: '+14085551234' + contactPreference: + $ref: '#/components/schemas/CrossConnectContactPreference' + CrossConnectNotification: + description: Cross Connect Notification. type: object properties: - property: + type: + $ref: '#/components/schemas/NotificationType' + firstName: type: string description: | - Possible field names to use on filters: - * `/subject` - subject - * `/type` - type - example: /type - operator: + First name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type. + example: John + lastName: type: string description: | - Possible operators to use on filters: - * `=` - equal - * `in` - in - * `LIKE` - case-sensitive like - * `ILIKE` - case-insensitive like - example: = - values: + Last name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type. + example: Doe + emails: type: array - description: | - ### Supported event or metric names to use on filters with property /type: - * `*` - all events or metrics - * `equinix.fabric.company_profile.*` - company profile events - * `equinix.fabric.connection.*` - connection events, metrics, or alerts - * `equinix.fabric.connection_bgpipv4_session.*` - connection BGP IPv4 session events - * `equinix.fabric.connection_bgpipv6_session.*` - connection BGP IPv6 session events - * `equinix.fabric.connection_maintenance.*` - connection maintenance events - * `equinix.fabric.connection_route_aggregation.*` - connection route aggregation events - * `equinix.fabric.connection_route_filter.*` - connection route filter events - * `equinix.fabric.connection_routing_protocol.*` - connection routing protocol events - * `equinix.fabric.internet_access.*` - internet access service events - * `equinix.fabric.ip_block.*` - IP block events - * `equinix.fabric.metric` - metric collection events - * `equinix.fabric.metro.*` - metro metrics or alerts - * `equinix.fabric.network.*` - network events - * `equinix.fabric.physical_port.*` - physical port events - * `equinix.fabric.port.*` - virtual port events, metrics, or alerts - * `equinix.fabric.port_maintenance.*` - port maintenance events - * `equinix.fabric.route_aggregation.*` - route aggregation events - * `equinix.fabric.route_aggregation_rule.*` - route aggregation rule events - * `equinix.fabric.route_filter.*` - route filter events - * `equinix.fabric.route_filter_rule.*` - route filter rule events - * `equinix.fabric.router.*` - cloud router events or alerts - * `equinix.fabric.router_action.*` - cloud router action events - * `equinix.fabric.router_command.*` - cloud router command events - * `equinix.fabric.routing_protocol_action.*` - routing protocol action events - * `equinix.fabric.service_profile_connection.*` - service profile connection events - * `equinix.fabric.service_token.*` - service token events - * `equinix.fabric.time_service.*` - precision time service events - * `equinix.network.maintenance.*` - network maintenance events - * `equinix.network.repair.*` - network repair events - * `equinix.network_edge.*` - network edge events, metrics, or alerts - * `equinix.network_edge.acl.*` - network edge acl events - * `equinix.network_edge.device.*` - network edge device events - * `equinix.network_edge.device_interface.*` - network edge device interface metrics or alerts - * `equinix.network_edge.devicelinkgroup.*` - network edge device link group events - * `equinix.access_manager.*` - identity access manager events - * `equinix.access_manager.user.role.*` - identity access manager user role events - * `equinix.iam.principal.*` - IAM principal authorization and token events - * `equinix.identity.user.*` - identity user events - * `equinix.identity.organization.*` - identity organization membership events - * `equinix.resource_manager.organization.*` - resource manager organization events - * `equinix.resource_manager.project.*` - resource manager project 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/ports//maintenances/` - port maintenance events - * `/fabric/v4/connections/` - connection events or metrics - * `/fabric/v4/connections//maintenances/` - connection maintenance events - * `/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" - MetricSelectorResponse: - type: object - properties: - include: + format: email + description: Email addresses for notifications. + example: + - abc@test.com + registeredUsers: type: array - description: Stream alert rule filtered by metric name items: type: string - example: equinix.fabric.metro.sv_da.latency - ResourceSelectorResponse: - type: object - properties: - include: + description: Registered users for notifications. + phone: type: array - description: | - ### Supported metric names to use on filters with property /subject: - * `/fabric/v4/ports/` - port metrics - * `/fabric/v4/connections/` - connection metrics - * `/fabric/v4/metros/` - metro latency metrics items: - type: string - DetectionMethodResponse: + $ref: '#/components/schemas/CrossConnectPhone' + description: Contact phone numbers. + required: + - type + - emails + PurchaseOrder: + description: Purchase Order information associated with the account. type: object properties: - type: + number: type: string - description: | - * THRESHOLD - Alert when a metric crosses a defined threshold by user. - * OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric. - enum: - - THRESHOLD - - OUTLIER - windowSize: + description: Purchase Order number. + example: '1233' + amount: type: string - description: Stream alert rule metric window size - example: PT15M - operand: + description: Purchase Order amount. + example: '10000' + startDate: type: string - description: Stream alert rule metric operand - enum: - - ABOVE - - BELOW - warningThreshold: + format: date + description: Date the Purchase Order takes effect. + example: '2026-02-26' + endDate: type: string - description: Stream alert rule metric warning threshold - criticalThreshold: + format: date + description: Date the Purchase Order expires. + example: '2027-02-26' + attachmentId: type: string - description: Stream alert rule metric critical threshold - CompanyProfileContact: - type: object - properties: + format: uuid + description: Identifier of the uploaded purchase order document. + example: e41f485e-3094-42de-8797-0ef19a51df79 type: type: string - description: Contact Type - example: SUPPORT + description: Purchase Order type. enum: - - SUPPORT - contacts: - type: array - items: - $ref: "#/components/schemas/CompanyProfileContact_contacts" - CompanyProfileState: - type: string - description: Company Profile State - CompanyMetro: - type: object - properties: - href: - type: string - metroCode: - type: string - CompanyLogo: + - EXEMPTION + - EXISTING + - NEW + example: NEW + OrderRequest: + description: Cross Connect Order. type: object properties: - href: + orderNumber: type: string - uuid: + description: Order Number. + example: 1-1234567890 + orderLineItemNumber: type: string - extensionType: + description: Order Line Item Number. + example: 1-1234567890 + purchaseOrder: + $ref: '#/components/schemas/PurchaseOrder' + customerReferenceId: type: string - CompanyServiceProfile: + description: Customer Reference Identifier. + example: '12345' + CrossConnectNoteRequest: + description: Cross Connect Note. type: object properties: - href: - type: string - uuid: + comments: type: string - type: - $ref: "#/components/schemas/ServiceProfileTypeEnum" - PrivateService: + description: Note comments. + example: test note + maxLength: 4000 + required: + - comments + CrossConnectAttachment: + description: Cross Connect Attachment. type: object properties: - href: - type: string - uuid: + attachmentId: type: string - CompanyProfileChange: + format: uuid + description: Attachment Identifier. + example: a11f485e-3094-42de-8797-0ef19a51df79 + required: + - attachmentId + CreateCrossConnect: + title: CreateCrossConnect + description: | + Create Cross Connect request. A single request body supports all Cross Connect connection types - patch panel to patch panel, connection with LOA and connection to a BMMR (by Equinix or by Self). Refer to the request examples for each use case. type: object properties: - uuid: - type: string type: + $ref: '#/components/schemas/CrossConnectType' + name: type: string - status: - type: string - createdDateTime: - type: string - format: date-time - updatedDateTime: + description: A short, descriptive name for this Cross Connect. + minLength: 3 + maxLength: 50 + example: My-CC-service + bmmrType: + allOf: + - $ref: '#/components/schemas/BmmrType' + description: | + Required when connecting to a BMMR.
Use EQUINIX when BMMR Extension is required and Equinix installs it, or SELF when you install it yourself. + circuitId: type: string - format: date-time - data: + description: Circuit identifier of the Cross Connect. + redundancy: + allOf: + - $ref: '#/components/schemas/CrossConnectRedundancy' + description: | + Provide it to place a diverse Cross Connect against an existing one - set group to the redundancy group id or the serial number of the existing Cross Connect, and priority to SECONDARY. + aSide: + allOf: + - $ref: '#/components/schemas/CrossConnectASideRequest' + description: A-Side connection details. + zSide: + allOf: + - $ref: '#/components/schemas/CrossConnectZSideRequest' + description: | + Z-Side connection details.
Provide the DemarcationPoint, the LOA reference or the BMMR location depending on the Cross Connect being requested. + schedule: + allOf: + - $ref: '#/components/schemas/ScheduleRequest' + description: | + Preferred installation schedule. When omitted, the Cross Connect is scheduled with the STANDARD schedule code. + services: type: array items: - $ref: "#/components/schemas/CompanyProfileChangeItem" - default: [] - CompanyProfileSortDirection: + $ref: '#/components/schemas/CrossConnectServiceRequest' + description: Cross Connect Services. + notifications: + type: array + items: + $ref: '#/components/schemas/CrossConnectNotification' + description: | + Preferences for notifications on Cross Connect configuration or status changes. + order: + $ref: '#/components/schemas/OrderRequest' + notes: + type: array + maxItems: 1 + items: + $ref: '#/components/schemas/CrossConnectNoteRequest' + description: Additional Note. + attachments: + type: array + maxItems: 5 + items: + $ref: '#/components/schemas/CrossConnectAttachment' + description: Additional Attachments. + required: + - type + - name + - aSide + - zSide + CrossConnectState: + description: Cross Connect State. type: string - description: Sorting direction - default: ASC enum: - - DESC - - ASC - IssueLoa: - title: IssueLoa - type: object - description: Issue Loa - allOf: - - $ref: "#/components/schemas/LoaRequest" - - required: - - demarcationPoint - type: object - properties: - expirationDateTime: - $ref: "#/components/schemas/LoaExpiration" - requestor: - $ref: "#/components/schemas/LoaRequestor" - demarcationPoint: - $ref: "#/components/schemas/LoaDemarcationPoint" - RequestLoa: - title: RequestLoa - description: Request Loa - allOf: - - $ref: "#/components/schemas/LoaRequest" - - required: - - location - type: object - properties: - issuer: - $ref: "#/components/schemas/LoaIssuer" - location: - $ref: "#/components/schemas/LoaLocation" - LoaType: - type: string + - PENDING + - PENDING_ACTION + - PROVISIONING + - PROVISIONED + - DEPROVISIONING + - DEPROVISIONED + - CANCELLING + - CANCELLED + - FAILED + example: PENDING + CrossConnectActionType: description: | - Type of Letter of Authorization - example: PATCH_PANEL_PORT_LOA - enum: - - CAGE_LOA - - PATCH_PANEL_LOA - - PATCH_PANEL_PORT_LOA - LoaProductType: + Action to perform on the Cross Connect. The applicable action types are listed in the allowedActions of the Cross Connect.
XC_SIGNATURE_SUBMISSION - resend the quote to the customer email for signature.
XC_PROPOSED_DATE_TIME_ACCEPTANCE - accept the date and time proposed by Equinix.
XC_PROPOSED_DATE_TIME_REJECTION - reject the date and time proposed by Equinix. The expedite is cancelled and the Cross Connect is scheduled as STANDARD.
XC_CANCEL - cancel the Cross Connect before it is provisioned.
XC_DEINSTALL - remove a provisioned Cross Connect. Provide the removal schedule, and optionally the services, the notification contacts and the order details, in data.
XC_INFORMATION_UPDATE - provide the requested information as a note and an attachment. type: string - description: | - Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge - example: XC - enum: - - XC - - XF_PORT - - VD - LoaState: - type: string - description: Current lifecycle state of the LOA. - example: ACTIVE - enum: - - PENDING - - FAILED - - PENDING_AUTHORIZATION - - PENDING_ACCEPTANCE - - CANCELLED - - INACTIVE - - ACTIVE - - EXPIRED - LoaRequestor: - type: object - properties: - email: - type: string - description: Email address of the requestor contact. - format: email - example: user@org1.com - orgId: - type: integer - description: Organization ID of the requestor. - example: 9257 - orgName: - type: string - description: Organization name of the requestor. - example: ABC Inc. - description: Requestor - LoaIssuer: - type: object - properties: - email: - type: string - description: Email address of the issuer contact. - format: email - example: user@org1.com - orgId: - type: integer - description: Organization ID of the issuer. - example: 9257 - orgName: - type: string - description: Organization name of the issuer. - example: ABC Inc. - description: Issuer - LoaDemarcationPoint: - type: object - properties: - cageUniqueSpaceId: - type: string - description: Unique identifier of the Cage. - example: SV1:00:000000 - cabinetUniqueSpaceId: - type: string - description: Unique identifier of the Cabinet. - example: SV1:00:000000:0105 - patchPanelId: - type: string - description: | - Unique identifier of the Patch Panel. - example: CP:Demarc:1259684 - patchPanelPortA: - type: integer - description: | - Specify the desired port number.
When ports are not provided, next available ports will be used. - example: 23 - patchPanelPortB: - type: integer - description: | - Specify the desired port number.
When ports are not provided, next available ports will be used.
Required for Connector type FC and ST only. - example: 24 - connectorType: - $ref: "#/components/schemas/LoaPatchPanelConnectorType" - description: | - Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB - and connectorType is required. - LoaLocation: - type: object - properties: - ibxCode: - type: string - description: IBX Code - example: AM1 - description: Eligible location where LOA can be issued. - LoaExpiration: - type: string - description: | - Date and time when this LOA expires.
Default to 3 months from the creation date - format: date-time - example: 2026-11-06T07:00:00Z - LoaChangelog: - 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 - description: Change log - LoaActionType: - type: string - description: Action to perform on the LOA. - example: LOA_ISSUER_AUTHORIZATION - enum: - - LOA_ISSUER_AUTHORIZATION - - LOA_REQUESTOR_ACCEPTANCE - - LOA_COPY_LINK - - LOA_SEND_EMAIL_NOTIFICATION - - LOA_CANCEL - LoaActionData: - type: object - properties: - demarcationPoint: - $ref: "#/components/schemas/LoaDemarcationPoint" - expirationDateTime: - $ref: "#/components/schemas/LoaExpiration" - portalUrl: - $ref: "#/components/schemas/LoaMagicLink" - description: | - Action Data.
For LOA_ISSUER_AUTHORIZATION — always required. - LoaActionState: - type: string - description: Action State - enum: - - COMPLETED - - FAILED - - PENDING - LoaConsumer: - type: object - properties: - href: - type: string - description: Consumer URI - format: uri - example: https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: - type: string - description: Consumer Identifier - format: uuid - example: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: - $ref: "#/components/schemas/LoaProductType" - changeLog: - $ref: "#/components/schemas/LoaChangelog" - description: Associated consumer response - CrossConnectType: - type: string - description: Type of Cross Connect. - example: XC - enum: - - XC - BmmrType: - type: string - description: Cross Connect BMMR Type. - example: EQUINIX - enum: - - EQUINIX - - SELF - CrossConnectRedundancy: - type: object - properties: - group: - type: string - description: | - Redundancy group identifier. When placing a diverse Cross Connect against an existing one, provide either this identifier or the serial number of the existing Cross Connect. - example: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: - type: string - description: Priority within the redundancy group. - example: PRIMARY - enum: - - PRIMARY - - SECONDARY - description: Cross Connect Redundancy. - CrossConnectASideRequest: - title: CrossConnectASideRequest - type: object - properties: - demarcationPoint: - allOf: - - $ref: "#/components/schemas/CrossConnectDemarcationPoint" - - required: - - connectorType - - patchPanelId - type: object - description: A-Side connection details. - CrossConnectZSideRequest: - title: CrossConnectZSideRequest - type: object - properties: - demarcationPoint: - description: Required for a patch panel to patch panel Cross Connect. - allOf: - - $ref: "#/components/schemas/CrossConnectZSideRequestDemarcationPoint" - location: - description: Required when connecting to a BMMR. - allOf: - - $ref: "#/components/schemas/CrossConnectLocation" - loa: - description: Required for a Cross Connect with LOA and when bmmrType is EQUINIX. - allOf: - - $ref: "#/components/schemas/CrossConnectLoaRef" - description: | - Z-Side connection details. Provide the demarcationPoint for a patch panel to patch panel Cross Connect, or location when connecting to a BMMR. loa is mandatory for a Cross Connect with LOA and when bmmrType is EQUINIX - provide either loa.uuid or loa.digitalLoaId. - ScheduleRequest: - required: - - code - type: object - properties: - type: - type: string - description: Schedule type. - example: XC_INSTALL_SCHEDULE - enum: - - XC_INSTALL_SCHEDULE - code: - $ref: "#/components/schemas/ScheduleType" - autoConvertToStandard: - type: boolean - description: | - Applicable only when the code is EXPEDITE. When true, Equinix schedules the Cross Connect as STANDARD when no EXPEDITE scheduling is available. - example: true - readinessDateTime: - type: string - description: | - Carrier Circuit delivery date is the date when the Carrier commits to enable the circuit. Your order will be placed on hold, pending the date you enter. Equinix will wait for the Carrier to deliver the service and then will complete the installation. - format: date-time - example: 2026-02-26T07:21:39Z - requestedDateTime: - type: string - description: Requested Installation Date and Time. - format: date-time - example: 2026-02-27T07:21:39Z - description: Cross Connect Installation Schedule. - CrossConnectServiceRequest: - required: - - type - type: object - properties: - type: - $ref: "#/components/schemas/CrossConnectServiceType" - device: - description: | - Patch equipment device details. Required for the XC_PATCH_EQUIPMENT service. - allOf: - - $ref: "#/components/schemas/PatchEquipmentRequest" - description: - maxLength: 100 - type: string - description: | - Additional notes for the service. Required for the XC_PATCH_EQUIPMENT service. - example: additional notes for patch equipment - description: | - Service to order alongside the Cross Connect.
Send one entry per service.
device and description apply to the XC_PATCH_EQUIPMENT service only. - CrossConnectNotification: - required: - - emails - - type - type: object - properties: - type: - $ref: "#/components/schemas/NotificationType" - firstName: - type: string - description: | - First name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type. - example: John - lastName: - type: string - description: | - Last name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type. - example: Doe - emails: - type: array - description: Email addresses for notifications. - example: - - abc@test.com - items: - type: string - format: email - registeredUsers: - type: array - description: Registered users for notifications. - items: - type: string - phone: - type: array - description: Contact phone numbers. - items: - $ref: "#/components/schemas/CrossConnectPhone" - description: Cross Connect Notification. - OrderRequest: - type: object - properties: - orderNumber: - type: string - description: Order Number. - example: 1-1234567890 - orderLineItemNumber: - type: string - description: Order Line Item Number. - example: 1-1234567890 - purchaseOrder: - $ref: "#/components/schemas/PurchaseOrder" - customerReferenceId: - type: string - description: Customer Reference Identifier. - example: "12345" - description: Cross Connect Order. - CrossConnectProject: - required: - - projectId - type: object - properties: - projectId: - type: string - description: Project Identifier. - format: uuid - example: e41f485e-3094-42de-8797-0ef19a51df79 - description: Cross Connect Project. - CrossConnectEndCustomer: - type: object - properties: - isDisclosed: - type: boolean - description: Indicates if the end customer is disclosed. - example: true - name: - type: string - description: End customer name. - example: Acme Corporation - mdmId: - type: string - description: | - Master Data Management identifier of the end customer, as held by Equinix. - description: End customer details for the Cross Connect. - CrossConnectState: - type: string - description: Cross Connect State. - example: PENDING - enum: - - PENDING - - PENDING_ACTION - - PROVISIONING - - PROVISIONED - - DEPROVISIONING - - DEPROVISIONED - - CANCELLING - - CANCELLED - - FAILED - CrossConnectActionType: - type: string - description: | - Action to perform on the Cross Connect. The applicable action types are listed in the allowedActions of the Cross Connect.
XC_SIGNATURE_SUBMISSION - resend the quote to the customer email for signature.
XC_PROPOSED_DATE_TIME_ACCEPTANCE - accept the date and time proposed by Equinix.
XC_PROPOSED_DATE_TIME_REJECTION - reject the date and time proposed by Equinix. The expedite is cancelled and the Cross Connect is scheduled as STANDARD.
XC_CANCEL - cancel the Cross Connect before it is provisioned.
XC_DEINSTALL - remove a provisioned Cross Connect. Provide the removal schedule, and optionally the services, the notification contacts and the order details, in data.
XC_INFORMATION_UPDATE - provide the requested information as a note and an attachment. - example: XC_SIGNATURE_SUBMISSION enum: - XC_SIGNATURE_SUBMISSION - XC_PROPOSED_DATE_TIME_ACCEPTANCE @@ -35869,36 +67763,72 @@ components: - XC_CANCEL - XC_DEINSTALL - XC_INFORMATION_UPDATE + example: XC_SIGNATURE_SUBMISSION + CrossConnectASideDemarcationPoint: + description: | + A-Side demarcation point.
cageUniqueSpaceId and cabinetUniqueSpaceId identify the A-Side space. + allOf: + - $ref: '#/components/schemas/CrossConnectDemarcationPoint' + - type: object + properties: + cageUniqueSpaceId: + type: string + readOnly: true + description: Unique identifier of the Cage. + example: SV1:00:000000 + cabinetUniqueSpaceId: + type: string + readOnly: true + description: Unique identifier of the Cabinet. + example: SV1:00:000000:0100 CrossConnectASideResponse: title: CrossConnectASideResponse + description: A-Side connection details. type: object properties: demarcationPoint: - $ref: "#/components/schemas/CrossConnectASideDemarcationPoint" + $ref: '#/components/schemas/CrossConnectASideDemarcationPoint' location: - $ref: "#/components/schemas/CrossConnectLocation" - description: A-Side connection details. + $ref: '#/components/schemas/CrossConnectLocation' + CrossConnectZSideResponseDemarcationPoint: + description: | + Z-Side demarcation point.
cageUniqueSpaceId and cabinetUniqueSpaceId identify the Z-Side space. + allOf: + - $ref: '#/components/schemas/CrossConnectDemarcationPoint' + - type: object + properties: + cageUniqueSpaceId: + type: string + readOnly: true + description: Unique identifier of the Cage. + example: SV2:00:000000 + cabinetUniqueSpaceId: + type: string + readOnly: true + description: Unique identifier of the Cabinet. + example: SV2:00:000000:0100 CrossConnectZSideResponse: title: CrossConnectZSideResponse + description: Z-Side connection details. type: object properties: demarcationPoint: - $ref: "#/components/schemas/CrossConnectZSideResponseDemarcationPoint" + $ref: '#/components/schemas/CrossConnectZSideResponseDemarcationPoint' location: - $ref: "#/components/schemas/CrossConnectLocation" + $ref: '#/components/schemas/CrossConnectLocation' loa: - $ref: "#/components/schemas/CrossConnectLoaRef" - description: Z-Side connection details. + $ref: '#/components/schemas/CrossConnectLoaRef' CrossConnectAccount: + description: Account the Cross Connect belongs to. type: object properties: accountNumber: type: integer - description: Account number. format: int64 + description: Account number. example: 123456 - description: Account the Cross Connect belongs to. OrderResponse: + description: Cross Connect Order. type: object properties: orderNumber: @@ -35910,241 +67840,637 @@ components: description: Order Line Item Number. example: 1-1234567890 purchaseOrder: - $ref: "#/components/schemas/PurchaseOrder" + $ref: '#/components/schemas/PurchaseOrder' customerReferenceId: type: string description: Customer Reference Identifier. - example: "12345" - description: Cross Connect Order. + example: '12345' CrossConnectLink: + description: Link to a Cross Connect sub-resource. type: object properties: href: type: string - description: Sub-resource URI. format: uri readOnly: true + description: Sub-resource URI. example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules rel: type: string - description: Operation identifier of the linked sub-resource. readOnly: true + description: Operation identifier of the linked sub-resource. example: getCrossConnectSchedulesByUuid method: type: string - description: HTTP method to use on the sub-resource. readOnly: true + description: HTTP method to use on the sub-resource. example: GET contentType: type: string - description: Content type returned by the sub-resource. readOnly: true + description: Content type returned by the sub-resource. example: application/json authenticate: type: boolean - description: Whether authentication is required. readOnly: true + description: Whether authentication is required. example: true - description: Link to a Cross Connect sub-resource. CrossConnectChangelog: + description: Cross Connect Change Log. type: object properties: createdDateTime: type: string - description: Created Date and Time. format: date-time - example: 2026-02-28T07:21:39Z + description: Created Date and Time. + example: '2026-02-28T07:21:39Z' createdBy: type: string description: User key of the user who created the resource. - example: "1234" + example: '1234' updatedDateTime: type: string - description: Updated Date and Time. format: date-time - example: 2026-02-28T07:21:39Z + description: Updated Date and Time. + example: '2026-02-28T07:21:39Z' updatedBy: type: string description: User key of the user who last updated the resource. - example: "1234" - description: Cross Connect Change Log. - DeinstallScheduleRequest: - required: - - requestedDateTime - type: object - properties: - type: - type: string - description: Schedule type. - example: XC_DEINSTALL_SCHEDULE - enum: - - XC_DEINSTALL_SCHEDULE - code: - type: string - description: | - Schedule code of the removal. Only STANDARD is supported, and it is applied when the code is omitted. - example: STANDARD - default: STANDARD - enum: - - STANDARD - requestedDateTime: - type: string - description: Requested Removal Date and Time. - format: date-time - example: 2026-06-14T17:21:25.586Z - deinstallationDateTime: - type: string - description: Deinstallation Date and Time. - format: date-time - example: 2026-06-16T17:21:25.586Z - description: Cross Connect Deinstallation Schedule. - CrossConnectScheduleResponse: + example: '1234' + CrossConnectResponse: + description: Cross Connect Response. type: object properties: href: type: string - description: Schedule URI. format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/e41f485e-3094-42de-8797-0ef19a51df79 + description: Cross Connect URI. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 + type: + $ref: '#/components/schemas/CrossConnectType' uuid: type: string - description: Schedule Identifier. format: uuid - readOnly: true - example: e41f485e-3094-42de-8797-0ef19a51df79 - type: + description: Cross Connect Identifier. + example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 + name: type: string - description: | - Sub-resource type.
XC_INSTALL_SCHEDULE - Installation schedule.
XC_DEINSTALL_SCHEDULE - Deinstallation schedule. - readOnly: true - example: XC_INSTALL_SCHEDULE - enum: - - XC_INSTALL_SCHEDULE - - XC_DEINSTALL_SCHEDULE - code: - readOnly: true - allOf: - - $ref: "#/components/schemas/ScheduleType" + description: A short, descriptive name for this Cross Connect. + example: My-CC-service state: + $ref: '#/components/schemas/CrossConnectState' + allowedActions: + type: array readOnly: true - allOf: - - $ref: "#/components/schemas/CrossConnectScheduleState" - autoConvertToStandard: - type: boolean description: | - Indicates whether the Cross Connect is scheduled as STANDARD when no EXPEDITE scheduling is available. Returned only for EXPEDITE schedule. - readOnly: true - example: true - readinessDateTime: + List of actions that can be performed on the Cross Connect based on its current state. Use these values to determine which action types are valid to submit to the actions endpoint. + items: + type: object + properties: + type: + $ref: '#/components/schemas/CrossConnectActionType' + bmmrType: + $ref: '#/components/schemas/BmmrType' + mediaType: type: string - description: | - Carrier Circuit delivery date is the date when the Carrier commits to enable the circuit. Your order will be placed on hold, pending the date you enter. Equinix will wait for the Carrier to deliver the service and then will complete the installation. - format: date-time - readOnly: true - example: 2026-08-23T07:21:39Z - requestedDateTime: + description: Media type of the Cross Connect. + example: SINGLE_MODE_FIBER + mediaSubType: type: string - description: Requested Installation Date and Time. - format: date-time - readOnly: true - example: 2026-08-24T07:21:39Z - equinixProposedDateTime: + description: Media sub-type of the Cross Connect. + example: SINGLE_MODE_FIBER + circuitId: type: string - description: | - Date and Time proposed by Equinix when the EXPEDITE schedule is not available. - format: date-time - readOnly: true - example: 2026-08-25T07:21:39Z - installationDateTime: + description: Circuit identifier of the Cross Connect. + serialNumber: type: string - description: Installation Date and Time. - format: date-time readOnly: true - example: 2026-08-25T09:21:39Z - deinstallationDateTime: - type: string - description: Deinstallation Date and Time. Returned for a removal schedule. - format: date-time + description: Serial number of the Cross Connect. + example: '234567890' + redundancy: + $ref: '#/components/schemas/CrossConnectRedundancy' + aSide: + $ref: '#/components/schemas/CrossConnectASideResponse' + zSide: + $ref: '#/components/schemas/CrossConnectZSideResponse' + account: + $ref: '#/components/schemas/CrossConnectAccount' + notifications: + type: array + items: + $ref: '#/components/schemas/CrossConnectNotification' + description: | + Preferences for notifications on Cross Connect configuration or status changes. + order: + $ref: '#/components/schemas/OrderResponse' + links: + type: array readOnly: true - example: 2026-09-16T17:21:25.586Z + description: | + Links to the Cross Connect sub-resources - schedules, services, notes and attachments. + items: + $ref: '#/components/schemas/CrossConnectLink' changeLog: - $ref: "#/components/schemas/CrossConnectChangelog" + $ref: '#/components/schemas/CrossConnectChangelog' + DiverseCrossConnectRequest: + title: DiverseCrossConnectRequest + description: | + Request to create several Cross Connects in a single order. Use it to order a diverse pair - one PRIMARY and one SECONDARY entry provisioned at the same time on separate paths - or to order multiple Cross Connects at once by sending one entry per Cross Connect. + type: object + properties: + data: + type: array + minItems: 1 + description: | + For a diverse pair, send two entries - one with redundancy.priority PRIMARY and one with SECONDARY - and omit redundancy.group, which Equinix assigns. + items: + $ref: '#/components/schemas/CreateCrossConnect' + required: + - data + CrossConnectDiverse: + title: CrossConnectDiverse + description: | + Cross Connects returned by a diverse order. One item is returned per Cross Connect requested; a diverse pair returns the PRIMARY and the SECONDARY Cross Connect sharing one redundancy group. + type: object + properties: + data: + type: array + description: The Cross Connects the diverse order applies to. + items: + $ref: '#/components/schemas/CrossConnectResponse' + CrossConnectFieldName: + description: Possible field names to use on filters. + type: string + enum: + - /uuid + - /name + - /type + - /state + - /bmmrType + - /circuitId + - /serialNumber + - /redundancy/group + - /redundancy/priority + - /aSide/demarcationPoint/patchPanelId + - /aSide/demarcationPoint/patchPanelPortA + - /aSide/demarcationPoint/patchPanelPortB + - /aSide/location/ibxCode + - /zSide/demarcationPoint/patchPanelId + - /zSide/demarcationPoint/patchPanelPortA + - /zSide/demarcationPoint/patchPanelPortB + - /zSide/location/ibxCode + - /zSide/loa/uuid + - /account/accountNumber + - /order/orderNumber + - /order/customerReferenceId + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + example: /name + CrossConnectSearchSimpleExpressions: + type: object + properties: + property: + $ref: '#/components/schemas/CrossConnectFieldName' + operator: + type: string + enum: + - '=' + - '!=' + - LIKE + - ILIKE + - BETWEEN + - NOT BETWEEN + - IN + - NOT IN + - '>' + - < + - '>=' + - <= + example: '=' + values: + type: array + items: + type: string + example: + - My-CC-service + CrossConnectOrFilter: + type: object + properties: + or: + type: array + items: + $ref: '#/components/schemas/CrossConnectSearchSimpleExpressions' + CrossConnectFilter: + type: object + anyOf: + - $ref: '#/components/schemas/CrossConnectSearchSimpleExpressions' + - $ref: '#/components/schemas/CrossConnectOrFilter' + CrossConnectSearchFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/CrossConnectFilter' + CrossConnectSortCriteria: + type: object + properties: + direction: + description: Sorting direction. + default: DESC + type: string + enum: + - DESC + - ASC + property: + description: Possible field names to use on sorting. + default: /changeLog/updatedDateTime + type: string + enum: + - /name + - /state + - /changeLog/createdDateTime + - /changeLog/updatedDateTime + CrossConnectSearchRequest: + type: object + description: Search Cross Connects based on filter criteria. + properties: + filter: + $ref: '#/components/schemas/CrossConnectSearchFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/CrossConnectSortCriteria' + CrossConnectSearchResponse: + description: List of Cross Connects. + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/CrossConnectSortCriteria' + data: + type: array + items: + $ref: '#/components/schemas/CrossConnectResponse' + CrossConnectScheduleState: + description: Cross Connect Schedule State. + type: string + enum: + - PENDING + - COMPLETED + - FAILED + - CANCELLED + - PENDING_ACTION + example: COMPLETED + CrossConnectScheduleResponse: description: Schedule of a Cross Connect. - CrossConnectServiceResponse: type: object properties: href: type: string - description: Service URI. format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/e41f485e-3094-42de-8797-0ef19a51df79 + description: Schedule URI. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/e41f485e-3094-42de-8797-0ef19a51df79 uuid: type: string - description: Service Identifier. format: uuid readOnly: true + description: Schedule Identifier. example: e41f485e-3094-42de-8797-0ef19a51df79 type: + type: string readOnly: true + description: | + Sub-resource type.
XC_INSTALL_SCHEDULE - Installation schedule.
XC_DEINSTALL_SCHEDULE - Deinstallation schedule. + enum: + - XC_INSTALL_SCHEDULE + - XC_DEINSTALL_SCHEDULE + example: XC_INSTALL_SCHEDULE + code: allOf: - - $ref: "#/components/schemas/CrossConnectServiceType" + - $ref: '#/components/schemas/ScheduleType' + readOnly: true state: + allOf: + - $ref: '#/components/schemas/CrossConnectScheduleState' + readOnly: true + autoConvertToStandard: + type: boolean + readOnly: true + description: | + Indicates whether the Cross Connect is scheduled as STANDARD when no EXPEDITE scheduling is available. Returned only for EXPEDITE schedule. + example: true + readinessDateTime: + type: string + format: date-time + readOnly: true + description: | + Carrier Circuit delivery date is the date when the Carrier commits to enable the circuit. Your order will be placed on hold, pending the date you enter. Equinix will wait for the Carrier to deliver the service and then will complete the installation. + example: '2026-08-23T07:21:39Z' + requestedDateTime: + type: string + format: date-time + readOnly: true + description: Requested Installation Date and Time. + example: '2026-08-24T07:21:39Z' + equinixProposedDateTime: + type: string + format: date-time + readOnly: true + description: | + Date and Time proposed by Equinix when the EXPEDITE schedule is not available. + example: '2026-08-25T07:21:39Z' + installationDateTime: + type: string + format: date-time + readOnly: true + description: Installation Date and Time. + example: '2026-08-25T09:21:39Z' + deinstallationDateTime: + type: string + format: date-time + readOnly: true + description: Deinstallation Date and Time. Returned for a removal schedule. + example: '2026-09-16T17:21:25.586Z' + changeLog: + $ref: '#/components/schemas/CrossConnectChangelog' + SchedulesResponse: + description: Schedules of the Cross Connect. + type: object + properties: + data: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectScheduleResponse' + CrossConnectServiceState: + description: Service status. + type: string + enum: + - PENDING + - COMPLETED + - FAILED + example: COMPLETED + PatchEquipmentResponse: + description: Patch equipment installed for the Cross Connect. + type: object + properties: + cabinetUniqueSpaceId: + type: string + description: Unique identifier of the Cabinet. + example: SV2:00:000000:0100 + port: + type: integer + description: Port number. + example: 32 + connectorType: + $ref: '#/components/schemas/CrossConnectConnectorType' + CrossConnectServiceResponse: + description: Service ordered alongside the Cross Connect. + type: object + properties: + href: + type: string + format: uri + readOnly: true + description: Service URI. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: + type: string + format: uuid readOnly: true + description: Service Identifier. + example: e41f485e-3094-42de-8797-0ef19a51df79 + type: allOf: - - $ref: "#/components/schemas/CrossConnectServiceState" - device: - description: Patch equipment device details. Returned for the XC_PATCH_EQUIPMENT service. + - $ref: '#/components/schemas/CrossConnectServiceType' readOnly: true + state: + allOf: + - $ref: '#/components/schemas/CrossConnectServiceState' + readOnly: true + device: allOf: - - $ref: "#/components/schemas/PatchEquipmentResponse" + - $ref: '#/components/schemas/PatchEquipmentResponse' + readOnly: true + description: Patch equipment device details. Returned for the XC_PATCH_EQUIPMENT service. description: - maxLength: 100 type: string - description: Additional notes captured for the service. readOnly: true + description: Additional notes captured for the service. example: additional notes for patch equipment + maxLength: 100 changeLog: - $ref: "#/components/schemas/CrossConnectChangelog" - description: Service ordered alongside the Cross Connect. + $ref: '#/components/schemas/CrossConnectChangelog' + CrossConnectServicesResponse: + description: List of services ordered alongside the Cross Connect. + type: object + properties: + data: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectServiceResponse' + CrossConnectAttachmentResponse: + description: Document attached to a Cross Connect. + type: object + properties: + href: + type: string + format: uri + readOnly: true + description: URI to the attachment resource. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: + type: string + format: uuid + readOnly: true + description: Attachment resource Identifier. + example: e41f485e-3094-42de-8797-0ef19a51df79 + type: + type: string + readOnly: true + description: Sub-resource type. + enum: + - ATTACHMENT + example: ATTACHMENT + source: + type: string + readOnly: true + description: Attachment Source. + enum: + - CUSTOMER + - EQUINIX + example: CUSTOMER + attachmentId: + type: string + format: uuid + readOnly: true + description: Attachment Identifier. + example: a11f485e-3094-42de-8797-0ef19a51df79 + downloadHref: + type: string + format: uri + readOnly: true + description: | + URI to download the attachment file content from the Equinix attachment service. + example: https://api.equinix.com/ecp/attachments/a11f485e-3094-42de-8797-0ef19a51df79 + changeLog: + $ref: '#/components/schemas/CrossConnectChangelog' + CrossConnectAttachmentsResponse: + description: List of documents attached to the Cross Connect. + type: object + properties: + data: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectAttachmentResponse' CrossConnectParentNote: + description: Note that this note is responding to. + type: object + properties: + href: + type: string + format: uri + readOnly: true + description: Parent note URI. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: + type: string + format: uuid + description: Parent note UUID. + example: e41f485e-3094-42de-8797-0ef19a51df79 required: - uuid + CrossConnectNoteResponse: + description: Cross Connect Note. type: object properties: href: type: string - description: Parent note URI. format: uri readOnly: true + description: Note URI. example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 uuid: type: string - description: Parent note UUID. format: uuid + readOnly: true + description: Note Identifier. example: e41f485e-3094-42de-8797-0ef19a51df79 - description: Note that this note is responding to. + type: + type: string + readOnly: true + description: Sub-resource type. + enum: + - NOTE + example: NOTE + source: + type: string + readOnly: true + description: Party that added the note. + enum: + - CUSTOMER + - EQUINIX + example: CUSTOMER + comments: + type: string + readOnly: true + description: Note comments. + example: this is reply to the technician note. + maxLength: 4000 + parentNote: + allOf: + - $ref: '#/components/schemas/CrossConnectParentNote' + readOnly: true + description: | + The note this note is responding to. Returned when the note was added in response to an Equinix note. + changeLog: + $ref: '#/components/schemas/CrossConnectChangelog' + CrossConnectNotesResponse: + description: List of notes added to the Cross Connect. + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectNoteResponse' + CrossConnectActionNote: + description: Note supplied by the customer when responding to an action. + type: object + properties: + parentNote: + $ref: '#/components/schemas/CrossConnectParentNote' + comments: + type: string + description: Note comments. + example: Please proceed + maxLength: 4000 + required: + - comments + DeinstallScheduleRequest: + description: Cross Connect Deinstallation Schedule. + type: object + properties: + type: + type: string + description: Schedule type. + enum: + - XC_DEINSTALL_SCHEDULE + example: XC_DEINSTALL_SCHEDULE + code: + type: string + description: | + Schedule code of the removal. Only STANDARD is supported, and it is applied when the code is omitted. + enum: + - STANDARD + default: STANDARD + example: STANDARD + requestedDateTime: + type: string + format: date-time + description: Requested Removal Date and Time. + example: '2026-06-14T17:21:25.586Z' + deinstallationDateTime: + type: string + format: date-time + description: Deinstallation Date and Time. + example: '2026-06-16T17:21:25.586Z' + required: + - requestedDateTime CrossConnectActionData: + description: | + Action Data.
notes and attachments are applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.
schedule is required for XC_DEINSTALL, where liveTrafficConsentProvided, services, notifications and order are applicable.
Not applicable to the other action types. type: object properties: notes: - maxItems: 1 type: array - description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. + maxItems: 1 items: - $ref: "#/components/schemas/CrossConnectActionNote" + $ref: '#/components/schemas/CrossConnectActionNote' + description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. attachments: - maxItems: 5 type: array - description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. + maxItems: 5 items: - $ref: "#/components/schemas/CrossConnectAttachment" + $ref: '#/components/schemas/CrossConnectAttachment' + description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. schedule: + allOf: + - $ref: '#/components/schemas/DeinstallScheduleRequest' description: | Removal schedule. Required for XC_DEINSTALL - the requestedDateTime is mandatory and only the STANDARD schedule type is supported. - allOf: - - $ref: "#/components/schemas/DeinstallScheduleRequest" liveTrafficConsentProvided: type: boolean description: | @@ -36152,141 +68478,465 @@ components: example: true services: type: array + items: + $ref: '#/components/schemas/CrossConnectServiceRequest' description: | Applicable for XC_DEINSTALL. Only XC_PATCH_EQUIPMENT is supported for deinstall. - items: - $ref: "#/components/schemas/CrossConnectServiceRequest" notifications: type: array + items: + $ref: '#/components/schemas/CrossConnectNotification' description: | Applicable for XC_DEINSTALL. The contacts are appended to the ones already held on the Cross Connect. - items: - $ref: "#/components/schemas/CrossConnectNotification" order: + allOf: + - $ref: '#/components/schemas/OrderRequest' description: | Applicable for XC_DEINSTALL. The purchase order and the customer reference identifier replace the ones already held on the Cross Connect. - allOf: - - $ref: "#/components/schemas/OrderRequest" - description: | - Action Data.
notes and attachments are applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.
schedule is required for XC_DEINSTALL, where liveTrafficConsentProvided, services, notifications and order are applicable.
Not applicable to the other action types. + CrossConnectActionRequest: + description: Cross Connect Action Request. + type: object + properties: + type: + $ref: '#/components/schemas/CrossConnectActionType' + data: + $ref: '#/components/schemas/CrossConnectActionData' + required: + - type CrossConnectActionState: - type: string description: Cross Connect Action State. - example: COMPLETED + type: string enum: - PENDING - COMPLETED - FAILED - CrossConnectActionResponseData: + example: COMPLETED + CrossConnectActionNoteResponse: + description: Note the action applies to. type: object properties: - notes: - maxItems: 1 - type: array - description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. - readOnly: true - items: - $ref: "#/components/schemas/CrossConnectActionNoteResponse" - attachments: - maxItems: 5 - type: array - description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. + href: + type: string + format: uri readOnly: true - items: - $ref: "#/components/schemas/CrossConnectActionAttachmentResponse" - schedule: - description: Applicable for XC_DEINSTALL. + description: Note URI. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: + type: string + format: uuid readOnly: true + description: Note Identifier. + example: e41f485e-3094-42de-8797-0ef19a51df79 + parentNote: allOf: - - $ref: "#/components/schemas/CrossConnectScheduleResponse" - liveTrafficConsentProvided: - type: boolean - description: | - Applicable for XC_DEINSTALL. Confirms the customer consents to the removal even though the Cross Connect may still be carrying live traffic. + - $ref: '#/components/schemas/CrossConnectParentNote' readOnly: true - example: true - services: - type: array description: | - Applicable for XC_DEINSTALL. Only XC_PATCH_EQUIPMENT is supported for deinstall. + The note this note is responding to. Returned when the note was added in response to an Equinix note. + comments: + type: string readOnly: true - items: - $ref: "#/components/schemas/CrossConnectServiceResponse" - notifications: - type: array - description: | - Applicable for XC_DEINSTALL. The contacts are appended to the ones already held on the Cross Connect. + description: Note comments. + example: Please proceed + maxLength: 4000 + CrossConnectActionAttachmentResponse: + description: Document the action applies to. + type: object + properties: + href: + type: string + format: uri readOnly: true - items: - $ref: "#/components/schemas/CrossConnectNotification" + description: URI to the attachment resource. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79 + uuid: + type: string + format: uuid + readOnly: true + description: Attachment resource Identifier. + example: e41f485e-3094-42de-8797-0ef19a51df79 + attachmentId: + type: string + format: uuid + readOnly: true + description: Attachment Identifier. + example: a11f485e-3094-42de-8797-0ef19a51df79 + CrossConnectActionResponseData: + description: | + Action Data.
notes and attachments are applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.
schedule, services, liveTrafficConsentProvided, notifications and order are applicable for XC_DEINSTALL.
Each schedule, service, note and attachment carries the href and the uuid of the sub-resource it refers to.
Not applicable to the other action types. + type: object + properties: + notes: + type: array + maxItems: 1 + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectActionNoteResponse' + description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. + attachments: + type: array + maxItems: 5 + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectActionAttachmentResponse' + description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. + schedule: + allOf: + - $ref: '#/components/schemas/CrossConnectScheduleResponse' + readOnly: true + description: Applicable for XC_DEINSTALL. + liveTrafficConsentProvided: + type: boolean + readOnly: true + description: | + Applicable for XC_DEINSTALL. Confirms the customer consents to the removal even though the Cross Connect may still be carrying live traffic. + example: true + services: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectServiceResponse' + description: | + Applicable for XC_DEINSTALL. Only XC_PATCH_EQUIPMENT is supported for deinstall. + notifications: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectNotification' + description: | + Applicable for XC_DEINSTALL. The contacts are appended to the ones already held on the Cross Connect. order: + allOf: + - $ref: '#/components/schemas/OrderResponse' + readOnly: true description: | Applicable for XC_DEINSTALL. The purchase order and the customer reference identifier replace the ones already held on the Cross Connect. + CrossConnectActionResponse: + description: Cross Connect Action Response. + type: object + properties: + href: + type: string + format: uri + readOnly: true + description: Action URI. + example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 + uuid: + type: string + format: uuid readOnly: true + description: Action Identifier. + example: 30cc7878-54e3-4e1a-8651-87a61354bad4 + type: allOf: - - $ref: "#/components/schemas/OrderResponse" - description: | - Action Data.
notes and attachments are applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.
schedule, services, liveTrafficConsentProvided, notifications and order are applicable for XC_DEINSTALL.
Each schedule, service, note and attachment carries the href and the uuid of the sub-resource it refers to.
Not applicable to the other action types. + - $ref: '#/components/schemas/CrossConnectActionType' + readOnly: true + state: + allOf: + - $ref: '#/components/schemas/CrossConnectActionState' + readOnly: true + data: + allOf: + - $ref: '#/components/schemas/CrossConnectActionResponseData' + readOnly: true + changeLog: + allOf: + - $ref: '#/components/schemas/CrossConnectChangelog' + readOnly: true + CrossConnectActionFieldName: + description: Possible field names to use on filters. + type: string + enum: + - /type + - /state + - /uuid + CrossConnectActionSearchSimpleExpressions: + type: object + properties: + property: + $ref: '#/components/schemas/CrossConnectActionFieldName' + operator: + type: string + enum: + - '=' + - '!=' + - LIKE + - ILIKE + - BETWEEN + - NOT BETWEEN + - IN + - NOT IN + - '>' + - < + - '>=' + - <= + values: + type: array + items: + type: string + example: XC_SIGNATURE_SUBMISSION + CrossConnectActionOrFilter: + type: object + properties: + or: + type: array + items: + $ref: '#/components/schemas/CrossConnectActionSearchSimpleExpressions' + CrossConnectActionFilter: + type: object + anyOf: + - $ref: '#/components/schemas/CrossConnectActionSearchSimpleExpressions' + - $ref: '#/components/schemas/CrossConnectActionOrFilter' + CrossConnectActionSearchFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/CrossConnectActionFilter' + CrossConnectActionSortCriteria: + type: object + properties: + direction: + description: Sorting direction. + default: DESC + type: string + enum: + - DESC + - ASC + property: + description: Possible field names to use on sorting. + default: /changeLog/createdDateTime + type: string + enum: + - /changeLog/createdDateTime + CrossConnectActionSearchRequest: + type: object + description: Search Cross Connect actions based on filter criteria. + properties: + filter: + $ref: '#/components/schemas/CrossConnectActionSearchFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/CrossConnectActionSortCriteria' + CrossConnectActionSearchResponse: + description: List of Cross Connect Actions. + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/CrossConnectActionSortCriteria' + data: + type: array + items: + $ref: '#/components/schemas/CrossConnectActionResponse' + CrossConnectScheduleFieldName: + description: Possible field names to use on filters. + type: string + enum: + - /type + - /code + - /aSide/location/ibxCode + - /zSide/location/ibxCode + example: /aSide/location/ibxCode + CrossConnectScheduleSearchSimpleExpressions: + type: object + properties: + property: + $ref: '#/components/schemas/CrossConnectScheduleFieldName' + operator: + type: string + enum: + - '=' + - '!=' + - IN + - NOT IN + example: '=' + values: + type: array + items: + type: string + example: + - SV11 + CrossConnectScheduleSearchFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/CrossConnectScheduleSearchSimpleExpressions' + CrossConnectScheduleSortCriteria: + type: object + properties: + direction: + description: Sorting direction. + default: DESC + type: string + enum: + - DESC + - ASC + property: + description: Possible field names to use on sorting. + default: /startDateTime + type: string + enum: + - /code + - /startDateTime + - /endDateTime + CrossConnectScheduleSearchRequest: + type: object + description: Search Cross Connect schedules based on filter criteria. + properties: + filter: + $ref: '#/components/schemas/CrossConnectScheduleSearchFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/CrossConnectScheduleSortCriteria' CrossConnectScheduleAvailability: + description: Cross Connect schedule window offered at an IBX. type: object properties: href: type: string - description: Schedule URI. format: uri readOnly: true + description: Schedule URI. example: https://api.equinix.com/fabric/v4/crossConnectSchedules/EXPEDITE type: type: string + readOnly: true description: | Sub-resource type.
XC_INSTALL_SCHEDULE - Installation schedule windows. - readOnly: true - example: XC_INSTALL_SCHEDULE enum: - XC_INSTALL_SCHEDULE + example: XC_INSTALL_SCHEDULE code: - readOnly: true allOf: - - $ref: "#/components/schemas/ScheduleType" + - $ref: '#/components/schemas/ScheduleType' + readOnly: true aSide: - $ref: "#/components/schemas/CrossConnectScheduleAvailability_aSide" + type: object + readOnly: true + description: A-Side of the schedule window. + properties: + location: + $ref: '#/components/schemas/CrossConnectLocation' zSide: - $ref: "#/components/schemas/CrossConnectScheduleAvailability_zSide" + type: object + readOnly: true + description: Z-Side of the schedule window. + properties: + location: + $ref: '#/components/schemas/CrossConnectLocation' startDateTime: type: string - description: Start of the schedule window. format: date-time readOnly: true - example: 2026-03-05T17:00:00Z + description: Start of the schedule window. + example: '2026-03-05T17:00:00Z' endDateTime: type: string - description: End of the schedule window. format: date-time readOnly: true - example: 2026-03-10T17:24:00Z + description: End of the schedule window. + example: '2026-03-10T17:24:00Z' unavailableDates: type: array + readOnly: true description: | Dates within the schedule window when the IBX is unavailable, such as the holidays observed at the IBX. - readOnly: true items: type: string format: date - example: 2026-03-07 - description: Cross Connect schedule window offered at an IBX. + example: '2026-03-07' + SearchSchedulesResponse: + description: List of Cross Connect schedule windows offered at an IBX. + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + sort: + type: array + items: + $ref: '#/components/schemas/CrossConnectScheduleSortCriteria' + data: + type: array + readOnly: true + items: + $ref: '#/components/schemas/CrossConnectScheduleAvailability' + TagRequest: + description: Equinix Fabric Tag Request Object + type: object + required: + - type + - displayName + properties: + type: + type: string + description: Type of tag + example: PREDEFINED_TAG + displayName: + type: string + minLength: 1 + maxLength: 24 + description: Display name of the Tag + example: LLM + notifications: + example: + - type: NOTIFICATION + emails: + - example1@example.com + - example2@example.com + type: array + items: + $ref: '#/components/schemas/SimplifiedNotification' AppDomainType: - type: string description: App Domain Type - example: APP_DOMAIN - default: APP_DOMAIN + type: string enum: - APP_DOMAIN + default: APP_DOMAIN + example: APP_DOMAIN x-order: 2 + AppDomainPostRequest: + type: object + description: Create App Domain + properties: + type: + $ref: '#/components/schemas/AppDomainType' + name: + description: Customer-provided App Domain name + type: string + format: string + minLength: 1 + maxLength: 50 + example: atlassian.net + description: + description: Customer-provided App Domain description + type: string + format: string + example: Atlassian Domain + project: + $ref: '#/components/schemas/Project' + required: + - type + - name + - project AppDomainState: - type: string description: App Domain lifecycle state + type: string format: string - example: PENDING_VERIFICATION enum: - PENDING_VERIFICATION - PROVISIONING_FAILED @@ -36294,31968 +68944,2468 @@ components: - DEPROVISIONING - DEPROVISIONING_FAILED - DEPROVISIONED + example: PENDING_VERIFICATION x-order: 6 - AppDomainChange: + AppDomainChangeOperation: + description: App Domain change operation data + type: object + properties: + op: + description: operation type applied to the resource + type: string + enum: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter + type: string + enum: + - /description + value: + description: new value for updated parameter + x-go-type: json.RawMessage required: - - type - - updatedDateTime + - op + - path + - value + AppDomainChange: + description: Current state of latest AppDomain change type: object properties: uuid: - type: string description: Uniquely identifies a change - type: type: string + type: description: Type of change + type: string enum: - APP_DOMAIN_UPDATE status: - type: string description: Current outcome of the change flow + type: string enum: - COMPLETED - FAILED - REQUESTED createdDateTime: - type: string description: Set when change flow starts + type: string format: date-time - example: 2026-06-29T07:00:00Z + example: '2026-06-29T07:00:00Z' updatedDateTime: - type: string description: Set when change object is updated + type: string format: date-time - example: 2026-06-29T07:15:00Z + example: '2026-06-29T07:15:00Z' data: type: array items: - $ref: "#/components/schemas/AppDomainChangeOperation" - description: Current state of latest AppDomain change - AppDomainChangeOperation: - required: - - op - - path - - value - type: object - properties: - op: - type: string - description: operation type applied to the resource - enum: - - replace - - add - - remove - path: - type: string - description: path inside document leading to updated parameter - enum: - - /description - value: - type: object - description: new value for updated parameter - x-go-type: json.RawMessage - description: App Domain change operation data - AppLinkState: - type: string - description: App Link lifecycle state - format: string - example: PROVISIONING - enum: - - PROVISIONING - - PROVISIONING_FAILED - - PROVISIONED - - DEPROVISIONING - - DEPROVISIONING_FAILED - - DEPROVISIONED - - REPROVISIONING - x-order: 6 - AppDomainAttachedAppLink: + $ref: '#/components/schemas/AppDomainChangeOperation' required: - type - - uuid + - updatedDateTime + AppDomain: + description: App Domain object type: object properties: href: - type: string description: Resource URI + type: string format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + example: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 x-order: 1 type: - $ref: "#/components/schemas/AppLinkType" + $ref: '#/components/schemas/AppDomainType' uuid: - type: string description: Equinix-assigned access point identifier + type: string format: uuid - example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 x-order: 3 name: + description: Customer-provided App Domain name type: string - description: Customer-provided App Link name format: string - example: Atlassian App Link + example: atlassian.net x-order: 4 description: + description: Customer-provided App Domain description type: string - description: Customer-provided App Link description format: string - example: Atlassian App Link in SV + example: Atlassian Domain x-order: 5 state: - $ref: "#/components/schemas/AppLinkState" - router: - $ref: "#/components/schemas/AppLinkCloudRouter" - ipv4Subnet: - type: string - description: Customer-provided IP subnet for AppLink setup (/29 or larger subnet) - example: 192.168.10.0/29 - x-order: 8 - ipv4Address: - type: string - description: App Link IP address - format: ipv4 - example: 192.168.10.1 - x-order: 9 - bandwidth: - type: integer - description: App Link aggregated data transfer capacity in Mbps - example: 1000 - x-order: 10 + $ref: '#/components/schemas/AppDomainState' project: - $ref: "#/components/schemas/Project" - description: App Link object - AppLinkType: - type: string - description: App Link Type - example: APP_LINK - default: APP_LINK - enum: - - APP_LINK - x-order: 2 - AppLinkPostRequestRouter: - required: - - uuid - type: object - properties: - uuid: - type: string - description: Cloud Router UUID - format: uuid - example: 36204584-2ae1-44f6-980f-08ecd555d9c6 - description: Cloud Router reference for App Link - AppLinkCloudRouter: - type: object - properties: - href: - type: string - description: Resource URI - format: uri - example: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - x-order: 1 - type: - type: string - description: Cloud Router Type - example: XF_ROUTER - enum: - - XF_ROUTER - x-order: 2 - uuid: - type: string - description: Cloud Router UUID - format: uuid - example: 36204584-2ae1-44f6-980f-08ecd555d9c6 - x-order: 3 - description: App Link Cloud Router - x-order: 7 - AppLinkChange: + $ref: '#/components/schemas/Project' + changeLog: + $ref: '#/components/schemas/Changelog' + change: + $ref: '#/components/schemas/AppDomainChange' required: - type - - updatedDateTime + - name + - project + AppDomainUpdateRequest: + description: App Domain Update Request + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/AppDomainChangeOperation' + AppDomainSimpleExpression: type: object properties: - uuid: + property: + description: | + Possible field names to use on filters: + * `/project/projectId` - project id + * `/uuid` - App Domain uuid + * `/name` - App Domain name + * `/description` - App Domain description + * `/state` - App Domain status + * `/changeLog/createdDateTime` - App Domain creation timestamp + * `/changeLog/updatedDateTime` - App Domain last updated timestamp + * `/changeLog/deletedDateTime` - App Domain deletion timestamp type: string - description: Uniquely identifies a change - type: + example: /name + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `>` - greater than + * `<` - less than + * `IN` - in + * `NOT IN` - not in + * `LIKE` - like + * `ILIKE` - case-insensitive like + * `BETWEEN` - between + * `NOT BETWEEN` - not between type: string - description: Type of change - enum: - - APP_LINK_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: 2026-06-29T07:00:00Z - updatedDateTime: - type: string - description: Set when change object is updated - format: date-time - example: 2026-06-29T07:15:00Z - data: + example: '=' + values: type: array items: - $ref: "#/components/schemas/AppLinkChangeOperation" - description: Current state of latest AppLink change - AppLinkChangeOperation: - required: - - op - - path - - value + type: string + example: Gateway + AppDomainOrFilter: type: object properties: - op: - type: string - description: operation type applied to the resource - enum: - - replace - - add - - remove - path: - type: string - description: path inside document leading to updated parameter - enum: - - /name - - /description - - /bandwidth - - /ipv4Subnet - value: - type: object - description: new value for updated parameter - x-go-type: json.RawMessage - description: App Link change operation data - AppLinkAttachState: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppDomainSimpleExpression' + AppDomainFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppDomainSimpleExpression' + - $ref: '#/components/schemas/AppDomainOrFilter' + AppDomainFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/AppDomainFilter' + AppDomainSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + AppDomainSortBy: + description: | + Possible field names to use on '400_InvalidSorting': + * `/name` - App Domain name + * `/uuid` - App Domain uuid + * `/state` - App Domain status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime + type: string + format: string + example: /changeLog/updatedDateTime + AppDomainSortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/AppDomainSortDirection' + property: + $ref: '#/components/schemas/AppDomainSortBy' + AppDomainSearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/AppDomainFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppDomainSortCriteria' + AppDomainSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppDomain' + AppLinkState: + description: App Link lifecycle state type: string - description: App Link attachment lifecycle state format: string - example: ATTACHED enum: - - ATTACHING - - ATTACHING_FAILED - - ATTACHED - - DETACHING - - DETACHING_FAILED - - DETACHED - - REATTACHING - - REATTACHING_FAILED - x-order: 10 - AppLinkAttachedAppDomain: - required: - - type - - uuid + - PROVISIONING + - PROVISIONING_FAILED + - PROVISIONED + - DEPROVISIONING + - DEPROVISIONING_FAILED + - DEPROVISIONED + - REPROVISIONING + example: PROVISIONING + x-order: 6 + AttachedAppLinkState: + description: Filter attached App Links by lifecycle state. + type: array + items: + $ref: '#/components/schemas/AppLinkState' + example: + - PROVISIONED + - PROVISIONING + AttachedAppLinkOrder: + description: Sort order for attached App Links. + type: string + enum: + - DESC + - ASC + default: DESC + example: DESC + Style: + description: Detail level of the response. + type: string + enum: + - MIN + - MEDIUM + - FULL + default: MEDIUM + example: MEDIUM + AppLinkType: + description: App Link Type + type: string + enum: + - APP_LINK + default: APP_LINK + example: APP_LINK + x-order: 2 + AppLinkCloudRouter: + description: App Link Cloud Router type: object + x-order: 7 properties: href: + description: Resource URI + type: string + format: uri + example: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 + x-order: 1 + type: + type: string + description: Cloud Router Type + enum: + - XF_ROUTER + example: XF_ROUTER + x-order: 2 + uuid: type: string + description: Cloud Router UUID + format: uuid + example: 36204584-2ae1-44f6-980f-08ecd555d9c6 + x-order: 3 + AppDomainAttachedAppLink: + description: App Link object + type: object + properties: + href: description: Resource URI + type: string format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + example: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 x-order: 1 type: - $ref: "#/components/schemas/AppDomainType" + $ref: '#/components/schemas/AppLinkType' uuid: - type: string description: Equinix-assigned access point identifier + type: string format: uuid - example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 x-order: 3 name: + description: Customer-provided App Link name type: string - description: Customer-provided App Domain name format: string - example: atlassian.net + example: Atlassian App Link x-order: 4 description: + description: Customer-provided App Link description type: string - description: Customer-provided App Domain description format: string - example: Atlassian Domain + example: Atlassian App Link in SV x-order: 5 state: - $ref: "#/components/schemas/AppDomainState" + $ref: '#/components/schemas/AppLinkState' + router: + $ref: '#/components/schemas/AppLinkCloudRouter' + ipv4Subnet: + description: Customer-provided IP subnet for AppLink setup (/29 or larger subnet) + type: string + example: 192.168.10.0/29 + x-order: 8 + ipv4Address: + description: App Link IP address + type: string + format: ipv4 + example: 192.168.10.1 + x-order: 9 + bandwidth: + description: App Link aggregated data transfer capacity in Mbps + type: integer + example: 1000 + x-order: 10 project: - $ref: "#/components/schemas/Project" - attachmentStatus: - $ref: "#/components/schemas/AppLinkAttachState" - description: App Domain object associated with App Link - AppServiceType: - type: string - description: App Service Type - example: APP_SERVICE - default: APP_SERVICE - enum: - - APP_SERVICE - x-order: 2 - AppLinkAppServiceAttachmentChange: + $ref: '#/components/schemas/Project' required: - type - - updatedDateTime + - uuid + AppDomainAttachedAppLinks: type: object properties: - uuid: - type: string - description: Uniquely identifies a change - type: - type: string - description: Type of change - enum: - - APP_SERVICE_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: 2026-06-29T07:00:00Z - updatedDateTime: - type: string - description: Set when change object is updated - format: date-time - example: 2026-06-29T07:15:00Z + pagination: + $ref: '#/components/schemas/Pagination' data: + description: Data returned from the API call. type: array items: - $ref: "#/components/schemas/AppLinkChangeOperation" - description: Current state of latest AppLink change - AppLinkAppServiceAttachmentChangeOperation: - required: - - op - - path - - value + $ref: '#/components/schemas/AppDomainAttachedAppLink' + AppLinkPostRequestRouter: type: object + description: Cloud Router reference for App Link properties: - op: - type: string - description: operation type applied to the resource - enum: - - replace - - add - - remove - path: + uuid: type: string - description: path inside document leading to updated parameter - enum: - - /destinationIp - value: - type: object - description: new value for updated parameter - x-go-type: json.RawMessage - description: App Link change operation data - AppLinkAttachedAppService: + description: Cloud Router UUID + format: uuid + example: 36204584-2ae1-44f6-980f-08ecd555d9c6 required: - - destinationIp - - geoScope - - type - uuid + AppLinkPostRequest: type: object + description: Create App Link properties: - href: - type: string - description: Resource URI - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - x-order: 1 type: - $ref: "#/components/schemas/AppServiceType" - uuid: - type: string - description: Equinix-assigned access point identifier - format: uuid - example: 5008a109-9d1c-485c-b0ba-de9736f283c2 - x-order: 3 + $ref: '#/components/schemas/AppLinkType' name: + description: Customer-provided App Link name type: string - description: Customer-provided App Service name format: string - example: Atlassian App Service - x-order: 4 + minLength: 1 + maxLength: 50 + example: Atlassian App Link description: + description: Customer-provided App Link description type: string - description: Customer-provided App Service description format: string - example: Atlassian App Service in SV - x-order: 5 - state: - $ref: "#/components/schemas/AppServiceState" - endpoint: + example: Atlassian App Link in SV + router: + $ref: '#/components/schemas/AppLinkPostRequestRouter' + ipv4Subnet: + description: Customer-provided IP subnet for AppLink setup (/29 or larger subnet) type: string - description: Accessible endpoint through this service - example: equinixjira.atlassian.net - x-order: 7 - sourceDomains: - type: array - description: List of source domains from where traffic is allowed - items: - type: string - example: equinix.com - x-order: 8 + example: 192.168.10.0/29 + bandwidth: + description: App Link aggregated data transfer capacity in Mbps + type: integer + example: 1000 project: - $ref: "#/components/schemas/Project" - geoScope: - type: string - description: Geo scope for the App Service - example: GLOBAL - x-order: 4 - destinationIp: - type: string - description: Target IP for forwarding API requests - format: ipv4 - example: 10.10.1.110 - x-order: 5 - attachmentStatus: - $ref: "#/components/schemas/AppLinkAttachState" - description: App Service object associated with App Link - AppProcessorType: - type: string - description: App Processor Type - example: APP_PROCESSOR - default: APP_PROCESSOR - enum: - - APP_PROCESSOR - x-order: 2 - AppProcessorState: - type: string - description: App Processor lifecycle state - format: string - example: PROVISIONING - enum: - - PROVISIONING - - PROVISIONING_FAILED - - PROVISIONED - - DEPROVISIONING - - DEPROVISIONING_FAILED - - DEPROVISIONED - - REPROVISIONING - x-order: 6 - AppProcessorMarketplace: - required: - - visibility - type: object - properties: - visibility: - type: string - description: App Processor marketplace visibility - format: string - example: PUBLIC - default: PUBLIC - enum: - - PUBLIC - - PRIVATE - description: App Processor marketplace settings - x-order: 8 - AppProcessorChange: + $ref: '#/components/schemas/Project' required: - type - - updatedDateTime + - name + - router + - ipv4Subnet + - bandwidth + - project + AppLinkChangeOperation: + description: App Link change operation data type: object properties: - uuid: - type: string - description: Uniquely identifies a change - type: + op: + description: operation type applied to the resource type: string - description: Type of change enum: - - APP_PROCESSOR_UPDATE - status: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter 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: 2026-06-29T07:00:00Z - updatedDateTime: - type: string - description: Set when change object is updated - format: date-time - example: 2026-06-29T07:15:00Z - data: - type: array - items: - $ref: "#/components/schemas/AppProcessorChangeOperation" - description: Current state of latest AppProcessor change - AppServiceState: - type: string - description: App Service lifecycle state - example: PROVISIONING - enum: - - PROVISIONING - - PROVISIONED - - DEPROVISIONING - - DEPROVISIONED - - REPROVISIONING - x-order: 6 - AppServiceChange: + - /name + - /description + - /bandwidth + - /ipv4Subnet + value: + description: new value for updated parameter + x-go-type: json.RawMessage required: - - type - - updatedDateTime + - op + - path + - value + AppLinkChange: + description: Current state of latest AppLink change type: object properties: uuid: - type: string description: Uniquely identifies a change - type: type: string + type: description: Type of change + type: string enum: - - APP_SERVICE_UPDATE + - APP_LINK_UPDATE status: - type: string description: Current outcome of the change flow + type: string enum: - COMPLETED - FAILED - REQUESTED createdDateTime: - type: string description: Set when change flow starts + type: string format: date-time - example: 2026-06-29T07:00:00Z + example: '2026-06-29T07:00:00Z' updatedDateTime: - type: string description: Set when change object is updated + type: string format: date-time - example: 2026-06-29T07:15:00Z + example: '2026-06-29T07:15:00Z' data: type: array items: - $ref: "#/components/schemas/AppServiceChangeOperation" - description: Current state of latest AppService change - AppServiceChangeOperation: - required: - - op - - path - - value - type: object - properties: - op: - type: string - description: operation type applied to the resource - enum: - - replace - - add - - remove - path: - type: string - description: path inside document leading to updated parameter - enum: - - /name - - /description - - /sourceDomains - value: - type: object - description: new value for updated parameter - x-go-type: json.RawMessage - description: App Service change operation data - AppServiceAttachedAppLink: + $ref: '#/components/schemas/AppLinkChangeOperation' required: - type - - uuid + - updatedDateTime + AppLink: + description: App Link object type: object properties: href: - type: string description: Resource URI + type: string format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 x-order: 1 type: - $ref: "#/components/schemas/AppLinkType" + $ref: '#/components/schemas/AppLinkType' uuid: - type: string description: Equinix-assigned access point identifier + type: string format: uuid example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 x-order: 3 name: - type: string description: Customer-provided App Link name + type: string format: string example: Atlassian App Link x-order: 4 description: - type: string description: Customer-provided App Link description + type: string format: string example: Atlassian App Link in SV x-order: 5 state: - $ref: "#/components/schemas/AppLinkState" + $ref: '#/components/schemas/AppLinkState' router: - $ref: "#/components/schemas/AppLinkCloudRouter" + $ref: '#/components/schemas/AppLinkCloudRouter' ipv4Subnet: - type: string description: Customer-provided IP subnet for AppLink setup (/29 or larger subnet) + type: string example: 192.168.10.0/29 x-order: 8 ipv4Address: - type: string description: App Link IP address + type: string format: ipv4 example: 192.168.10.1 x-order: 9 bandwidth: - type: integer description: App Link aggregated data transfer capacity in Mbps + type: integer example: 1000 x-order: 10 project: - $ref: "#/components/schemas/Project" - description: App Link object - AppSubscriptionState: - type: string - description: App Subscription lifecycle state - example: PROVISIONING - enum: - - PROVISIONING - - PROVISIONING_FAILED - - PROVISIONED - - DEPROVISIONING - - DEPROVISIONING_FAILED - - DEPROVISIONED - - REPROVISIONING - x-order: 6 - AppServiceAttachedAppSubscription: + $ref: '#/components/schemas/Project' + changeLog: + $ref: '#/components/schemas/Changelog' + change: + $ref: '#/components/schemas/AppLinkChange' required: - - state - type - - uuid + - name + - router + - ipv4Subnet + - bandwidth + - project + AppLinkUpdateRequest: + description: App Link Update Request + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/AppLinkChangeOperation' + AppLinkSimpleExpression: type: object properties: - href: + property: + description: | + Possible field names to use on filters: + * `/project/projectId` - project id + * `/uuid` - App Link uuid + * `/name` - App Link name + * `/description` - App Link description + * `/state` - App Link status + * `/ipv4Subnet` - App Link ipv4 subnet + * `/bandwidth` - App Link bandwidth + * `/changeLog/createdDateTime` - App Link creation timestamp + * `/changeLog/updatedDateTime` - App Link last updated timestamp + * `/changeLog/deletedDateTime` - App Link deletion timestamp + type: string + example: /name + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `>` - greater than + * `<` - less than + * `IN` - in + * `NOT IN` - not in + * `LIKE` - like + * `ILIKE` - case-insensitive like + * `BETWEEN` - between + * `NOT BETWEEN` - not between type: string + example: '=' + values: + type: array + items: + type: string + example: Gateway + AppLinkOrFilter: + type: object + properties: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppLinkSimpleExpression' + AppLinkFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppLinkSimpleExpression' + - $ref: '#/components/schemas/AppLinkOrFilter' + AppLinkFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/AppLinkFilter' + AppLinkSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + AppLinkSortBy: + description: | + Possible field names to use on '400_InvalidSorting': + * `/name` - App Link name + * `/uuid` - App Link uuid + * `/state` - App Link status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime + type: string + format: string + example: /changeLog/updatedDateTime + AppLinkSortCriteria: + type: object + properties: + direction: + $ref: '#/components/schemas/AppLinkSortDirection' + property: + $ref: '#/components/schemas/AppLinkSortBy' + AppLinkSearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/AppLinkFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppLinkSortCriteria' + AppLinkSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppLink' + AppLinkAttachState: + description: App Link attachment lifecycle state + type: string + format: string + enum: + - ATTACHING + - ATTACHING_FAILED + - ATTACHED + - DETACHING + - DETACHING_FAILED + - DETACHED + - REATTACHING + - REATTACHING_FAILED + example: ATTACHED + x-order: 10 + AppLinkAppDomainAttachment: + description: App Link Attached App Domain object + type: object + properties: + href: description: Resource URI + type: string format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 x-order: 1 type: - $ref: "#/components/schemas/AppSubscriptionType" + $ref: '#/components/schemas/AppDomainType' uuid: - type: string description: Equinix-assigned access point identifier + type: string format: uuid example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 x-order: 3 - state: - $ref: "#/components/schemas/AppSubscriptionState" - account: - $ref: "#/components/schemas/SimplifiedAccount" - description: App Subscription object attached to an App Service - AppSubscriptionType: - type: string - description: App Subscription Type - example: APP_SUBSCRIPTION - default: APP_SUBSCRIPTION - enum: - - APP_SUBSCRIPTION - x-order: 2 - AppSubscriptionSourceRequest: + name: + description: Customer-provided App Domain name + type: string + example: atlassian.net + x-order: 4 + attachmentStatus: + $ref: '#/components/schemas/AppLinkAttachState' + changeLog: + $ref: '#/components/schemas/Changelog' required: - - ipSubnets + - uuid + AppLinkAttachDomainSimpleExpression: type: object properties: - appLink: - $ref: "#/components/schemas/AppSubscriptionSourceRequestAppLink" - ipSubnets: + property: + description: | + Possible field names to use on filters: + * `/uuid` - App Domain attach to App Link uuid + * `/attachmentStatus` - App Domain attach to App Link status + type: string + example: /attachmentStatus + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `IN` - in + * `NOT IN` - not in + type: string + example: '=' + values: type: array - description: List of IP subnets in CIDR notation items: type: string - format: ipv4-cidr - example: 192.168.100.0/24 - description: Source details for the Subscription - x-order: 4 - AppSubscriptionTargetRequest: - required: - - geoScope - - prioritization + example: Gateway + AppLinkAttachDomainOrFilter: type: object properties: - appService: - $ref: "#/components/schemas/AppSubscriptionTargetRequestAppService" - geoScope: - type: string - description: Geo scope - example: GLOBAL - prioritization: - $ref: "#/components/schemas/AppSubscriptionPrioritization" - description: Target details for the Subscription - x-order: 5 - AppSubscriptionSource: - required: - - ipSubnets + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppLinkAttachDomainSimpleExpression' + AppLinkAttachDomainFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppLinkAttachDomainSimpleExpression' + - $ref: '#/components/schemas/AppLinkAttachDomainOrFilter' + AppLinkAttachDomainFilters: type: object properties: - appLink: - $ref: "#/components/schemas/AppSubscriptionSourceAppLink" - ipSubnets: + and: type: array - description: List of IP subnets in CIDR notation + maxItems: 8 items: - type: string - format: ipv4-cidr - example: 192.168.100.0/24 - description: Source details for the Subscription - x-order: 4 - AppSubscriptionTarget: - required: - - geoScope - - prioritization + $ref: '#/components/schemas/AppLinkAttachDomainFilter' + AppLinkAttachDomainSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + AppLinkAttachDomainSortBy: + description: | + Possible field names to use on '400_InvalidSorting': + * `/uuid` - App Domain attach to App Link uuid + * `/attachmentStatus` - App Domain attach to App Link status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime + type: string + format: string + example: /changeLog/updatedDateTime + AppLinkAttachDomainSortCriteria: type: object properties: - appService: - $ref: "#/components/schemas/AppSubscriptionTargetAppService" - geoScope: + direction: + $ref: '#/components/schemas/AppLinkAttachDomainSortDirection' + property: + $ref: '#/components/schemas/AppLinkAttachDomainSortBy' + AppLinkAttachDomainSearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/AppLinkAttachDomainFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppLinkAttachDomainSortCriteria' + AppLinkAttachDomainSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppLinkAppDomainAttachment' + AttachedAppDomainAttachmentStatus: + description: Filter attached App Domains by attachment lifecycle state. + type: array + items: + $ref: '#/components/schemas/AppLinkAttachState' + example: + - ATTACHED + - ATTACHING + AttachedAppDomainOrder: + description: Sort order for attached App Domains. + type: string + enum: + - DESC + - ASC + default: DESC + example: DESC + AppLinkAttachedAppDomain: + description: App Domain object associated with App Link + type: object + properties: + href: + description: Resource URI type: string - description: Geo scope - example: GLOBAL - prioritization: - $ref: "#/components/schemas/AppSubscriptionPrioritization" - description: Target details for the Subscription - x-order: 5 - AppSubscriptionChange: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + x-order: 1 + type: + $ref: '#/components/schemas/AppDomainType' + uuid: + description: Equinix-assigned access point identifier + type: string + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + x-order: 3 + name: + description: Customer-provided App Domain name + type: string + format: string + example: atlassian.net + x-order: 4 + description: + description: Customer-provided App Domain description + type: string + format: string + example: Atlassian Domain + x-order: 5 + state: + $ref: '#/components/schemas/AppDomainState' + project: + $ref: '#/components/schemas/Project' + attachmentStatus: + $ref: '#/components/schemas/AppLinkAttachState' required: - type - - updatedDateTime + - uuid + AppLinkAttachedAppDomains: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppLinkAttachedAppDomain' + AppServiceType: + description: App Service Type + type: string + enum: + - APP_SERVICE + default: APP_SERVICE + example: APP_SERVICE + x-order: 2 + AppLinkAppServiceAttachmentChange: + description: Current state of latest AppLink change type: object properties: uuid: - type: string description: Uniquely identifies a change - type: type: string + type: description: Type of change + type: string enum: - - APP_SUBSCRIPTION_UPDATE + - APP_SERVICE_UPDATE status: - type: string description: Current outcome of the change flow + type: string enum: - COMPLETED - FAILED - REQUESTED createdDateTime: - type: string description: Set when change flow starts + type: string format: date-time - example: 2026-06-29T07:00:00Z + example: '2026-06-29T07:00:00Z' updatedDateTime: - type: string description: Set when change object is updated + type: string format: date-time - example: 2026-06-29T07:15:00Z + example: '2026-06-29T07:15:00Z' data: type: array items: - $ref: "#/components/schemas/AppSubscriptionChangeOperation" - description: Current state of latest AppSubscription change - AppSubscriptionChangeOperation: + $ref: '#/components/schemas/AppLinkChangeOperation' required: - - op - - path - - value - type: object - properties: - op: - type: string - description: operation type applied to the resource - enum: - - replace - - add - - remove - path: - type: string - description: path inside document leading to updated parameter - value: - type: object - description: new value for updated parameter - x-go-type: json.RawMessage - description: App Subscription change operation data - Router: + - type + - updatedDateTime + AppLinkAppServiceAttachment: + description: App Link Attached App Service object type: object properties: href: + description: Resource URI type: string - description: Fabric Cloud Router URI format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/routers/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 + example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 1 + type: + $ref: '#/components/schemas/AppServiceType' uuid: + description: Equinix-assigned access point identifier type: string - description: Cloud Router UUID format: uuid - example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 - type: + example: 5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 3 + geoScope: + description: Geo scope for the App Service type: string - enum: - - XF_ROUTER - Phone: + example: GLOBAL + x-order: 4 + destinationIp: + description: Target IP for forwarding API requests + type: string + format: ipv4 + example: 10.10.1.110 + x-order: 5 + attachmentStatus: + $ref: '#/components/schemas/AppLinkAttachState' + changeLog: + $ref: '#/components/schemas/Changelog' + change: + $ref: '#/components/schemas/AppLinkAppServiceAttachmentChange' + required: + - uuid + - geoScope + - destinationIp + AppLinkAttachServiceRequest: type: object + description: Attach App Service to App Link properties: - type: + geoScope: + description: Geo scope for the App Service type: string - description: Notification Type - example: MOBILE - enum: - - MOBILE - - OFFICE - number: - pattern: ^\+[1-9]\d{1,14}$ + example: GLOBAL + destinationIp: + description: Target IP for forwarding API requests type: string - description: Phone number - contactPreference: - $ref: "#/components/schemas/ContactPreference" - ConnectionPriority: - type: string - description: Connection priority in redundancy group - enum: - - PRIMARY - - SECONDARY - AccessPoint: + format: ipv4 + example: 10.10.1.110 + required: + - geoScope + - destinationIp + AppLinkAppServiceAttachmentChangeOperation: + description: App Link change operation data 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" - environment: - $ref: "#/components/schemas/ProviderEnvironment" - sellerRegion: - type: string - description: Access point seller region - peeringType: - $ref: "#/components/schemas/PeeringType" - authenticationKey: - type: string - description: Access point authentication key - activationKey: - type: string - description: Access point activation key - providerConnectionId: - type: string - description: Provider assigned Connection Id - virtualNetwork: - $ref: "#/components/schemas/VirtualNetwork" - interconnection: - $ref: "#/components/schemas/MetalInterconnection" - role: + op: + description: operation type applied to the resource type: string - description: E-Tree network connection role enum: - - LEAF - - ROOT - productOffering: - $ref: "#/components/schemas/ProductOffering" - bandwidthCommit: - maximum: 100000 - minimum: 0 - type: integer - description: Bandwidth commit in Mbps - providerIdentifier: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter type: string - description: Provider identifier - address: - $ref: "#/components/schemas/Address" - description: Access point object - InternetAccess: + enum: + - /destinationIp + value: + description: new value for updated parameter + x-go-type: json.RawMessage + required: + - op + - path + - value + AppLinkAttachServiceUpdateRequest: + description: App Service attachment Update Request + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/AppLinkAppServiceAttachmentChangeOperation' + AppLinkAttachServiceSimpleExpression: type: object properties: - uuid: - type: string - description: Internet Access Service Identifier - format: uuid - description: Internet Access Details - ConnectionInvitation: - type: object - properties: - email: - type: string - description: invitee email - example: test@equinix.com - message: + property: + description: | + Possible field names to use on filters: + * `/uuid` - App Service attach to App Link uuid + * `/attachmentStatus` - App Service attach to App Link status type: string - description: invitation message - example: Hello, Please accept my invitation - ctrDraftOrderId: + example: /attachmentStatus + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `IN` - in + * `NOT IN` - not in 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 - - ERROR - - ORDERING - - DELETING - - PENDING DELETE - - N/A - - QUOTING - EquinixStatus: - type: string - description: Connection status - enum: - - REJECTED_ACK - - REJECTED - - PENDING_DELETE - - PROVISIONED - - PENDING_APPROVAL - - NOT_PROVISIONED - - DEPROVISIONING - - NOT_DEPROVISIONED - - PENDING_AUTO_APPROVAL - - PROVISIONING - - PENDING_BGP_PEERING - - PENDING_PROVIDER_VLAN - - DEPROVISIONED - - DELETED - - AUTO_APPROVAL_FAILED - - 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: + example: '=' + values: + type: array + items: + type: string + example: Gateway + AppLinkAttachServiceOrFilter: 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: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppLinkAttachServiceSimpleExpression' + AppLinkAttachServiceFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppLinkAttachServiceSimpleExpression' + - $ref: '#/components/schemas/AppLinkAttachServiceOrFilter' + AppLinkAttachServiceFilters: type: object properties: - errors: + and: type: array + maxItems: 8 items: - $ref: "#/components/schemas/Error" - RoutingProtocolProject: - required: - - projectId + $ref: '#/components/schemas/AppLinkAttachServiceFilter' + AppLinkAttachServiceSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + AppLinkAttachServiceSortBy: + description: | + Possible field names to use on '400_InvalidSorting': + * `/uuid` - App Service attach to App Link uuid + * `/attachmentStatus` - App Service attach to App Link status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime + type: string + format: string + example: /changeLog/updatedDateTime + AppLinkAttachServiceSortCriteria: type: object properties: - projectId: - type: string - description: Uniquely identifies a project - description: The Routing Protocol's project - RoutingProtocolConnection: + direction: + $ref: '#/components/schemas/AppLinkAttachServiceSortDirection' + property: + $ref: '#/components/schemas/AppLinkAttachServiceSortBy' + AppLinkAttachServiceSearchRequest: type: object + description: Search requests containing criteria properties: - uuid: - type: string - description: Equinix-assigned connection identifier - platformUuid: - type: string - description: Equinix-assigned platform connection identifier - description: Connection specification - ExchangeServiceRequestBgp: + filter: + $ref: '#/components/schemas/AppLinkAttachServiceFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppLinkAttachServiceSortCriteria' + AppLinkAttachServiceSearchResponse: type: object properties: - domainName: - maxLength: 253 - minLength: 1 - type: string - description: Domain name for BGP - example: gw01.sin.example.net - asSet: - maxLength: 48 - minLength: 2 - type: string - description: AS-SET used to filter the prefixes announced by the customer - example: AS-EC-SV - mlpeEnabled: - type: boolean - description: Whether Multi-Lateral Peering Exchange (MLPE) is enabled - example: true - default: false - md5AuthKey: - maxLength: 255 - minLength: 1 - type: string - description: MD5 key for BGP - example: TestAuthKey12345 - rcMd5AuthKey: - maxLength: 255 - minLength: 1 - type: string - description: RC MD5 key for BGP - example: TestAuthKey123456 - prefixes: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. type: array - description: List of IP prefix items: - type: string - description: IP prefix - maxPrefixLimit: - type: integer - description: Max Prefix Limit number - format: int64 - example: 300 - prependSelfEnabled: - type: boolean - description: Prepend Self Enabled - example: true - default: true - ExchangeServiceResponseBgp: + $ref: '#/components/schemas/AppLinkAppServiceAttachment' + AttachedAppServiceAttachmentStatus: + description: Filter attached App Services by attachment lifecycle state. + type: array + items: + $ref: '#/components/schemas/AppLinkAttachState' + example: + - ATTACHED + - ATTACHING + AttachedAppServiceOrder: + description: Sort order for attached App Services. + type: string + enum: + - DESC + - ASC + default: DESC + example: DESC + AppServiceState: + description: App Service lifecycle state + type: string + enum: + - PROVISIONING + - PROVISIONED + - DEPROVISIONING + - DEPROVISIONED + - REPROVISIONING + example: PROVISIONING + x-order: 6 + AppLinkAttachedAppService: + description: App Service object associated with App Link type: object properties: - customerPeerIp: - type: string - description: Customer peer IP address - example: 12.1.1.1 - domainName: - type: string - description: Domain name for BGP - example: ix-v4.gw01.sin.example.net - primaryRouteServerIp: + href: + description: Resource URI type: string - description: Primary route server IP address with prefix length - example: 206.126.239.251/22 - secondaryRouteServerIp: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 1 + type: + $ref: '#/components/schemas/AppServiceType' + uuid: + description: Equinix-assigned access point identifier type: string - description: Secondary route server IP address with prefix length - example: 206.126.239.252/22 - asSet: + format: uuid + example: 5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 3 + name: + description: Customer-provided App Service name type: string - description: AS-SET used to filter the prefixes announced by the customer - example: AS-EC-SV - mlpeEnabled: - type: boolean - description: Whether Multi-Lateral Peering Exchange (MLPE) is enabled - example: true - md5AuthKey: + format: string + example: Atlassian App Service + x-order: 4 + description: + description: Customer-provided App Service description type: string - description: MD5 key for BGP - example: TestAuthKey12345 - rcMd5AuthKey: + format: string + example: Atlassian App Service in SV + x-order: 5 + state: + $ref: '#/components/schemas/AppServiceState' + endpoint: + description: Accessible endpoint through this service type: string - description: RC MD5 key for BGP - example: TestAuthKey123456 - prefixes: + x-order: 7 + example: equinixjira.atlassian.net + sourceDomains: type: array - description: List of IP prefix + description: List of source domains from where traffic is allowed + x-order: 8 items: type: string - description: IP prefix - maxPrefixLimit: - type: integer - description: Max Prefix Limit number - format: int64 - example: 300 - prependSelfEnabled: - type: boolean - description: Prepend Self Enabled - example: true - RouteCollector: - type: object - properties: - asn: - type: integer - description: Route Collector ASN - format: int64 - example: 1238 - ipV4: + example: equinix.com + project: + $ref: '#/components/schemas/Project' + geoScope: + description: Geo scope for the App Service type: string - description: Route Collector ipV4 address - example: 206.126.239.250/22 - ipV6: + example: GLOBAL + x-order: 4 + destinationIp: + description: Target IP for forwarding API requests type: string - description: Route Collector ipV6 address - example: 2001:504:0:2:0:6:5517:1/64 - description: Route Collector - InternetAccessConnection: + format: ipv4 + example: 10.10.1.110 + x-order: 5 + attachmentStatus: + $ref: '#/components/schemas/AppLinkAttachState' required: - - href + - type - uuid + - geoScope + - destinationIp + AppLinkAttachedAppServices: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppLinkAttachedAppService' + AppProcessorType: + description: App Processor Type + type: string + enum: + - APP_PROCESSOR + default: APP_PROCESSOR + example: APP_PROCESSOR + x-order: 2 + AppLinkAppProcessorAttachment: + description: App Link Attached App Processor object type: object properties: href: + description: Resource URI type: string - description: URI of the connection format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + x-order: 1 + type: + $ref: '#/components/schemas/AppProcessorType' uuid: + description: App Processor UUID type: string - description: Unique identifier for the connection format: uuid - peeringIpv4: - $ref: "#/components/schemas/InternetAccessPeeringIpv4" - peeringIpv6: - $ref: "#/components/schemas/InternetAccessPeeringIpv6" - InternetAccessPeeringIpv4: - type: object - properties: - prefix: - pattern: ^([01]?\d\d?|2[0-4]\d|25[0-5])(?:\.(?:[01]?\d\d?|2[0-4]\d|25[0-5])){3}/(?:[1-9]|[12]\d|3[0-2])$ - type: string - description: IPv4 prefix for the peering connection - prefixLength: - maximum: 32 - minimum: 1 - type: integer - description: Determines the size of subnet - example: 30 - equinixPeerIp: - pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ - type: string - description: IPv4 peering IP address for Equinix side - customerPeerIp: - pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ - type: string - description: IPv4 peering IP address for customer side - equinixVrrpIp: - pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + example: 90ee425c-9988-454c-96d9-1128bc16350f + x-order: 3 + config: + description: Base64-encoded configuration for the processor attachment type: string - description: IPv4 address for Equinix VRRP IP - customerVrrpIp: - pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ + format: byte + example: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... + x-order: 4 + endpoint: + description: Endpoint DNS name assigned to the attached App Processor type: string - description: IPv4 address for customer VRRP IP - InternetAccessPeeringIpv6: + example: 123456.privateai.link + x-order: 5 + attachmentStatus: + $ref: '#/components/schemas/AppLinkAttachState' + changeLog: + $ref: '#/components/schemas/Changelog' + required: + - uuid + AppLinkAttachProcessorRequest: type: object + description: Attach App Processor to App Link properties: - prefix: - type: string - description: IPv6 prefix for the peering connection - prefixLength: - maximum: 128 - minimum: 8 - type: integer - description: Determines the size of subnet - example: 64 - equinixPeerIp: - type: string - description: IPv6 peering IP address for Equinix side - customerPeerIp: - type: string - description: IPv6 peering IP address for customer side - equinixVrrpIp: - type: string - description: IPv6 address for Equinix VRRP IP - customerVrrpIp: + config: + description: Base64-encoded configuration for the processor attachment type: string - description: IPv6 address for customer VRRP IP - InternetAccessIpBlock: + format: byte + example: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... required: - - href - - uuid + - config + AppLinkAttachProcessorSimpleExpression: type: object properties: - href: + property: + description: | + Possible field names to use on filters: + * `/uuid` - App Processor attach to App Link uuid + * `/attachmentStatus` - App Processor attach to App Link status type: string - description: URI of the IP block - format: uri - uuid: + example: /attachmentStatus + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `IN` - in + * `NOT IN` - not in type: string - description: Unique identifier for the IP block - format: uuid - IpBlockProductType: + example: '=' + values: + type: array + items: + type: string + example: ATTACHED + AppLinkAttachProcessorOrFilter: + type: object + properties: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppLinkAttachProcessorSimpleExpression' + AppLinkAttachProcessorFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppLinkAttachProcessorSimpleExpression' + - $ref: '#/components/schemas/AppLinkAttachProcessorOrFilter' + AppLinkAttachProcessorFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/AppLinkAttachProcessorFilter' + AppLinkAttachProcessorSortDirection: + description: Sorting direction + default: DESC type: string enum: - - EIA - - FABRIC - - NE - ProductType: + - DESC + - ASC + AppLinkAttachProcessorSortBy: + description: | + Possible field names to use on '400_InvalidSorting': + * `/uuid` - App Processor attach to App Link uuid + * `/attachmentStatus` - App Processor attach to App Link status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime type: string - description: Product type - enum: - - VIRTUAL_CONNECTION_PRODUCT - - IP_BLOCK_PRODUCT - - VIRTUAL_PORT_PRODUCT - - CLOUD_ROUTER_PRODUCT - - PRECISION_TIME_PRODUCT - - OPTICAL_CONNECT_PRODUCT - PriceCharge: + format: string + example: /changeLog/updatedDateTime + AppLinkAttachProcessorSortCriteria: 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: + direction: + $ref: '#/components/schemas/AppLinkAttachProcessorSortDirection' + property: + $ref: '#/components/schemas/AppLinkAttachProcessorSortBy' + AppLinkAttachProcessorSearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/AppLinkAttachProcessorFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppLinkAttachProcessorSortCriteria' + AppLinkAttachProcessorSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppLinkAppProcessorAttachment' + AttachedAppProcessorAttachmentStatus: + description: Filter attached App Processors by attachment lifecycle state. + type: array + items: + $ref: '#/components/schemas/AppLinkAttachState' + example: + - ATTACHED + - ATTACHING + AttachedAppProcessorOrder: + description: Sort order for attached App Processors. type: string - description: Price category enum: - - COUNTRY - - CUSTOMER - VirtualConnectionPrice: + - DESC + - ASC + default: DESC + example: DESC + AppLinkAttachedAppProcessors: 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" - geoScope: - $ref: "#/components/schemas/GeoScopeType" - description: Virtual Connection Product configuration - IpBlockPrice: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppLinkAppProcessorAttachment' + AppProcessorState: + description: App Processor lifecycle state + type: string + format: string + enum: + - PROVISIONING + - PROVISIONING_FAILED + - PROVISIONED + - DEPROVISIONING + - DEPROVISIONING_FAILED + - DEPROVISIONED + - REPROVISIONING + example: PROVISIONING + x-order: 6 + AppProcessorMarketplace: + description: App Processor marketplace settings type: object + x-order: 8 properties: - uuid: + visibility: + description: App Processor marketplace visibility 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: + format: string + enum: + - PUBLIC + - PRIVATE + default: PUBLIC + example: PUBLIC + required: + - visibility + AppProcessorChangeOperation: + description: App Processor change operation data type: object properties: - uuid: + op: + description: operation type applied to the resource 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: + enum: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter + type: string + enum: + - /name + value: + description: new value for updated parameter + x-go-type: json.RawMessage + required: + - op + - path + - value + AppProcessorChange: + description: Current state of latest AppProcessor change type: object properties: uuid: + description: Uniquely identifies a change 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" - package: - $ref: "#/components/schemas/VirtualPortPackage" - serviceCode: - $ref: "#/components/schemas/VirtualPortServiceCode" - 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: + description: Type of change 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 - OpticalConnectPrice: - type: object - properties: - type: - $ref: "#/components/schemas/OpticalConnectPricePortType" - bandwidth: - minimum: 0 - type: integer - description: Bandwidth in Mbps - example: 1000 - pathType: - $ref: "#/components/schemas/OpticalConnectPricePathType" - connectionDestinationType: - $ref: "#/components/schemas/OpticalConnectConnectionDestinationType" - aSide: - $ref: "#/components/schemas/OpticalConnectPriceASide" - zSide: - $ref: "#/components/schemas/OpticalConnectPriceZSide" - description: Optical Metro Connect Port Product configuration - ServiceTokenSide: - type: object - properties: - accessPointSelectors: + - APP_PROCESSOR_UPDATE + status: + description: Current outcome of the change flow + type: string + enum: + - COMPLETED + - FAILED + - REQUESTED + createdDateTime: + description: Set when change flow starts + type: string + format: date-time + example: '2026-06-29T07:00:00Z' + updatedDateTime: + description: Set when change object is updated + type: string + format: date-time + example: '2026-06-29T07:15:00Z' + data: type: array - description: List of AccessPointSelectors items: - $ref: "#/components/schemas/AccessPointSelector" - description: Connection link protocol,virtual device or network configuration - OpticalConnectDemarcationPoint: + $ref: '#/components/schemas/AppProcessorChangeOperation' + required: + - type + - updatedDateTime + AppProcessor: + description: App Processor object type: object properties: - patchPanelId: + href: + description: Resource URI type: string - description: Unique identifier of the patch panel. - example: CP:Demarc:1259684 - patchPanelPortA: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f + x-order: 1 + type: + $ref: '#/components/schemas/AppProcessorType' + uuid: + description: Equinix-assigned access point identifier + type: string + format: uuid + example: 90ee425c-9988-454c-96d9-1128bc16350f + x-order: 3 + name: + description: Customer-provided App Processor name + type: string + format: string + minLength: 1 + maxLength: 50 + example: agent-gateway + x-order: 4 + description: + description: Customer-provided App Processor description + type: string + format: string + minLength: 1 + maxLength: 255 + example: llm-routing, a2a-routing, mcp-routing + x-order: 5 + state: + $ref: '#/components/schemas/AppProcessorState' + registryId: + description: Container image reference for the processor runtime type: string + format: string + minLength: 1 + maxLength: 255 + example: agentgateway/agentgateway:1.3.0 + x-order: 7 + marketplace: + $ref: '#/components/schemas/AppProcessorMarketplace' + project: + $ref: '#/components/schemas/Project' + changeLog: + $ref: '#/components/schemas/Changelog' + change: + $ref: '#/components/schemas/AppProcessorChange' + required: + - type + - name + - registryId + - marketplace + - project + AppProcessorSimpleExpression: + type: object + properties: + property: description: | - Specify the desired port number for Port A.
When ports are not provided, next available ports will be used. - example: "10" - patchPanelPortB: + Possible field names to use on filters: + * `/project/projectId` - project id + * `/uuid` - App Processor uuid + * `/name` - App Processor name + * `/description` - App Processor description + * `/state` - App Processor status + * `/ipv4Subnet` - App Processor ipv4 subnet + * `/bandwidth` - App Processor bandwidth + * `/changeLog/createdDateTime` - App Processor creation timestamp + * `/changeLog/updatedDateTime` - App Processor last updated timestamp + * `/changeLog/deletedDateTime` - App Processor deletion timestamp type: string + example: /name + operator: description: | - Specify the desired port number for Port B.
When ports are not provided, next available ports will be used.
Required for Connector type FC, SC and ST only. - example: "11" - connectorType: + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `>` - greater than + * `<` - less than + * `IN` - in + * `NOT IN` - not in + * `LIKE` - like + * `ILIKE` - case-insensitive like + * `BETWEEN` - between + * `NOT BETWEEN` - not between type: string - description: Type of Connector - example: SC - enum: - - FC - - SC - - LC - - ST - description: | - Specifies the demarcation point: the patch panel and ports at this side. - OpticalConnectLocation: + example: '=' + values: + type: array + items: + type: string + example: Gateway + AppProcessorOrFilter: type: object properties: - ibxCode: - type: string - description: Equinix IBX data centre code. - example: SV1 - description: Destination location for BMMR and REMOTE connections. - OpticalConnectLOA: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppProcessorSimpleExpression' + AppProcessorFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppProcessorSimpleExpression' + - $ref: '#/components/schemas/AppProcessorOrFilter' + AppProcessorFilters: type: object properties: - uuid: - type: string - description: Identifier of the Letter of Authorization - example: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - description: | - Letter of Authorization granting the right to terminate at the Z-side location.
Required for BMMR and REMOTE. - OpticalConnectResponseDemarcationPoint: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/AppProcessorFilter' + AppProcessorSortDirection: + description: Sorting direction + default: DESC + type: string + enum: + - DESC + - ASC + AppProcessorSortBy: description: | - Demarcation point as provisioned, with the cage and cabinet it belongs to. - allOf: - - $ref: "#/components/schemas/OpticalConnectDemarcationPoint" - - type: object - properties: - cageUniqueSpaceId: - type: string - description: Unique identifier of the cage. - example: SV1:01:002174 - cabinetUniqueSpaceId: - type: string - description: Unique identifier of the cabinet. - example: Demarc - PortOrderPurchaseOrder: + Possible field names to use on '400_InvalidSorting': + * `/name` - App Processor name + * `/uuid` - App Processor uuid + * `/state` - App Processor status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime + type: string + format: string + example: /changeLog/updatedDateTime + AppProcessorSortCriteria: type: object properties: - number: - type: string - description: purchase order number - amount: - type: string - description: purchase order amount - startDate: + direction: + $ref: '#/components/schemas/AppProcessorSortDirection' + property: + $ref: '#/components/schemas/AppProcessorSortBy' + AppProcessorSearchRequest: + type: object + description: Search requests containing criteria + properties: + filter: + $ref: '#/components/schemas/AppProcessorFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppProcessorSortCriteria' + AppProcessorSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppProcessor' + AppServicePostRequest: + type: object + description: Create App Service + properties: + type: + $ref: '#/components/schemas/AppServiceType' + name: + description: Customer-provided App Service name type: string - endDate: + format: string + minLength: 1 + maxLength: 50 + example: Atlassian App Service + description: + description: Customer-provided App Service description type: string - attachmentId: + format: string + example: Atlassian App Service in SV + endpoint: + description: Accessible endpoint through this service type: string - format: uuid - selectionType: + example: equinixjira.atlassian.net + sourceDomains: + type: array + description: List of source domains from where traffic is allowed + items: + type: string + example: equinix.com + project: + $ref: '#/components/schemas/Project' + required: + - type + - name + - endpoint + - project + AppServiceChangeOperation: + description: App Service change operation data + type: object + properties: + op: + description: operation type applied to the resource type: string - deprecated: true enum: - - EXEMPTION - - EXISTING - - NEW - - BLANKET - type: + - replace + - add + - remove + path: + description: path inside document leading to updated parameter type: string enum: - - EXEMPTION - - EXISTING - - NEW - - BLANKET - description: Purchase Order information associate to the account - PortOrderSignature: + - /name + - /description + - /sourceDomains + value: + description: new value for updated parameter + x-go-type: json.RawMessage + required: + - op + - path + - value + AppServiceChange: + description: Current state of latest AppService change type: object properties: - signatory: + uuid: + description: Uniquely identifies a change + type: string + type: + description: Type of change type: string - description: Port signature Type enum: - - DELEGATE - - SELF - - ACCOUNT_SUPPORT - delegate: - $ref: "#/components/schemas/PortOrderSignatureDelegate" - description: Port signature details - PortOrderSignatureDelegate: - type: object - properties: - firstName: + - APP_SERVICE_UPDATE + status: + description: Current outcome of the change flow type: string - description: first name of delegate - lastName: + enum: + - COMPLETED + - FAILED + - REQUESTED + createdDateTime: + description: Set when change flow starts type: string - description: last Name of delegate - email: + format: date-time + example: '2026-06-29T07:00:00Z' + updatedDateTime: + description: Set when change object is updated type: string - description: email of delegate - description: order delegate details - PortDeviceRedundancy: + format: date-time + example: '2026-06-29T07:15:00Z' + data: + type: array + items: + $ref: '#/components/schemas/AppServiceChangeOperation' + required: + - type + - updatedDateTime + AppService: + description: App Service object type: object properties: - group: + href: + description: Resource URI type: string - description: Device redundancy group - priority: + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 1 + type: + $ref: '#/components/schemas/AppServiceType' + uuid: + description: Equinix-assigned access point identifier 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: + format: uuid + example: 5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 3 + name: + description: Customer-provided App Service name + type: string + format: string + example: Atlassian App Service + x-order: 4 + description: + description: Customer-provided App Service description + type: string + format: string + example: Atlassian App Service in SV + x-order: 5 + state: + $ref: '#/components/schemas/AppServiceState' + endpoint: + description: Accessible endpoint through this service + type: string + x-order: 7 + example: equinixjira.atlassian.net + sourceDomains: + type: array + description: List of source domains from where traffic is allowed + x-order: 8 + items: + type: string + example: equinix.com + account: + $ref: '#/components/schemas/SimplifiedAccount' + project: + $ref: '#/components/schemas/Project' + changeLog: + $ref: '#/components/schemas/Changelog' + change: + $ref: '#/components/schemas/AppServiceChange' + required: + - type + - name + AppServiceUpdateRequest: + description: App Service Update Request + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/AppServiceChangeOperation' + AppServiceSimpleExpression: + type: object + properties: + property: + description: | + Possible field names to use on filters: + * `/project/projectId` - project id + * `/uuid` - App Service uuid + * `/name` - App Service name + * `/description` - App Service description + * `/state` - App Service status + * `/endpoint` - App Service endpoint + * `/sourceDomains` - App Service source domains + * `/changeLog/createdDateTime` - App Service creation timestamp + * `/changeLog/updatedDateTime` - App Service last updated timestamp + * `/changeLog/deletedDateTime` - App Service deletion timestamp + type: string + example: /name + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `>` - greater than + * `<` - less than + * `IN` - in + * `NOT IN` - not in + * `LIKE` - like + * `ILIKE` - case-insensitive like + * `BETWEEN` - between + * `NOT BETWEEN` - not between + type: string + example: '=' + values: + type: array + items: + type: string + example: Gateway + AppServiceOrFilter: + type: object + properties: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppServiceSimpleExpression' + AppServiceFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppServiceSimpleExpression' + - $ref: '#/components/schemas/AppServiceOrFilter' + AppServiceFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/AppServiceFilter' + AppServiceSortDirection: + description: Sorting direction + default: DESC type: string - description: Network status enum: - - RESERVED - - RELEASED - LinkProtocolRequestType: + - DESC + - ASC + AppServiceSortBy: + description: | + Possible field names to use on '400_InvalidSorting': + * `/name` - App Service name + * `/uuid` - App Service uuid + * `/state` - App Service status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime type: string - description: Type of Link Protocol - enum: - - UNTAGGED - - DOT1Q - - QINQ - - VXLAN - SubInterface: + format: string + example: /changeLog/updatedDateTime + AppServiceSortCriteria: type: object properties: - name: - type: string - description: name of subInterface of a port - deprecated: true - unit: - type: integer - example: 200 - description: Sub Interface information - LinkProtocolConnection: + direction: + $ref: '#/components/schemas/AppServiceSortDirection' + property: + $ref: '#/components/schemas/AppServiceSortBy' + AppServiceSearchRequest: type: object + description: Search requests containing criteria 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: + filter: + $ref: '#/components/schemas/AppServiceFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppServiceSortCriteria' + AppServiceSearchResponse: + type: object + properties: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppService' + AppServiceAttachedAppLink: + description: App Link object type: object properties: href: + description: Resource URI type: string - description: Service Token URI format: uri readOnly: true + example: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + x-order: 1 + type: + $ref: '#/components/schemas/AppLinkType' uuid: + description: Equinix-assigned access point identifier type: string format: uuid - example: cd67f685-41b0-1b07-6de0-320a5c00eabe - type: + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + x-order: 3 + name: + description: Customer-provided App Link name type: string - example: TOKEN + format: string + example: Atlassian App Link + x-order: 4 + description: + description: Customer-provided App Link description + type: string + format: string + example: Atlassian App Link in SV + x-order: 5 + state: + $ref: '#/components/schemas/AppLinkState' + router: + $ref: '#/components/schemas/AppLinkCloudRouter' + ipv4Subnet: + description: Customer-provided IP subnet for AppLink setup (/29 or larger subnet) + type: string + example: 192.168.10.0/29 + x-order: 8 + ipv4Address: + description: App Link IP address + type: string + format: ipv4 + example: 192.168.10.1 + x-order: 9 bandwidth: + description: App Link aggregated data transfer capacity in Mbps type: integer - format: int64 example: 1000 - description: Service Token details of Link Protocol - PortPackageSourceType: - type: string - description: Port Package Source Type - enum: - - COLO - - REMOTE - - BMMR - Operation: - type: object - properties: - bgpIpv4RoutesCount: - type: integer - description: IPV4 route count - example: 6 - bgpIpv6RoutesCount: - type: integer - description: IPV6 route count - example: 6 - distinctIpv4PrefixesCount: - type: integer - description: distinct IPV4 prefixes count - example: 4 - distinctIpv6PrefixesCount: - type: integer - description: distinct IPV6 prefixes count - example: 4 - description: Operation object for router actions - CloudRouterCommandRequestConnection: + x-order: 10 + project: + $ref: '#/components/schemas/Project' required: + - type - uuid + AppServiceAttachedAppLinks: type: object properties: - uuid: - type: string - description: Connection UUID - example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - description: Connection object for Cloud Router Command - CloudRouterCommandPingResponse: - type: object - properties: - output: - type: string - outputStructuredPing: - $ref: "#/components/schemas/OutputStructuredPing" - errors: - type: array - items: - $ref: "#/components/schemas/Error" - CloudRouterCommandTracerouteResponse: - type: object - properties: - output: - type: string - outputStructuredTraceroute: - $ref: "#/components/schemas/OutputStructuredTraceroute" - errors: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. type: array items: - $ref: "#/components/schemas/Error" - RouteTableEntryState: - type: string - description: Route table entry state - enum: - - ACTIVE - NetworkEquinixStatus: + $ref: '#/components/schemas/AppServiceAttachedAppLink' + AppSubscriptionState: + description: App Subscription lifecycle state type: string - description: Network status enum: - PROVISIONING + - PROVISIONING_FAILED - PROVISIONED - - NOT_PROVISIONED - DEPROVISIONING + - DEPROVISIONING_FAILED - DEPROVISIONED - - NOT_DEPROVISIONED - NetworkSortDirectionResponse: + - REPROVISIONING + example: PROVISIONING + x-order: 6 + AttachedAppSubscriptionState: + description: Filter attached App Subscriptions by lifecycle state. + type: array + items: + $ref: '#/components/schemas/AppSubscriptionState' + example: + - PROVISIONED + - PROVISIONING + AttachedAppSubscriptionOrder: + description: Sort order for attached App Subscriptions. type: string - description: Sorting direction - default: DESC enum: - DESC - ASC - NetworkSortByResponse: + default: DESC + example: DESC + AppSubscriptionType: + description: App Subscription Type 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: + - APP_SUBSCRIPTION + default: APP_SUBSCRIPTION + example: APP_SUBSCRIPTION + x-order: 2 + AppServiceAttachedAppSubscription: + description: App Subscription object attached to an App Service type: object properties: - type: + href: + description: Resource URI type: string - enum: - - ASCII - - HEX - keyNumber: - maximum: 65535 - minimum: 1 - type: integer - description: The authentication Key ID. - example: 10 - key: - pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ + format: uri + readOnly: true + example: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 + x-order: 1 + type: + $ref: '#/components/schemas/AppSubscriptionType' + uuid: + description: Equinix-assigned access point identifier type: string - description: The plaintext authentication key. Must be Base64 encoded. For ASCII type, the key must contain printable ASCII characters, range 10-20 characters. For HEX type, range should be 10-40 characters. - format: byte - virtualConnectionSide: - title: fabricConnectionAccessPoint + format: uuid + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 + x-order: 3 + state: + $ref: '#/components/schemas/AppSubscriptionState' + account: + $ref: '#/components/schemas/SimplifiedAccount' + required: + - type + - uuid + - state + AppServiceAttachedAppSubscriptions: type: object properties: - accessPoint: - $ref: "#/components/schemas/AccessPoint" - description: Fabric Connection access point object. - CompanyProfileChangeItem: - required: - - op - - path - - value + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppServiceAttachedAppSubscription' + AppServiceAttachedAppSubscriptionSimpleExpression: type: object properties: - op: + property: + description: | + Possible field names to use on filters: + * `/uuid` - App Subscription UUID + * `/state` - App Subscription lifecycle state type: string - description: Handy shortcut for operation name - example: replace - path: + example: /state + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `IN` - in + * `NOT IN` - not in type: string - description: path inside document leading to updated parameter - example: /name - value: - type: object - description: new value for updated parameter - LoaRequest: - required: - - authorizedProductType - - name - - type + example: IN + values: + type: array + items: + type: string + example: PROVISIONED + AppServiceAttachedAppSubscriptionOrFilter: type: object properties: - type: - $ref: "#/components/schemas/LoaType" - name: - maxLength: 50 - minLength: 3 - type: string - description: A short, descriptive name for this LOA. - example: LOA-Equinix-SV1-2026 - description: - maxLength: 450 - minLength: 0 - type: string - description: Additional context about this LOA. - example: Authorization for patch panel port access to Equinix at SV1 - authorizedProductType: - $ref: "#/components/schemas/LoaProductType" - description: Create Loa - LoaPatchPanelConnectorType: + or: + type: array + maxItems: 3 + items: + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSimpleExpression' + AppServiceAttachedAppSubscriptionFilter: + type: object + anyOf: + - $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSimpleExpression' + - $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionOrFilter' + AppServiceAttachedAppSubscriptionFilters: + type: object + properties: + and: + type: array + maxItems: 8 + items: + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionFilter' + AppServiceAttachedAppSubscriptionSortDirection: + description: Sorting direction + default: DESC type: string - description: Connector Type - example: SC enum: - - FC - - SC - - LC - - ST - LoaMagicLink: - type: string + - DESC + - ASC + AppServiceAttachedAppSubscriptionSortBy: description: | - Portal URL for the LOA to either accept from requestor
or authorize from the issuer. - readOnly: true - example: https://portal.equinix.com/fabric/loa/inventory/issuer/29cc7878-54e3-4e1a-8651-87a61354bac2/authorize - CrossConnectDemarcationPoint: + Possible field names to use on '400_InvalidSorting': + * `/uuid` - App Subscription UUID + * `/state` - App Subscription lifecycle state + default: /uuid + type: string + format: string + example: /uuid + AppServiceAttachedAppSubscriptionSortCriteria: type: object properties: - patchPanelId: - type: string - description: Patch Panel Identifier. - example: CP:Demarc:1259684 - patchPanelPortA: - type: integer - description: | - Specify the desired port number. When ports are not provided, next available ports will be used. - example: 35 - patchPanelPortB: - type: integer - description: | - Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only. - example: 32 - connectorType: - $ref: "#/components/schemas/CrossConnectConnectorType" - description: Cross Connect Demarcation Point - patch panel and port details. - CrossConnectZSideRequestDemarcationPoint: - description: | - Z-Side demarcation point.
Specify the destination patch panel and ports.
Specify cageUniqueSpaceId and cabinetUniqueSpaceId to identify the destination space. - allOf: - - $ref: "#/components/schemas/CrossConnectDemarcationPoint" - - type: object - properties: - cageUniqueSpaceId: - type: string - description: Unique identifier of the Cage. - example: SV2:00:000000 - cabinetUniqueSpaceId: - type: string - description: Unique identifier of the Cabinet. - example: SV2:00:000000:0100 - CrossConnectLocation: + direction: + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSortDirection' + property: + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSortBy' + AppServiceAttachedAppSubscriptionSearchRequest: type: object + description: Search requests containing criteria properties: - ibxCode: - type: string - description: IBX Code. - example: SV1 - description: Cross Connect Location details. - CrossConnectLoaRef: + filter: + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: + type: array + items: + $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSortCriteria' + AppServiceAttachedAppSubscriptionSearchResponse: type: object properties: - href: - type: string - description: LOA URI. - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/loas/c61f485e-3094-42de-8797-0ef19a51df79 - uuid: - type: string - description: LOA Identifier - Attachment UUID or LOA UUID. - format: uuid - example: c61f485e-3094-42de-8797-0ef19a51df79 - description: | - LOA Reference for Cross Connect. Provide either uuid or digitalLoaId. - CrossConnectProvider: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. + type: array + items: + $ref: '#/components/schemas/AppServiceAttachedAppSubscription' + AppSubscriptionSourceRequestAppLink: + description: App Link reference for App Subscription type: object properties: - name: + uuid: + description: Equinix-assigned access point identifier type: string - description: Name of the provider at the Z-Side. - example: Equinix - description: Provider at the Z-Side. - ScheduleType: - type: string - description: Schedule Code. - example: STANDARD - enum: - - STANDARD - - FLEXIBLE - - EXPEDITE - CrossConnectServiceType: - type: string - description: | - Type of service ordered alongside the Cross Connect.
XC_LINK_LIGHT_VERIFICATION - To verify transmit and receive alignment after the Cross Connect is Provisioned.
XC_PATCH_EQUIPMENT - Equinix will install the Cross Connect from the demarcation panel to your equipment device. - example: XC_LINK_LIGHT_VERIFICATION - enum: - - XC_LINK_LIGHT_VERIFICATION - - XC_PATCH_EQUIPMENT - PatchEquipmentRequest: + format: uuid + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 required: - - cabinetUniqueSpaceId - - connectorType - - port - type: object - properties: - cabinetUniqueSpaceId: - type: string - description: Unique identifier of the Cabinet. - example: SV2:00:000000:0100 - port: - type: integer - description: Port number. - example: 32 - connectorType: - $ref: "#/components/schemas/CrossConnectConnectorType" - description: Patch equipment installed for the Cross Connect. - NotificationType: - type: string - description: Notification Type. - example: TECHNICAL - enum: - - ORDERING - - TECHNICAL - - NOTIFICATION - - PROVIDER_NOTIFICATION - - TECHNICAL_UNREGISTERED - CrossConnectPhone: + - uuid + AppSubscriptionSourceRequest: + description: Source details for the Subscription type: object + x-order: 4 properties: - type: - type: string - description: Phone number type. - example: MOBILE - enum: - - MOBILE - - OFFICE - number: - pattern: ^\+[1-9]\d{1,14}$ - type: string - description: Phone number. - example: 14085551234 - contactPreference: - $ref: "#/components/schemas/CrossConnectContactPreference" - description: Contact phone number. - PurchaseOrder: + appLink: + $ref: '#/components/schemas/AppSubscriptionSourceRequestAppLink' + ipSubnets: + type: array + description: List of IP subnets in CIDR notation + items: + type: string + format: ipv4-cidr + example: 192.168.100.0/24 + required: + - ipSubnets + AppSubscriptionTargetRequestAppService: + description: App Service reference for App Subscription type: object properties: - number: - type: string - description: Purchase Order number. - example: "1233" - amount: - type: string - description: Purchase Order amount. - example: "10000" - startDate: - type: string - description: Date the Purchase Order takes effect. - format: date - example: 2026-02-26 - endDate: - type: string - description: Date the Purchase Order expires. - format: date - example: 2027-02-26 - attachmentId: + uuid: + description: Equinix-assigned access point identifier type: string - description: Identifier of the uploaded purchase order document. format: uuid - example: e41f485e-3094-42de-8797-0ef19a51df79 - type: - type: string - description: Purchase Order type. - example: NEW - enum: - - EXEMPTION - - EXISTING - - NEW - description: Purchase Order information associated with the account. - SignatureRequest: + example: 5008a109-9d1c-485c-b0ba-de9736f283c2 required: - - type - type: object - properties: - type: - $ref: "#/components/schemas/SignatureType" - email: - type: string - description: Signatory email address. - format: email - example: abc@test.com - description: Cross Connect Order Signature. - CrossConnectASideDemarcationPoint: - description: | - A-Side demarcation point.
cageUniqueSpaceId and cabinetUniqueSpaceId identify the A-Side space. - allOf: - - $ref: "#/components/schemas/CrossConnectDemarcationPoint" - - type: object - properties: - cageUniqueSpaceId: - type: string - description: Unique identifier of the Cage. - readOnly: true - example: SV1:00:000000 - cabinetUniqueSpaceId: - type: string - description: Unique identifier of the Cabinet. - readOnly: true - example: SV1:00:000000:0100 - CrossConnectZSideResponseDemarcationPoint: - description: | - Z-Side demarcation point.
cageUniqueSpaceId and cabinetUniqueSpaceId identify the Z-Side space. - allOf: - - $ref: "#/components/schemas/CrossConnectDemarcationPoint" - - type: object - properties: - cageUniqueSpaceId: - type: string - description: Unique identifier of the Cage. - readOnly: true - example: SV2:00:000000 - cabinetUniqueSpaceId: - type: string - description: Unique identifier of the Cabinet. - readOnly: true - example: SV2:00:000000:0100 - CrossConnectScheduleState: - type: string - description: Cross Connect Schedule State. - example: COMPLETED - enum: - - PENDING - - COMPLETED - - FAILED - - CANCELLED - - PENDING_ACTION - CrossConnectServiceState: + - uuid + AppSubscriptionPrioritization: + description: Prioritization strategy for forwarding API requests type: string - description: Service status. - example: COMPLETED enum: - - PENDING - - COMPLETED - - FAILED - PatchEquipmentResponse: + - LATENCY + - PERFORMANCE + - UTILIZATION + - THRESHOLD + - ANY_TAG + example: LATENCY + AppSubscriptionTargetRequest: + description: Target details for the Subscription type: object + x-order: 5 properties: - cabinetUniqueSpaceId: + appService: + $ref: '#/components/schemas/AppSubscriptionTargetRequestAppService' + geoScope: type: string - description: Unique identifier of the Cabinet. - example: SV2:00:000000:0100 - port: - type: integer - description: Port number. - example: 32 - connectorType: - $ref: "#/components/schemas/CrossConnectConnectorType" - description: Patch equipment installed for the Cross Connect. - CrossConnectActionNote: + description: Geo scope + example: GLOBAL + prioritization: + $ref: '#/components/schemas/AppSubscriptionPrioritization' required: - - comments + - prioritization + - geoScope + AppSubscriptionPostRequest: type: object + description: Create App Subscription properties: - parentNote: - $ref: "#/components/schemas/CrossConnectParentNote" - comments: - maxLength: 4000 - type: string - description: Note comments. - example: Please proceed - description: Note supplied by the customer when responding to an action. - CrossConnectActionNoteResponse: + type: + $ref: '#/components/schemas/AppSubscriptionType' + source: + $ref: '#/components/schemas/AppSubscriptionSourceRequest' + target: + $ref: '#/components/schemas/AppSubscriptionTargetRequest' + project: + $ref: '#/components/schemas/Project' + required: + - type + - project + AppSubscriptionSourceAppLink: + description: App Link reference for App Subscription type: object properties: href: + description: Resource URI type: string - description: Note URI. format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 + example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 + x-order: 1 + type: + description: App Link Type + type: string + example: APP_LINK + x-order: 2 uuid: + description: Equinix-assigned access point identifier type: string - description: Note Identifier. format: uuid - readOnly: true - example: e41f485e-3094-42de-8797-0ef19a51df79 - parentNote: - description: | - The note this note is responding to. Returned when the note was added in response to an Equinix note. - readOnly: true - allOf: - - $ref: "#/components/schemas/CrossConnectParentNote" - comments: - maxLength: 4000 - type: string - description: Note comments. - readOnly: true - example: Please proceed - description: Note the action applies to. - CrossConnectActionAttachmentResponse: + example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 + x-order: 3 + required: + - uuid + AppSubscriptionSource: + description: Source details for the Subscription + type: object + x-order: 4 + properties: + appLink: + $ref: '#/components/schemas/AppSubscriptionSourceAppLink' + ipSubnets: + type: array + description: List of IP subnets in CIDR notation + items: + type: string + format: ipv4-cidr + example: 192.168.100.0/24 + required: + - ipSubnets + AppSubscriptionTargetAppService: + description: App Service reference for App Subscription type: object properties: href: + description: Resource URI type: string - description: URI to the attachment resource. format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79 + example: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 1 + type: + description: App Service Type + type: string + example: APP_SERVICE + x-order: 2 uuid: + description: Equinix-assigned access point identifier type: string - description: Attachment resource Identifier. format: uuid - readOnly: true - example: e41f485e-3094-42de-8797-0ef19a51df79 - attachmentId: + example: 5008a109-9d1c-485c-b0ba-de9736f283c2 + x-order: 3 + required: + - uuid + AppSubscriptionTarget: + description: Target details for the Subscription + type: object + x-order: 5 + properties: + appService: + $ref: '#/components/schemas/AppSubscriptionTargetAppService' + geoScope: type: string - description: Attachment Identifier. - format: uuid - readOnly: true - example: a11f485e-3094-42de-8797-0ef19a51df79 - description: Document the action applies to. - AppProcessorChangeOperation: + description: Geo scope + example: GLOBAL + prioritization: + $ref: '#/components/schemas/AppSubscriptionPrioritization' required: - - op - - path - - value + - prioritization + - geoScope + AppSubscriptionChangeOperation: + description: App Subscription change operation data type: object properties: op: - type: string description: operation type applied to the resource + type: string enum: - replace - add - remove path: - type: string description: path inside document leading to updated parameter - enum: - - /name + type: string value: - type: object description: new value for updated parameter x-go-type: json.RawMessage - description: App Processor change operation data - AppSubscriptionSourceRequestAppLink: required: - - uuid + - op + - path + - value + AppSubscriptionChange: + description: Current state of latest AppSubscription change type: object properties: uuid: + description: Uniquely identifies a change type: string - description: Equinix-assigned access point identifier - format: uuid - example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - description: App Link reference for App Subscription - AppSubscriptionTargetRequestAppService: - required: - - uuid - type: object - properties: - uuid: + type: + description: Type of change type: string - description: Equinix-assigned access point identifier - format: uuid - example: 5008a109-9d1c-485c-b0ba-de9736f283c2 - description: App Service reference for App Subscription - AppSubscriptionPrioritization: - type: string - description: Prioritization strategy for forwarding API requests - example: LATENCY - enum: - - LATENCY - - PERFORMANCE - - UTILIZATION - - THRESHOLD - - ANY_TAG - AppSubscriptionSourceAppLink: - required: - - uuid - type: object - properties: - href: + enum: + - APP_SUBSCRIPTION_UPDATE + status: + description: Current outcome of the change flow type: string - description: Resource URI - format: uri - readOnly: true - example: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - x-order: 1 - type: + enum: + - COMPLETED + - FAILED + - REQUESTED + createdDateTime: + description: Set when change flow starts type: string - description: App Link Type - example: APP_LINK - x-order: 2 - uuid: + format: date-time + example: '2026-06-29T07:00:00Z' + updatedDateTime: + description: Set when change object is updated type: string - description: Equinix-assigned access point identifier - format: uuid - example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - x-order: 3 - description: App Link reference for App Subscription - AppSubscriptionTargetAppService: + format: date-time + example: '2026-06-29T07:15:00Z' + data: + type: array + items: + $ref: '#/components/schemas/AppSubscriptionChangeOperation' required: - - uuid + - type + - updatedDateTime + AppSubscription: + description: App Subscription object type: object properties: href: - type: string description: Resource URI + type: string format: uri readOnly: true - example: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 + example: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 x-order: 1 type: - type: string - description: App Service Type - example: APP_SERVICE - x-order: 2 + $ref: '#/components/schemas/AppSubscriptionType' uuid: - type: string description: Equinix-assigned access point identifier + type: string format: uuid - example: 5008a109-9d1c-485c-b0ba-de9736f283c2 + example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 x-order: 3 - description: App Service reference for App Subscription - ContactPreference: + source: + $ref: '#/components/schemas/AppSubscriptionSource' + target: + $ref: '#/components/schemas/AppSubscriptionTarget' + state: + $ref: '#/components/schemas/AppSubscriptionState' + project: + $ref: '#/components/schemas/Project' + changeLog: + $ref: '#/components/schemas/Changelog' + change: + $ref: '#/components/schemas/AppSubscriptionChange' + required: + - type + - source + - target + - project + AppSubscriptionUpdateRequest: + description: App Subscription Update Request + type: array + minItems: 1 + items: + $ref: '#/components/schemas/AppSubscriptionChangeOperation' + AppSubscriptionSimpleExpression: type: object properties: - timezone: + property: + description: | + Possible field names to use on filters: + * `/project/projectId` - project id + * `/uuid` - App Subscription uuid + * `/state` - App Subscription status + * `/source/appLink/uuid` - Source App Link uuid + * `/source/ipSubnets` - Source App Link ip subnets + * `/target/appService/uuid` - Target App Service uuid + * `/target/geoScope` - Target App Service geo scope + * `/target/prioritization` - Target App Service prioritization + * `/changeLog/createdDateTime` - App Subscription creation timestamp + * `/changeLog/updatedDateTime` - App Subscription last updated timestamp + * `/changeLog/deletedDateTime` - App Subscription deletion timestamp type: string - description: Timezone of the contact preference - availability: + example: /name + operator: + description: | + Possible operators to use on filters: + * `=` - equal + * `!=` - not equal + * `>` - greater than + * `<` - less than + * `IN` - in + * `NOT IN` - not in + * `LIKE` - like + * `ILIKE` - case-insensitive like + * `BETWEEN` - between + * `NOT BETWEEN` - not between type: string - description: Availability of the contact preference - enum: - - WORK_HOURS - - ANYTIME - description: Contact preference for the phone number - AccessPointType: - type: string - description: Access point type - enum: - - VD - - VG - - SP - - IGW - - COLO - - SUBNET - - CLOUD_ROUTER - - NETWORK - - METAL_NETWORK - - VPIC_INTERFACE - - APP_LINK - - IC - SimplifiedPort: + example: '=' + values: + type: array + items: + type: string + example: Gateway + AppSubscriptionOrFilter: 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 - serviceCode: - $ref: "#/components/schemas/PortServiceCode" - 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: + or: type: array - description: Physical ports that implement this port + maxItems: 3 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" - cluster: - type: string - description: Virtual Device Cluster Information - description: Virtual Device AccessPoint Information - Interface: + $ref: '#/components/schemas/AppSubscriptionSimpleExpression' + AppSubscriptionFilter: 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 + anyOf: + - $ref: '#/components/schemas/AppSubscriptionSimpleExpression' + - $ref: '#/components/schemas/AppSubscriptionOrFilter' + AppSubscriptionFilters: 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: + and: type: array - description: Network sub-resources links - readOnly: true + maxItems: 8 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 - ProductOffering: - type: object - properties: - id: - type: string - description: Product offering identifier - name: - type: string - description: Product offering name - billingTerm: - minimum: 1 - type: integer - description: Billing term in months. - example: 12 - enum: - - 1 - - 12 - - 24 - - 36 - - 48 - - 60 - description: Product offering for connection. Applicable to zSide only. - Address: - type: object - properties: - id: - type: string - description: Address identifier - streetNr: - type: string - description: Street number of address - streetName: - type: string - description: Street name of address - city: - type: string - description: City of address - stateOrProvince: - type: string - description: State of address - postCode: - type: string - description: Postal code of address - country: - type: string - description: Country of address - description: Address. - 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 - - EVPTREE_VC - - EPTREE_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. - VirtualPortPackage: - type: object - properties: - code: - $ref: "#/components/schemas/VirtualPortPackageCode" - description: Virtual Port Package - VirtualPortServiceCode: - type: string - description: Port service code. - TimeServicePriceConnection: - type: object - properties: - aSide: - $ref: "#/components/schemas/TimeServicePriceConnectionASide" - description: Time Service Price Connection configuration - OpticalConnectPricePortType: - type: string - description: Optical Connect type. - example: OC - OpticalConnectPricePathType: + $ref: '#/components/schemas/AppSubscriptionFilter' + AppSubscriptionSortDirection: + description: Sorting direction + default: DESC type: string - description: Optical Connect Port Path type. enum: - - PROTECTED - - UNPROTECTED - - DUAL_DIVERSE - OpticalConnectConnectionDestinationType: + - DESC + - ASC + AppSubscriptionSortBy: + description: | + Possible field names to use on '400_InvalidSorting': + * `/uuid` - App Subscription uuid + * `/state` - App Subscription status + * `/changeLog/createdDateTime` - Date and time when change flow starts + * `/changeLog/updatedDateTime` - Date and time when change object is updated + default: /changeLog/updatedDateTime type: string - description: Destination Port connectivity type - enum: - - COLO - - BMMR - - REMOTE - OpticalConnectPriceASide: - type: object - properties: - location: - $ref: "#/components/schemas/OpticalConnectPriceLocation" - description: Optical Connection ASide configuration - OpticalConnectPriceZSide: - type: object - properties: - location: - $ref: "#/components/schemas/OpticalConnectPriceLocation" - description: Optical Connection ZSide configuration - AccessPointSelector: + format: string + example: /changeLog/updatedDateTime + AppSubscriptionSortCriteria: 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. - OutputStructuredPing: + direction: + $ref: '#/components/schemas/AppSubscriptionSortDirection' + property: + $ref: '#/components/schemas/AppSubscriptionSortBy' + AppSubscriptionSearchRequest: type: object + description: Search requests containing criteria 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: + filter: + $ref: '#/components/schemas/AppSubscriptionFilters' + pagination: + $ref: '#/components/schemas/PaginationRequest' + sort: type: array items: - $ref: "#/components/schemas/OutputStructuredPingResponseItem" - OutputStructuredTraceroute: + $ref: '#/components/schemas/AppSubscriptionSortCriteria' + AppSubscriptionSearchResponse: type: object properties: - destinationIp: - type: string - example: 8.8.8.8 - destinationName: - type: string - example: 8.8.8.8 - packetBytes: - type: integer - example: 60 - hopsMax: - type: integer - example: 10 - hops: + pagination: + $ref: '#/components/schemas/Pagination' + data: + description: Data returned from the API call. type: array items: - $ref: "#/components/schemas/Hop" - CrossConnectConnectorType: - type: string - description: Connector Type. - example: SC - CrossConnectContactPreference: - type: object - properties: - timezone: - type: string - description: Timezone. - example: PST - availability: - $ref: "#/components/schemas/CrossConnectContactAvailability" - description: Cross Connect Contact Preference. - SignatureType: - type: string - description: Cross Connect Signature Type. - example: DELEGATE - enum: - - DELEGATE - - SELF - - ACCOUNT_SUPPORT - 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 - - BASIC - - STANDARD - - ADVANCED - - 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 - VirtualPortPackageCode: - type: string - description: Virtual port package code - example: STANDARD, UNLIMITED or UNLIMITED_PLUS - TimeServicePriceConnectionASide: - type: object - properties: - accessPoint: - $ref: "#/components/schemas/TimeServicePriceConnectionAccessPoint" - description: Time Service Price Connection ASide configuration - OpticalConnectPriceLocation: - type: object - properties: - ibxCode: - type: string - description: IBX identifier - example: SV1 - description: Optical Connect Location - 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 - name: - type: string - description: Customer-assigned Virtual Device name - type: - type: string - description: Type of Virtual Device - enum: - - EDGE - account: - $ref: "#/components/schemas/SimplifiedAccount" - 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 - - EVPTREE - - EPTREE - name: - type: string - description: Network Name - scope: - type: string - description: scope of Network - enum: - - LOCAL - - REGIONAL - - GLOBAL - location: - $ref: "#/components/schemas/SimplifiedLocation" - 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 - Hop: - type: object - properties: - hop: - type: integer - example: 1 - probes: - type: array - items: - $ref: "#/components/schemas/Hop_probes" - CrossConnectContactAvailability: - type: string - description: Availability preference. - example: ANYTIME - enum: - - ANYTIME - - NEVER - - WORK_HOURS - - IBX_HOURS - TimeServicePriceConnectionAccessPoint: - type: object - properties: - location: - $ref: "#/components/schemas/PriceLocation" - description: Time Service Price Connection Access Point configuration - InternetAccessPostRequest_billing: - required: - - type - type: object - properties: - type: - $ref: "#/components/schemas/InternetAccessBillingType" - InternetAccessRoutingProtocolBgpRequest_asn: - required: - - uuid - type: object - properties: - uuid: - type: string - description: Unique identifier of the ASN - format: uuid - example: ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91 - 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 - 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 - ValidateRequest_filter_and: - type: object - 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 - CompanyProfileResponse_account: - type: object - properties: - rootOrgId: - type: string - LoaResponse_operation: - type: object - properties: - consumersCount: - type: integer - description: Number of consumers associated with this LOA. - example: 10 - CrossConnectResponse_allowedActions: - type: object - properties: - type: - $ref: "#/components/schemas/CrossConnectActionType" - Response_incomplete_details: - type: object - properties: - reason: - type: string - description: The reason why the response is incomplete. - enum: - - max_output_tokens - - content_filter - description: | - Details about why the response is incomplete. - nullable: true - ResponseUsage_input_tokens_details: - required: - - cached_tokens - type: object - properties: - cached_tokens: - type: integer - description: | - The number of tokens that were retrieved from the cache. - [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching). - description: A detailed breakdown of the input tokens. - ResponseUsage_output_tokens_details: - required: - - reasoning_tokens - type: object - properties: - reasoning_tokens: - type: integer - description: The number of reasoning tokens. - description: A detailed breakdown of the output tokens. - Gateway_ipv4: - type: object - properties: - primaryIp: - type: string - example: 192.168.1.1/30 - secondaryIp: - type: string - example: 192.168.1.2/30 - description: Gateway IPv4 address - TunnelRoutingProtocolPostRequest_ipv4: - type: object - properties: - enabled: - type: boolean - description: Enable or disable the Routing Protocol on IPv4 - example: true - description: IPv4 configuration for the Routing Protocol - TunnelRoutingProtocol_ipv4: - type: object - properties: - enabled: - type: boolean - description: Enable or disable the Routing Protocol on IPv4 - example: true - localPeerIp: - type: string - description: The local IP address - format: string - example: 192.168.1.1 - remotePeerIp: - type: string - description: The remote peer's IP address - format: string - example: 192.168.1.2 - description: IPv4 configuration for the Routing Protocol - Metric_resource: - type: object - properties: - href: - type: string - description: Metric resource href - uuid: - type: string - description: Metric resource UUID - type: - type: string - description: Metric resource type - state: - type: string - description: Metric resource state - name: - type: string - description: Metric resource name - description: - type: string - description: Metric resource description - description: Metric resource - Metric_datapoints: - type: object - properties: - endDateTime: - type: string - description: Datapoint end date and time - format: date-time - startDateTime: - type: string - description: Datapoint start date and time - format: date-time - value: - type: number - description: Datapoint value - ConnectionRouteTableEntry_connection: - type: object - properties: - uuid: - type: string - example: 81331c52-04c0-4656-a4a7-18c52669348f - name: - type: string - example: connection_1 - href: - type: string - example: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 - InternetAccessRoutingProtocolBgp_asn: - required: - - uuid - type: object - properties: - href: - type: string - description: URI of the ASN resource - example: https://api.equinix.com/fabric/v4/asns/ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91 - uuid: - type: string - description: Unique identifier of the ASN - format: uuid - example: ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91 - IpBlockRegulations_questions: - required: - - privateSpaceConsidered - - refusedPreviously - - returningAddressSpace - type: object - properties: - privateSpaceConsidered: - type: boolean - refusedPreviously: - type: boolean - returningAddressSpace: - type: boolean - PatchIpBlockRequestBodyItem_value: - required: - - uuid - type: object - properties: - uuid: - type: string - format: uuid - description: new value - RouteTableEntry_connection: - type: object - properties: - uuid: - type: string - example: 81331c52-04c0-4656-a4a7-18c52669348f - name: - type: string - example: connection_1 - href: - type: string - format: uri - CompanyProfileContact_contacts: - required: - - email - properties: - name: - type: string - role: - type: string - email: - type: string - CrossConnectScheduleAvailability_aSide: - type: object - properties: - location: - $ref: "#/components/schemas/CrossConnectLocation" - description: A-Side of the schedule window. - readOnly: true - CrossConnectScheduleAvailability_zSide: - type: object - properties: - location: - $ref: "#/components/schemas/CrossConnectLocation" - description: Z-Side of the schedule window. - readOnly: true - 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" - Hop_probes: - type: object - properties: - name: - type: string - example: dns.google - ip: - type: string - example: 8.8.8.8 - asn: - type: integer - example: 15169 - rtt: - type: string - example: "11.764" - annotation: - type: string - examples: - "400": - value: - - errorCode: EQ-3036013 - errorMessage: Invalid Query Parameter - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: presence - reason: Allowed value for presence is MY_SERVICES - "401": - value: - - errorCode: EQ-3000039 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - "403": - value: - - errorCode: EQ-3142402 - errorMessage: Do not have create connection permission on this port - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - "404": - value: - - errorCode: EQ-3045811 - 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: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - "500": - value: - - errorCode: EQ-3034003 - errorMessage: Method not supported,Please check the URL passed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: method:PATCH - AgentTemplatesGetAllResponseExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/agentTemplates/d684aa26-8276-48b7-bb42-a6d9def0a418 - type: ANO_AGENT_TEMPLATE - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - name: CONNECTION BANDWIDTH UPGRADER AGENT TEMPLATE - description: connection bandwidth upgrader Agent Template - state: PROVISIONED - enabled: true - definition: - url: /equinix/agent-factory/refs/heads/use_pdf_html/agent_factory_schema/equinix/fabric/v1/event_driven/upgrade-bw-primary-connection.md - modes: - - ON_EVENT - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - updatedBy: testuser - updatedDateTime: 2024-05-06T16:21:18.545214Z - AgentTemplate_401: - value: - - errorCode: EQ-3164013 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - AgentTemplate_403: - value: - - errorCode: EQ-3164013 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - AgentTemplate_404: - value: - - errorCode: EQ-3164811 - errorMessage: Agent Template not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: Agent Template not found or already deleted - AgentTemplate_500: - value: - - errorCode: EQ-3164004 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - AgentTemplatesResponseExample: - value: - href: https://api.equinix.com/fabric/v4/agentTemplates/d684aa26-8276-48b7-bb42-a6d9def0a418 - type: ANO_AGENT_TEMPLATE - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - name: CONNECTION BANDWIDTH UPGRADER AGENT TEMPLATE - description: connection bandwidth upgrader Agent Template - state: PROVISIONED - enabled: true - definition: - url: /equinix/agent-factory/refs/heads/use_pdf_html/agent_factory_schema/equinix/fabric/v1/event_driven/upgrade-bw-primary-connection.md - modes: - - ON_EVENT - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - updatedBy: testuser - updatedDateTime: 2024-05-06T16:21:18.545214Z - AgentTemplatesSearchExample: - value: - filter: - and: - - property: /name - operator: IN - values: - - name1 - pagination: - offset: 0 - limit: 20 - AgentTemplatesTagsResponseExample: - value: - pagination: - offset: 0 - limit: 20 - total: 3 - data: - - href: https://api.equinix.com/fabric/v4/tags/d684aa26-8276-48b7-bb42-a6d9def0a418 - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - type: PREDEFINED_TAG - name: equinix.fabric.agent_factory.templates.design - displayName: Design & Plan Agents - - href: https://api.equinix.com/fabric/v4/tags/e684aa26-8276-48b7-bb42-a6d9def0a418 - uuid: e684aa26-8276-48b7-bb42-a6d9def0a418 - type: PREDEFINED_TAG - name: equinix.fabric.agent_factory.templates.deploy - displayName: Deploy & Change Agents - - href: https://api.equinix.com/fabric/v4/tags/f684aa26-8276-48b7-bb42-a6d9def0a418 - uuid: f684aa26-8276-48b7-bb42-a6d9def0a418 - type: PREDEFINED_TAG - name: equinix.fabric.agent_factory.templates.monitor - displayName: Monitor & Report Agents - AgentTemplatesByUuidTagsResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tags/d684aa26-8276-48b7-bb42-a6d9def0a418 - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - type: PREDEFINED_TAG - name: equinix.fabric.agent_factory.templates.design - displayName: Design & Plan Agents - AgentGetAllResponseExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/agents/d684aa26-8276-48b7-bb42-a6d9def0a418 - type: ANO_AGENT - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - name: bandwidth-upgrader-agent - description: connection bandwidth upgrader agent - state: PROVISIONED - enabled: true - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - agentTemplate: - uuid: 657400f8-c0af-430c-8216-43d44f08c1c5 - mode: ON_DEMAND - configuration: - prompt: Connection uuid is . Alert rule is . Upgrade bandwidth to 10GB. - activitiesCount: 0 - operation: - latestExecution: - href: https://api.equinix.com/fabric/v4/agents/d684aa26-8276-48b7-bb42-a6d9def0a418/activities/e684aa26-8276-48b7-bb42-a6d9def0a418 - uuid: e684aa26-8276-48b7-bb42-a6d9def0a418 - status: COMPLETED - startDateTime: 2026-07-29T00:00:00.001201Z - endDateTime: 2026-07-29T00:01:00.001201Z - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - Agent_401: - value: - - errorCode: EQ-3164013 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - Agent_403: - value: - - errorCode: EQ-3164013 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - Agent_404: - value: - - errorCode: EQ-3164811 - errorMessage: Agent not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: Agent not found or already deleted - Agent_500: - value: - - errorCode: EQ-3164004 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - AgentPostRequestExample: - value: - type: ANO_AGENT - name: bandwidth-upgrader-agent - description: connection bandwidth upgrader agent - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - agentTemplate: - uuid: 657400f8-c0af-430c-8216-43d44f08c1c5 - configuration: - prompt: Connection uuid is . Alert rule is . Upgrade bandwidth to 10GB. - AgentPostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/agents/d684aa26-8276-48b7-bb42-a6d9def0a418 - type: ANO_AGENT - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - name: bandwidth-upgrader-agent - description: connection bandwidth upgrader agent - state: PROVISIONING - enabled: true - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - agentTemplate: - uuid: 657400f8-c0af-430c-8216-43d44f08c1c5 - configuration: - prompt: Connection uuid is . Alert rule is . Upgrade bandwidth to 10GB. - activitiesCount: 0 - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - deletedBy: testuser - deletedDateTime: 2024-05-10T16:21:18.545214Z - Agent_415: - value: - - errorCode: EQ-3164009 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - AgentResponseExample: - value: - href: https://api.equinix.com/fabric/v4/agents/d684aa26-8276-48b7-bb42-a6d9def0a418 - type: ANO_AGENT - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - name: bandwidth-upgrader-agent - description: connection bandwidth upgrader agent - state: PROVISIONING - enabled: true - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - agentTemplate: - uuid: 657400f8-c0af-430c-8216-43d44f08c1c5 - configuration: - prompt: Connection uuid is . Alert rule is . Upgrade bandwidth to 10GB. - activitiesCount: 0 - operation: - latestExecution: - href: https://api.equinix.com/fabric/v4/agents/d684aa26-8276-48b7-bb42-a6d9def0a418/activities/e684aa26-8276-48b7-bb42-a6d9def0a418 - uuid: e684aa26-8276-48b7-bb42-a6d9def0a418 - status: COMPLETED - startDateTime: 2026-07-29T00:00:00.001201Z - endDateTime: 2026-07-29T00:01:00.001201Z - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - AgentDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/agents/d684aa26-8276-48b7-bb42-a6d9def0a418 - type: ANO_AGENT - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - name: bandwidth-upgrader-agent - description: connection bandwidth upgrader agent - state: DEPROVISIONING - enabled: true - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - agentTemplate: - uuid: 657400f8-c0af-430c-8216-43d44f08c1c5 - configuration: - prompt: Connection uuid is . Alert rule is . Upgrade bandwidth to 10GB. - activitiesCount: 0 - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - deletedBy: testuser - deletedDateTime: 2024-05-10T16:21:18.545214Z - AgentPatchRequestExample: - value: - path: /name - op: replace - value: bandwidth-upgrader-agent-updated - AgentPatchResponseExample: - value: - href: https://api.equinix.com/fabric/v4/agents/d684aa26-8276-48b7-bb42-a6d9def0a418 - type: ANO_AGENT - uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 - name: bandwidth-upgrader-agent-updated - description: connection bandwidth upgrader agent updated - state: PROVISIONING - enabled: true - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - agentTemplate: - uuid: 657400f8-c0af-430c-8216-43d44f08c1c5 - configuration: - prompt: Connection uuid is . Alert rule is . Upgrade bandwidth to 10GB. - activitiesCount: 0 - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - updatedBy: testuser - updatedDateTime: 2024-05-06T16:21:18.545214Z - AgentActivitiesResponseExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/agents/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/activities - type: AGENT_ACTIVITY - uuid: 123e4567-e89b-12d3-a456-426614174000 - agent: - uuid: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 - type: ANO_AGENT - status: COMPLETED - metadata: - chatMessage: - messages: - - type: user - content: |- - Here are additional parameters: json - { - "connection_uuid": "456e4567-e89b-12d3-a456-426614174000", - "operand": "ABOVE", - "critical_threshold": 400000, - "stream_uuid": 789e4567-e89b-12d3-a456-426614174000 - }. Follow the instructions step by step and complete all the operations. - - type: assistant - content: The agent is setup process has been successfully completed. - toolCallInformation: - - name: search_connections - input: '{"query":{"filter":{"and":[{"property":"/uuid","operator":"=","values":["456e4567-e89b-12d3-a456-426614174000"]}]},"pagination":{"limit":5}}}' - response: '{"results":[{"uuid":"456e4567-e89b-12d3-a456-426614174000","name":"Primary Connection","bandwidth":"1Gbps"}]}' - changeLog: - createdBy: testuser - createdDateTime: 2024-05-06T16:21:18.545214Z - AgentActionGetAllResponseExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/agents/e59b74d7-58ca-408e-a406-b701e3fba0a7/actions/ee8532ca-7378-4343-b5f8-d17d9aad2895 - uuid: ee8532ca-7378-4343-b5f8-d17d9aad2895 - type: EXECUTE_AGENT - status: PENDING - schedule: - executeDateTime: 2026-03-20T10:10:10.000Z - changeLog: - createdBy: testUser@equinix.com - createdDateTime: 2026-03-10T10:10:10.000Z - AgentActionPostRequestExample: - value: - type: EXECUTE_AGENT - schedule: - executeDateTime: 2026-03-20T10:10:10.000Z - AgentActionResponseExample: - value: - href: https://api.equinix.com/fabric/v4/agents/e59b74d7-58ca-408e-a406-b701e3fba0a7/actions/ee8532ca-7378-4343-b5f8-d17d9aad2895 - uuid: ee8532ca-7378-4343-b5f8-d17d9aad2895 - type: EXECUTE_AGENT - status: PENDING - schedule: - executeDateTime: 2026-03-20T10:10:10.000Z - changeLog: - createdBy: testUser@equinix.com - createdDateTime: 2026-03-10T10:10:10.000Z - AgentActionDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/agents/e59b74d7-58ca-408e-a406-b701e3fba0a7/actions/ee8532ca-7378-4343-b5f8-d17d9aad2895 - uuid: ee8532ca-7378-4343-b5f8-d17d9aad2895 - type: EXECUTE_AGENT - status: DELETED - schedule: - executeDateTime: 2026-03-20T10:10:10.000Z - changeLog: - createdBy: testUser@equinix.com - createdDateTime: 2026-03-10T10:10:10.000Z - AgentSearchExample: - value: - filter: - and: - - property: /name - operator: IN - values: - - name1 - pagination: - offset: 0 - limit: 20 - 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 - traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, - tracestate: 71a60705518f,81a607055181 - data: - message: Neighbor 100.100.100.102 address session state changed to Connect - auth: - authtype: system - authid: 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" - traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, - tracestate: 71a60705518f,81a607055181 - data: - message: Connection named TEST-CONNECTION state changed to provisioning - resource: - href: http://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: - authtype: user - authid: "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 - traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, - tracestate: 71a60705518f,81a607055181 - data: - message: Connection named TEST-CONNECTION state changed to provisioned - resource: - href: http://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: - authtype: system - authid: 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" - traceparent: 00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00, - tracestate: 71a60705518f,81a607055181 - data: - message: Connection named TEST-CONNECTION state changed to provisioning - resource: - href: http://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: - authtype: user - authid: "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: /equinixorganization - operator: = - values: - - "526698000597331" - - property: /equinixproject - operator: = - values: - - dadd3ab6-c0af-430c-8216-43d44f08c1c5 - - property: /time - operator: ">" - values: - - 2018-04-05T17:31:00.000Z - pagination: - offset: 0 - limit: 20 - search-live-events: - value: - filter: - and: - - property: /subject - operator: IN - values: - - /fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - pagination: - offset: 0 - limit: 2 - search-live-events-response: - value: - pagination: - offset: 0 - limit: 2 - total: 1 - data: - - specversion: "1.0" - source: https://api.equinix.com/fabric/v4/cloudevents - id: 6c573287-9914-4202-8b6d-2d15e7da04b8 - type: equinix.fabric.port.status.down - subject: /fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - time: 2018-04-05T17:31:00.000Z - dataschema: https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json - datacontenttype: application/json - severitynumber: "21" - severitytext: FATAL - equinixalert: raise/AABBcCCDDeEfFf123, - equinixproject: project-123 - data: - message: Virtual port 'port-name' status changed to DOWN - resource: - href: https://api.equinix.com//fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - uuid: 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - type: XF_PORT - state: PROVISIONED - operation: - operationalStatus: DOWN - search-live-alerts: - value: - filter: - and: - - property: /equinixalert - operator: LIKE - values: - - raise/% - - property: /time - operator: BETWEEN - values: - - 2026-01-01T00:00:00.000Z - - 2026-01-02T00:00:00.000Z - - or: - - property: /equinixproject - operator: IN - values: - - 6a7ce6bb-4424-414d-bea4-7a6a05ff1919 - - property: /subject - operator: LIKE - values: - - /fabric/v4/metros/* - sort: - property: /time - order: DESC - pagination: - limit: 100 - offset: 0 - search-live-alerts-response: - value: - pagination: - offset: 0 - limit: 100 - total: 2 - data: - - specversion: "1.0" - source: https://api.equinix.com/fabric/v4/liveAlerts - id: 6c573287-9914-4202-8b6d-2d15e7da04b8 - type: equinix.fabric.connection.status.down - subject: /fabric/v4/connections/956a86fb-d03d-436c-8d5d-30d1f51f7688 - time: 2026-01-01T03:00:00.000Z - dataschema: https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json - datacontenttype: application/json - severitynumber: "19" - severitytext: CRITICAL - equinixalert: raise/NCAB543WC4lrLpET8nLX4Vm8 - equinixproject: 6a7ce6bb-4424-414d-bea4-7a6a05ff1919 - data: - message: Connection 'Test-Connection' status changed to Down - resource: - href: https://api.equinix.com/fabric/v4/connections/956a86fb-d03d-436c-8d5d-30d1f51f7688 - uuid: 956a86fb-d03d-436c-8d5d-30d1f51f7688 - type: IP_VC - state: PROVISIONED - name: Test name - - specversion: "1.0" - source: https://api.equinix.com/fabric/v4/liveAlerts - id: 6c573287-9914-4202-8b6d-2d15e7da04b8 - type: equinix.fabric.metro.sv_ch.latency - subject: /fabric/v4/metros/SV - time: 2026-01-01T03:30:00.000Z - dataschema: https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json - datacontenttype: application/json - severitynumber: "13" - severitytext: WARN - equinixalert: raise/DAEB543WC4lrLpET8nLX4Vm8 - data: - message: Abnormal detected for metro latency from Silicon to Chicago - resource: - href: https://api.equinix.com/fabric/v4/metros/SV - code: SV - type: XF_METRO - metrics: - - type: GAUGE - name: equinix.fabric.metro.sv_ch.latency - unit: ms - datapoints: - - endDateTime: 2026-01-01T03:30:00.000Z - value: 63.6634 - get-metrics-by-asset-id: - value: - pagination: - offset: 0 - limit: 10 - total: 2 - next: null - previous: null - data: - - type: GAUGE - name: equinix.fabric.port.bandwidth_rx.usage - unit: bit/s - interval: PT5M - resource: - href: https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72 - uuid: 0689734d-25c6-40d1-a9ff-3e4edea07a72 - type: XF_PORT - state: PROVISIONED - name: my-port-name - summary: - mean: 102.15384615384616 - max: 107 - datapoints: - - endDateTime: 2025-05-14T13:57:56.000Z - value: 107 - - endDateTime: 2025-05-14T14:02:48.000Z - value: 97 - - endDateTime: 2025-05-14T14:07:58.000Z - value: 105 - - endDateTime: 2025-05-14T14:12:36.000Z - value: 102 - - endDateTime: 2025-05-14T14:18:00.000Z - value: 96 - - endDateTime: 2025-05-14T14:23:03.000Z - value: 106 - - endDateTime: 2025-05-14T14:27:59.000Z - value: 104 - - endDateTime: 2025-05-14T14:32:56.000Z - value: 104 - - endDateTime: 2025-05-14T14:37:51.000Z - value: 103 - - endDateTime: 2025-05-14T14:42:59.000Z - value: 100 - - endDateTime: 2025-05-14T14:47:58.000Z - value: 105 - - endDateTime: 2025-05-14T14:53:08.000Z - value: 94 - - endDateTime: 2025-05-14T14:57:46.000Z - value: 105 - - type: GAUGE - name: equinix.fabric.port.bandwidth_tx.usage - unit: bit/s - interval: PT5M - resource: - href: https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72 - uuid: 0689734d-25c6-40d1-a9ff-3e4edea07a72 - summary: - mean: 255.92307692307693 - max: 295 - datapoints: - - endDateTime: 2025-05-14T13:57:56.000Z - value: 259 - - endDateTime: 2025-05-14T14:02:48.000Z - value: 234 - - endDateTime: 2025-05-14T14:07:58.000Z - value: 242 - - endDateTime: 2025-05-14T14:12:36.000Z - value: 280 - - endDateTime: 2025-05-14T14:18:00.000Z - value: 243 - - endDateTime: 2025-05-14T14:23:03.000Z - value: 262 - - endDateTime: 2025-05-14T14:27:59.000Z - value: 247 - - endDateTime: 2025-05-14T14:32:56.000Z - value: 295 - - endDateTime: 2025-05-14T14:37:51.000Z - value: 284 - - endDateTime: 2025-05-14T14:42:59.000Z - value: 227 - - endDateTime: 2025-05-14T14:47:58.000Z - value: 260 - - endDateTime: 2025-05-14T14:53:08.000Z - value: 251 - - endDateTime: 2025-05-14T14:57:46.000Z - value: 243 - maintenancesGetAll: - value: - pagination: - offset: 0 - limit: 20 - total: 2 - data: - - href: https://api.equinix.com/fabric/v4/ports/b2d93b39-02db-2dbc-ace0-30fa5c00ad04/maintenances/a1d93b39-02db-2dbc-ace0-30fa5c00ad04 - uuid: a1d93b39-02db-2dbc-ace0-30fa5c00ad04 - type: XF_MAINTENANCE - category: NETWORK_UPGRADE - state: POSTPONED - incidentRefId: CHG0123456 - root: - href: https://api.equinix.com/fabric/v4/ports/b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - type: XF_PORT - uuid: b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - startDateTime: 2026-07-10T00:00:00Z - endDateTime: 2026-07-10T08:00:00Z - group: - uuid: c3d93b39-02db-2dbc-ace0-30fa5c00ad04 - scope: ASIDE - changeLog: - createdBy: admin_user - createdDateTime: 2026-07-01T09:00:00Z - updatedBy: test_user - updatedDateTime: 2026-07-05T14:30:00Z - - href: https://api.equinix.com/fabric/v4/ports/b2d93b39-02db-2dbc-ace0-30fa5c00ad04/maintenances/b1d93b39-02db-2dbc-ace0-30fa5c00ad04 - uuid: b1d93b39-02db-2dbc-ace0-30fa5c00ad04 - type: XF_MAINTENANCE - category: NETWORK_UPGRADE - state: SCHEDULED - incidentRefId: CHG0123457 - root: - href: https://api.equinix.com/fabric/v4/ports/b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - type: XF_PORT - uuid: b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - startDateTime: 2026-07-11T00:00:00Z - endDateTime: 2026-07-11T08:00:00Z - group: - uuid: c3d93b39-02db-2dbc-ace0-30fa5c00ad04 - scope: ZSIDE - changeLog: - createdBy: admin_user - createdDateTime: 2026-07-01T09:00:00Z - updatedBy: test_user - updatedDateTime: 2026-07-05T14:30:00Z - maintenanceGet: - value: - href: https://api.equinix.com/fabric/v4/ports/b2d93b39-02db-2dbc-ace0-30fa5c00ad04/maintenances/a1d93b39-02db-2dbc-ace0-30fa5c00ad04 - uuid: a1d93b39-02db-2dbc-ace0-30fa5c00ad04 - type: XF_MAINTENANCE - category: NETWORK_UPGRADE - state: POSTPONED - incidentRefId: CHG0123456 - root: - href: https://api.equinix.com/fabric/v4/ports/b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - type: XF_PORT - uuid: b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - startDateTime: 2026-07-10T00:00:00Z - endDateTime: 2026-07-10T08:00:00Z - group: - uuid: c3d93b39-02db-2dbc-ace0-30fa5c00ad04 - scope: ASIDE - changeLog: - createdBy: admin_user - createdDateTime: 2026-07-01T09:00:00Z - updatedBy: test_user - updatedDateTime: 2026-07-05T14:30:00Z - maintenanceActionsGetAll: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2/maintenances/a1d93b39-02db-2dbc-ace0-30fa5c00ad04/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: MAINTENANCE_POSTPONE - state: COMPLETED - notes: Deferring maintenance at customer request. - changeLog: - createdBy: admin_user - createdDateTime: 2025-10-21T10:30:00Z - maintenanceActionRequest: - value: - type: MAINTENANCE_POSTPONE - notes: Deferring maintenance at customer request. - maintenanceActionPost: - value: - href: https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2/maintenances/a1d93b39-02db-2dbc-ace0-30fa5c00ad04/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: MAINTENANCE_POSTPONE - state: PENDING - notes: Deferring maintenance at customer request. - changeLog: - createdBy: admin_user - createdDateTime: 2025-10-21T10:30:00Z - maintenanceActionSearchRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - MAINTENANCE_POSTPONE - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - maintenanceActionGet: - value: - href: https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2/maintenances/a1d93b39-02db-2dbc-ace0-30fa5c00ad04/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: MAINTENANCE_POSTPONE - state: COMPLETED - notes: Deferring maintenance at customer request. - changeLog: - createdBy: admin_user - createdDateTime: 2025-10-21T10:30:00Z - maintenanceSearchByAssetId: - value: - filter: - property: /root/uuid - operator: IN - values: - - b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - - f2d93b39-02db-2dbc-ace0-30fa5c00ad08 - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - maintenanceSearchByOptionalFilters: - value: - filter: - and: - - property: /state - operator: IN - values: - - POSTPONED - - SCHEDULED - - IN_PROGRESS - - COMPLETED - - CANCELLED - - or: - - property: /root/uuid - operator: IN - values: - - b2d93b39-02db-2dbc-ace0-30fa5c00ad04 - - f2d93b39-02db-2dbc-ace0-30fa5c00ad08 - - property: /uuid - operator: IN - values: - - a1d93b39-02db-2dbc-ace0-30fa5c00ad04 - pagination: - offset: 0 - limit: 20 - sort: - - property: /startDateTime - direction: ASC - - property: /changeLog/updatedDateTime - direction: DESC - maintenanceSearchRangeOperators: - value: - filter: - and: - - property: /startDateTime - operator: BETWEEN - values: - - 2026-07-01T00:00:00Z - - 2026-07-31T23:59:59Z - - property: /endDateTime - operator: BETWEEN - values: - - 2026-07-01T00:00:00Z - - 2026-07-31T23:59:59Z - - property: /state - operator: IN - values: - - SCHEDULED - - POSTPONED - - IN_PROGRESS - - COMPLETED - - CANCELLED - pagination: - offset: 0 - limit: 50 - sort: - - property: /startDateTime - direction: ASC - get-metrics-by-name: - value: - pagination: - offset: 0 - limit: 5000 - total: 3 - data: - - type: GAUGE - name: equinix.fabric.metro.at_am.latency - unit: ms - resource: - href: https://uatapi.equinix.com/fabric/v4/metros/AT - type: XF_METRO - description: Atlanta to Amsterdam intermetro latency, average in milliseconds - datapoints: - - endDateTime: 2026-02-03T23:05:04Z - value: 94.8 - - type: GAUGE - name: equinix.fabric.metro.at_ba.latency - unit: ms - resource: - href: https://uatapi.equinix.com/fabric/v4/metros/AT - type: XF_METRO - description: Atlanta to Barcelona intermetro latency, average in milliseconds - datapoints: - - endDateTime: 2026-02-03T23:05:04Z - value: 111 - - type: GAUGE - name: equinix.fabric.metro.at_bg.latency - unit: ms - resource: - href: https://uatapi.equinix.com/fabric/v4/metros/AT - type: XF_METRO - description: Atlanta to Bogota intermetro latency, average in milliseconds - datapoints: - - endDateTime: 2026-02-03T23:05:04Z - value: 69.8 - search-metrics: - value: - filter: - and: - - property: /subject - operator: = - values: - - /fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - - property: /name - operator: IN - values: - - equinix.fabric.port.bandwidth_rx.usage - - equinix.fabric.port.bandwidth_tx.usage - - equinix.fabric.port.packets_dropped_rx.count - - equinix.fabric.port.packets_dropped_tx.count - - property: /dataPoints/endDateTime - operator: BETWEEN - values: - - 2025-09-01T19:19:50Z - - 2025-09-03T19:19:50Z - pagination: - offset: 0 - limit: 10 - COLO2COLO-Dot1q2Dot1q: - value: - type: EVPL_VC - name: My-Port-2-Port-Connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a8ba52de-faae-43b5-b0b1-6904d37ee063 - linkProtocol: - type: DOT1Q - vlanTag: 1001 - zSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2COLO-Dot1q2Dot1q-withTerms: - value: - type: EVPL_VC - name: My-Port-2-Port-Connection-1 - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 24 - aSide: - accessPoint: - type: COLO - port: - uuid: a8ba52de-faae-43b5-b0b1-6904d37ee063 - linkProtocol: - type: DOT1Q - vlanTag: 1001 - zSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2COLO-Dot1q2Dot1q-withGeoScope: - value: - type: EVPL_VC - name: My-Port-2-Port-Connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a867f685-41b0-1b07-6de0-320a5c00abdd - linkProtocol: - type: DOT1Q - vlanTag: 1001 - zSide: - accessPoint: - type: COLO - port: - uuid: b067f685-49b0-1a09-6fe0-360a5d00afdd - linkProtocol: - type: DOT1Q - vlanTag: 1001 - geoScope: CONUS - project: - projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 - notifications: - - type: ALL - emails: - - test@test.com - COLO2COLO-Dot1Q2QinQ: - value: - type: EVPL_VC - name: My-Port-2-Port-Connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - zSide: - accessPoint: - type: COLO - port: - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - linkProtocol: - type: QINQ - vlanSTag: 1001 - vlanCTag: 1002 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2COLO-Qinq2Qinq: - value: - type: EVPL_VC - name: My-Port-2-Port-Connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: QINQ - vlanSTag: 12 - zSide: - accessPoint: - type: COLO - port: - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - linkProtocol: - type: QINQ - vlanSTag: 13 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2COLO-Qinq2Dot1q: - value: - type: EVPL_VC - name: My-Port-2-Port-Connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: QINQ - vlanSTag: 1001 - vlanCTag: 1125 - 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 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - COLO2COLO-MetroConnect: - value: - type: MC_VC - name: metro-connect-P2P - bandwidth: 1000 - 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: - value: - type: EPL_VC - name: My-Port-2-Port-Connection-1 - order: - purchaseOrderNumber: po1234 - termLength: 1 - bandwidth: 100 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - zSide: - accessPoint: - type: COLO - port: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - COLO2COLO-AccessEpl: - value: - type: ACCESS_EPL_VC - name: My-Port-2-Port-Connection-1 - order: - purchaseOrderNumber: 1-129105284100 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - COLO2SPwithDot1q: - value: - type: EVPL_VC - name: My-Layer2-Connection-3 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2SPwithGeoScope: - value: - type: EVPL_VC - name: My-Port-2-GenSP-Conn-1 - bandwidth: 50 - redundancy: - priority: PRIMARY - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: c4d93b39-034e-34ec-ace0-30fa5c00ad01 - linkProtocol: - type: DOT1Q - vlanTag: 23 - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 5a76497a-ff00-4a89-a605-b0680799c6aa - location: - metroCode: DC - geoScope: CONUS - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - COLO2SPNonGenwithGeoScope: - value: - type: EVPL_VC - name: My-Port-2-NonGenSP-Conn-1 - bandwidth: 100 - redundancy: - priority: PRIMARY - order: - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: c4d93b39-0341-341c-ace0-30fa5c00ad01 - linkProtocol: - type: QINQ - vlanSTag: 23 - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: bfb74121-7e2c-4f74-99b3-69cdafb03b41 - location: - metroCode: SV - authenticationKey: xxxx-xxx-xxxx - geoScope: CONUS - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - COLO2AlibabaSPwithDot1q: - value: - type: EVPL_VC - name: port2alibaba-connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2AWSSPwithDot1q-Primary: - value: - type: EVPL_VC - name: Primary-Aws - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2AzureSP-Primary: - value: - type: EVPL_VC - name: port2azure-connection-1 - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: d166b9ce-79ed-4ea6-8f8b-785fd69f3dcc - linkProtocol: - type: DOT1Q - vlanTag: 123 - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: a1390b22-abe0-4e93-ad37-85beef9d254a - location: - metroCode: DC - peeringType: PRIVATE - authenticationKey: xxx-xxx-xxx - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2LMaaSSP: - value: - type: EVPL_VC - name: Last Mile Connection 1 - bandwidth: 10 - redundancy: - priority: PRIMARY - order: - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: d4db1048-ef3d-f3d6-49e0-306a5c00a341 - linkProtocol: - type: QINQ - vlanSTag: 121 - vlanCTag: 145 - zSide: - accessPoint: - type: SP - profile: - uuid: 8236fbb9-51e5-428f-86bf-6b67e1223ac1 - location: - metroCode: DC - productOffering: - id: sample-product-offering-id - name: Sample product offering 1 - billingTerm: 12 - bandwidthCommit: 50 - address: - id: lmaas-addr-sample-id - streetNr: "1234" - streetName: Main St - city: San Jose - stateOrProvince: CA - postCode: "95101" - country: United States - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - someone@sample.com - - type: ORDERING - emails: - - someone@sample.com - phone: - - type: OFFICE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: MOBILE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: TECHNICAL - emails: - - someone@sample.com - phone: - - type: OFFICE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: MOBILE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - COLO2GoogleSPwithDot1q: - value: - type: EVPL_VC - name: My-Layer2-Connection-3 - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@test.com - COLO2IBM_1: - value: - type: EVPL_VC - name: My-Layer2-Connection-3 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - 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 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - 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 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - linkProtocol: - type: DOT1Q - vlanTag: 1001 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - COLO2ServiceToken: - value: - type: EVPL_VC - name: Conn-1 - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - location: - metroCode: SV - zSide: - serviceToken: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - COLO2NETWORKwithDot1q: - value: - type: EVPLAN_VC - name: colo2network-evplan-vc - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - COLO2NETWORKwithEPL: - value: - type: EPLAN_VC - name: colo2network-eplan-vc - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 - zSide: - accessPoint: - type: NETWORK - network: - uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - COLO2NETWORK_EVPTREE_withDot1q: - value: - type: EVPTREE_VC - name: colo2network-evptree-vc - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - role: LEAF - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - COLO2NETWORK_EPTREE_withEPL: - value: - type: EPTREE_VC - name: colo2network-eptree-vc - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: COLO - port: - uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 - zSide: - accessPoint: - type: NETWORK - network: - uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 - role: LEAF - 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 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: VD - virtualDevice: - type: EDGE - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - interface: - type: NETWORK - id: 3 - zSide: - accessPoint: - type: NETWORK - network: - uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 - 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 - order: - purchaseOrderNumber: 1-1234567890 - termLength: 1 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - Vd2AzureSP: - value: - type: EVPL_VC - name: vd2azure-connection-1 - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - Vd2OracleSP: - value: - type: EVPL_VC - name: vd2oracle-connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 24 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - Vd2Ibm_1: - value: - type: EVPL_VC - name: vd2ibm10-connection-1 - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - Vd2Ibm_2: - value: - type: EVPL_VC - name: vd2ibm20-connection-1 - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - Vd2AlibabaSP: - value: - type: EVPL_VC - name: vd2alibaba-connection-1 - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - fabric@equinix.com - Vd2GoogleSP: - value: - type: EVPL_VC - name: vd2googleSp-connection-1 - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 24 - 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 - notifications: - - type: ALL - emails: - - fabric@equinx.com - Vd2Sp-Primary: - value: - type: EVPL_VC - name: Network Device to SP - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: VD - virtualDevice: - type: EDGE - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - interface: - type: NETWORK - id: 3 - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 - authenticationKey: xx-xx-xx - sellerRegion: us-west-1 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Vd2Sp-Secondary: - value: - type: EVPL_VC - name: Network Device to SP - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: 3 - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 - authenticationKey: xx-xx-xx - sellerRegion: us-west-1 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Vd2Colo: - value: - type: EVPL_VC - name: vd to COLO - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 24 - aSide: - accessPoint: - type: VD - virtualDevice: - type: EDGE - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - interface: - type: NETWORK - id: 3 - zSide: - accessPoint: - type: COLO - port: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - linkProtocol: - type: DOT1Q - vlanTag: 300 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - VD2COLO-Dot1q-withGeoScope: - value: - type: EVPL_VC - name: My-VD-2-COLO-Connection-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: VD - virtualDevice: - uuid: a867f685-41b0-1b07-6de0-320a5c00abdd - interface: - type: NETWORK - id: 1 - location: - metroCode: FR - zSide: - accessPoint: - type: COLO - port: - uuid: b067f685-49b0-1a09-6fe0-360a5d00afd0 - linkProtocol: - type: DOT1Q - vlanTag: 1001 - location: - metroCode: AM - geoScope: EU - project: - projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 - notifications: - - type: ALL - emails: - - test@test.com - Vd2Colo-VlanTag: - value: - type: EVPL_VC - name: vd to COLO - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: VD - virtualDevice: - type: EDGE - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - interface: - type: NETWORK - id: 3 - zSide: - accessPoint: - type: COLO - port: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - linkProtocol: - type: DOT1Q - vlanTagMin: 300 - vlanTagMax: 1099 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Vd2Colo-VlanCTag: - value: - type: EVPL_VC - name: vd to COLO - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: VD - virtualDevice: - type: EDGE - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - interface: - type: NETWORK - id: 3 - zSide: - accessPoint: - type: COLO - port: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - linkProtocol: - type: QINQ - vlanCTag: 300 - vlanSTag: 301 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Vd2ColoUntagged: - value: - type: EVPL_VC - name: vd to SP - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: VD - virtualDevice: - type: EDGE - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - interface: - type: NETWORK - id: 3 - zSide: - accessPoint: - type: COLO - port: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - linkProtocol: - type: UNTAGGED - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Vd2ServiceToken: - value: - type: EVPL_VC - name: vd2token-conn-1 - order: - purchaseOrderNumber: po1234 - termLength: 1 - bandwidth: 10 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: VD - virtualDevice: - type: EDGE - uuid: 207667ba-3211-452c-b0a8-8b9046e122a2 - zSide: - serviceToken: - uuid: 557411a5-16a6-4aef-beea-7f622e94f1e0 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcda - Fcr2Colo: - value: - type: IP_VC - name: My-FCR-Connection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Sp-Google: - value: - type: IP_VC - name: My-FCR-GCPConnection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Sp-Azure: - value: - type: IP_VC - name: My-FCR-AzureConnection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Sp-IBM: - value: - type: IP_VC - name: My-FCR-IBMConnection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: CLOUD_ROUTER - router: - uuid: 66a21614-1c4a-11ec-9621-0242ac130002 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - additionalInfo: - - key: Global - value: "false" - - key: IBM IPv4 CIDR - value: 172.16.0.18/30 - - key: CER IPv4 CIDR - value: 172.16.0.19/30 - Fcr2Sp-Generic: - value: - type: IP_VC - name: My-FCR-GenericConnection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - 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 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - 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 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Sp-Aws: - value: - type: IP_VC - name: My-FCR-AWSConnection - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Sp-Oracle: - value: - type: IP_VC - name: My-FCR-OracleConnection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - Fcr2Sp-Alibaba: - value: - type: IP_VC - name: My-FCR-AlibabaConnection - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - authenticationKey: xx-xx-xx - sellerRegion: us-west-1 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Vd: - value: - type: IP_VC - name: My-GW-VDConnection - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: 3 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Vd-Redundant-Secondary: - value: - type: IP_VC - name: My-GW-VDConnection-Secondary - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: 3 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2IpWan: - value: - type: IPWAN_VC - name: MY-IPWAN-CONNECTION-1 - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: CLOUD_ROUTER - router: - uuid: 66a21614-1c4a-11ec-9621-0242ac130002 - zSide: - accessPoint: - type: NETWORK - network: - uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2Sp-Aws-marketplaceSubscription: - value: - type: IP_VC - name: My-FCR-AWSConnection - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Fcr2ServiceToken: - value: - type: IP_VC - name: My-FCR-Connection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: CLOUD_ROUTER - router: - uuid: 66a21614-1c4a-11ec-9621-0242ac130002 - location: - metroCode: SV - zSide: - serviceToken: - uuid: 4cc30499-d472-4edb-9114-1381ed17e356 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - AsideServiceToken2PortWithDot1q: - value: - type: EVPL_VC - name: Aside-token - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - AsideServiceToken2PortWithQinq: - value: - type: EVPL_VC - name: Aside-Token - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - AsideServiceToken2PrivateSP-NE: - value: - type: EVPL_VC - name: Token2PrivateSP-NE - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - serviceToken: - uuid: 41a9e1ef-18bb-485b-a9b3-99801ac03684 - zSide: - accessPoint: - type: SP - profile: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 - location: - metroCode: SV - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - AsideServiceToken2ZsideServiceToken: - value: - type: EVPL_VC - name: Aside to zside token connection - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - serviceToken: - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - zSide: - serviceToken: - uuid: 4f9c5438-90eb-4295-b109-7754119a1e8d - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - Metal2Sp-Aws: - value: - type: EVPL_VC - name: My-Metal-sp-connection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - Metal2Sp-Azure: - value: - type: EVPL_VC - name: Metal2Azure Connection - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: 16799d66-ef43-445c-ba29-d17522d8a137 - notifications: - - type: ALL - emails: - - eqxfabricamcrh@gmail.com - Metal2Sp-GCP: - value: - type: EVPL_VC - name: Metal2GCP-Connection - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - Metal2Sp-Oracle: - value: - type: EVPL_VC - name: Metal2Oracle-Connection - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: 16799d66-ef43-445c-ba29-d17522d8a137 - notifications: - - type: ALL - emails: - - test@gmail.com - Metal2Sp-IBM: - value: - type: EVPL_VC - name: Metal2IBM-Connection - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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" - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - Metal2Port-Dot1q: - value: - type: EVPL_VC - name: Metal2Port-dot1q - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: METAL_NETWORK - authenticationKey: xxxxxxxxx - zSide: - accessPoint: - type: COLO - port: - uuid: 6c73d02c-87e1-4642-8e18-01eb4b87e243 - linkProtocol: - type: DOT1Q - vlanTag: 128 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - Metal2Port-Qinq: - value: - type: EVPL_VC - name: Metal2Port-qinq - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - Metal2ServiceToken: - value: - type: EVPL_VC - name: Metal2ServiceToken - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: METAL_NETWORK - authenticationKey: xxxxxxxxx - zSide: - serviceToken: - uuid: bc1383be-579a-4d75-ae19-b0d487bbff90 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - Metal2Sp-Generic: - value: - type: EVPL_VC - name: Metal2Generic - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: METAL_NETWORK - authenticationKey: xxxxxxxxx - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@test.com - Vd2IAProfile-Request: - value: - type: IA_VC - name: Network Device to IA SP - bandwidth: 50 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - CreateConnectionDryRunRequest: - value: - type: EVPL_VC - name: My-EVPL-Connection - bandwidth: 500 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - notifications: - - type: ALL - emails: - - test@test.com - IXDedicatedPublicPeeringConnection: - value: - type: IX_VC - name: Virtual-Connection-1 - bandwidth: 1000 - aSide: - accessPoint: - type: COLO - port: - uuid: 99e83e59-fd26-4134-b1b3-4c5dea6924d6 - zSide: - accessPoint: - type: SP - profile: - uuid: 0f6bdb36-e130-4924-b038-ee1785fad166 - notifications: - - type: ALL - emails: - - test@test.com - project: - projectId: 03ed2230-604a-494c-bca2-c042d38d80bc - 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 - COLO2COLO-Dot1q2Dot1q-withTerms-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/6c157170-f84d-424a-9396-b5d6ee723296 - type: EVPL_VC - uuid: 6c157170-f84d-424a-9396-b5d6ee723296 - name: My-Port-2-Port-Connection-1 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: po1234 - billingTier: Up to 100 MB - termLength: 24 - contractedBandwidth: 100 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - changeLog: - createdBy: fabric_user - createdDateTime: 2026-04-11T19:26:58.847Z - updatedBy: fabric_user - updatedDateTime: 2026-04-11T19:26:58.847Z - bandwidth: 10 - redundancy: - group: d630b469-2322-481b-9c32-d04a35ca7a60 - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033a-33ac-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033a-33ac-ace0-30fa5c00ad01 - name: port-001-NK-709 - linkProtocol: - type: DOT1Q - vlanTag: 23 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DA - metroCode: DA - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-0348-348c-ace0-30fa5c00ad04 - type: XF_PORT - uuid: c4d93b39-0348-348c-ace0-30fa5c00ad09 - name: port-001-NK-710 - linkProtocol: - type: DOT1Q - vlanTag: 24 - COLO2COLO-Dot1q2Dot1q-withGeoScope-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/3656347c-4ed2-4d13-8907-f4238b8a057a - type: EVPL_VC - uuid: 3656347c-4ed2-4d13-8907-f4238b8a057a - name: My-Port-2-Port-Connection-1 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - changeLog: - createdBy: fabric_user - createdDateTime: 2026-04-11T19:42:50.774Z - updatedBy: fabric_user - updatedDateTime: 2026-04-11T19:42:50.774Z - bandwidth: 50 - geoScope: CONUS - redundancy: - group: 6e26930e-9fbb-449e-b9eb-cd98c97725er - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033b-33bc-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033b-33bc-ace0-30fa5c00ad01 - name: reg-001-CH2-JUN-698 - linkProtocol: - type: DOT1Q - vlanTag: 39 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033a-33ac-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033a-33ac-ace0-30fa5c00ad01 - name: reg-001-CH2-JUN-694 - linkProtocol: - type: DOT1Q - vlanTag: 40 - 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 - COLO2SPwithGeoScope-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/0bbd1d06-35df-47b7-b358-2f435cecb198 - type: EVPL_VC - uuid: 0bbd1d06-35df-47b7-b358-2f435cecb198 - name: My-Port-2-GenSP-Conn-1 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PENDING_APPROVAL - order: - billingTier: Up to 10 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - changeLog: - createdBy: fabric_user - createdDateTime: 2026-05-11T20:23:48.480Z - updatedBy: fabric_user - updatedDateTime: 2026-05-11T20:23:48.480Z - bandwidth: 10 - geoScope: CONUS - redundancy: - group: b19a678b-bcf7-428f-963b-55ea07eb1ef7 - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033a-83ac-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033a-83ac-ace0-30fa5c00ad01 - name: reg-001-JUN-691 - linkProtocol: - type: DOT1Q - vlanTag: 37 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - metroCode: DC - profile: - href: https://api.equinix.com/fabric/v4/serviceProfiles/5a76497a-ff00-4a89-a605-b0680799c6aa - type: L2_PROFILE - name: Fabric_L2_SP - uuid: 5a76497a-ff00-4a89-a605-b0680799c6aa - COLO2SPNonGenwithGeoScope-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/360a076f-0d2f-454c-b227-c5e6f48920ea - type: EVPL_VC - uuid: 360a076f-0d2f-454c-b227-c5e6f48920ea - name: My-Port-2-NonGenSP-Conn-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - billingTier: Up to 1G - termLength: 1 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - changeLog: - createdBy: fabric_user - createdDateTime: 2026-04-11T20:07:16.611Z - updatedBy: fabric_user - updatedDateTime: 2026-04-11T20:07:16.611Z - bandwidth: 1000 - geoScope: CONUS - redundancy: - group: 27d24507-3222-4654-9b97-ce16c8313b01 - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-0341-341c-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-0341-341c-ace0-30fa5c00ad01 - name: reg-001-JUN-703 - linkProtocol: - type: QINQ - vlanSTag: 23 - vlanCTag: 24 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - profile: - href: https://api.equinix.com/fabric/v4/serviceProfiles/bfb74121-7e2c-4f74-99b3-69cdafb03b41 - type: L2_PROFILE - name: Azure Express Route - uuid: bfb74121-7e2c-4f74-99b3-69cdafb03b12 - authenticationKey: xxxx-xxx-xxxx - COLO2COLO-MetroConnect-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 - type: MC_VC - uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 - name: metro-connect-P2P - bandwidth: 1000 - 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: UNTAGGED - location: - metroCode: ME - zSide: - accessPoint: - type: COLO - port: - href: https://api.equinix.com/fabric/v4/ports/20d32a80-0d61-4333-bc03-707b591ae2f4 - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - linkProtocol: - type: UNTAGGED - location: - metroCode: ME - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - changeLog: - createdDateTime: 2020-05-21T10:30:00Z - project: - projectId: 37c8212c-c393-465c-8267-09d28c49774c - COLO2AzureSP-Primary-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/5901c429-cd23-4149-b1cc-5f1b10cc5041 - type: EVPL_VC - uuid: 5901c429-cd23-4149-b1cc-5f1b10cc5041 - name: port2azure-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-129105284100 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabricuser - createdDateTime: 2026-03-10T02:26:31.546Z - updatedBy: fabricuser - updatedDateTime: 2026-03-10T02:26:31.546Z - bandwidth: 100 - redundancy: - group: ce76ec16-5857-4472-9067-2fa3d7a9f52q - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DA - metroCode: DA - port: - href: https://api.equinix.com/fabric/v4/ports/d966b9ce-79ed-4ea6-8f8a-785fd69f3dcb - type: XF_PORT - uuid: d966b9ce-79ed-4ea6-8f8a-785fd69f3dcb - name: 1-DA1-CX-PRI-012345 - linkProtocol: - type: DOT1Q - vlanTag: 123 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - metroCode: DC - profile: - href: https://api.equinix.com/fabric/v4/serviceProfiles/a1390b22-bbe0-4e93-ad37-85beef9d254a - type: L2_PROFILE - name: Azure ExpressRoute - uuid: a1390b22-bbe0-4e93-ad37-85beef9d254a - authenticationKey: xxxx-xxx-xxxx - COLO2LMaaSSP-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/8236fbb9-51e5-428f-86bf-6b67e1223ac1 - uuid: 8236fbb9-51e5-428f-86bf-6b67e1223ac1 - type: EVPL_VC - name: Last Mile Connection 1 - bandwidth: 10 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PENDING_APPROVAL - redundancy: - group: d4db1048-ef3d-f3d6-49e0-306a5c00a341 - priority: PRIMARY - order: - billingTier: Up to 10 MB - termLength: 1 - aSide: - accessPoint: - location: - metroCode: DC - port: - href: https://api.equinix.com/fabric/v4/ports/c4d9350e-780f-80fd-1ce0-306a5c00a600 - type: XF_PORT - uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 - name: Sample Port DC - linkProtocol: - type: QINQ - vlanSTag: 121 - vlanCTag: 145 - zSide: - accessPoint: - location: - metroCode: DC - profile: - href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 - uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 - type: LMAAS_PROFILE - name: Last Mile Service Profile 1 - productOffering: - id: sample-product-offering-id - name: Sample product offering 1 - billingTerm: 12 - bandwidthCommit: 50 - address: - id: lmaas-addr-sample-id - streetNr: "1234" - streetName: Main St - city: San Jose - stateOrProvince: CA - postCode: "95101" - country: United States - notifications: - - type: ALL - emails: - - someone@sample.com - - type: ORDERING - emails: - - someone@sample.com - phone: - - type: OFFICE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: MOBILE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: TECHNICAL - emails: - - someone@sample.com - phone: - - type: OFFICE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: MOBILE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - changeLog: - createdBy: sampleuser - createdByFullName: Sample User - createdByEmail: someone@sample.com - createdDateTime: 2026-01-01T00:00:00.000Z - updatedBy: sampleuser - updatedByFullName: Sample User - updatedByEmail: someone@sample.com - updatedDateTime: 2026-01-01T00:00:00.000Z - COLO2GoogleSPwithDot1q-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/f662d4c4-fcd8-40ba-b95b-64fc7e0a61fb - type: EVPL_VC - uuid: f662d4c4-fcd8-40ba-b95b-64fc7e0a61fb - name: My-Layer2-Connection-3 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: po1234 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-25T14:25:30.509Z - updatedBy: fabric - updatedDateTime: 2024-04-25T14:25:30.509Z - bandwidth: 50 - redundancy: - group: 2673c07d-9bd3-43c2-9827-91e940d01a54 - priority: PRIMARY - aSide: - accessPoint: - location: - metroCode: DA - port: - href: https://api.equinix.com/fabric/v4/ports/33353aa1-18f2-4b32-94d6-59a12500f7e2 - type: XF_PORT - 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: - href: https://api.equinix.com/fabric/v4/connections/2c7bb68e-f560-41ac-9950-e62c87be191e - type: EVPL_VC - uuid: 2c7bb68e-f560-41ac-9950-e62c87be191e - name: port2alibaba-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - billingTier: Up to 50 MB - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-05-02T20:07:38.626Z - updatedBy: fabric - updatedDateTime: 2024-05-02T20:07:38.626Z - bandwidth: 50 - redundancy: - group: 6aafb605-f3e4-4380-a9c0-1eddf829bca0 - priority: PRIMARY - aSide: - accessPoint: - location: - metroCode: SV - port: - href: https://api.equinix.com/fabric/v4/ports/b54d71a6-aecb-40cc-b458-8a4103f5cdba - type: XF_PORT - 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: - href: https://api.equinix.com/fabric/v4/connections/6c157170-f84d-424a-9396-b5d6ee723296 - type: EVPL_VC - uuid: 6c157170-f84d-424a-9396-b5d6ee723296 - name: vd2oracle-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-129105284100 - billingTier: Up to 1G - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-05-02T20:25:09.841Z - updatedBy: fabric - updatedDateTime: 2024-05-02T20:25:09.841Z - bandwidth: 1000 - redundancy: - group: e8400059-34e1-47f1-9914-cb5907ee7913 - priority: PRIMARY - aSide: - accessPoint: - location: - metroCode: SV - port: - href: https://api.equinix.com/fabric/v4/ports/b54d71a6-aecb-40cc-b458-8a4103f5cdba - type: XF_PORT - 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 - termLength: 1 - 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/e3bf3fa5-2b8f-4437-8171-688175240a1a - type: EVPL_VC - uuid: e3bf3fa5-2b8f-4437-8171-688175240a1a - name: vd2token-conn-1 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: po1234 - billingTier: Up to 10 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - changeLog: - createdBy: fabric_user - createdDateTime: 2026-04-11T20:49:02.630Z - updatedBy: fabric_user - updatedDateTime: 2026-04-11T20:49:02.630Z - bandwidth: 10 - redundancy: - group: 7c2b584c-f184-43ab-9626-52533a2cdb2a - priority: PRIMARY - aSide: - accessPoint: - interface: - uuid: 09918b27-0fb6-428e-a9c5-c26334e825ca - id: 10 - type: CLOUD - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - metroCode: DC - linkProtocol: - type: DOT1Q - vlanTag: 788 - virtualDevice: - uuid: 207667ba-3211-452c-b0a8-8b9046e122a1 - type: EDGE - zSide: - serviceToken: - href: https://api.equinix.com/fabric/v4/serviceTokens/557411a5-16a6-4aef-beea-7f622e94f1e1 - uuid: 557411a5-16a6-4aef-beea-7f622e94f1e1 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee965 - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DA - metroCode: DA - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-0348-348c-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-0348-348c-ace0-30fa5c00ad01 - name: reg-NK-710 - linkProtocol: - type: DOT1Q - vlanTag: 101 - 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 - termLength: 1 - 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 - linkProtocol: - type: DOT1Q - vlanTag: 1522 - 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-Dot1q-withGeoScope-response: - value: - href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f3e9-4f84-8c8f-1505b43df5e2 - uuid: 3a58dd05-f3e9-4f84-8c8f-1505b43df5e2 - type: EVPL_VC - name: My-VD-2-COLO-Connection-1 - state: ACTIVE - bandwidth: 1000 - order: - purchaseOrderNumber: po1234 - termLength: 1 - aSide: - accessPoint: - type: VD - virtualDevice: - uuid: a867f685-41b0-1b07-6de0-320a5c00abdd - name: my-virtual-device - interface: - type: NETWORK - id: 1 - location: - metroHref: https://api.equinix.com/fabric/v4/metros/FR - metroCode: FR - zSide: - accessPoint: - type: COLO - port: - uuid: b067f685-49b0-1a09-6fe0-360a5d00afd9 - name: my-port - linkProtocol: - type: DOT1Q - vlanTag: 1001 - location: - metroCode: AM - geoScope: EU - project: - projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 - notifications: - - type: ALL - emails: - - test@test.com - operation: - providerStatus: AVAILABLE - equinixStatus: PROVISIONED - changeLog: - createdDateTime: 2023-01-15T10:00:00Z - updatedDateTime: 2023-01-15T10:05:00Z - 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 - termLength: 1 - 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-27T16:25:37.229Z - aSide: - accessPoint: - virtualDevice: - type: EDGE - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 - interface: - uuid: 20d32a80-0d61-4333-bc03-707b591ae2f8 - 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 - termLength: 1 - 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 - termLength: 1 - 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 - 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 - 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: - purchaseOrderNumber: 1-129105284100 - billingTier: Up to 50 MB - termLength: 1 - 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 - 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 - termLength: 1 - 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 - createdDateTime: 2022-05-12T17:53:45.401Z - AsideServiceToken2PortResponseWithDot1q: - value: - href: https://api.equinix.com/fabric/v4/connections/e972bd9b-5726-4062-b046-7086fe9921ab - type: EVPL_VC - uuid: e972bd9b-5726-4062-b046-7086fe9921ab - name: token2port-conn-1 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - billingTier: Up to 10 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - changeLog: - createdBy: fabric_user - createdDateTime: 2026-05-11T21:03:02.631Z - updatedBy: fabric_user - updatedDateTime: 2026-05-11T21:03:02.631Z - bandwidth: 10 - redundancy: - group: 48852efe-f68a-4f0d-8449-36abd43a4afa - priority: PRIMARY - aSide: - serviceToken: - href: https://api.equinix.com/fabric/v4/serviceTokens/f10d177b-4afb-461a-bb23-b65b021af367 - type: VC_TOKEN - uuid: f10d177b-4afb-461a-bb23-b65b021af367 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee96a - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033f-33fc-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033f-33fc-ace0-30fa5c00ad01 - name: reg-JUN-701 - linkProtocol: - type: DOT1Q - vlanTag: 45 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033e-33ec-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033e-33ec-ace0-30fa5c00ad01 - name: reg-JUN-700 - linkProtocol: - type: DOT1Q - vlanTag: 34 - AsideServiceToken2PortResponseWithQinq: - value: - href: https://api.equinix.com/fabric/v4/connections/e972bd9b-5726-4062-b046-7086fe9921ab - type: EVPL_VC - uuid: e972bd9b-5726-4062-b046-7086fe9921ab - name: token2port-conn-1 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - billingTier: Up to 10 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric_user@equinix.com - changeLog: - createdBy: fabric_user - createdDateTime: 2026-05-11T21:03:02.631Z - updatedBy: fabric_user - updatedDateTime: 2026-05-11T21:03:02.631Z - bandwidth: 10 - redundancy: - group: 48852efe-f68a-4f0d-8449-36abd43a4afa - priority: PRIMARY - aSide: - serviceToken: - href: https://api.equinix.com/fabric/v4/serviceTokens/f10d177b-4afb-461a-bb23-b65b021af367 - type: VC_TOKEN - uuid: f10d177b-4afb-461a-bb23-b65b021af367 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee96a - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033f-33fc-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033f-33fc-ace0-30fa5c00ad01 - name: reg-JUN-701 - linkProtocol: - type: QINQ - vlanSTag: 45 - vlanCTag: 46 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-033e-33ec-ace0-30fa5c00ad01 - type: XF_PORT - uuid: c4d93b39-033e-33ec-ace0-30fa5c00ad01 - name: reg-JUN-700 - linkProtocol: - type: QINQ - vlanSTag: 34 - vlanCTag: 35 - 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 - redundancy: - group: 3cbd354d-d147-4552-bfd0-78c559b4cc91 - priority: PRIMARY - aSide: - accessPoint: - type: METAL_NETWORK - virtualNetwork: - href: https://api.equinix.com/metal/v1/virtual-networks/a867f685-41b0-1b07-6de0-320a5c00abd0 - uuid: a867f685-41b0-1b07-6de0-320a5c00abd0 - 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: - accountNumber: 123213 - notifications: - - type: ALL - emails: - - fabric@gmail.com - - fabric1@gmail.com - changeLog: - createdBy: fabric - createdDateTime: 2020-05-21T10:30:00Z - Metal2Sp-Azure-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/d3b69c6b-3b23-4ac0-a1bb-8db16460714d - type: EVPL_VC - 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 - createdDateTime: 2024-03-21T20:14:04.072Z - updatedBy: fabric - 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: - href: https://api.equinix.com/fabric/v4/connections/d3b69c6b-3b23-4ac0-a1bb-8db16460714d - type: EVPL_VC - 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 - createdDateTime: 2024-03-21T20:14:04.072Z - updatedBy: fabric - 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: - href: https://api.equinix.com/fabric/v4/connections/7a21d5d8-f153-45f8-ad76-f92babf3f103 - type: EVPL_VC - 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 - createdDateTime: 2024-03-19T23:09:15.547Z - updatedBy: fabric - 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: - href: https://api.equinix.com/fabric/v4/connections/f0e56501-d92f-4ca3-b047-f95628d4a32a - type: EVPL_VC - 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 - createdDateTime: 2024-03-06T17:20:41.574Z - updatedBy: fabric - 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: - href: https://api.equinix.com/fabric/v4/connections/02b7b7d4-1726-4451-9598-e28091c096cd - type: EVPL_VC - 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 - createdDateTime: 2024-03-20T00:39:07.648Z - updatedBy: fabric - 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: - href: https://api.equinix.com/fabric/v4/connections/d87489aa-c32d-4756-a81a-6f557afb871d - type: EVPL_VC - 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 - createdDateTime: 2024-03-21T23:44:22.347Z - updatedBy: fabric - 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: - href: https://api.equinix.com/fabric/v4/connections/f712745e-ccf9-4a0d-9e4d-83c1bb5b9028 - type: EVPL_VC - 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 - createdDateTime: 2024-03-20T20:12:08.595Z - updatedBy: fabric - 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: - href: https://api.equinix.com/fabric/v4/connections/1a9ffa8f-d4d4-44ab-9733-362c9a36ec94 - type: EVPL_VC - 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 - createdDateTime: 2024-03-22T00:42:35.386Z - updatedBy: fabric - 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 - COLO2NETWORKwithDot1q-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/f3dd7395-7196-45f4-9b6f-54094aa75f53 - type: EVPLAN_VC - 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: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-23T02:51:07.675Z - updatedBy: fabric - updatedDateTime: 2024-04-23T02:51:07.675Z - bandwidth: 50 - redundancy: - group: ecebee55-975b-4017-857c-74617f821b87 - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DA - metroCode: DA - port: - href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 - type: XF_PORT - 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 - COLO2NETWORKwithEPL-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/cce170c5-a496-4928-8426-507e00818887 - type: EPLAN_VC - 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: 1 - notifications: - - type: ALL - emails: - - fabric@test.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-23T03:07:17.587Z - updatedBy: fabric - updatedDateTime: 2024-04-23T03:07:17.587Z - bandwidth: 50 - redundancy: - group: dbab0e00-db97-4abf-aebe-76c7a40a371e - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SP - metroCode: SP - port: - href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 - type: XF_PORT - 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 - COLO2NETWORK_EVPTREE_withDot1q-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/f3dd7395-7196-45f4-9b6f-54094aa75f53 - type: EVPTREE_VC - uuid: f3dd7395-7196-45f4-9b6f-54094aa75f53 - name: colo2network-evptree-vc - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-129105284100 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-23T02:51:07.675Z - updatedBy: fabric - updatedDateTime: 2024-04-23T02:51:07.675Z - bandwidth: 50 - redundancy: - group: ecebee55-975b-4017-857c-74617f821b87 - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DA - metroCode: DA - port: - href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 - type: XF_PORT - 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: EVPTREE-GLOBAL - platformUuid: afe28606-8021-4161-802c-b80d4bc22f20 - state: ACTIVE - type: EVPTREE - scope: GLOBAL - role: LEAF - COLO2NETWORK_EPTREE_withEPL-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/cce170c5-a496-4928-8426-507e00818887 - type: EPTREE_VC - uuid: cce170c5-a496-4928-8426-507e00818887 - name: colo2network-eptree-vc - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-129105284100 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@test.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-23T03:07:17.587Z - updatedBy: fabric - updatedDateTime: 2024-04-23T03:07:17.587Z - bandwidth: 50 - redundancy: - group: dbab0e00-db97-4abf-aebe-76c7a40a371e - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SP - metroCode: SP - port: - href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 - type: XF_PORT - 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: EPTREE-GLOBAL - platformUuid: 47aedd04-64dc-4e86-8da3-f88a9755a214 - state: ACTIVE - type: EPTREE - scope: GLOBAL - role: LEAF - Vd2IAProfile-Response: - value: - href: https://uatapi.npclouda.equinix.com/fabric/v4/connections/ce42ca81-538d-4f38-b020-d45fb48d20c7 - type: IA_VC - uuid: ce42ca81-538d-4f38-b020-d45fb48d20c7 - name: vd2eia-connection-1 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-30T20:19:44.279Z - updatedBy: fabric - 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: - metroHref: https://api.equinix.com/fabric/v4/metros/SY - 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: - href: https://api.equinix.com/fabric/v4/connections/e1f165fd-29bb-4c15-8ec7-56242677e6fc - type: EVPLAN_VC - uuid: e1f165fd-29bb-4c15-8ec7-56242677e6fc - name: vd2network-connection - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-1234567890 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-23T02:12:20.334Z - updatedBy: fabric - 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: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - 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 - Vd2AwsSP-Response: - value: - href: https://api.equinix.com/fabric/v4/connections/f0a954e7-bdc5-4727-90cc-869f990e289f - type: EVPL_VC - uuid: f0a954e7-bdc5-4727-90cc-869f990e289f - name: vd2aws-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-1234567890 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-27T00:32:21.879Z - updatedBy: fabric - 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: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - 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: - href: https://api.equinix.com/fabric/v4/connections/3da14bba-d81c-4497-93c3-3f4a3cb0bc40 - type: EVPL_VC - uuid: 3da14bba-d81c-4497-93c3-3f4a3cb0bc40 - name: vd2azure-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-1234567890 - billingTier: Up to 200 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-25T20:30:24.632Z - updatedBy: fabric - 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: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - 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: - href: https://api.equinix.com/fabric/v4/connections/53c89f1a-0be7-44a1-9c03-28059632a72d - type: EVPL_VC - uuid: 53c89f1a-0be7-44a1-9c03-28059632a72d - name: vd2oracle-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-129105284100 - billingTier: Up to 1G - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-25T20:40:40.676Z - updatedBy: fabric - 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: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - 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: - href: https://api.equinix.com/fabric/v4/connections/66ed4e8a-584c-4027-9788-748fecb5ce35 - type: EVPL_VC - uuid: 66ed4e8a-584c-4027-9788-748fecb5ce35 - name: vd2alibaba-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: po1234 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinix.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-25T20:43:43.199Z - updatedBy: fabric - 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: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - 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: - href: https://api.equinix.com/fabric/v4/connections/50ae793c-b466-4d71-9724-c32b5e402bbe - type: EVPL_VC - uuid: 50ae793c-b466-4d71-9724-c32b5e402bbe - name: vd2googleSp-connection-1 - operation: - providerStatus: PROVISIONING - equinixStatus: PROVISIONING - order: - purchaseOrderNumber: 1-1234567890 - billingTier: Up to 50 MB - termLength: 1 - notifications: - - type: ALL - emails: - - fabric@equinx.com - changeLog: - createdBy: fabric - createdDateTime: 2024-04-25T14:06:48.933Z - updatedBy: fabric - 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: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - 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 - IXDedicatedPublicPeeringConnectionResponse: - value: - href: https://api.equinix.com/fabric/v4/connections/a8ba52de-faae-43b5-b0b1-6904d37ee011 - uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 - type: IX_VC - name: Virtual-Connection-1 - bandwidth: 1000 - operation: - providerStatus: NOT_AVAILABLE - equinixStatus: PROVISIONING - aSide: - accessPoint: - type: COLO - port: - href: https://api.equinix.com/fabric/v4/ports/99e83e59-fd26-4134-b1b3-4c5dea6924d6 - uuid: 99e83e59-fd26-4134-b1b3-4c5dea6924d6 - type: XF_PORT - name: A-IX-Port - linkProtocol: - type: DOT1Q - vlanTag: 99 - zSide: - accessPoint: - type: SP - profile: - href: https://api.equinix.com/fabric/v4/serviceProfiles/0f6bdb36-e130-4924-b038-ee1785fad166 - uuid: 0f6bdb36-e130-4924-b038-ee1785fad166 - type: IX_PROFILE - name: Equinix Internet Exchange Peering Profile - project: - projectId: 03ed2230-604a-494c-bca2-c042d38d80bc - notifications: - - type: ALL - emails: - - test@test.com - 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 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - - type: EVPL_VC - name: Conn-1 - order: - purchaseOrderNumber: 1-129105284100 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Vd2Colo-Redundant: - value: - data: - - type: EVPL_VC - name: Conn-1 - order: - purchaseOrderNumber: 1-129105284100 - termLength: 1 - 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 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - - type: EVPL_VC - name: Conn-1 - order: - purchaseOrderNumber: 1-129105284100 - termLength: 1 - 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 - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - notifications: - - type: ALL - emails: - - test@equinix.com - - test1@equinix.com - Vd2ServiceToken-Redundant: - value: - data: - - type: EVPL_VC - name: VD2ST-Conn-1 - bandwidth: 100 - order: - purchaseOrderNumber: po1234 - termLength: 1 - 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 - termLength: 1 - 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 - termLength: 1 - 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 - termLength: 1 - 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 - termLength: 1 - 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 - termLength: 1 - 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 - termLength: 1 - 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: 1829 - 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 - termLength: 1 - notifications: - - type: ALL - emails: - - test@equinix.com - changeLog: - createdBy: test - createdDateTime: 2023-03-01T22:57:15.874Z - updatedBy: test - 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: 1830 - 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 - createdDateTime: 2023-03-01T22:57:15.918Z - updatedBy: test - updatedDateTime: 2023-03-01T22:57:15.918Z - ConnectionBulkMigrationRequest: - value: - - op: replace - path: /aSide/accessPoint/port/uuid - value: c791f8cb-594a-94a0-8ce0-306a5c00a4ee - ConnectionBulkMigrationResponse: - value: - 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-02T07:17:41.663Z - updatedBy: testBuyer - updatedDateTime: 2021-12-02T07:17:41.663Z - change: - uuid: 2f395804-c197-4796-b7b3-359d5fa5d853 - type: CONNECTION_UPDATE - status: APPROVED - createdDateTime: 2021-12-06T22:11:18.616Z - 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: ACTIVE - 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 - ColoToColoWithMaintenanceResponseExample: - 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-ColoToColo-280122023234849 - state: ACTIVE - operation: - providerStatus: AVAILABLE - equinixStatus: PROVISIONED - maintenanceStatus: SCHEDULED - lockEnabled: true - order: - purchaseOrderNumber: PO754587184643 - notifications: - - type: ALL - emails: - - fake@mail.com - account: - accountNumber: 270001 - orgId: 91997 - globalOrgId: 0016u000003JZ4sAAG - changeLog: - createdBy: admin_user - createdDateTime: 2022-01-28T02:32:36.402Z - updatedBy: test_user - updatedDateTime: 2022-01-29T02: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 - type: XF_PORT - uuid: c791f8cb-5a41-a410-8ce0-306a5c00a4ee - name: testBuyer-DA1-L-Dot1q-STD-PRI-10G-NK-329 - linkProtocol: - type: DOT1Q - vlanTag: 1043 - zSide: - 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-5a49-a490-8ce0-306a5c00a4ee - type: XF_PORT - uuid: c791f8cb-5a49-a490-8ce0-306a5c00a4ee - name: testBuyer-DA1-L-Dot1q-STD-SEC-10G-NK-337 - linkProtocol: - type: DOT1Q - vlanTag: 3322 - LMaaSConnectionResponse: - value: - href: https://api.equinix.com/fabric/v4/connections/8236fbb9-51e5-428f-86bf-6b67e1223ac1 - uuid: 8236fbb9-51e5-428f-86bf-6b67e1223ac1 - type: EVPL_VC - name: Last Mile Connection 1 - state: ACTIVE - operation: - providerStatus: AVAILABLE - equinixStatus: PROVISIONED - order: - billingTier: Up to 10 MB - termLength: 1 - bandwidth: 10 - redundancy: - group: d4db1048-ef3d-f3d6-49e0-306a5c00a341 - priority: PRIMARY - isRemote: false - direction: INCOMING - account: - accountNumber: 201257 - orgId: 91955 - globalOrgId: "" - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - changeLog: - createdBy: sampleuser - createdDateTime: 2026-01-01T00:00:00.000Z - updatedBy: sampleuser - updatedDateTime: 2026-01-01T00:00:00.000Z - notifications: - - type: ALL - emails: - - someone@sample.com - - type: ORDERING - emails: - - someone@sample.com - phone: - - type: OFFICE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: MOBILE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: TECHNICAL - emails: - - someone@sample.com - phone: - - type: OFFICE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - - type: MOBILE - number: 11234567890 - contactPreference: - timezone: America/Los_Angeles - availability: ANYTIME - aSide: - accessPoint: - type: COLO - account: - accountNumber: 201257 - organizationName: Sample Organization - location: - region: AMER - metroName: Ashburn - metroCode: DC - ibx: DC11 - port: - href: https://api.equinix.com/fabric/v4/ports/c4d9350e-780f-80fd-1ce0-306a5c00a600 - uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 - name: Sample Port DC - redundancy: - priority: SECONDARY - linkProtocol: - type: QINQ - vlanSTag: 121 - vlanCTag: 145 - zSide: - accessPoint: - type: SP - account: - organizationName: Sample Provider Organization - location: - region: AMER - metroName: Ashburn - metroCode: DC - ibx: DC11 - profile: - href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 - type: LMAAS_PROFILE - name: Last Mile Service Profile 1 - uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 - productOffering: - id: sample-product-offering-id - name: Sample product offering 1 - billingTerm: 12 - bandwidthCommit: 50 - address: - id: lmaas-addr-sample-id - streetNr: "1234" - streetName: Main St - city: San Jose - stateOrProvince: CA - postCode: "95101" - country: United States - 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 - 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 - ConnectionUpdateTermLengthRequest: - value: - - op: replace - path: /order/termLength - value: 12 - 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 - ConnectionPriorityMigrationAsideVirtualDeviceRequest: - value: - - op: replace - path: /aSide/accessPoint/fabricEdgePriority - value: PRIMARY - 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 - ConnectionUpdateTermLengthResponse: - value: - href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 - type: EVPL_VC - uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 - name: dha_p2p_CH_1m - change: - uuid: 9b9f8a9b-4583-4649-9d91-a48494f822a7 - type: CONNECTION_UPDATE - createdDateTime: 2025-09-10T12:33:42.916Z - data: - op: replace - path: /order/termLength - value: 12 - operation: - providerStatus: AVAILABLE - equinixStatus: PROVISIONED - order: - billingTier: Up to 200 MB - termLength: 12 - notifications: - - type: ALL - emails: - - testuser@equinix.com - changeLog: - createdBy: testuser - createdDateTime: 2025-09-10T12:26:12.344Z - updatedBy: testuser - updatedDateTime: 2025-09-10T12:33:42.996Z - bandwidth: 200 - redundancy: - group: 561082c7-d979-4beb-9536-520cc5b9d0ac - priority: PRIMARY - aSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DC - metroCode: DC - port: - href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d - type: XF_PORT - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - name: gen-l2-qa-01-auto-DC5-NL-Dot1q-STD-PRI-1G-JUN-51 - linkProtocol: - type: DOT1Q - vlanTag: 1246 - zSide: - accessPoint: - location: - metroHref: https://api.equinix.com/fabric/v4/metros/CH - metroCode: CH - port: - href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d - type: XF_PORT - uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d - name: gen-l2-qa-01-auto-CH1-L-Dot1q-BO-PRI-10G-JUN-189 - linkProtocol: - type: DOT1Q - vlanTag: 1247 - 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 - Connection_Provider_Status_Update: - value: - type: CONNECTION_PROVIDER_STATUS_UPDATE_REQUEST - data: - operation: - providerStatus: QUOTING - 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 - ConnectionRoutesSearchByPrefix: - value: - filter: - and: - - property: /prefix - operator: = - values: - - 192.168.10.0/24 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - ConnectionRoutesSearchByNextHop: - value: - filter: - and: - - property: /nextHop - operator: = - values: - - 10.10.10.5 - 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 - CloudRouterAdvertisedRoutesSearchResponse: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - type: IPv4_BGP_ROUTE - protocolType: BGP - state: ACTIVE - prefix: 192.168.10.0/24 - nextHop: 10.10.10.5 - MED: 5 - asPath: - - "20001" - connection: - href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 - uuid: 81331c52-04c0-4656-a4a7-18c52669348f - name: connection_1 - changeLog: - createdBy: johnsmith - createdByFullName: John Smith - createdByEmail: john.smith@example.com - createdDateTime: 2020-11-06T07:00:00Z - updatedBy: johnsmith - updatedByFullName: John Smith - updatedByEmail: john.smith@example.com - updatedDateTime: 2020-11-06T07:00:00Z - deletedBy: johnsmith - deletedByFullName: John Smith - deletedByEmail: john.smith@example.com - deletedDateTime: 2020-11-06T07:00:00Z - CloudRouterReceivedRoutesSearchResponse: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - type: IPv4_BGP_ROUTE - protocolType: BGP - state: ACTIVE - prefix: 192.168.10.0/24 - nextHop: 10.10.10.5 - MED: 5 - asPath: - - "20001" - connection: - href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 - uuid: 81331c52-04c0-4656-a4a7-18c52669348f - name: connection_1 - changeLog: - createdBy: johnsmith - createdByFullName: John Smith - createdByEmail: john.smith@example.com - createdDateTime: 2020-11-06T07:00:00Z - updatedBy: johnsmith - updatedByFullName: John Smith - updatedByEmail: john.smith@example.com - updatedDateTime: 2020-11-06T07:00:00Z - deletedBy: johnsmith - deletedByFullName: John Smith - deletedByEmail: john.smith@example.com - deletedDateTime: 2020-11-06T07:00:00Z - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: - enabled: true - customerPeerIp: 10.1.1.2 - equinixPeerIp: 192.168.100.1 - bgpIpv6: - enabled: true - 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: - enabled: true - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: - enabled: true - customerPeerIp: 10.1.1.2 - equinixPeerIp: 192.168.100.1 - outboundASPrependCount: 3 - inboundMED: 1000 - outboundMED: 2000 - bgpIpv6: - enabled: true - customerPeerIp: 2001:db8:c59b::2 - equinixPeerIp: 2001:db8:c59b::1 - outboundASPrependCount: 3 - inboundMED: 1000 - outboundMED: 2000 - customerAsn: 0 - asOverrideEnabled: true - bgpAuthKey: string - bfd: - enabled: true - interval: "100" - CreateRoutingWithDirectAndBGP: - value: - data: - - type: BGP - bgpIpv4: - enabled: true - customerPeerIp: 192.168.100.2 - equinixPeerIp: 192.168.100.1 - outboundASPrependCount: 3 - inboundMED: 1000 - outboundMED: 2000 - bgpIpv6: - enabled: true - customerPeerIp: 2001:db8:c59b::2 - equinixPeerIp: 2001:db8:c59b::1 - outboundASPrependCount: 3 - inboundMED: 1000 - outboundMED: 2000 - customerAsn: 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: - enabled: true - customerPeerIp: 192.168.100.2 - equinixPeerIp: 192.168.100.1 - outboundASPrependCount: 3 - inboundMED: 1000 - outboundMED: 2000 - bgpIpv6: - enabled: true - customerPeerIp: 2001:db8:c59b::2 - equinixPeerIp: 2001:db8:c59b::1 - outboundASPrependCount: 3 - customerAsn: 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - updatedDateTime: 2021-10-30T07:21:39Z - deletedBy: fabric - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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: fabric - createdDateTime: 2021-10-30T07:21:39Z - updatedBy: fabric - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: 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 - createdDateTime: 2020-05-21T10:20:00Z - updatedBy: 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 - 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 - 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 - 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 - 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 - 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 - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: 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: - enabled: true - 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: - enabled: true - 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 - 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: - enabled: true - 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: - enabled: true - 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 - 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: - enabled: true - customerPeerIp: 10.1.1.3 - equinixPeerIp: 10.1.1.4 - operation: - operationalStatus: UP - opStatusChangedAt: 2021-10-30T07:21:39Z - bgpIpv6: - enabled: true - customerPeerIp: 2001:db8:c59b::1 - equinixPeerIp: 2001:db8:c59b::1 - operation: - operationalStatus: UP - opStatusChangedAt: 2021-10-30T07:21:39Z - customerAsn: 0 - bgpAuthKey: string - bfd: - enabled: true - interval: "100" - ExchangeServiceCreateRequest: - value: - type: IX - name: ix_exchange_service - publicPeeringConnection: - uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 - description: ix_exchange_service - routingProtocol: - customerAsn: 5555 - macAddress: 00:11:22:33:44:55 - bgpIpv4: - domainName: gw01.sin.example.net - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5KEY12345 - prefixes: - - 203.0.113.0/24 - bgpIpv6: - domainName: gw01.sin.example.net - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5KEY123456 - prefixes: - - 2001:DB8:123::/48 - order: - purchaseOrderNumber: 1-3456576 - notifications: - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - project: - projectId: e275485c-7072-439f-943a-c923548b2be5 - account: - accountNumber: 100179 - ExchangeServiceResponse: - value: - href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 - uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 - type: IX - name: ix_exchange_service - bandwidth: 400000 - description: ix_exchange_service - state: PROVISIONING - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - publicPeeringConnection: - type: IX_VC - href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 - uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 - routingProtocol: - customerAsn: 5555 - macAddress: 00:11:22:33:44:55 - vlan: 99 - routeServerAsn: 24115 - bgpIpv4: - customerPeerIp: 12.1.1.1 - domainName: gw01.sin.example.net - primaryRouteServerIp: 10.1.1.1 - secondaryRouteServerIp: 10.1.1.2 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key12345 - prefixes: - - 203.0.113.0/24 - maxPrefixLimit: 300 - prependSelfEnabled: true - bgpIpv6: - customerPeerIp: 2001:db8:c59b::22 - domainName: gw01.sin.example.net - primaryRouteServerIp: 2001:db8:c59b::33 - secondaryRouteServerIp: 2001:db8:c59b::322 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key123456 - prefixes: - - 2001:DB8:123::/48 - maxPrefixLimit: 300 - prependSelfEnabled: true - routeCollector: - asn: 1238 - ipV4: 10.255.255.254 - ipV6: 2001:db8:85a3::8a2e:370:7334\ - order: - purchaseOrderNumber: 1-3456576 - orderNumber: 1-139105284200 - project: - projectId: e275485c-7072-439f-943a-c923548b2be5 - account: - accountNumber: 100179 - notifications: - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - changelog: - createdBy: "12345" - createdDateTime: 2025-08-30T07:21:39Z - additionalInfo: - errorCode: EQ-3058039 - errorMessage: Unable to activate Exchange Service Port. Please verify your configuration or contact support. - ExchangeService_400: - value: - - errorCode: EQ-3067103 - errorMessage: Invalid request. Please verify the request payload. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - details: Invalid request. Please verify the request payload. - ExchangeService_401: - value: - - errorCode: EQ-3067106 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - ExchangeService_403: - value: - - errorCode: EQ-3067102 - errorMessage: Operation not allowed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - details: Operation not allowed for current user - ExchangeService_404: - value: - - errorCode: EQ-3067101 - errorMessage: Internet Exchange Service not found. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - details: Internet Exchange Service not found. - ExchangeService_500: - value: - - errorCode: EQ-3067104 - errorMessage: Internal Server Error - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - details: Internal Server Error - ExchangeServiceDeleteResponse: - value: - href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 - uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 - type: IX - name: ix_exchange_service - bandwidth: 400000 - description: ix_exchange_service - state: DEPROVISIONING - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - publicPeeringConnection: - type: IX_VC - href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 - uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 - routingProtocol: - customerAsn: 5555 - macAddress: 00:11:22:33:44:55 - vlan: 99 - routeServerAsn: 24115 - bgpIpv4: - customerPeerIp: 12.1.1.1 - domainName: gw01.sin.example.net - primaryRouteServerIp: 10.1.1.1 - secondaryRouteServerIp: 10.1.1.2 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key12345 - prefixes: - - 203.0.113.0/24 - maxPrefixLimit: 300 - prependSelfEnabled: true - bgpIpv6: - customerPeerIp: 2001:db8:c59b::22 - domainName: gw01.sin.example.net - primaryRouteServerIp: 2001:db8:c59b::33 - secondaryRouteServerIp: 2001:db8:c59b::322 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key123456 - prefixes: - - 2001:DB8:123::/48 - maxPrefixLimit: 300 - prependSelfEnabled: true - routeCollector: - asn: 1238 - ipV4: 10.255.255.254 - ipV6: 2001:db8:85a3::8a2e:370:7334 - order: - purchaseOrderNumber: 1-3456576 - orderNumber: 1-139105284200 - project: - projectId: e275485c-7072-439f-943a-c923548b2be5 - account: - accountNumber: 100179 - notifications: - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - changelog: - updatedBy: "12345" - updatedDateTime: 2025-08-30T07:21:39Z - ExchangeServicePatchMacAddressRequest: - value: - - op: replace - path: /routingProtocol/macAddress - value: 00:1A:2B:3C:4D:5E - ExchangeServicePatchCustomerAsnRequest: - value: - - op: replace - path: /routingProtocol/customerAsn - value: 1232 - ExchangeServicePatchRoutingProtocolIPv4PrefixesRequest: - value: - - op: replace - path: /routingProtocol/bgpIpv4/prefixes - value: - - 10.10.10.0/24 - - 10.10.20.0/24 - ExchangeServicePatchRoutingProtocolIPv6PrefixesRequest: - value: - - op: replace - path: /routingProtocol/bgpIpv6/prefixes - value: - - 2001:db8:10::/48 - - 2001:db8:20::/48 - ExchangeServicePatchResponse: - value: - href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 - uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 - type: IX - name: ix_exchange_service - bandwidth: 400000 - description: ix_exchange_service - state: REPROVISIONING - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - publicPeeringConnection: - type: IX_VC - href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 - uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 - routingProtocol: - customerAsn: 5555 - macAddress: 00:11:22:33:44:55 - vlan: 99 - routeServerAsn: 24115 - bgpIpv4: - customerPeerIp: 12.1.1.1 - domainName: gw01.sin.example.net - primaryRouteServerIp: 10.1.1.1 - secondaryRouteServerIp: 10.1.1.2 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key12345 - prefixes: - - 203.0.113.0/24 - maxPrefixLimit: 300 - prependSelfEnabled: true - bgpIpv6: - customerPeerIp: 2001:db8:c59b::22 - domainName: gw01.sin.example.net - primaryRouteServerIp: 2001:db8:c59b::33 - secondaryRouteServerIp: 2001:db8:c59b::322 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key123456 - prefixes: - - 2001:DB8:123::/48 - maxPrefixLimit: 300 - prependSelfEnabled: true - routeCollector: - asn: 1238 - ipV4: 10.255.255.254 - ipV6: 2001:db8:85a3::8a2e:370:7334 - order: - purchaseOrderNumber: 1-3456576 - orderNumber: 1-139105284200 - project: - projectId: e275485c-7072-439f-943a-c923548b2be5 - account: - accountNumber: 100179 - notifications: - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - changelog: - updatedBy: "12345" - updatedDateTime: 2025-08-30T07:21:39Z - ExchangeServiceSearchProjectId: - value: - filter: - and: - - property: /project/projectId - operator: = - values: - - 30ad25e2-53dc-11ed-bdc3-0242ac120002 - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchMultipleProjectIds: - value: - filter: - and: - - property: /project/projectId - operator: IN - values: - - 30ad25e2-53dc-11ed-bdc3-0242ac120002 - - 30ad25e2-53dc-11ed-bdc3-0242ac120003 - - 30ad25e2-53dc-11ed-bdc3-0242ac120004 - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchState: - value: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONING - pagination: - limit: 10 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchMultipleState: - value: - filter: - and: - - property: /state - operator: IN - values: - - PROVISIONING - - REPROVISIONING - pagination: - limit: 10 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchMetroCode: - value: - filter: - and: - - property: /location/metroCode - operator: = - values: - - SV - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchMultipleMetroCode: - value: - filter: - and: - - property: /location/metroCode - operator: IN - values: - - SV - - NY - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchBandwidth: - value: - filter: - and: - - property: /bandwidth - operator: = - values: - - "500" - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchMultipleBandwidth: - value: - filter: - and: - - property: /bandwidth - operator: IN - values: - - "500" - - "1000" - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ExchangeServiceSearchResponse: - value: - pagination: - offset: 0 - limit: 10 - total: 1 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - data: - - href: https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 - uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 - type: IX - name: ix_exchange_service - bandwidth: 400000 - description: ix_exchange_service - state: PROVISIONING - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - publicPeeringConnection: - type: IX_VC - href: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 - uuid: b44c6e6c-2c36-4488-b3f1-47064357b5b4 - routingProtocol: - customerAsn: 5555 - macAddress: 00:11:22:33:44:55 - vlan: 99 - routeServerAsn: 24115 - bgpIpv4: - customerPeerIp: 12.1.1.1 - domainName: gw01.sin.example.net - primaryRouteServerIp: 10.1.1.1 - secondaryRouteServerIp: 10.1.1.2 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key12345 - prefixes: - - 203.0.113.0/24 - maxPrefixLimit: 300 - prependSelfEnabled: true - bgpIpv6: - customerPeerIp: 2001:db8:c59b::22 - domainName: gw01.sin.example.net - primaryRouteServerIp: 2001:db8:c59b::33 - secondaryRouteServerIp: 2001:db8:c59b::322 - asSet: AS-EC-SV - mlpeEnabled: true - md5AuthKey: TESTMD5Key123456 - prefixes: - - 2001:DB8:123::/48 - maxPrefixLimit: 300 - prependSelfEnabled: true - routeCollector: - asn: 1238 - ipV4: 10.255.255.254 - ipV6: 2001:db8:85a3::8a2e:370:7334 - order: - purchaseOrderNumber: 1-3456576 - orderNumber: 1-139105284200 - project: - projectId: e275485c-7072-439f-943a-c923548b2be5 - account: - accountNumber: 100179 - notifications: - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - changelog: - updatedBy: "12345" - updatedDateTime: 2025-08-30T07:21:39Z - additionalInfo: - errorCode: EQ-3058039 - errorMessage: Unable to activate Exchange Service Port. Please verify your configuration or contact support. - EXCHANGE_SERVICE_ACTIVATE: - value: - type: EXCHANGE_SERVICE_ACTIVATE - EXCHANGE_SERVICE_VALIDATE: - value: - type: EXCHANGE_SERVICE_VALIDATE - EXCHANGE_SERVICE_RETRY_PROVISION: - value: - type: EXCHANGE_SERVICE_RETRY_PROVISION - ExchangeServiceActionResponse: - value: - href: https://api.equinix.com/fabric/v4/exchangeService/a8ba52de-faae-43b5-b0b1-6904d37ee011/actions/3a58dd05-f46d-4b1d-a154-2e85c396ea62 - type: EXCHANGE_SERVICE_ACTIVATE - uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 - state: SUCCEEDED - changelog: - createdDateTime: 2026-02-10T11:30:00Z - createdBy: Alice - InternetAccessCreate: - value: - type: SINGLE_IA - name: internet-access-primary - bandwidth: 1000 - routingProtocol: - type: BGP - exportPolicy: FULL - asn: - uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 - connections: - - uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 - customerRoutes: - - ipBlock: - uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - billing: - type: FIXED - project: - projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 - account: - accountNumber: "57689234" - order: - purchaseOrderNumber: PO-98765 - InternetAccessServiceAcceptedResponseExample: - value: - href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 - type: SINGLE_IA - uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 - name: internet-access-primary - state: PROVISIONING - change: - href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents - routingProtocol: - type: BGP - exportPolicy: FULL - asn: - href: https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1 - uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 - customerRoutes: - - ipBlock: - href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - connections: - - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 - uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 - billing: - type: FIXED - enabled: true - startDate: 2026-04-16T00:00:00Z - account: - accountNumber: "57689234" - href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 - project: - projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 - order: - href: https://api.equinix.com/colocations/v2/orders/100200300 - orderNumber: 100200300 - purchaseOrderNumber: PO-98765 - changeLog: - createdBy: api-user - createdDateTime: 2026-04-16T00:00:00Z - updatedBy: api-user - updatedDateTime: 2026-04-16T00:00:01Z - useCase: MAIN - InternetAccessSearchByProject: - value: - filter: - and: - - property: /project/projectId - operator: = - values: - - 44f4c4f8-2f39-494e-838c-d8e640591be5 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/updatedDateTime - InternetAccessServicesRetrievedResponseExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - sort: - - direction: DESC - property: /changeLog/updatedDateTime - data: - - href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 - type: SINGLE_IA - uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 - name: internet-access-primary - state: PROVISIONED - change: - href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents - routingProtocol: - type: BGP - customerRoutes: - - ipBlock: - href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - connections: - - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 - uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 - billing: - type: FIXED - account: - accountNumber: "57689234" - project: - projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 - order: - purchaseOrderNumber: PO-98765 - changeLog: - createdDateTime: 2026-04-16T00:00:00Z - useCase: MAIN - InternetAccessServiceRetrievedResponseExample: - value: - href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4 - type: SINGLE_IA - uuid: 673c6e6c-2c36-4488-b3f1-47064357b5b4 - name: internet-access-primary - state: PROVISIONED - bandwidth: 1000 - bandwidthCommit: 500 - change: - href: https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents - locations: - - metroHref: https://api.equinix.com/fabric/v4/metros/WA - metroCode: WA - region: AMER - ibx: WA1 - routingProtocol: - type: BGP - exportPolicy: FULL - asn: - href: https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1 - uuid: 5dd81532-c313-35ba-8a0f-be05fb275fa1 - customerRoutes: - - ipBlock: - href: https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - connections: - - href: https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 - uuid: 6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671 - billing: - type: FIXED - enabled: true - startDate: 2026-04-16T00:00:00Z - account: - accountNumber: "57689234" - href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234 - project: - projectId: 44f4c4f8-2f39-494e-838c-d8e640591be5 - order: - href: https://api.equinix.com/colocations/v2/orders/100200300 - orderNumber: 100200300 - purchaseOrderNumber: PO-98765 - changeLog: - createdBy: api-user - createdDateTime: 2026-04-16T00:00:00Z - updatedBy: api-user - updatedDateTime: 2026-04-16T00:10:00Z - useCase: MAIN - InternetAccessPatchManageCustomerRoutes: - value: - - op: add - path: /routingProtocol/customerRoutes - value: - ipBlock: - uuid: fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92 - - op: remove - path: /routingProtocol/customerRoutes[@.ipBlock.uuid=ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91] - InternetAccessPatchUpdateServiceBandwidth: - value: - - op: replace - path: /bandwidth - value: 50 - - op: replace - path: /order/purchaseOrderNumber - value: PO-98765 - InternetAccessPatchUpdateName: - value: - - op: replace - path: /name - value: New Name - InterconnectCreate: - value: - type: XF_IC - name: test ic sv - description: test interconnect - location: - metroCode: SV - package: - type: IC_PACKAGE - code: BASIC - order: - termLength: 1 - account: - accountNumber: 456789 - project: - projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 - notifications: - - type: NOTIFICATIONS - emails: - - abc@test.com - InterconnectResponse: - value: - href: https://api.equinix.com/fabric/v4/interconnects/34085b91-2ea3-4578-bc1f-bbd526b57885 - uuid: 34085b91-2ea3-4578-bc1f-bbd526b57885 - type: XF_IC - name: test ic sv - description: test interconnect - state: PROVISIONING - location: - href: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - usedBandwidth: 0 - package: - href: https://api.equinix.com/fabric/v4/interconnectPackages/BASIC - type: IC_PACKAGE - code: BASIC - router: - href: https://api.equinix.com/fabric/v4/routers/24884a4e-bb47-403a-9426-a1b766305226 - type: IC_ROUTER - uuid: 24884a4e-bb47-403a-9426-a1b766305226 - order: - termLength: 1 - account: - accountNumber: 456789 - project: - projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 - notifications: - - type: NOTIFICATIONS - emails: - - test@test.com - - abc@test.com - changeLog: - createdBy: "1111" - createdDateTime: 2026-01-15T08:00:00Z - InterconnectDeleteResponse: - value: - href: https://api.equinix.com/fabric/v4/interconnects/34085b91-2ea3-4578-bc1f-bbd526b57885 - uuid: 34085b91-2ea3-4578-bc1f-bbd526b57885 - type: XF_IC - name: test ic sv - description: test interconnect - state: DEPROVISIONED - location: - href: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - usedBandwidth: 0 - package: - href: https://api.equinix.com/fabric/v4/interconnectPackages/BASIC - type: IC_PACKAGE - code: BASIC - router: - href: https://api.equinix.com/fabric/v4/routers/24884a4e-bb47-403a-9426-a1b766305226 - type: IC_ROUTER - uuid: 24884a4e-bb47-403a-9426-a1b766305226 - order: - termLength: 1 - account: - accountNumber: 456789 - project: - projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 - changeLog: - createdBy: johnsmith - createdDateTime: 2026-01-15T08:00:00Z - updatedBy: johnsmith - updatedDateTime: 2026-07-24T10:30:00Z - deletedBy: johndoe - deletedDateTime: 2026-07-24T10:30:00Z - InterconnectSearchRequest: - value: - filter: - and: - - property: /project/projectId - operator: IN - values: - - ae708bbb-d669-406a-845a-99b39ff65fd0 - - property: /state - operator: IN - values: - - PROVISIONED - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - InterconnectSearchResponse: - value: - pagination: - total: 1 - offset: 0 - limit: 20 - sort: - - property: /changeLog/createdDateTime - direction: DESC - data: - - href: https://api.equinix.com/fabric/v4/interconnects/34085b91-2ea3-4578-bc1f-bbd526b57885 - uuid: 34085b91-2ea3-4578-bc1f-bbd526b57885 - type: XF_IC - state: PROVISIONED - description: test interconnect - location: - href: https://api.equinix.com/fabric/v4/metros/SV - metroCode: SV - usedBandwidth: 2000 - package: - href: https://api.equinix.com/fabric/v4/interconnectPackages/BASIC - type: IC_PACKAGE - code: BASIC - router: - href: https://api.equinix.com/fabric/v4/routers/24884a4e-bb47-403a-9426-a1b766305226 - uuid: 24884a4e-bb47-403a-9426-a1b766305226 - type: IC_ROUTER - order: - termLength: 1 - account: - accountNumber: 456789 - project: - projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 - notifications: - - type: NOTIFICATIONS - emails: - - test@test.com - changeLog: - createdBy: johnsmith - createdDateTime: 2026-01-15T08:00:00Z - interconnect-packages: - value: - data: - - href: https://api.equinix.com/fabric/v4/interconnectPackages/b3ceae25-fc42-4857-9aa8-bd72e0d063df - type: IC_PACKAGE - uuid: b3ceae25-fc42-4857-9aa8-bd72e0d063df - code: BASIC - description: string - routesMax: 1000 - bandwidthMax: 100000 - isRemote: true - state: ACTIVE - - href: https://api.equinix.com/fabric/v4/interconnectPackages/d89066ca-7861-457c-9dc1-63f131af4179 - type: IC_PACKAGE - uuid: d89066ca-7861-457c-9dc1-63f131af4179 - code: STANDARD - description: string - routesMax: 2000 - bandwidthMax: 200000 - isRemote: true - state: ACTIVE - - href: https://api.equinix.com/fabric/v4/interconnectPackages/ca1551cd-0364-4508-a969-6631c4bf9ea7 - type: IC_PACKAGE - uuid: ca1551cd-0364-4508-a969-6631c4bf9ea7 - code: PREMIUM - description: string - routesMax: 3000 - bandwidthMax: 400000 - isRemote: true - state: ACTIVE - IpBlockCreateEquinixApacRequest: - value: - prefixLength: 24 - location: - metroCode: SY - project: - projectId: 52cb19be-63c4-434d-bec8-5e94636291fc - type: IPV4_IP_BLOCK - regulations: - addressingPlans: - - purpose: SERVERS - size: 100 - - purpose: ROUTERS - size: 154 - questions: - privateSpaceConsidered: true - refusedPreviously: true - returningAddressSpace: false - account: - accountNumber: 2-57689234 - order: - purchaseOrderNumber: purchase-order123 - IpBlockCreateCustomerOwnedRequest: - value: - prefix: 128.112.4.0/24 - type: IPV4_IP_BLOCK - project: - projectId: 52cb19be-63c4-434d-bec8-5e94636291fc - IpBlockEquinixOwnershipAcceptedResponse: - value: - href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb - uuid: 31fbdb3f-8def-410d-868b-ef920878affb - state: PENDING - ownership: EQUINIX - location: - metroHref: https://api.equinix.com/fabric/v4/metros/WA - metroCode: SY - prefixLength: 24 - type: IPV4_IP_BLOCK - change: - href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents - order: - href: https://api.equinix.com/colocations/v2/orders/1-34834234 - orderNumber: 1-34834234 - account: - href: https://api.equinix.com/billing/v2/billingAccounts/accountNumber/2-57689234 - accountNumber: 2-57689234 - project: - href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc - projectId: 03ed2230-604a-494c-bca2-c042d38d80bc - regulations: - addressingPlans: - - purpose: SERVERS - size: 100 - - purpose: ROUTERS - size: 154 - questions: - privateSpaceConsidered: true - refusedPreviously: true - returningAddressSpace: false - changeLog: - createdDateTime: 2025-12-01T12:11:22.222351Z - assets: [] - IpBlockCustomerOwnershipAcceptedResponse: - value: - href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb - uuid: 31fbdb3f-8def-410d-868b-ef920878affb - state: ACTIVE - ownership: CUSTOMER - prefixLength: 24 - prefix: 128.112.4.0/24 - type: IPV4_IP_BLOCK - change: - href: https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents - project: - href: https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc - projectId: 03ed2230-604a-494c-bca2-c042d38d80bc - changeLog: - createdDateTime: 2025-12-01T12:11:22.222351Z - assets: [] - ConnectionSearchDirection: - value: - filter: - and: - - property: /direction - operator: = - values: - - OUTGOING - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ConnectionSearchIsremote: - value: - filter: - and: - - property: /isRemote - operator: = - values: - - "true" - pagination: - limit: 25 - offset: 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 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - ConnectionSearchCustorg: - value: - filter: - and: - - property: /account/orgId - operator: = - values: - - "91997" - pagination: - limit: 25 - offset: 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 - 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: - 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: - 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: - 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: - limit: 25 - offset: 0 - ConnectionSearchAsideaccesspointtype: - value: - filter: - and: - - property: /aSide/accessPoint/type - operator: = - values: - - COLO - sort: - - direction: DESC - property: /changeLog/updatedDateTime - pagination: - 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: - 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: - 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: - limit: 25 - offset: 0 - ConnectionSearchChangestatus: - value: - filter: - and: - - property: /change/status - operator: = - values: - - APPROVED - pagination: - limit: 25 - offset: 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: - limit: 25 - offset: 0 - ConnectionSearchEquinixstatus: - value: - filter: - and: - - property: /operation/equinixStatus - operator: = - values: - - PROVISIONED - sort: - - direction: DESC - property: /changeLog/updatedDateTime - pagination: - limit: 25 - offset: 0 - ConnectionSearchProviderstatus: - value: - filter: - and: - - property: /operation/providerStatus - operator: = - values: - - AVAILABLE - sort: - - direction: DESC - property: /changeLog/updatedDateTime - pagination: - limit: 25 - offset: 0 - ConnectionSearchProjectidOPtional-CRH: - value: - filter: - and: - - property: /project/projectId - operator: = - values: - - 30ad25e2-53dc-11ed-bdc3-0242ac120002 - pagination: - limit: 25 - offset: 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: - limit: 25 - offset: 0 - ConnectionSearchRedundancypriority: - value: - filter: - and: - - operator: = - property: /redundancy/priority - values: - - PRIMARY - sort: - - direction: DESC - property: /changeLog/updatedDateTime - pagination: - 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: - 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: - 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: - 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: - limit: 25 - offset: 0 - ConnectionSearchZsideaccesspointtype: - value: - filter: - and: - - property: /zSide/accessPoint/type - operator: = - values: - - COLO - sort: - - direction: DESC - property: /changeLog/updatedDateTime - pagination: - 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: - 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: - 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: - 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: - 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: - 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 - ConnectionSearchByMaintenanceStatus: - value: - filter: - and: - - property: /operation/maintenanceStatus - operator: IN - values: - - SCHEDULED - - COMPLETED - - property: /operation/lockEnabled - operator: IN - values: - - "true" - 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" - VirtualConnectionProductColoToColoWithGeoScope: - 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 - - property: /connection/geoScope - operator: = - values: - - CONUS - 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" - VirtualPortProductUPP: - 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/package/code - operator: = - values: - - UNLIMITED_PLUS - - property: /port/serviceType - operator: = - values: - - EPL - - property: /port/connectivitySource/type - operator: = - values: - - COLO - - property: /port/lag/enabled - operator: = - values: - - "false" - VirtualPortProductIX: - value: - filter: - and: - - property: /type - operator: = - values: - - VIRTUAL_PORT_PRODUCT - - property: /port/location/ibx - operator: = - values: - - DA1 - - property: /port/type - operator: = - values: - - XF_PORT - - property: /port/bandwidth - operator: = - values: - - "1000" - - property: /port/serviceCode - operator: = - values: - - IX - - property: /port/connectivitySource/type - operator: = - values: - - COLO - 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 - OpticalConnectProduct: - value: - filter: - and: - - property: /type - operator: = - values: - - OPTICAL_CONNECT_PRODUCT - - property: /account/accountNumber - operator: = - values: - - "200551" - - property: /opticalConnect/type - operator: = - values: - - OC - - property: /opticalConnect/bandwidth - operator: = - values: - - "1000" - - property: /opticalConnect/pathType - operator: = - values: - - PROTECTED - - property: /opticalConnect/connectionDestinationType - operator: = - values: - - COLO - - property: /opticalConnect/aSide/location/ibxCode - operator: = - values: - - CH1 - - property: /opticalConnect/zSide/location/ibxCode - 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 - VirtualPortUPP: - 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 - package: - code: UNLIMITED_PLUS - VirtualPortIX: - value: - pagination: - offset: 0 - limit: 1 - total: 1 - data: - - type: VIRTUAL_PORT_PRODUCT - code: IX00008.PROD - name: Equinix Internet Exchange Port Product - description: Internet Exchange 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 - serviceCode: IX - 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 - OpticalConnect: - value: - pagination: - offset: 0 - limit: 1 - total: 1 - data: - - type: OPTICAL_CONNECT_PRODUCT - code: MC00007.PROD - name: Optical Connect Port Product - description: Optical Connect Port - account: - accountNumber: 200551 - orgId: 123 - charges: - - type: MONTHLY_RECURRING - price: 500 - - type: NON_RECURRING - price: 0 - currency: USD - opticalConnect: - type: OC - bandwidth: 1000 - pathType: PROTECTED - connectionDestinationType: COLO - aSide: - location: - ibxCode: CH1 - zSide: - location: - ibxCode: 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: http://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 - selectiveRedundancy: 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 - selectiveRedundancy: 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 - selectiveRedundancy: 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 - selectiveRedundancy: 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 - LmaasServiceProfileCreate: - value: - name: Last Mile Service Profile 1 - description: Sample Last Mile Service Profile - type: LMAAS_PROFILE - notifications: - - emails: - - someone@sample.com - type: QUOTE_NOTIFICATIONS - tags: [] - visibility: PUBLIC - customFields: [] - allowedEmails: [] - ports: - - type: XF_PORT - uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 - location: - metroCode: DC - crossConnectId: ECX.03.00000962 - lastMileConfig: - productCatalogs: - - id: sample-product-offering-id - name: Sample Product Offering - webUrl: https://www.example.com/lastmile - deliveryDate: - min: 10 - max: 30 - unit: DAYS - billingTerms: - - 1 - - 12 - - 24 - - 36 - - 48 - - 60 - offerings: - - bandwidth: 50 - price: - unit: USD - min: 100 - max: 500 - - bandwidth: 100 - price: - unit: USD - min: 200 - max: 500 - - bandwidth: 200 - price: - unit: USD - min: 300 - max: 500 - - bandwidth: 1000 - price: - unit: USD - min: 1000 - max: 2000 - accessPointTypeConfigs: - - type: COLO - linkProtocolConfig: - namedTags: [] - reuseVlanSTag: false - enableAutoGenerateServiceKey: false - apiConfig: - equinixManagedPort: false - equinixManagedVlan: false - allowOverSubscription: false - overSubscriptionLimit: 1 - apiAvailable: false - integrationId: "" - bandwidthFromApi: false - authenticationKey: - required: false - allowRemoteConnections: true - supportedBandwidths: - - 10 - - 50 - - 200 - - 500 - - 1000 - allowCustomBandwidth: false - connectionLabel: Connection - allowBandwidthAutoApproval: false - connectionRedundancyRequired: false - selectiveRedundancy: true - marketingInfo: - processSteps: [] - promotion: true - 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 - selectiveRedundancy: 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 - LmaasServiceProfileCreateResponse: - value: - href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 - uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 - name: Last Mile Service Profile 1 - description: Sample Last Mile Service Profile - type: LMAAS_PROFILE - notifications: - - emails: - - someone@sample.com - type: QUOTE_NOTIFICATIONS - tags: [] - visibility: PUBLIC - customFields: [] - allowedEmails: [] - ports: - - type: XF_PORT - uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 - location: - metroCode: DC - crossConnectId: ECX.03.00000962 - lastMileConfig: - apiIntegration: - siteValidationEnabled: false - dataCenterLocationEnabled: false - productOfferingEnabled: false - poqEnabled: false - quoteEnabled: false - placeOrderEnabled: false - quoteViaAggregatorEnabled: false - productCatalogs: - - id: sample-product-offering-id - name: Sample Product Offering - webUrl: https://www.example.com/lastmile - deliveryDate: - min: 10 - max: 30 - unit: DAYS - billingTerms: - - 1 - - 12 - - 24 - - 36 - - 48 - - 60 - offerings: - - bandwidth: 50 - price: - unit: USD - min: 100 - max: 500 - - bandwidth: 100 - price: - unit: USD - min: 200 - max: 500 - - bandwidth: 200 - price: - unit: USD - min: 300 - max: 500 - - bandwidth: 1000 - price: - unit: USD - min: 1000 - max: 2000 - accessPointTypeConfigs: - - type: COLO - linkProtocolConfig: - namedTags: [] - reuseVlanSTag: false - enableAutoGenerateServiceKey: false - apiConfig: - equinixManagedPort: false - equinixManagedVlan: false - allowOverSubscription: false - overSubscriptionLimit: 1 - apiAvailable: false - integrationId: "" - bandwidthFromApi: false - authenticationKey: - required: false - allowRemoteConnections: true - supportedBandwidths: - - 10 - - 50 - - 200 - - 500 - - 1000 - allowCustomBandwidth: false - connectionLabel: Connection - allowBandwidthAutoApproval: false - connectionRedundancyRequired: false - selectiveRedundancy: true - marketingInfo: - processSteps: [] - promotion: true - 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 - ServiceProfileSearchWithTypeAndMetro: - value: - filter: - and: - - property: /type - operator: = - values: - - L2_PROFILE - - property: /metros/code - operator: = - values: - - SG - 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 - selectiveRedundancy: 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 - selectiveRedundancy: 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 - LmaasServiceProfileResponse: - value: - state: ACTIVE - account: - orgId: 90925 - organizationName: Sample Organization - globalOrgId: 0017i000011X23ZAAS - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-1234567abcde - changeLog: - createdBy: sampleuser - createdByFullName: Sample User - createdByEmail: someone@sample.com - createdDateTime: 2026-01-01T00:00:00.000Z - updatedBy: sampleuser - updatedByFullName: Sample User - updatedByEmail: someone@sample.com - updatedDateTime: 2026-01-01T00:00:00.000Z - href: https://api.equinix.com/fabric/v4/serviceProfiles/e36b0f9b-6080-4909-90a7-d5e3623d00d1 - uuid: e36b0f9b-6080-4909-90a7-d5e3623d00d1 - type: LMAAS_PROFILE - name: Last Mile Service Profile 1 - description:

Sample Last Mile Service Profile

- notifications: - - type: QUOTE_NOTIFICATIONS - emails: - - someone@sample.com - visibility: PUBLIC - customFields: - - label: Account Id - description: Provider Portal User ID - required: true - dataType: NUMBER - captureInEmail: false - ports: - - type: XF_PORT - uuid: c4d9350e-780f-80fd-1ce0-306a5c00a600 - location: - metroCode: DC - crossConnectId: ECX.03.00000962 - metros: - - code: DC - name: Ashburn - ibxs: - - DC6 - - DC5 - displayName: Ashburn - accessPointTypeConfigs: - - uuid: d2d8105b-da0c-4b09-92d7-2584a85cbb33 - type: COLO - supportedBandwidths: - - 10 - - 50 - - 200 - - 500 - - 1000 - allowRemoteConnections: true - allowCustomBandwidth: false - allowBandwidthAutoApproval: false - linkProtocolConfig: - reuseVlanSTag: false - encapsulation: DOT1Q - enableAutoGenerateServiceKey: false - connectionRedundancyRequired: false - selectiveRedundancy: true - apiConfig: - apiAvailable: false - integrationId: "" - equinixManagedPort: false - equinixManagedVlan: false - allowOverSubscription: false - overSubscriptionLimit: 1 - bandwidthFromApi: false - connectionLabel: Connection - authenticationKey: - required: false - marketingInfo: - promotion: true - lastMileConfig: - apiIntegration: - siteValidationEnabled: false - dataCenterLocationEnabled: false - productOfferingEnabled: false - poqEnabled: false - quoteEnabled: false - placeOrderEnabled: false - quoteViaAggregatorEnabled: false - productCatalogs: - - id: Sample-product-offering-id - name: Sample Product Offering - webUrl: https://www.example.com/lastmile - deliveryDate: - unit: DAYS - min: 10 - max: 90 - billingTerms: - - 1 - - 12 - - 24 - - 36 - - 48 - - 60 - offerings: - - bandwidth: 50 - price: - unit: USD - min: 100 - max: 500 - - bandwidth: 100 - price: - unit: USD - min: 200 - max: 500 - - bandwidth: 500 - price: - unit: USD - min: 500 - max: 1000 - - bandwidth: 1000 - price: - unit: USD - min: 1000 - max: 2000 - 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 - selectiveRedundancy: 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 - selectiveRedundancy: 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 - selectiveRedundancy: 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 - ServiceProfilePatchRequestForVisibility: - value: - - op: replace - path: /visibility - value: PUBLIC - 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 - selectiveRedundancy: 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 - ServiceProfilePatchResponseForVisibility: - value: - state: ACTIVE - account: - orgId: 91785 - organizationName: testSeller-270010 - globalOrgId: 0016u000003JZ4tAAG - change: - type: PROFILE_UPDATE_ACCEPTANCE - uuid: 9b9f8a9b-4583-4649-9d91-a48494f822a7 - createdDateTime: 2026-02-17T17:23:35.543Z - 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: PRIVATE - 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 - selectiveRedundancy: 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 - ServiceProfileActionRequest: - value: - type: PROFILE_UPDATE_ACCEPTANCE - description: Approved to migrate to public - ServiceProfileActionRejectionRequest: - value: - type: PROFILE_UPDATE_REJECTION - description: Rejected the migration to public - ServiceProfileActionResponse: - value: - href: https://api.equinix.com/fabric/v4/serviceProfiles/f30a9de3-c79e-443e-b65d-0a0692c6f3e0/actions/ac2a3233-23d9-423c-b375-0e78717bd348 - type: PROFILE_UPDATE_ACCEPTANCE - uuid: ac2a3233-23d9-423c-b375-0e78717bd348 - comments: Approved to migrate to public - changeLog: - createdBy: adminuser - createdDateTime: 2026-03-04T10:30:00Z - updatedBy: adminuser - updatedDateTime: 2026-03-04T10:35:00Z - ServiceProfileEnvironmentsResponse: - value: - data: - - href: https://api.equinix.com/fabric/v4/serviceProfiles/23ad37d0-6b1c-4d1f-a4eb-9f3d68fbe4fd/environments/6ad498b5-d929-44ac-a199-ce9f0d31d9ac - uuid: 6ad498b5-d929-44ac-a199-ce9f0d31d9ac - type: IC_ENV - name: US West 1 – Production - description: Primary production environment - sellerRegion: us-west-1 - metros: - - code: CH - name: Chicago - displayName: Chicago - - code: DC - name: Ashburn - displayName: Ashburn - supportedBandwidths: - - 1000 - - 10000 - - 100000 - - href: https://api.equinix.com/fabric/v4/serviceProfiles/23ad37d0-6b1c-4d1f-a4eb-9f3d68fbe4fd/environments/1ad498b5-d929-44ac-a199-ce9f0d31d9ab - uuid: 1ad498b5-d929-44ac-a199-ce9f0d31d9ab - type: IC_ENV - name: US East 1 – Production - description: Primary production environment - sellerRegion: us-east-1 - metros: - - code: DC - name: Ashburn - displayName: Ashburn - supportedBandwidths: - - 1000 - - 10000 - - 100000 - pagination: - offset: 0 - limit: 2 - total: 2 - getServiceToken: - value: - href: http://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: http://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: http://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 - expirationDateTime: 2020-05-31T10:30:00Z - connection: - type: EVPL_VC - bandwidthLimit: 100 - allowRemoteConnection: false - allowCustomBandwidth: false - aSide: - accessPointSelectors: - - type: COLO - port: - href: http://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: http://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: http://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 - vni: 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 - vni: 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 - createZsideServiceTokenWithNetworkEvplan: - 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 - createZsideServiceTokenWithNetworkEplan: - value: - type: VC_TOKEN - name: zside_Network_token - description: Zside_Network_token - connection: - type: EPLAN_VC - allowRemoteConnection: true - supportedBandwidths: - - 10 - - 50 - - 200 - zSide: - accessPointSelectors: - - type: NETWORK - network: - type: EPLAN - 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 - createZsideServiceTokenWithNetworkEvptree: - value: - type: VC_TOKEN - name: zside_Network_token - description: Zside_Network_token - connection: - type: EVPTREE_VC - allowRemoteConnection: true - supportedBandwidths: - - 10 - - 50 - - 200 - zSide: - accessPointSelectors: - - type: NETWORK - network: - type: EVPTREE - 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 - createZsideServiceTokenWithNetworkEptree: - value: - type: VC_TOKEN - name: zside_Network_token - description: Zside_Network_token - connection: - type: EPTREE_VC - allowRemoteConnection: true - supportedBandwidths: - - 10 - - 50 - - 200 - zSide: - accessPointSelectors: - - type: NETWORK - network: - type: EPTREE - 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: http://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 - createZsideServiceTokenWithNetworkEvplan-Response: - value: - href: https://api.equinix.com/fabric/v4/serviceTokens/7cf92aa3-18b8-435c-b3fc-55e45b1ce964 - type: VC_TOKEN - uuid: 7cf92aa3-18b8-435c-b3fc-55e45b1ce964 - expirationDateTime: 2025-09-09T00:00:00Z - connection: - type: EVPLAN_VC - allowRemoteConnection: true - allowCustomBandwidth: false - supportedBandwidths: - - 10 - - 50 - - 200 - - 500 - zSide: - accessPointSelectors: - - type: NETWORK - network: - href: https://api.equinix.com/fabric/v4/networks/5e17244a-b3e6-4830-aea3-5269d61efd8c - uuid: 5e17244a-b3e6-4830-aea3-5269d61efd8c - type: EVPLAN - name: AUTO-EVPLAN-939087546 - scope: GLOBAL - state: INACTIVE - notifications: - - type: NOTIFICATION - emails: - - test@equinix.com - - user01@equinix.com - account: - orgId: 90837 - changelog: - createdBy: "890742" - createdDateTime: 2025-06-11T15:23:19.237Z - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee962 - createZsideServiceTokenWithNetworkEvptree-Response: - value: - href: https://api.equinix.com/fabric/v4/serviceTokens/543b869e-a9ba-4492-860b-44927ce619f9 - type: VC_TOKEN - uuid: 543b869e-a9ba-4492-860b-44927ce619f9 - expirationDateTime: 2025-09-09T00:00:00Z - connection: - type: EVPTREE_VC - allowRemoteConnection: true - allowCustomBandwidth: false - supportedBandwidths: - - 10 - - 50 - - 200 - - 500 - - 1000 - zSide: - accessPointSelectors: - - type: NETWORK - network: - href: https://api.equinix.com/fabric/v4/networks/a3536780-6118-4374-ab65-23b17fc4cbbb - uuid: a3536780-6118-4374-ab65-23b17fc4cbbb - type: EVPTREE - name: EVPTREE-AMER-01 - scope: REGIONAL - location: - region: AMER - state: INACTIVE - notifications: - - type: NOTIFICATION - emails: - - test@equinix.com - - user01@equinix.com - account: - orgId: 90837 - changelog: - createdBy: "890742" - createdDateTime: 2025-06-11T15:54:33.007Z - project: - projectId: ac4d34ca-0d9c-4bc2-9aab-195743fee962 - Resend_Service_Token: - value: - type: RESEND_EMAIL_NOTIFICATION - postServiceTokenActionResponse: - value: - href: http://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: http://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 - ColoOpticalConnectCreate: - description: Both ends terminate on patch panels in colocation space you occupy, so no Letter of Authorization is needed. - value: - type: OC - bandwidth: 100000 - connectionDestinationType: COLO - pathType: UNPROTECTED - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "9" - patchPanelPortB: "10" - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: PP:Demarc:1259695 - patchPanelPortA: "20" - patchPanelPortB: "21" - connectorType: SC - order: - purchaseOrderNumber: "156576" - notifications: - - type: NOTIFICATION - emails: - - test@test.com - RemoteOpticalConnectCreate: - description: |- - The Z-side is identified by IBX code and the Letter of Authorization - issued by the destination customer. - value: - type: OC - bandwidth: 100000 - connectionDestinationType: REMOTE - pathType: UNPROTECTED - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - purchaseOrderNumber: "156576" - notifications: - - type: NOTIFICATION - emails: - - test@test.com - BMMROpticalConnectCreate: - description: The Z-side is identified by location and Letter of Authorization.
bmmrType declares who operates the meet-me room. - value: - type: OC - bandwidth: 100000 - connectionDestinationType: BMMR - pathType: UNPROTECTED - bmmrType: EQUINIX - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - purchaseOrderNumber: "156576" - notifications: - - type: NOTIFICATION - emails: - - test@test.com - ColoOpticalConnectResponseExample: - summary: COLO connection - value: - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-01 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: COLO - pathType: UNPROTECTED - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259690 - patchPanelPortA: "20" - patchPanelPortB: "21" - connectorType: SC - cageUniqueSpaceId: SV2:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV2 - order: - purchaseOrderNumber: "156576" - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - changeLog: - createdByEmail: abc@xyz.com - createdDateTime: 2025-07-24T06:50:46Z - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-07-24T06:51:46Z - RemoteOpticalConnectResponseExample: - summary: Remote connection - value: - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-01 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: REMOTE - pathType: UNPROTECTED - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - purchaseOrderNumber: "156576" - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - changeLog: - createdByEmail: abc@xyz.com - createdDateTime: 2025-07-24T06:50:46Z - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-07-24T06:51:46Z - BMMROpticalConnectResponseExample: - summary: BMMR connection - value: - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-01 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: BMMR - pathType: UNPROTECTED - bmmrType: EQUINIX - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - purchaseOrderNumber: "156576" - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - changeLog: - createdByEmail: abc@xyz.com - createdDateTime: 2025-07-24T06:50:46Z - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-07-24T06:51:46Z - OpticalConnect_400: - summary: Unknown or inaccessible connection. - value: - - errorCode: EQ-3057103 - errorMessage: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - details: Optical Connect Service does not exist or does not belong to the user.Please check Optical Connect UUID - OpticalConnect_403: - summary: Operation not permitted - value: - - errorCode: EQ-3057102 - errorMessage: Operation not allowed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - details: Operation not allowed for current user - OpticalConnect_404: - summary: Optical connection not found - value: - - errorCode: EQ-3057101 - errorMessage: Optical Connect Service not found or already deleted - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - details: Optical Connect Service not found or already deleted - OpticalConnect_500: - summary: Unexpected server error - value: - - errorCode: EQ-3057104 - errorMessage: Internal Server Error - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - details: Internal Server Error - ColoOpticalConnectBulkCreate: - summary: COLO diverse pair - description: Two connections on separate patch panels. Equinix assigns the shared redundancy group and returns it on both connections. - value: - data: - - type: OC - bandwidth: 100000 - connectionDestinationType: COLO - pathType: DUAL_DIVERSE - redundancy: - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259690 - patchPanelPortA: "20" - patchPanelPortB: "21" - connectorType: SC - notifications: - - type: NOTIFICATION - emails: - - test@test.com - registeredUsers: - - test - - type: OC - bandwidth: 100000 - connectionDestinationType: COLO - pathType: DUAL_DIVERSE - redundancy: - priority: SECONDARY - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260385 - patchPanelPortA: "24" - patchPanelPortB: "25" - connectorType: SC - notifications: - - type: NOTIFICATION - emails: - - test@test.com - RemoteOpticalConnectBulkCreate: - value: - data: - - type: OC - bandwidth: 100000 - connectionDestinationType: REMOTE - pathType: DUAL_DIVERSE - redundancy: - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - account: - accountNumber: 270848 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - registeredUsers: - - test@test.com - - type: OC - bandwidth: 100000 - connectionDestinationType: REMOTE - pathType: DUAL_DIVERSE - redundancy: - priority: SECONDARY - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: SC - zSide: - location: - ibxCode: SV2 - loa: - uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 - account: - accountNumber: 270848 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - BMMROpticalConnectBulkCreate: - value: - data: - - type: OC - bandwidth: 100000 - connectionDestinationType: BMMR - pathType: DUAL_DIVERSE - bmmrType: EQUINIX - redundancy: - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - account: - accountNumber: 270848 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - registeredUsers: - - test@test.com - - type: OC - bandwidth: 100000 - connectionDestinationType: BMMR - pathType: DUAL_DIVERSE - bmmrType: EQUINIX - redundancy: - priority: SECONDARY - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: SC - zSide: - location: - ibxCode: SV2 - loa: - uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 - account: - accountNumber: 270848 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - ColoOpticalConnectBulkResponseExample: - value: - data: - - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-PRI-01 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: COLO - pathType: DUAL_DIVERSE - redundancy: - priority: PRIMARY - group: 22f8e668-4754-4564-825d-d1c7889c885a - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259690 - patchPanelPortA: "20" - patchPanelPortB: "21" - connectorType: SC - cageUniqueSpaceId: SV2:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV2 - order: - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - - href: https://api.equinix.com/fabric/v4/opticalConnects/a6f77b33-96c6-4eeb-8d79-76374d950603 - uuid: a6f77b33-96c6-4eeb-8d79-76374d950603 - type: OC - name: 270848-SV1-SV2-SEC-02 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: COLO - pathType: DUAL_DIVERSE - redundancy: - priority: SECONDARY - group: 22f8e668-4754-4564-825d-d1c7889c885a - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260385 - patchPanelPortA: "24" - patchPanelPortB: "25" - connectorType: SC - cageUniqueSpaceId: SV2:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV2 - order: - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - RemoteOpticalConnectBulkResponseExample: - value: - data: - - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-PRI-01 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: REMOTE - pathType: DUAL_DIVERSE - redundancy: - priority: PRIMARY - group: 22f8e668-4754-4564-825d-d1c7889c885a - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - - href: https://api.equinix.com/fabric/v4/opticalConnects/c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 - uuid: c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 - type: OC - name: 270848-SV1-SV2-SEC-02 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: REMOTE - pathType: DUAL_DIVERSE - redundancy: - priority: SECONDARY - group: 22f8e668-4754-4564-825d-d1c7889c885a - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 - order: - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - BMMROpticalConnectBulkResponseExample: - value: - data: - - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-PRI-01 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: BMMR - pathType: DUAL_DIVERSE - bmmrType: EQUINIX - redundancy: - priority: PRIMARY - group: 22f8e668-4754-4564-825d-d1c7889c885a - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - - href: https://api.equinix.com/fabric/v4/opticalConnects/c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 - uuid: c9e2a1b6-7d4f-4c3e-8b2a-5f1d6e7a9c58 - type: OC - name: 270848-SV1-SV2-SEC-02 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: BMMR - pathType: DUAL_DIVERSE - bmmrType: EQUINIX - redundancy: - priority: SECONDARY - group: 22f8e668-4754-4564-825d-d1c7889c885a - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: e9e2a1b6-8d4f-4c3e-8b2a-5f1d6e7a9c59 - order: - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - ColoOpticalConnectResponseDeprovisioningExample: - value: - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-01 - state: DEPROVISIONING - bandwidth: 100000 - connectionDestinationType: COLO - pathType: UNPROTECTED - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259690 - patchPanelPortA: "20" - patchPanelPortB: "21" - connectorType: SC - cageUniqueSpaceId: SV2:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV2 - order: - purchaseOrderNumber: "156576" - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - changeLog: - createdByEmail: abc@xyz.com - createdDateTime: 2025-07-24T06:50:46Z - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-07-24T06:51:46Z - RemoteOpticalConnectResponseDeprovisioningExample: - value: - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-01 - state: DEPROVISIONING - bandwidth: 100000 - connectionDestinationType: REMOTE - pathType: UNPROTECTED - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - purchaseOrderNumber: "156576" - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - BMMROpticalConnectResponseDeprovisioningExample: - value: - href: https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-01 - state: DEPROVISIONING - bandwidth: 100000 - connectionDestinationType: BMMR - pathType: UNPROTECTED - bmmrType: EQUINIX - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV2 - loa: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - order: - purchaseOrderNumber: "156576" - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - changeLog: - createdByEmail: abc@xyz.com - createdDateTime: 2025-07-24T06:50:46Z - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-07-24T06:51:46Z - SearchOpticalConnectFilterByStatus: - summary: All provisioned connections - value: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONED - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/updatedDateTime - SearchOpticalConnectByName: - summary: A named connection of a given type - value: - filter: - and: - - property: /name - operator: = - values: - - 270848-SV1-SV2-01 - - property: /type - operator: = - values: - - OC - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/updatedDateTime - SearchOpticalConnectFilterOrAnd: - summary: Partial match on uuid or name - description: An OR group nested inside the top-level AND — matches circuits whose uuid starts with the given prefix, or whose name is like the value. - value: - filter: - and: - - or: - - property: /uuid - operator: LIKE - values: - - 676a0c3f-a785-4294-87bc-25fe9318a620% - - property: /name - operator: LIKE - values: - - 270848-SV1-SV2-01 - OpticalConnectSearchResponseExample: - summary: One matching connection. - 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/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0 - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 - type: OC - name: 270848-SV1-SV2-01-1 - state: PROVISIONING - bandwidth: 100000 - connectionDestinationType: COLO - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "10" - patchPanelPortB: "11" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259690 - patchPanelPortA: "20" - patchPanelPortB: "21" - cageUniqueSpaceId: SV2:01:002174 - cabinetUniqueSpaceId: Demarc - connectorType: SC - location: - ibxCode: SV2 - order: - purchaseOrderNumber: "156576" - orderNumber: 1-129105284100 - account: - accountNumber: 270848 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - changeLog: - createdByEmail: abc@xyz.com - createdDateTime: 2025-07-24T06:50:46Z - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-07-24T06:51:46Z - - href: https://api.equinix.com/fabric/v4/opticalConnects/07abb0e3-e67d-5090-9aff-fc5654abaae0 - uuid: 07abb0e3-e67d-5090-9aff-fc5654abaae0 - type: OC - name: 270848-SV1-SV2-01-2 - state: PROVISIONED - bandwidth: 100000 - connectionDestinationType: COLO - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1234685 - patchPanelPortA: "11" - patchPanelPortB: "12" - connectorType: SC - cageUniqueSpaceId: SV1:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: "22" - patchPanelPortB: "23" - connectorType: SC - cageUniqueSpaceId: SV2:01:002174 - cabinetUniqueSpaceId: Demarc - location: - ibxCode: SV2 - order: - purchaseOrderNumber: "126758" - orderNumber: 1-139105284200 - account: - accountNumber: 280845 - orgId: 123 - notifications: - - type: NOTIFICATION - emails: - - test@test.com - changeLog: - createdByEmail: abc@xyz.com - createdDateTime: 2024-07-24T06:50:46Z - updatedByEmail: abc@xyz.com - updatedDateTime: 2024-07-24T06:51:46Z - OpticalConnect_400_invalid_sorting: - summary: Invalid sort direction. - value: - - errorCode: EQ-3057105 - errorMessage: Invalid value for sorting direction. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - OpticalConnect_401: - summary: Missing or invalid credentials - value: - - errorCode: EQ-3057106 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - 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 - services: - - type: ETHERNET_IP_SERVICE - - type: TIME_SERVICE - geoScopes: - - CANADA - - CONUS - - JAPAN - - UK - - AUSTRALIA - - BRAZIL - - SWITZERLAND - - EU - geoZones: - - code: EU - name: European Union - description: Note that Ireland and Italy are not currently included - 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 - services: - - type: ETHERNET_IP_SERVICE - - type: TIME_SERVICE - geoScopes: - - CANADA - - CONUS - - JAPAN - - UK - - AUSTRALIA - - BRAZIL - - SWITZERLAND - - EU - geoZones: - - code: EU - name: European Union - description: Note that Ireland and Italy are not currently included - 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 - services: - - type: ETHERNET_IP_SERVICE - - type: TIME_SERVICE - ports: - value: - pagination: - offset: 0 - limit: 1000 - total: 2 - data: - - href: https://api.equinix.com/fabric/v4/ports/c4d93b39-02db-2dbc-ace0-30fa5c00ad04 - type: XF_PORT - uuid: c4d93b39-02db-2dbc-ace0-30fa5c00ad04 - name: gen-l2-qa-01-auto-TY4-L-Qinq-STD-SEC-10G-JUN-598 - physicalPortsSpeed: 10000 - physicalPortsType: 10GBASE_LR - connectivitySourceType: COLO - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - package: - code: STANDARD - state: REPROVISIONING - cvpId: "1616554" - operation: - connectionCount: 0 - evplVCCount: 0 - accessVCCount: 0 - account: - accountNumber: 200559 - accountName: gen-l2-qa-01-auto-200559 - orgId: 90946 - organizationName: gen-l2-qa-01-auto-200551. - ucmId: 500DFED2-EBDB-480d-896C-C7870E52D0D8 - globalCustId: 0017i000011X242AAC - changeLog: - createdBy: vvyugovskiy-IMPORT_JOB - createdDateTime: 2021-06-16T01:46:52Z - updatedBy: Order-to-activation - updatedDateTime: 2025-04-07T23:03:08.900Z - bandwidth: 10000 - availableBandwidth: 10000 - usedBandwidth: 0 - location: - metroHref: https://api.equinix.com/fabric/v4/metros/TY - region: APAC - metroName: Tokyo - metroCode: TY - ibx: TY4 - device: - name: sit-tb1-ty-a2.lab - redundancy: - priority: SECONDARY - demarcationPointIbx: TY4 - tetherIbx: TY4 - redundancy: - priority: SECONDARY - encapsulation: - type: QINQ - tagProtocolId: 37120 - lagEnabled: false - settings: - buyout: false - physicalPorts: - - type: XF_PHYSICAL_PORT - id: 1362185 - state: TO_BE_ADDED - uuid: 01892489-ce9b-7f25-b1f5-d32a5ac6a423 - tether: - crossConnectId: ECX.05.00001836 - cabinetNumber: Demarc - systemName: TY4:01:002181 - patchPanel: PP:1240:1089399 - patchPanelPortA: "7" - patchPanelPortB: "8" - ibx: TY4 - demarcationPoint: - patchPanel: PP:Demarc:00002181 - patchPanelName: PP:Demarc:00002181 - patchPanelPortA: "5" - patchPanelPortB: "6" - ibx: TY4 - operation: - operationalStatus: UP - - href: https://api.equinix.com/fabric/v4/ports/6f0f3015-2d51-4b6e-a98c-1defb4fe88f1 - type: XF_PORT - uuid: 6f0f3015-2d51-4b6e-a98c-1defb4fe88f1 - name: 200558-SY4-CX-PRI-02 - physicalPortsSpeed: 10000 - physicalPortsType: 10GBASE_LR - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - package: - code: STANDARD - state: ACTIVE - cvpId: "2000348" - operation: - connectionCount: 1 - evplVCCount: 1 - accessVCCount: 0 - maintenanceStatus: SCHEDULED - lockEnabled: true - account: - accountNumber: 200558 - accountName: Gen-L2-Qa-01-Auto-200558 - orgId: 90946 - organizationName: gen-l2-qa-01-auto-200551. - ucmId: 2D26D682-B62E-495d-AFDF-698EC3B353F8 - globalCustId: 0017i000011X242AAC - changeLog: - createdDateTime: 2025-05-06T17:29:30.800Z - updatedBy: API - updatedDateTime: 2025-05-06T17:29:40.300Z - bandwidth: 10000 - availableBandwidth: 9500 - usedBandwidth: 500 - location: - metroHref: https://api.equinix.com/fabric/v4/metros/SY - region: APAC - metroName: Sydney - metroCode: SY - ibx: SY4 - device: - name: sit-tb1-sy-e1.lab - redundancy: - group: "1" - priority: PRIMARY - demarcationPointIbx: SY4 - tetherIbx: SY4 - redundancy: - priority: PRIMARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: true - settings: - buyout: false - physicalPorts: - - type: XF_PHYSICAL_PORT - id: 1362737 - state: ACTIVE - uuid: 01892489-ce07-7962-b676-b1a4d8091515 - tether: - crossConnectId: "22035616" - cabinetNumber: Demarc - systemName: SY4:01:002204 - patchPanel: PP:1240:1089399 - patchPanelPortA: "12" - patchPanelPortB: "14" - ibx: SY4 - demarcationPoint: - patchPanel: PP:Demarc:00002204 - patchPanelName: PP:Demarc:00002204 - patchPanelPortA: "17" - patchPanelPortB: "18" - ibx: SY4 - operation: - operationalStatus: UP - ports-500: - value: - - errorCode: EQ-3046030 - errorMessage: Internal error. - details: Internal system error - ports-500-user-failure: - value: - - errorCode: IC-USR-014-01 - errorMessage: Error in getting user's profile - 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 - connectivitySourceType: COLO - location: - metroCode: AT - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 16432 - project: - projectId: e275485c-7072-439f-943a-c923548b2be5 - package: - code: STANDARD - redundancy: - priority: PRIMARY - lagEnabled: true - physicalPorts: - - type: XF_PHYSICAL_PORT - demarcationPoint: - ibx: AT1 - cageUniqueSpaceId: AT1:02:FE50010 - cabinetUniqueSpaceId: "9999" - patchPanel: CD:9999:186947 - connectorType: SC - patchPanelPortA: "4" - patchPanelPortB: "5" - endCustomer: - isDisclosed: true - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - demarcationPointIbx: AT1 - notifications: - - type: TECHNICAL - registeredUsers: - - username - - type: NOTIFICATION - registeredUsers: - - user@equinix.com - coloUnlimitedPlusPortLag: - value: - type: XF_PORT - connectivitySourceType: COLO - location: - metroCode: GV - package: - code: UNLIMITED_PLUS - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 270848 - project: - projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 - redundancy: - priority: PRIMARY - lagEnabled: true - physicalPorts: - - type: XF_PHYSICAL_PORT - demarcationPoint: - ibx: GV1 - cageUniqueSpaceId: GV1:01:002174 - cabinetUniqueSpaceId: Demarc - patchPanel: CP:Demarc:1259684 - connectorType: SC - endCustomer: - isDisclosed: false - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - demarcationPointIbx: GV1 - notifications: - - type: TECHNICAL - registeredUsers: - - jaguarsuser-port-order - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - coloLagPortNewGroup: - value: - type: XF_PORT - connectivitySourceType: COLO - location: - metroCode: TR - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 96127367 - package: - code: UNLIMITED - project: - projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 - redundancy: - priority: PRIMARY - lagEnabled: true - physicalPorts: - - type: XF_PHYSICAL_PORT - demarcationPoint: - ibx: TR1 - cageUniqueSpaceId: TR1:01:JSIT001 - cabinetUniqueSpaceId: DEM - patchPanel: PP:DEM:1265410 - connectorType: LC - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - demarcationPointIbx: TR1 - order: - signature: - signatory: SELF - delegate: - email: jaguars-test-user-001@equinix.com - purchaseOrder: - type: EXEMPTION - notifications: - - type: TECHNICAL - registeredUsers: - - jaguars-test-user-001 - - type: NOTIFICATION - registeredUsers: - - jaguars-test-user-001 - coloAddSecondaryPort: - value: - type: XF_PORT - physicalPortsSpeed: 10000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: COLO - location: - metroCode: GV - demarcationPointIbx: GV1 - package: - code: STANDARD - 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 - cabinetUniqueSpaceId: AM1:02:032575:0105 - cageUniqueSpaceId: AM1:02:032575 - patchPanel: PP:0105:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: LC - COLOSinglePortNonLagCreateDryRun: - 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 - COLOSinglePortLagCreateDryRun: - 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 - remoteSinglePortNewGroupLagRequest: - value: - type: XF_PORT - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: REMOTE - 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 - bmmrSinglePortLag: - value: - type: XF_PORT - connectivitySourceType: BMMR - location: - metroCode: SE - package: - code: STANDARD - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 200551 - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - redundancy: - priority: PRIMARY - lagEnabled: true - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - demarcationPointIbx: SE2 - bmmrType: SELF - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - bmmrSinglePortNoLag: - value: - type: XF_PORT - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: BMMR - location: - metroCode: GV - demarcationPointIbx: GV1 - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - project: - projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 - package: - code: STANDARD - 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 - location: - metroCode: GV - demarcationPointIbx: GV1 - redundancy: - priority: SECONDARY - group: 1f6bdb37-f131-5925-c039-fe1785fad165 - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - project: - projectId: "567" - package: - code: STANDARD - 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 - createIXPublicPrivatePeeringPortRequest: - value: - type: XF_PORT - physicalPortsSpeed: 400000 - physicalPortsType: 400GBASE_LR4 - connectivitySourceType: COLO - location: - metroCode: GV - demarcationPointIbx: GV1 - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - project: - projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 - account: - accountNumber: 270848 - notifications: - - registeredUsers: - - jaguarsuser-port-order - type: TECHNICAL - physicalPorts: - - demarcationPoint: - ibx: GV1 - cabinetUniqueSpaceId: Demarc - cageUniqueSpaceId: GV1:01:002174 - patchPanel: CP:Demarc:1259684 - connectorType: SC - serviceCode: IX - createIXPublicPeeringPortRequest: - value: - type: XF_PORT - physicalPortsSpeed: 400000 - physicalPortsType: 400GBASE_LR4 - connectivitySourceType: COLO - location: - metroCode: GV - demarcationPointIbx: GV1 - lagEnabled: false - encapsulation: - type: UNTAGGED - project: - projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 - account: - accountNumber: 270848 - notifications: - - registeredUsers: - - jaguarsuser-port-order - type: TECHNICAL - physicalPorts: - - demarcationPoint: - ibx: GV1 - cabinetUniqueSpaceId: Demarc - cageUniqueSpaceId: GV1:01:002174 - patchPanel: CP:Demarc:1259684 - connectorType: SC - serviceCode: IX - PortCreateDryRunResponse: - value: - type: XF_PORT - physicalPortsType: 10GBASE_LR - physicalPortsSpeed: 10000 - physicalPortsCount: 1 - location: - metroCode: AM - demarcationPointIbx: AM1 - redundancy: - group: "1" - priority: PRIMARY - lagEnabled: true - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - package: - code: STANDARD - settings: - sharedPortType: false - project: - projectId: "567" - 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 - bmmrSinglePortCreateDryRunResponse: - value: - type: XF_PORT - connectivitySourceType: BMMR - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - location: - metroCode: AT - demarcationPointIbx: AT1 - redundancy: - priority: PRIMARY - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - package: - code: STANDARD - project: - projectId: b7c8d9e0-f1a2-4b3c-9d4e-5f6a7b8c9d0e - account: - accountNumber: 100001 - accountName: Test-Account - order: - purchaseOrder: - number: Fabric-PO-TEST-001 - amount: "1000" - startDate: 2025-01-01 - endDate: 2030-01-01 - type: EXISTING - signature: - signatory: SELF - delegate: - email: test-user@example.com - notifications: - - type: TECHNICAL - registeredUsers: - - test-technical-user - - type: NOTIFICATION - registeredUsers: - - test-notification-user - loas: - - uuid: a0b1c2d3-e4f5-4678-a6b7-c8d9e0f1a2b3 - remoteSinglePortCreateDryRunResponse: - value: - type: XF_PORT - connectivitySourceType: REMOTE - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - location: - metroCode: AT - demarcationPointIbx: AT1 - redundancy: - priority: PRIMARY - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - package: - code: STANDARD - project: - projectId: e3d4f5a6-7b8c-4d9e-a0b1-c2d3e4f56789 - account: - accountNumber: 100002 - accountName: Test-Account - order: - purchaseOrder: - number: Fabric-PO-TEST-002 - amount: "1000" - startDate: 2025-01-01 - endDate: 2030-01-01 - type: EXISTING - signature: - signatory: SELF - delegate: - email: test-user@example.com - notifications: - - type: TECHNICAL - registeredUsers: - - test-technical-user - - type: NOTIFICATION - registeredUsers: - - test-notification-user - loas: - - uuid: f1e2d3c4-b5a6-4978-8e0f-1a2b3c4d5e6f - coloSinglePortNonLagResponse: - value: - href: https://api.equinix.com/fabric/v4/ports/11abfba0-907f-460b-95ff-5a7bda4471ed - type: XF_PORT - uuid: 11abfba0-907f-460b-95ff-5a7bda4471ed - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - connectivitySourceType: COLO - project: - projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 - state: PENDING - order: - orderNumber: 1-233948565342 - uuid: d8ab29fe-e849-417d-b0a0-946e69dcd2ce - 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: - accountNumber: 96127367 - accountName: Jaguars_toronto__sig - ucmId: 86B71B7D-D0CC-4ee9-854D-A2C1AA7FA152 - changeLog: - createdBy: "923209" - createdDateTime: 2025-06-11T22:41:39.669Z - location: - metroCode: TR - demarcationPointIbx: TR1 - redundancy: - priority: PRIMARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: false - settings: - sharedPortType: false - package: - code: STANDARD - notifications: - - type: TECHNICAL - registeredUsers: - - jaguars-test-user-001 - - type: NOTIFICATION - registeredUsers: - - jaguars-test-user-001 - physicalPorts: - - demarcationPoint: - ibx: GV1 - cabinetUniqueSpaceId: Demarc - cageUniqueSpaceId: GV1:01:002174 - patchPanel: CP:Demarc:1259684 - connectorType: SC - bmmrSinglePortLagResponse: - value: - href: https://api.equinix.com/fabric/v4/ports/ed9d0b79-ff29-404a-b016-566435093afc - type: XF_PORT - uuid: ed9d0b79-ff29-404a-b016-566435093afc - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 0 - connectivitySourceType: BMMR - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - state: PENDING - order: - orderNumber: 1-289477804403 - uuid: b325f02c-69dd-41d2-838b-ea495c873e9d - account: - accountNumber: 200551 - accountName: gen-l2-qa-01-auto-200551 - ucmId: 83C58EBD-E231-4a8b-902E-0CFBE50E32C2 - changeLog: - createdBy: "1067822" - createdDateTime: 2025-06-21T00:15:48.414Z - location: - metroCode: SE - demarcationPointIbx: SE2 - redundancy: - priority: PRIMARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: true - package: - code: STANDARD - settings: - sharedPortType: false - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - additionalInfo: - - key: lagType - value: New - remoteSinglePortLagResponse: - value: - href: https://api.equinix.com/fabric/v4/ports/68adcd26-d66c-489d-9c72-8990b92a288e - type: XF_PORT - uuid: 68adcd26-d66c-489d-9c72-8990b92a288e - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - connectivitySourceType: REMOTE - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - state: PENDING - order: - orderNumber: 1-289477804403 - uuid: b325f02c-69dd-41d2-838b-ea495c873e9d - purchaseOrder: - type: EXEMPTION - account: - accountNumber: 200551 - accountName: gen-l2-qa-01-auto-200551 - ucmId: 83C58EBD-E231-4a8b-902E-0CFBE50E32C2 - changeLog: - createdBy: "1067822" - createdDateTime: 2025-06-21T00:15:48.414Z - location: - metroCode: SE - demarcationPointIbx: SE2 - redundancy: - priority: PRIMARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: true - package: - code: STANDARD - settings: - productCode: CX - sharedPortType: false - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - additionalInfo: - - key: lagType - value: New - remoteSinglePortLagWithPurchaseOrderExemption: - value: - type: XF_PORT - connectivitySourceType: REMOTE - location: - metroCode: AT - package: - code: STANDARD - settings: - sharedPortType: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 200551 - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - redundancy: - priority: PRIMARY - lagEnabled: true - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - demarcationPointIbx: AT1 - order: - purchaseOrder: - type: EXEMPTION - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - additionalInfo: - - key: lagType - value: New - loas: - - uuid: 2f78191c-0920-4f13-b1c7-2cef03d07570 - createIXPublicPrivatePeeringPortResponse: - value: - href: https://api.equinix.com/fabric/v4/ports/11abfba0-907f-460b-95ff-5a7bda4471ed - type: XF_PORT - uuid: 11abfba0-907f-460b-95ff-5a7bda4471ed - physicalPortsSpeed: 400000 - physicalPortsType: 400GBASE_LR4 - physicalPortsCount: 1 - connectivitySourceType: COLO - project: - projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 - state: PENDING - order: - orderNumber: 1-633948565342 - uuid: d8ab29fe-e849-417d-b0a0-946e69dcd2ce - account: - accountNumber: 270848 - accountName: Jaguars_toronto__sig - ucmId: 86B71B7D-D0CC-4ee9-854D-A2C1AA7FA152 - changeLog: - createdBy: "923209" - createdDateTime: 2025-06-11T22:41:39.669Z - location: - metroCode: GV - demarcationPointIbx: GV1 - redundancy: - priority: PRIMARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: false - settings: - sharedPortType: false - productCode: IX - notifications: - - type: TECHNICAL - registeredUsers: - - jaguars-test-user-001 - - type: NOTIFICATION - registeredUsers: - - jaguars-test-user-001 - physicalPorts: - - demarcationPoint: - ibx: GV1 - cabinetUniqueSpaceId: Demarc - cageUniqueSpaceId: GV1:01:002174 - patchPanel: CP:Demarc:1259684 - connectorType: SC - createIXPublicPeeringPortResponse: - value: - href: https://api.equinix.com/fabric/v4/ports/1babfba0-907f-460b-95ff-5a7bda4471ed - type: XF_PORT - uuid: 1babfba0-907f-460b-95ff-5a7bda4471ed - physicalPortsSpeed: 400000 - physicalPortsType: 400GBASE_LR4 - physicalPortsCount: 1 - connectivitySourceType: COLO - project: - projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 - state: PENDING - order: - orderNumber: 1-233948565342 - uuid: a8ab29fe-e849-417d-b0a0-946e69dcd2ce - account: - accountNumber: 270848 - accountName: Jaguars_toronto__sig - ucmId: 86B71B7D-D0CC-4ee9-854D-A2C1AA7FA152 - changeLog: - createdBy: "923209" - createdDateTime: 2025-06-11T22:41:39.669Z - location: - metroCode: GV - demarcationPointIbx: GV1 - redundancy: - priority: PRIMARY - encapsulation: - type: UNTAGGED - lagEnabled: false - settings: - sharedPortType: false - productCode: IX - notifications: - - type: TECHNICAL - registeredUsers: - - jaguars-test-user-001 - - type: NOTIFICATION - registeredUsers: - - jaguars-test-user-001 - physicalPorts: - - demarcationPoint: - ibx: GV1 - cabinetUniqueSpaceId: Demarc - cageUniqueSpaceId: GV1:01:002174 - patchPanel: CP:Demarc:1259684 - connectorType: SC - 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-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 - createPortBadRequest: - value: - - errorCode: EQ-3143004 - errorMessage: Json syntax error, please check request body - details: Unknown json property - correlationId: TEST - additionalInfo: - - property: encapsulation.type - reason: Unexpected value 'DOT1' - 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 - physicalPortsSpeed: 10000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: BMMR - package: - code: STANDARD - 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 - cabinetUniqueSpaceId: AM1:02:032575:0105 - cageUniqueSpaceId: AM1:02:032575 - patchPanel: PP:0105:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: LC - - type: XF_PORT - name: L2-DEV-USER01-CX-10G-SECONDARY - physicalPortsSpeed: 10000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: BMMR - location: - metroCode: AM - demarcationPointIbx: AM1 - package: - code: STANDARD - 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 - cabinetUniqueSpaceId: AM1:02:032575:0105 - cageUniqueSpaceId: AM1:02:032575 - patchPanel: PP:0105:1260379 - patchPanelPortA: "14" - patchPanelPortB: "15" - connectorType: LC - bmmrBulkPortRequest: - value: - data: - - type: XF_PORT - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: BMMR - redundancy: - priority: PRIMARY - location: - metroCode: SG - demarcationPointIbx: SG4 - settings: - sharedPortType: false - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 715013 - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - package: - code: STANDARD - loas: - - uuid: 96cb973f-0eea-4cf1-a93d-23a27f070a98 - additionalInfo: - - key: InterfaceReferenceId - value: "906234" - bmmrType: EQUINIX - order: - uuid: 3fefa958-7bb2-496b-8e9a-14dc92187e7e - - type: XF_PORT - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: BMMR - redundancy: - priority: SECONDARY - location: - metroCode: SG - demarcationPointIbx: SG4 - settings: - sharedPortType: false - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 715013 - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - package: - code: STANDARD - loas: - - uuid: 96cb973f-0eea-4cf1-a93d-23a27f070a98 - additionalInfo: - - key: InterfaceReferenceId - value: "906234" - bmmrType: EQUINIX - order: - uuid: 3fefa958-7bb2-496b-8e9a-14dc92187e7e - remoteBulkPortRequest: - value: - data: - - type: XF_PORT - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: REMOTE - redundancy: - priority: PRIMARY - location: - metroCode: SV - demarcationPointIbx: SV1 - settings: - sharedPortType: false - lagEnabled: false - package: - code: STANDARD - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 200551 - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - physicalPorts: - - type: XF_PHYSICAL_PORT - demarcationPoint: - ibx: SV1 - cabinetUniqueSpaceId: Demarc - cageUniqueSpaceId: SV1:01:002121 - patchPanel: PP:Demarc:00002121 - connectorType: SC - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - additionalInfo: - - key: InterfaceReferenceId - value: "261376" - order: - uuid: 3f3a8ac3-1fed-4355-8f81-8fe371dc9328 - - type: XF_PORT - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - connectivitySourceType: REMOTE - redundancy: - priority: SECONDARY - location: - metroCode: SV - demarcationPointIbx: SV1 - package: - code: STANDARD - settings: - sharedPortType: false - sharedPortProduct: null - lagEnabled: false - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - account: - accountNumber: 200551 - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - physicalPorts: - - type: XF_PHYSICAL_PORT - demarcationPoint: - ibx: SV1 - cabinetUniqueSpaceId: Demarc - cageUniqueSpaceId: SV1:01:002121 - patchPanel: PP:Demarc:00002121 - connectorType: SC - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - additionalInfo: - - key: InterfaceReferenceId - value: "261376" - order: - uuid: 3f3a8ac3-1fed-4355-8f81-8fe371dc9328 - 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 - settings: - sharedPortType: false - package: - code: STANDARD - 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 - package: - code: STANDARD - 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 - settings: - sharedPortType: false - notifications: - - type: TECHNICAL - registeredUsers: - - jaguarsuser-port-order - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - bmmrBulkPortResponse: - value: - data: - - href: https://api.equinix.com/fabric/v4/ports/136c412b-8c9d-429c-8030-de484c1371c4 - type: XF_PORT - uuid: 136c412b-8c9d-429c-8030-de484c1371c4 - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 0 - connectivitySourceType: BMMR - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - state: PENDING - order: - orderNumber: 1-293571904079 - uuid: 3fefa958-7bb2-496b-8e9a-14dc92187e7e - account: - accountNumber: 715013 - accountName: Equinix - ucmId: A5C6ED82-6DAE-4c3b-B524-67F8B51D65BE - changeLog: - createdBy: "1067822" - createdDateTime: 2025-06-23T20:04:15.549Z - location: - metroCode: SG - demarcationPointIbx: SG4 - redundancy: - group: 57eb2e60-d16a-40ad-8395-6e083ce0d631 - priority: PRIMARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: false - package: - code: STANDARD - settings: - sharedPortType: false - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - additionalInfo: - - key: InterfaceReferenceId - value: "906234" - - href: https://api.equinix.com/fabric/v4/ports/57eb2e60-d16a-40ad-8395-6e083ce0d631 - type: XF_PORT - uuid: 57eb2e60-d16a-40ad-8395-6e083ce0d631 - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 0 - connectivitySourceType: BMMR - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - state: PENDING - order: - orderNumber: 1-293571904079 - uuid: 3fefa958-7bb2-496b-8e9a-14dc92187e7e - account: - accountNumber: 715013 - accountName: Equinix - ucmId: A5C6ED82-6DAE-4c3b-B524-67F8B51D65BE - changeLog: - createdBy: "1067822" - createdDateTime: 2025-06-23T20:04:15.549Z - location: - metroCode: SG - demarcationPointIbx: SG4 - redundancy: - group: 136c412b-8c9d-429c-8030-de484c1371c4 - priority: SECONDARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: false - settings: - sharedPortType: false - package: - code: STANDARD - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - additionalInfo: - - key: InterfaceReferenceId - value: "906234" - remoteBulkPortResponse: - value: - data: - - href: https://api.equinix.com/fabric/v4/ports/9042c980-0a8d-4d53-b0fb-73388db92a3b - type: XF_PORT - uuid: 9042c980-0a8d-4d53-b0fb-73388db92a3b - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - connectivitySourceType: REMOTE - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - state: PENDING - order: - orderNumber: 1-293571904094 - uuid: 3f3a8ac3-1fed-4355-8f81-8fe371dc9328 - account: - accountNumber: 200551 - accountName: gen-l2-qa-01-auto-200551 - ucmId: 83C58EBD-E231-4a8b-902E-0CFBE50E32C2 - changeLog: - createdBy: "1067822" - createdDateTime: 2025-06-23T21:28:48.386Z - location: - metroCode: SV - demarcationPointIbx: SV1 - redundancy: - group: 44cea0ee-1a05-4347-a39b-c11dfde4b591 - priority: PRIMARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: false - package: - code: STANDARD - settings: - productCode: CX - sharedPortType: false - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - additionalInfo: - - key: InterfaceReferenceId - value: "261376" - - href: https://api.equinix.com/fabric/v4/ports/44cea0ee-1a05-4347-a39b-c11dfde4b591 - type: XF_PORT - uuid: 44cea0ee-1a05-4347-a39b-c11dfde4b591 - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - physicalPortsCount: 1 - connectivitySourceType: REMOTE - project: - projectId: 333cd592-1709-4238-bb0d-2c2b41896aa1 - state: PENDING - order: - orderNumber: 1-293571904094 - uuid: 3f3a8ac3-1fed-4355-8f81-8fe371dc9328 - account: - accountNumber: 200551 - accountName: gen-l2-qa-01-auto-200551 - ucmId: 83C58EBD-E231-4a8b-902E-0CFBE50E32C2 - changeLog: - createdBy: "1067822" - createdDateTime: 2025-06-23T21:28:48.386Z - location: - metroCode: SV - demarcationPointIbx: SV1 - redundancy: - group: 9042c980-0a8d-4d53-b0fb-73388db92a3b - priority: SECONDARY - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - lagEnabled: false - package: - code: STANDARD - settings: - productCode: CX - sharedPortType: false - notifications: - - type: TECHNICAL - registeredUsers: - - falconsExternalUser@seller.com - - type: NOTIFICATION - registeredUsers: - - falconsExternalUser@seller.com - additionalInfo: - - key: InterfaceReferenceId - value: "261376" - 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 - uuid: bdfa360d-8ffb-4394-8905-56ea6ae3e87d - notifications: - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - - 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 - uuid: bdfa360d-8ffb-4394-8905-56ea6ae3e87d - notifications: - - type: NOTIFICATION - registeredUsers: - - jaguarsuser-port-order - portByUUID: - value: - href: https://api.equinix.com/fabric/v4/ports/44c5712b-d704-4ca5-9b42-ee6be32ee06a - type: XF_PORT - uuid: 44c5712b-d704-4ca5-9b42-ee6be32ee06a - name: 270843-DA1-CX-PRI-33 - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - project: - projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 - package: - code: UNLIMITED - state: ACTIVE - cvpId: "2000833" - connectivitySourceType: COLO - operation: - operationalStatus: UP - connectionCount: 10 - evplVCCount: 10 - accessVCCount: 0 - account: - accountNumber: 270843 - accountName: ctr-sit-account1 - orgId: 93055 - organizationName: ctr-sit-account1-270843 - ucmId: 64726950-A62C-4749-98E2-5AA4CA44284F - globalCustId: 0016u000003JZ3XAAW - change: - uuid: ed41e367-e09d-4c2f-b6ab-30506de4437f - type: PORT_UPDATE - status: COMPLETED - data: - op: REPLACE - path: /encapsulation - value: - type: QINQ - tagProtocolId: 34984 - createdDateTime: 2025-05-29T20:38:45.630759Z - updatedDateTime: 2025-05-29T20:38:49.330822Z - changeLog: - createdBy: qa-automation - createdDateTime: 2025-05-21T18:12:18.300Z - updatedBy: qa-automation - updatedDateTime: 2025-05-29T20:38:48.900Z - bandwidth: 1000 - availableBandwidth: 500 - usedBandwidth: 500 - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DA - region: AMER - metroName: Dallas - metroCode: DA - ibx: DA1 - device: - name: qa3-da-a1.lab - redundancy: - priority: PRIMARY - demarcationPointIbx: DA1 - tetherIbx: DA1 - redundancy: - priority: PRIMARY - encapsulation: - type: QINQ - tagProtocolId: 34984 - lagEnabled: false - settings: - buyout: true - viewPortPermission: true - placeVcOrderPermission: true - physicalPorts: - - type: XF_PHYSICAL_PORT - id: 1426359 - state: ADDED - bandwidth: 0 - uuid: 0189244a-f3ac-7258-a8b4-3167af899305 - tether: - crossConnectId: "513213223" - ibx: DA1 - demarcationPoint: - ibx: DA1 - operation: - operationalStatus: UP - maintenanceScheduledPortByUUID: - value: - href: https://api.equinix.com/fabric/v4/ports/44c5712b-d704-4ca5-9b42-ee6be32ee06a - type: XF_PORT - uuid: 44c5712b-d704-4ca5-9b42-ee6be32ee06a - name: 270843-DA1-CX-PRI-33 - physicalPortsSpeed: 1000 - physicalPortsType: 1000BASE_LX - project: - projectId: 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 - package: - code: UNLIMITED - state: ACTIVE - connectivitySourceType: COLO - operation: - operationalStatus: UP - connectionCount: 10 - evplVCCount: 10 - accessVCCount: 0 - maintenanceStatus: SCHEDULED - lockEnabled: true - account: - accountNumber: 270843 - accountName: ctr-sit-account1 - orgId: 93055 - organizationName: ctr-sit-account1-270843 - ucmId: 64726950-A62C-4749-98E2-5AA4CA44284F - globalCustId: 0016u000003JZ3XAAW - changeLog: - createdBy: admin_user - createdDateTime: 2025-05-21T18:12:18.300Z - updatedBy: test_user - updatedDateTime: 2025-05-29T20:38:48.900Z - bandwidth: 1000 - availableBandwidth: 500 - usedBandwidth: 500 - location: - metroHref: https://api.equinix.com/fabric/v4/metros/DA - region: AMER - metroName: Dallas - metroCode: DA - ibx: DA1 - demarcationPointIbx: DA1 - tetherIbx: DA1 - redundancy: - priority: PRIMARY - encapsulation: - type: QINQ - tagProtocolId: 34984 - lagEnabled: false - physicalPorts: - - type: XF_PHYSICAL_PORT - state: ADDED - bandwidth: 0 - uuid: 0189244a-f3ac-7258-a8b4-3167af899305 - tether: - crossConnectId: "513213223" - ibx: DA1 - demarcationPoint: - ibx: DA1 - operation: - operationalStatus: UP - portDryRunDelete: - value: - type: XF_PORT - uuid: e91484bb-4f65-4ab3-8f77-500dec2f855d - name: test-AT1-Dot1q-L-Secondary-108608 - physicalPortsType: 10GBASE_LR - physicalPortsSpeed: 10000 - physicalPortsCount: 1 - location: - metroCode: AM - demarcationPointIbx: AM1 - redundancy: - group: "1" - priority: PRIMARY - lagEnabled: true - encapsulation: - type: DOT1Q - tagProtocolId: 33024 - package: - code: STANDARD - settings: - sharedPortType: false - project: - projectId: "567" - 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 - physicalPorts: - - 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" - 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 - portUpdateEncapsulationAndTagProtocolIdRequest: - value: - - op: replace - path: /encapsulation - value: - type: DOT1Q - tagProtocolId: 33024 - PortUpdateNameDryRunRequest: - value: - - op: replace - path: /name - value: 1234-ibx-port - portUpdateLagEnabledRequest: - value: - - op: replace - path: /lagEnabled - value: true - PortUpdateDryRunResponse: - 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 - physicalPortsSpeed: 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 - portPatchResponse202: - value: - href: https://api.equinix.com/fabric/v4/ports/44c5712b-d704-4ca5-9b42-ee6be32ee06a - type: XF_PORT - uuid: 08693250-e67f-431f-b1ac-d3204263876a - name: 290061-SV1-NE-Shared-CX-PRI-01 - physicalPortsSpeed: 10000 - physicalPortsType: 10GBASE_LR - physicalPortsCount: 1 - project: - projectId: "377533000114703" - state: REPROVISIONING - cvpId: "2001190" - account: - accountNumber: 290061 - ucmId: BD8EB6F3-F8EF-40dc-8AAF-032B85804920 - change: - type: PORT_UPDATE - status: REQUESTED - data: - op: REPLACE - path: /encapsulation - value: - type: DOT1Q - tagProtocolId: 33024 - bandwidth: 10000 - location: - metroName: Silicon Valley - metroCode: SV - device: - name: qa3-sv-em-e3.lab - redundancy: - priority: PRIMARY - configModel: UPF - demarcationPointIbx: SV5 - encapsulation: - type: QINQ - tagProtocolId: 37120 - lagEnabled: true - settings: - buyout: false - additionalInfo: - - key: crossConnectId - value: 21918108-A - package: - code: STANDARD - physicalPorts: - - tether: - crossConnectId: 21918108-A - patchPanel: CP:Demarc:1257694 - patchPanelPortA: "21" - patchPanelPortB: "22" - demarcationPoint: - patchPanelPortA: "18" - patchPanelPortB: "19" - ibx: SV1 - portPatchMultipleConnections400Response: - value: - - errorCode: EQ-3143253 - errorMessage: Port is used by one or more Connections, connectors, subscriptions and/or tokens - details: There are 9 Connections/ connectors/ subscriptions/ tokens associated to this port - correlationId: TEST - additionalInfo: - - property: /uuid - 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: - - property: /state - operator: = - values: - - ACTIVE - - REPROVISIONING - - property: /settings/productCode - operator: = - values: - - CX - - property: /project/projectId - operator: = - values: - - 66a2d2f7-b79b-49bc-8642-d2b3c1c138b4 - pagination: - limit: 1000 - offset: 0 - sort: - - property: /device/name - direction: DESC - portSearchByOptionalFilters: - value: - filter: - or: - - and: - - property: /device/name - operator: = - values: - - qa3-sv-em-e3.lab - - property: /physicalPorts/tether/crossConnectId - operator: = - values: - - 21918108-A - - property: /physicalPorts/interface/name - operator: = - values: - - et-0/0/0 - - property: /uuid - operator: = - values: - - 08693250-e67f-431f-b1ac-d3204263876a - - property: /name - operator: LIKE - values: - - port-name - - property: /account/orgId - operator: = - values: - - "94513" - - property: /account/accountNumber - operator: = - values: - - "290061" - - property: /location/metroCode - operator: IN - values: - - SV - pagination: - limit: 1000 - offset: 0 - sort: - - property: /device/name - direction: DESC - portSearchRangeOperators: - value: - filter: - or: - - and: - - property: /changeLog/createdDateTime - operator: BETWEEN - values: - - 2023-06-27T15:05:37Z - - 2023-07-27T15:05:37Z - - property: /badwidth - operator: ">=" - values: - - "1000" - pagination: - limit: 1000 - offset: 0 - sort: - - property: /changeLog/createdDateTime - direction: DESC - portSearchByMaintenanceStatus: - value: - filter: - and: - - property: /operation/maintenanceStatus - operator: IN - values: - - SCHEDULED - - COMPLETED - - property: /operation/lockEnabled - operator: IN - values: - - "true" - pagination: - limit: 25 - offset: 0 - portSearchInvalidProjectRequest: - value: - - errorCode: EQ-3046110 - errorMessage: ProjectID required. - details: ProjectId and ports are not found for the user - correlationId: TEST - additionalInfo: - - property: /project/projectId - reason: " before searching for ports, assign project and ports" - portSearchInvalidRequest: - value: - - errorCode: EQ-3046116 - errorMessage: JSON syntax error. - details: Unknown json property - correlationId: TEST - additionalInfo: - - property: filter.or.[0].and.[1].property - reason: Unexpected value '/settings/productCod' - portSearchInvalidSearchFieldProperty: - value: - - errorCode: EQ-3046116 - errorMessage: JSON syntax error. - details: Please refer the contracts for correct fields - correlationId: TEST - portSearchInvalidSearchFieldArgument: - value: - - errorCode: EQ-3046112 - errorMessage: Invalid argument value. - details: Please refer the contracts for correct fields - correlationId: TEST - port-packages: - value: - data: - - href: /fabric/v4/portPackages/XF_UNLIMITED_PLUS - type: PORT_PACKAGE - code: XF_UNLIMITED_PLUS - vcBandwidthMax: 100000 - vcRemoteSupported: true - supportedServiceTypes: - - MSP - supportedSourceTypes: - - COLO - supportedMetros: - - SV - - DA - - href: /fabric/v4/portPackages/XF_UNLIMITED - type: PORT_PACKAGE - code: XF_UNLIMITED - vcBandwidthMax: 100000 - vcRemoteSupported: false - supportedServiceTypes: - - MSP - supportedSourceTypes: - - REMOTE - - COLO - - href: /fabric/v4/portPackages/XF_STANDARD - type: PORT_PACKAGE - code: XF_STANDARD - vcBandwidthMax: 100000 - vcRemoteSupported: false - supportedServiceTypes: - - MSP - supportedSourceTypes: - - BMMR - - REMOTE - - COLO - port-packages-500: - value: - - errorCode: EQ-3143001 - errorMessage: Internal Error - details: Internal system error - correlationId: 80066c00-0f20-11f0-8367-d5075ee362a7 - 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_LR - physicalPortsSpeed: 10000 - physicalPortsAvailable: 8 - redundancy: - priority: PRIMARY - - demarcationPointIbx: AM2 - tetherIbx: AM1 - metroConnectUsed: true - lagEnabled: true - physicalPortsType: 10GBASE_LR - physicalPortsSpeed: 10000 - physicalPortsAvailable: 8 - redundancy: - priority: SECONDARY - ConnectionRouteAggregationsGetAll: - value: - pagination: - offset: 0 - limit: 20 - total: 4 - 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_IPv4_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_IPv4_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 - 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 - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: replace - path: /name - value: - type: BGP_IPv4_PREFIX_FILTER - name: My-route-filter-v4-updated - description: Test filter - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - 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 - SearchRouteFiltersAndRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_FILTER - - property: /state - operator: IN - values: - - PROVISIONED - - PROVISIONING - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteFiltersOrRequest: - value: - filter: - or: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_FILTER - - property: /name - operator: LIKE - values: - - "%Route_Filter_Demo%" - - property: /project/projectId - operator: IN - values: - - dadd3ab6-c0af-430c-8216-43d44f08c1c5 - - 4f08c1c6-c0af-430c-8216-43d44f08c1c5 - pagination: - offset: 1 - limit: 2 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteFiltersNestedRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_FILTER - - property: /changeLog/createdDateTime - operator: ">" - values: - - 2025-03-28T04:12:36.607Z - - or: - - property: /name - operator: LIKE - values: - - "%Demo%" - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteFiltersResponse: - value: - pagination: - offset: 1 - limit: 2 - total: 10 - next: /search?offset=3&limit=2 - previous: /search?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: BGP_IPv4_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: BGP_IPv4_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 - additionalInfo: - - property: prefixMatch - reason: Invalid argument value passed - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - name: Private-subnet-filter - description: Test rule - prefix: 192.168.0.0/25 - prefixMatch: exact - - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: replace - path: /prefixMatch - value: - name: Private-subnet-filter - description: Test rule - prefix: 192.168.0.0/25 - prefixMatch: orlonger - - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: replace - path: /prefixMatch - value: - name: Private-subnet-filter - description: Test rule - prefix: 192.168.0.0/25 - prefixMatch: exact - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - name: Private-subnet-filter - description: Test rule - prefix: 192.168.0.0/25 - prefixMatch: exact - 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: BGP_IPv4_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: BGP_IPv4_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 - SearchRouteFilterRulesAndRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_FILTER_RULE - - property: /state - operator: = - values: - - PROVISIONED - - or: - - property: /name - operator: LIKE - values: - - "%Demo%" - - property: /name - operator: LIKE - values: - - "%Production%" - - or: - - property: /state - operator: = - values: - - PROVISIONED - - and: - - property: /prefix - operator: = - values: - - 192.168.2.0/24 - - property: /prefixMatch - operator: = - values: - - exact - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteFilterRulesOrRequest: - value: - filter: - or: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_FILTER_RULE - - property: /state - operator: = - values: - - PROVISIONED - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteFilterRulesResponse: - value: - pagination: - offset: 1 - limit: 2 - total: 10 - next: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/search?offset=3&limit=2 - previous: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/search?offset=0&limit=2 - 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: Route_Filter_Rule_Demo1 - description: Test rule1 - prefixMatch: exact - action: PERMIT - prefix: 192.168.10.0/24 - state: PROVISIONED - 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: Route_Filter_Rule_Demo2 - description: Test rule2 - prefixMatch: orlonger - action: PERMIT - prefix: 192.168.20.0/24 - state: PROVISIONED - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: replace - path: /name - value: - type: BGP_IPv4_PREFIX_AGGREGATION - name: My-route-aggregations-v4-updated - description: Test Aggregation - project: - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - 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 - SearchRouteAggregationsAndRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_AGGREGATION - - property: /state - operator: IN - values: - - PROVISIONED - - DEPROVISIONING - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteAggregationsOrRequest: - value: - filter: - or: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_AGGREGATION - - property: /name - operator: LIKE - values: - - "%Route_Aggregation_Demo%" - - property: /project/projectId - operator: IN - values: - - dadd3ab6-c0af-430c-8216-43d44f08c1c5 - - 8c1c5ab6-c0af-d44f-430c-43d44f08c1c5 - pagination: - offset: 1 - limit: 2 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteAggregationsNestedRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_AGGREGATION - - property: /changeLog/createdDateTime - operator: ">" - values: - - 2025-03-28T04:12:36.607Z - - or: - - property: /name - operator: LIKE - values: - - "%Demo%" - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteAggregationsResponse: - value: - pagination: - offset: 1 - limit: 2 - total: 10 - next: /search?offset=3&limit=2 - previous: /search?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: BGP_IPv4_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: BGP_IPv4_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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - 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 - createdDateTime: 2020-05-21T10:30:00Z - updatedBy: _system - updatedDateTime: 2020-05-21T10:30:00Z - data: - op: add - path: / - value: - 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: BGP_IPv4_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: BGP_IPv4_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 - SearchRouteAggregationRulesAndRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_AGGREGATION_RULE - - property: /state - operator: = - values: - - PROVISIONED - - or: - - property: /name - operator: LIKE - values: - - "%Demo%" - - property: /name - operator: LIKE - values: - - "%Production%" - - or: - - property: /prefix - operator: = - values: - - 192.168.2.0/24 - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteAggregationRulesOrRequest: - value: - filter: - or: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_AGGREGATION_RULE - - property: /state - operator: = - values: - - PROVISIONED - pagination: - offset: 0 - limit: 20 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - SearchRouteAggregationRulesResponse: - value: - pagination: - offset: 1 - limit: 2 - total: 10 - next: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/search?offset=3&limit=2 - previous: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/search?offset=0&limit=2 - 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: Route_Aggregation_Rule_Demo1 - description: Test rule1 - prefix: 192.168.10.0/24 - state: PROVISIONED - 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: Route_Aggregation_Rule_Demo2 - description: Test rule2 - prefix: 192.168.20.0/24 - state: PROVISIONED - 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. - 400_attached_to_gateway: - value: - - errorCode: EQ-3000039 - errorMessage: Gateway must be detached before deleting Fabric Cloud Router. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01586 - details: User must detach Gateway before deleting a Fabric Cloud Router. - 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 - UpdateTermLength: - value: - - op: replace - path: /order/termLength - value: 12 - UpdatePackageAndTermLength: - value: - - op: replace - path: /package/code - value: PREMIUM - - op: replace - path: /order/termLength - value: 12 - 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 - data: - - op: replace - path: /package/code - value: PREMIUM - - op: replace - path: /order/termLength - value: 12 - 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 - CloudRouterActionSearchResponse: - value: - pagination: - offset: 0 - limit: 1 - total: 2 - prev: null - next: null - data: - - href: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9 - uuid: 1e9414f1-763e-4c0a-86c6-0bc8336048d9 - type: RECEIVED_ROUTE_ENTRY_UPDATE - state: SUCCEEDED - connection: - href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 - uuid: 3066ab1d-af87-49d7-8a14-c9bdb57ac809 - type: IP_VC - operation: - bgpIpv4RoutesCount: 6 - bgpIpv6RoutesCount: 6 - distinctIpv4PrefixesCount: 4 - distinctIpv6PrefixesCount: 4 - changeLog: - createdDateTime: 2024-01-01T01:00:00Z - updatedDateTime: 2024-01-01T01:01:00Z - - href: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9 - uuid: 1e9414f1-763e-4c0a-86c6-0bc8336048d9 - type: ROUTE_TABLE_ENTRY_UPDATE - state: SUCCEEDED - router: - href: https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809 - uuid: 3066ab1d-af87-49d7-8a14-c9bdb57ac809 - type: XF_ROUTER - operation: - bgpIpv4RoutesCount: 6 - bgpIpv6RoutesCount: 6 - distinctIpv4PrefixesCount: 4 - distinctIpv6PrefixesCount: 4 - changeLog: - createdDateTime: 2024-01-01T01:00:00Z - updatedDateTime: 2024-01-01T01:01:00Z - RouteEntriesStatusUpdate: - value: - type: ROUTE_TABLE_ENTRY_UPDATE - ReceivedRouteEntriesStatusUpdate: - value: - type: RECEIVED_ROUTE_ENTRY_UPDATE - connection: - uuid: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - AdvertisedRouteEntriesStatusUpdate: - value: - type: ADVERTISED_ROUTE_ENTRY_UPDATE - connection: - uuid: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - CloudRouterActionResponse: - value: - type: ROUTE_TABLE_ENTRY_UPDATE - uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 - state: PENDING - changeLog: - createdDateTime: 2020-05-21T10:30:00Z - 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 - 108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms - 108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms - 108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms - 108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms - --- 8.8.8.8 ping statistics --- - 4 packets transmitted, 4 packets received, 0.0% packet loss - round-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 - PostRequestTracerouteCommand: - value: - type: TRACEROUTE_COMMAND - name: traceroute-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 - probes: 3 - hopsMax: 20 - 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 - PostResponseTracerouteCommand: - value: - href: https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00 - type: TRACEROUTE_COMMAND - uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 - name: traceroute-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 - probes: 3 - hopsMax: 20 - 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 - 108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms - 108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms - 108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms - 108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms - --- 8.8.8.8 ping statistics --- - 4 packets transmitted, 4 packets received, 0.0% packet loss - round-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 - 108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms - 108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms - 108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms - 108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms - --- 8.8.8.8 ping statistics --- - 4 packets transmitted, 4 packets received, 0.0% packet loss - round-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 - GetResponseTracerouteCommandWithError: - value: - href: https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00 - type: TRACEROUTE_COMMAND - uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 - name: traceroute-test-1 - description: Testing FCR-SV-1 - state: FAILED - project: - projectId: b11d4cb5-978a-418a-8b13-bf19abb97938 - request: - destination: 8.8.8.8 - sourceConnection: - uuid: 1da3778c-6aa3-4e47-b2fe-83a0773dde18 - timeout: 2 - probes: 3 - hopsMax: 20 - response: - errors: - - errorCode: EQ-3041105 - errorMessage: Request timeout. - correlationId: 86c57a79-06fb-4ba3-b496-5387f3b45380 - details: Request timeout after 480 seconds. - additionalInfo: - - reason: Request timeout after 480 seconds. - 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: - - 10.10.10.5 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - SearchFilterByPrefix: - value: - filter: - and: - - property: /prefix - operator: = - values: - - 192.168.10.0/24 - 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 - CloudRouterActiveRoutesSearchResponse: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - type: IPv4_BGP_ROUTE - protocolType: BGP - state: ACTIVE - prefix: 192.168.10.0/24 - nextHop: 10.10.10.5 - asPath: - - "20001" - changeLog: - createdBy: johnsmith - createdByFullName: John Smith - createdByEmail: john.smith@example.com - createdDateTime: 2020-11-06T07:00:00Z - updatedBy: johnsmith - updatedByFullName: John Smith - updatedByEmail: john.smith@example.com - updatedDateTime: 2020-11-06T07:00:00Z - deletedBy: johnsmith - deletedByFullName: John Smith - deletedByEmail: john.smith@example.com - deletedDateTime: 2020-11-06T07:00:00Z - 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 - CloudRouterSearchRouteFiltersRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_FILTER - - property: /direction - operator: = - values: - - INBOUND - - property: /attachmentStatus - operator: = - values: - - ATTACHED - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - CloudRouterSearchRouteFiltersResponse: - value: - pagination: - offset: 0 - limit: 20 - total: 2 - next: /search?offset=3&limit=2 - previous: /search?offset=0&limit=2 - data: - - href: https://api.equinix.com/fabric/v4/connections/57f82f8c-d899-4a21-93ae-5cfe33c50556/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d - type: BGP_IPv4_PREFIX_FILTER - uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - direction: INBOUND - attachmentStatus: ATTACHED - changeLog: - createdBy: testuser - createdDateTime: 2020-05-21T10:30:00Z - - href: https://api.equinix.com/fabric/v4/connections/500589e0-4196-4839-8d43-a0c073b4d747/routeFilters/4ed45b37-2b26-49de-ab35-4ad039586c7a - type: BGP_IPv4_PREFIX_FILTER - uuid: 4ed45b37-2b26-49de-ab35-4ad039586c7a - direction: INBOUND - attachmentStatus: ATTACHED - changeLog: - createdBy: testuser - createdDateTime: 2020-05-21T10:30:00Z - CloudRouterSearchRouteAggregationsRequest: - value: - filter: - and: - - property: /type - operator: = - values: - - BGP_IPv4_PREFIX_AGGREGATION - - property: /attachmentStatus - operator: = - values: - - ATTACHED - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - CloudRouterSearchRouteAggregationsResponse: - value: - pagination: - offset: 1 - limit: 2 - total: 10 - next: /search?offset=3&limit=2 - previous: /search?offset=0&limit=2 - data: - - href: https://api.equinix.com/fabric/v4/connections/57f82f8c-d899-4a21-93ae-5cfe33c50556/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d - type: BGP_IPv4_PREFIX_AGGREGATION - uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - attachmentStatus: ATTACHED - changeLog: - createdBy: testuser - createdDateTime: 2020-05-21T10:30:00Z - - href: https://api.equinix.com/fabric/v4/connections/500589e0-4196-4839-8d43-a0c073b4d747/routeAggregations/4ed45b37-2b26-49de-ab35-4ad039586c7a - type: BGP_IPv4_PREFIX_AGGREGATION - uuid: 4ed45b37-2b26-49de-ab35-4ad039586c7a - attachmentStatus: ATTACHED - changeLog: - createdBy: testuser - createdDateTime: 2020-05-21T10:30:00Z - 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: https://api.equinix.com/fabric/v4/health - version: "4.4" - release: 2022.4.0 - 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 - 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: http://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: http://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 - createdDateTime: 2025-03-03T19:37:29.326Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-03T19:21:43.145Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-03T19:43:20.145Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-03T20:52:23.469Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-03T19:21:43.145Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-03T20:55:57.858Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-05T21:17:46.656Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-05T20:57:07.206Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-05T21:22:30.984Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-05T21:37:08.370Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-06T00:23:29.030Z - links: - - href: http://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: http://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: http://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 - createdDateTime: 2025-03-06T00:30:42.972Z - links: - - href: http://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 - updatedBy: testuser - updatedDateTime: 2020-05-21T10:30:00Z - 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 - updatedBy: testuser - updatedDateTime: 2020-05-21T10:30:00Z - 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 - updatedBy: testuser1 - updatedDateTime: 2020-05-21T10:30:00Z - deletedBy: testuser1 - deletedDateTime: 2020-05-21T10:30:00Z - 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 - updatedBy: testuser - updatedDateTime: 2020-05-21T10:30:00Z - 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 - updatedBy: testuser1 - updatedDateTime: 2020-05-21T10:30:00Z - 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: PTP - 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: PTP - 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= - - type: HEX - keyNumber: 65535 - key: YTFhMWExYTFhMWExYTE= - 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= - - type: HEX - keyNumber: 65535 - key: YTFhMWExYTFhMWExYTE= - 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: PTP - 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: PTP - 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 - operation: - operationalStatus: UP - 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 - operation: - operationalStatus: UP - 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 - operation: - operationalStatus: UP - 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 - operation: - operationalStatus: UP - 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 - operation: - operationalStatus: UP - 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= - - type: HEX - keyNumber: 65535 - key: YTFhMWExYTFhMWExYTE= - 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 - operation: - operationalStatus: UP - 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= - - type: HEX - keyNumber: 65535 - key: YTFhMWExYTFhMWExYTE= - 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 - operation: - operationalStatus: UP - 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= - - type: HEX - keyNumber: 65535 - key: YTFhMWExYTFhMWExYTE= - 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 - operation: - operationalStatus: UP - 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 - operation: - operationalStatus: UP - 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: PTP - 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= - - type: HEX - keyNumber: 65535 - key: YTFhMWExYTFhMWExYTE= - 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: PTP - 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 - operation: - operationalStatus: UP - 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: YmFzZTY0X3ByaW50YWJsZV9rZXk= - - type: HEX - keyNumber: 65535 - key: YTFhMWExYTFhMWExYTE= - 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 - operation: - operationalStatus: UP - 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 - alertRulesCount: 3 - 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 - account: - accountNumber: 123456 - notifications: - - type: ALL - emails: - - johndoe@equinix.com - 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 - account: - accountNumber: 123456 - notifications: - - type: ALL - emails: - - johndoe@equinix.com - state: PROVISIONED - assetsCount: 1 - streamSubscriptionsCount: 2 - alertRulesCount: 3 - changeLog: - createdDateTime: 2024-05-06T16:21:18.545214Z - StreamSearchRequestExample: - value: - filter: - and: - - property: /project/projectId - operator: IN - values: - - 2f7f1a59-2dbf-43f8-b1a4-3c1f4e4b55b5 - - or: - - property: /uuid - operator: IN - values: - - 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 - - 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - - property: /state - operator: = - values: - - PROVISIONED - sort: - - direction: DESC - property: /changeLog/createdDateTime - pagination: - offset: 0 - limit: 20 - stream-search-all-example: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/streams/12f4d4a1-c7cb-4def-9f77-5ce93c19d999 - uuid: 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 - type: TELEMETRY_STREAM - name: stream-dev-01 - description: Observability stream for project assets - project: - projectId: 2f7f1a59-2dbf-43f8-b1a4-3c1f4e4b55b5 - state: PROVISIONED - assetsCount: 3 - streamSubscriptionsCount: 1 - alertRulesCount: 2 - changeLog: - createdDateTime: 2026-06-17T10:15:30Z - updatedDateTime: 2026-06-18T10:15:30Z - 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: /uuid - operator: IN - values: - - 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - - 9ac8ecfe-c7cb-4def-9f77-5ce93c19d83e - - property: /streamUuid - operator: = - values: - - 4719e319-65ae-4001-aabf-ca5f107b9b29 - - property: /attachmentStatus - operator: IN - values: - - ATTACHED - - ATTACHING - sort: - - direction: DESC - property: /uuid - pagination: - offset: 0 - limit: 20 - stream-asset-search-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 - streamUuid: e784aa26-8276-48b7-bb42-a6d9def0a424 - type: XF_PORT - metricsEnabled: false - attachmentStatus: ATTACHED - projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - 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 - StreamDeviceAssetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d - uuid: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d - type: VIRTUAL_DEVICE - metricsEnabled: true - attachmentStatus: ATTACHED - interfaces: - - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3 - id: 3 - uuid: 1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b - type: DATA - state: ASSIGNED - attachmentStatus: ATTACHED - - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5 - id: 5 - uuid: 4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d - type: DATA - state: ASSIGNED - attachmentStatus: ATTACHED - StreamDevicePutRequestExample: - value: - metricsEnabled: true - interfaces: - - id: 3 - - id: 5 - StreamDeviceAssetAttachResponseExample: - value: - href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d - uuid: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d - type: VIRTUAL_DEVICE - metricsEnabled: true - attachmentStatus: ATTACHING - interfaces: - - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3 - id: 3 - uuid: 1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b - type: DATA - state: ASSIGNED - attachmentStatus: ATTACHING - - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5 - id: 5 - uuid: 4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d - type: DATA - state: ASSIGNED - attachmentStatus: ATTACHING - StreamDeviceAssetDetachResponseExample: - value: - href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d - uuid: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d - type: VIRTUAL_DEVICE - metricsEnabled: true - attachmentStatus: DETACHING - interfaces: - - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3 - id: 3 - uuid: 1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b - type: DATA - state: ASSIGNED - attachmentStatus: DETACHING - - href: https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5 - id: 5 - uuid: 4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d - type: DATA - state: ASSIGNED - 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 - operation: - eventsDeliveredCount: 0 - metricsDeliveredCount: 0 - alertsDeliveredCount: 0 - errors: [] - changeLog: - createdDateTime: 2024-05-06T16:21:18.545214Z - StreamSubscriptionPostRequestExampleSimpleDefaultSplunk: - value: - type: STREAM_SUBSCRIPTION - name: splunk1 - description: subscription-1 - enabled: true - sink: - uri: https://http-inputs-.splunkcloud.com:/services/collector/event - 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://http-inputs-.splunkcloud.com:/services/collector/event - 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: https://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: https://.datadoghq.com - type: DATADOG - credential: - type: API_KEY - apiKey: my-api-key - settings: - source: Equinix - applicationKey: my-application-key - eventUri: https://.datadoghq.com/api/v1/events - metricUri: https://.datadoghq.com/api/v2/series - StreamSubscriptionPostRequestExampleDynatrace: - value: - type: STREAM_SUBSCRIPTION - name: dynatrace-subscription - description: subscription-1 - enabled: true - metricSelector: - include: - - equinix.fabric.connection.* - sink: - type: DYNATRACE - credential: - type: API_TOKEN - apiToken: - settings: - eventUri: https://.live.dynatrace.com/platform/ingest/v1/events - metricUri: https://.live.dynatrace.com/api/v2/metrics/ingest - 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 - StreamSubscriptionPostRequestExampleGenericWebhookNoAuth: - value: - type: STREAM_SUBSCRIPTION - name: webhook - description: subscription-1 - enabled: true - sink: - type: WEBHOOK - settings: - eventUri: https://xxxxxx - metricUri: https://xxxxxx - format: CLOUDEVENT - StreamSubscriptionPostRequestExampleGenericWebhookApiKey: - value: - type: STREAM_SUBSCRIPTION - name: webhook - description: subscription-1 - enabled: true - sink: - type: WEBHOOK - settings: - eventUri: https://xxxxxx - metricUri: https://xxxxxx - format: CLOUDEVENT - credential: - type: API_KEY - apiKey: - StreamSubscriptionPostRequestExampleGenericWebhookAccessToken: - value: - type: STREAM_SUBSCRIPTION - name: webhook - description: subscription-1 - enabled: true - sink: - type: WEBHOOK - settings: - eventUri: https://xxxxxx - metricUri: https://xxxxxx - format: CLOUDEVENT - credential: - type: ACCESS_TOKEN - accessToken: - StreamSubscriptionPostRequestExampleGenericWebhookUsernamePassword: - value: - type: STREAM_SUBSCRIPTION - name: webhook - description: subscription-1 - enabled: true - sink: - type: WEBHOOK - settings: - eventUri: https://xxxxxx - metricUri: https://xxxxxx - format: CLOUDEVENT - credential: - type: USERNAME_PASSWORD - username: - password: - StreamSubscriptionPostRequestExampleGrafanaWebhook: - value: - type: STREAM_SUBSCRIPTION - name: webhook - description: subscription-1 - enabled: true - metricSelector: - include: - - equinix.fabric.connection.* - sink: - type: WEBHOOK - settings: - eventUri: https:///otlp/v1/logs - metricUri: https:///otlp/v1/metrics - format: OPENTELEMETRY - credential: - type: API_KEY - apiKey: : - StreamSubscriptionPostRequestExampleGooglePubSub: - value: - type: STREAM_SUBSCRIPTION - name: gcp-pubsub - description: subscription-1 - enabled: true - metricSelector: - include: - - equinix.fabric.connection.* - sink: - type: GOOGLE_PUBSUB - uri: https://pubsub.googleapis.com/v1/projects//topics/:publish - credential: - type: ACCESS_TOKEN - accessToken: - 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://http-inputs-.splunkcloud.com:/services/collector/event - 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 - operation: - eventsDeliveredCount: 0 - metricsDeliveredCount: 0 - alertsDeliveredCount: 0 - errors: [] - changeLog: - createdDateTime: 2024-05-06T16:21:18.545214Z - StreamSubscriptionPutRequestExample: - 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: 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 - StreamSubscriptionSearchRequestExample: - value: - filter: - and: - - property: /streamUuid - operator: = - values: - - 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 - - or: - - property: /uuid - operator: = - values: - - 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - - property: /name - operator: ILIKE - values: - - demo% - sort: - - direction: DESC - property: /changeLog/createdDateTime - pagination: - offset: 0 - limit: 20 - stream-subscription-search-all-example: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/streams/12f4d4a1-c7cb-4def-9f77-5ce93c19d999/subscriptions/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - uuid: 8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d - type: STREAM_SUBSCRIPTION - name: demo-subscription - description: Subscription for demo stream events - state: PROVISIONED - enabled: true - metricSelector: - include: - - equinix.fabric.connection.* - eventSelector: - include: - - equinix.fabric.connection.* - sink: - uri: https://hooks.example.com/fabric - type: WEBHOOK - batchEnabled: false - batchSizeMax: 50 - batchWaitTimeMax: 5 - operation: - eventsDeliveredCount: 12 - metricsDeliveredCount: 4 - alertsDeliveredCount: 0 - errors: [] - changeLog: - createdDateTime: 2026-06-17T10:15:30Z - updatedDateTime: 2026-06-18T10:15:30Z - 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 - metricSelector: - include: - - equinix.fabric.connection.bandwidth_tx.usage - resourceSelector: - include: - - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b - detectionMethod: - type: THRESHOLD - windowSize: PT15M - operand: ABOVE - warningThreshold: "35000000" - criticalThreshold: "45000000" - changeLog: - createdBy: user - createdDateTime: 2024-05-06T16:21:18.545214Z - StreamAlertRulePostRequestExample: - value: - name: metric-alert-1 - type: METRIC_ALERT - description: metric-alert-1 - enabled: true - metricSelector: - include: - - equinix.fabric.connection.bandwidth_tx.usage - resourceSelector: - include: - - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b - detectionMethod: - type: THRESHOLD - windowSize: PT15M - warningThreshold: "35000000" - criticalThreshold: "45000000" - StreamSmartAlertRulePostRequestExample: - value: - name: metric-alert-1 - type: METRIC_ALERT - description: metric-alert-1 - enabled: true - metricSelector: - include: - - equinix.fabric.metro.sv_sy.latency - resourceSelector: - include: - - /fabric/v4/metros/SV - detectionMethod: - type: OUTLIER - 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 - metricSelector: - include: - - equinix.fabric.connection.bandwidth_tx.usage - resourceSelector: - include: - - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b - detectionMethod: - type: THRESHOLD - 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 - type: METRIC_ALERT - description: metric-alert-1 - enabled: true - metricSelector: - include: - - equinix.fabric.connection.bandwidth_tx.usage - resourceSelector: - include: - - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b - detectionMethod: - type: THRESHOLD - windowSize: PT15M - operand: ABOVE - 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 - metricSelector: - include: - - equinix.fabric.connection.bandwidth_tx.usage - resourceSelector: - include: - - /fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b - detectionMethod: - type: THRESHOLD - 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 - DeploymentCreate: - value: - type: TOPOLOGY_DEPLOYMENT - name: MCN-Deployment - description: FCR and AWS DGW Deployment in DC - topology: - uuid: 3d4cfd38-5f56-4f71-b3e4-5f44631f1b2a - providers: - - type: FABRIC_PROVIDER - resources: - - type: XF_ROUTER - name: router-1 - location: - metroCode: DC - package: - code: LAB - deploymentProperties: - elementId: 13fc5d30-036d-11f0-96a3-5336ee83f43f - - type: XF_ROUTER - uuid: 9e0f9cf0-6584-41d3-933b-e8d7c5b88450 - deploymentProperties: - elementId: f29757aa-ae8a-4170-9acf-7b2176bdbe49 - - type: IP_VC - bandwidth: 50 - name: My connection to router1 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: CLOUD_ROUTER - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - sellerRegion: us-east-1 - authenticationKey: 12345678923 - deploymentProperties: - elementId: adbad8be-10d7-42d5-ab85-066d1c8a8259 - dependsOn: - - 13fc5d30-036d-11f0-96a3-5336ee83f43f - - type: IP_VC - bandwidth: 50 - name: My connection to router2 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: CLOUD_ROUTER - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - sellerRegion: us-east-1 - authenticationKey: 12345678923 - deploymentProperties: - elementId: 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - f29757aa-ae8a-4170-9acf-7b2176bdbe49 - - type: BGP - bgpIpv4: - equinixip: 192.168.100.1/30 - customerip: 192.168.100.2 - enabled: true - bgpAuthKey: xxxxxxx - customerAsn: 65333 - asOverrideEnabled: true - deploymentProperties: - elementId: 3184e34a-69ba-4821-aa54-1e66a8a6672e - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - type: BGP - bgpIpv4: - equinixip: 192.168.100.5/30 - customerip: 192.168.100.6 - enabled: true - bgpAuthKey: xxxxxxx - customerAsn: 65334 - asOverrideEnabled: true - deploymentProperties: - elementId: 2194e34a-69ba-4821-aa54-1e66a8a6672e - dependsOn: - - 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - - type: IPWAN - name: ipwan-1 - scope: REGIONAL - location: - region: AMER - deploymentProperties: - elementId: 074fcae4-a679-4f0b-b6ba-cb00bd491048 - - type: IPWAN_VC - bandwidth: 50 - name: My connection from router1 to ipwan - deploymentProperties: - elementId: 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - 074fcae4-a679-4f0b-b6ba-cb00bd491048, 13fc5d30-036d-11f0-96a3-5336ee83f43f - - type: IPWAN_VC - bandwidth: 50 - name: My connection from router2 to ipwan - deploymentProperties: - elementId: 468cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - 074fcae4-a679-4f0b-b6ba-cb00bd491048, f29757aa-ae8a-4170-9acf-7b2176bdbe49 - - type: AWS_PROVIDER - resources: - - type: PERMISSION - roleArn: arn:aws:iam:::role/ - region: us-east-1 - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f48 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - type: DIRECT_CONNECT - uuid: c3af0941-b4e1-45d3-b961-8fc50768fcfb - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f46 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - c2a3d2ec-265a-41af-b72d-fded5a371f48 - - type: VIRTUAL_PRIVATE_GATEWAY - required: true/false - vpcId: c0c68cc5-6e7f-43d3-a322-afdac89038d7 - subnetId: c3af0941-b4e1-45d3-b961-8fc50768fcfb - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f45 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - c2a3d2ec-265a-41af-b72d-fded5a371f48 - project: - projectId: ad444dd7-1144-47db-bacc-bab4d313222d - account: - accountNumber: 346346456 - order: - purchaseOrderNumber: PO345346534563 - termLength: 12 - notifications: - - type: ALL - emails: - - test@test.com - DeploymentPostResponse: - value: - href: https://api.equinix.com/fabric/v4/deployments/8c9dfc8d-b32b-44a4-aa2e-e3dcc3c7fdac - type: TOPOLOGY_DEPLOYMENT - uuid: 8c9dfc8d-b32b-44a4-aa2e-e3dcc3c7fdac - name: MCN-Deployment - state: PENDING - description: FCR and AWS DGW Deployment in DC - topology: - uuid: 3d4cfd38-5f56-4f71-b3e4-5f44631f1b2a - providers: - - type: FABRIC_PROVIDER - resources: - - type: XF_ROUTER - deploymentProperties: - elementId: 13fc5d30-036d-11f0-96a3-5336ee83f43f - - href: https://api.equinix.com/fabric/v4/routers/9e0f9cf0-6584-41d3-933b-e8d7c5b88450 - type: XF_ROUTER - uuid: 9e0f9cf0-6584-41d3-933b-e8d7c5b88450 - deploymentProperties: - elementId: f29757aa-ae8a-4170-9acf-7b2176bdbe49 - dependsOn: [] - - type: IP_VC - bandwidth: 50 - state: PROVISIONING - name: My connection to router1 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: CLOUD_ROUTER - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - sellerRegion: us-east-1 - authenticationKey: 12345678923 - deploymentProperties: - elementId: adbad8be-10d7-42d5-ab85-066d1c8a8259 - dependsOn: - - 13fc5d30-036d-11f0-96a3-5336ee83f43f - - type: IP_VC - uuid: 31f5251c-8142-45b7-b566-76ae345d81ef - bandwidth: 50 - state: PROVISIONING - name: My connection to router2 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: CLOUD_ROUTER - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - sellerRegion: us-east-1 - authenticationKey: 12345678923 - deploymentProperties: - elementId: 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - f29757aa-ae8a-4170-9acf-7b2176bdbe49 - - type: BGP - bgpIpv4: - equinixip: 192.168.100.1/30 - customerip: 192.168.100.2 - enabled: true - bgpAuthKey: xxxxxxx - customerAsn: 65333 - asOverrideEnabled: true - deploymentProperties: - elementId: 3184e34a-69ba-4821-aa54-1e66a8a6672e - dependsOn: - - e40def8d-b067-4a94-8a67-e6caa5fa41b3 - - type: BGP - bgpIpv4: - equinixip: 192.168.100.5/30 - customerip: 192.168.100.6 - enabled: true - bgpAuthKey: xxxxxxx - customerAsn: 65334 - asOverrideEnabled: true - deploymentProperties: - elementId: 2194e34a-69ba-4821-aa54-1e66a8a6672e - dependsOn: - - 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - - href: https://api.equinix.com/fabric/v4/networks/6658cc3b-18e0-437c-b972-62b51a419a1e - type: IPWAN - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - name: ipwan-1 - scope: REGIONAL - state: PROVISIONING - location: - region: AMER - deploymentProperties: - elementId: 074fcae4-a679-4f0b-b6ba-cb00bd491048 - - href: https://api.equinix.com/fabric/v4/connections/8548cc3b-18e0-437c-b972-62b51a419a11 - type: IPWAN_VC - uuid: 8548cc3b-18e0-437c-b972-62b51a419a11 - bandwidth: 50 - name: My connection from router1 to ipwan - state: PROVISIONING - deploymentProperties: - elementId: 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - 074fcae4-a679-4f0b-b6ba-cb00bd491048 - - 13fc5d30-036d-11f0-96a3-5336ee83f43f - - href: https://api.equinix.com/fabric/v4/connections/2348cc3b-18e0-437c-b972-62b51a419a1f - type: IPWAN_VC - uuid: 2348cc3b-18e0-437c-b972-62b51a419a1f - bandwidth: 50 - name: My connection from router2 to ipwan - state: PROVISIONING - deploymentProperties: - elementId: 468cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - 074fcae4-a679-4f0b-b6ba-cb00bd491048 - - f29757aa-ae8a-4170-9acf-7b2176bdbe49 - - type: AWS_PROVIDER - resources: - - type: PERMISSION - roleArn: arn:aws:iam:::role/ - region: us-east-1 - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f48 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - type: DIRECT_CONNECT - uuid: c3af0941-b4e1-45d3-b961-8fc50768fcfb - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f46 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - c2a3d2ec-265a-41af-b72d-fded5a371f48 - - type: VIRTUAL_PRIVATE_GATEWAY - required: true - vpcId: c0c68cc5-6e7f-43d3-a322-afdac89038d7 - subnetId: c3af0941-b4e1-45d3-b961-8fc50768fcfb - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f45 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - c2a3d2ec-265a-41af-b72d-fded5a371f48 - project: - projectId: ad444dd7-1144-47db-bacc-bab4d313222d - account: - accountNumber: 346346456 - order: - purchaseNumber: PO345346534563 - termLength: 12 - notifications: - - type: ALL - emails: - - test@test.com - Orchestrator_400_InvalidName: - value: - - errorCode: EQ-8020022 - errorMessage: Name is minimum 0 and up to 50 characters in length - correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e - details: Name is minimum 0 and up to 50 characters in length - additionalInfo: - - property: /name - reason: Name is minimum 0 and up to 50 characters in length - Orchestrator_401: - value: - - errorCode: EQ-8020001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - Orchestrator_403: - value: - - errorCode: EQ-8020002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - Orchestrator_404: - value: - - errorCode: EQ-8020020 - errorMessage: Deployement not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: Deployement not found or already deleted - Orchestrator_500: - value: - - errorCode: EQ-8020030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - DeploymentGet: - value: - href: https://api.equinix.com/fabric/v4/deployments/8c9dfc8d-b32b-44a4-aa2e-e3dcc3c7fdac - type: TOPOLOGY_DEPLOYMENT - uuid: 8c9dfc8d-b32b-44a4-aa2e-e3dcc3c7fdac - name: MCN-Deployment - state: PROVISIONED - description: FCR and AWS DGW Deployment in DC - providers: - - type: FABRIC_PROVIDER - resources: - - href: https://api.equinix.com/fabric/v4/routers/1479d681-a7f5-4ea9-9495-9f54c4ca2ec4 - type: XF_ROUTER - uuid: 1479d681-a7f5-4ea9-9495-9f54c4ca2ec4 - deploymentProperties: - elementId: 13fc5d30-036d-11f0-96a3-5336ee83f43f - dependsOn: [] - - href: https://api.equinix.com/fabric/v4/routers/9e0f9cf0-6584-41d3-933b-e8d7c5b88450 - type: XF_ROUTER - uuid: 9e0f9cf0-6584-41d3-933b-e8d7c5b88450 - deploymentProperties: - elementId: f29757aa-ae8a-4170-9acf-7b2176bdbe49 - dependsOn: [] - - href: https://api.equinix.com/fabric/v4/connections/21d5251c-8142-45b7-b566-76ae345d81ee - type: IP_VC - uuid: 21d5251c-8142-45b7-b566-76ae345d81ee - bandwidth: 50 - state: PROVISIONING - name: My connection to router1 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: CLOUD_ROUTER - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - sellerRegion: us-east-1 - authenticationKey: 12345678923 - deploymentProperties: - elementId: adbad8be-10d7-42d5-ab85-066d1c8a8259 - dependsOn: - - 13fc5d30-036d-11f0-96a3-5336ee83f43f - - href: https://api.equinix.com/fabric/v4/connections/31f5251c-8142-45b7-b566-76ae345d81ef - type: IP_VC - uuid: 31f5251c-8142-45b7-b566-76ae345d81ef - bandwidth: 50 - state: PROVISIONING - name: My connection to router2 - redundancy: - priority: PRIMARY - aSide: - accessPoint: - type: CLOUD_ROUTER - zSide: - accessPoint: - type: SP - profile: - type: L2_PROFILE - uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c - location: - metroCode: DC - sellerRegion: us-east-1 - authenticationKey: 12345678923 - deploymentProperties: - elementId: 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - f29757aa-ae8a-4170-9acf-7b2176bdbe49 - - type: BGP - bgpIpv4: - equinixip: 192.168.100.1/30 - customerip: 192.168.100.2 - enabled: true - bgpAuthKey: xxxxxxx - customerAsn: 65333 - asOverrideEnabled: true - deploymentProperties: - elementId: 3184e34a-69ba-4821-aa54-1e66a8a6672e - dependsOn: - - e40def8d-b067-4a94-8a67-e6caa5fa41b3 - - type: BGP - bgpIpv4: - equinixip: 192.168.100.5/30 - customerip: 192.168.100.6 - enabled: true - bgpAuthKey: xxxxxxx - customerAsn: 65334 - asOverrideEnabled: true - deploymentProperties: - elementId: 2194e34a-69ba-4821-aa54-1e66a8a6672e - dependsOn: - - 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - - href: https://api.equinix.com/fabric/v4/networks/6658cc3b-18e0-437c-b972-62b51a419a1e - type: IPWAN - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - name: ipwan-1 - scope: REGIONAL - state: PROVISIONING - location: - region: AMER - deploymentProperties: - elementId: 074fcae4-a679-4f0b-b6ba-cb00bd491048 - - href: https://api.equinix.com/fabric/v4/connections/8548cc3b-18e0-437c-b972-62b51a419a11 - type: IPWAN_VC - uuid: 8548cc3b-18e0-437c-b972-62b51a419a11 - bandwidth: 50 - name: My connection from router1 to ipwan - state: PROVISIONING - deploymentProperties: - elementId: 367cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - 074fcae4-a679-4f0b-b6ba-cb00bd491048 - - 13fc5d30-036d-11f0-96a3-5336ee83f43f - - href: https://api.equinix.com/fabric/v4/connections/2348cc3b-18e0-437c-b972-62b51a419a1f - type: IPWAN_VC - uuid: 2348cc3b-18e0-437c-b972-62b51a419a1f - bandwidth: 50 - name: My connection from router2 to ipwan - state: PROVISIONING - deploymentProperties: - elementId: 468cd6d7-eb88-43b0-bf66-dae6eb2e18b9 - dependsOn: - - 074fcae4-a679-4f0b-b6ba-cb00bd491048 - - f29757aa-ae8a-4170-9acf-7b2176bdbe49 - - type: AWS_PROVIDER - resources: - - type: PERMISSION - roleArn: arn:aws:iam:::role/ - region: us-east-1 - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f48 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - type: DIRECT_CONNECT - uuid: c3af0941-b4e1-45d3-b961-8fc50768fcfb - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f46 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - c2a3d2ec-265a-41af-b72d-fded5a371f48 - - type: VIRTUAL_PRIVATE_GATEWAY - required: true - vpcId: c0c68cc5-6e7f-43d3-a322-afdac89038d7 - subnetId: c3af0941-b4e1-45d3-b961-8fc50768fcfb - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f45 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - - c2a3d2ec-265a-41af-b72d-fded5a371f48 - project: - projectId: ad444dd7-1144-47db-bacc-bab4d313222d - account: - accountNumber: 346346456 - order: - purchaseNumber: PO345346534563 - termLength: 12 - notifications: - - type: ALL - emails: - - test@test.com - Orchestrator_400_InvalidState: - value: - - errorCode: EQ-8020030 - errorMessage: Cannot delete Deployment in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete Deployment in transient state. - DeploymentActions: - value: - type: DEPLOY - data: - - type: PERMISSION - roleArn: arn:aws:iam:::role/ - region: us-east-1 - deploymentProperties: - elementId: c2a3d2ec-265a-41af-b72d-fded5a371f48 - dependsOn: - - adbad8be-10d7-42d5-ab85-066d1c8a8259 - ProviderResourcesSearch: - value: - filter: - and: - - property: /providers/type - operator: = - values: - - AWS_PROVIDER - - property: /providers/oidcCredentials/roleArn - operator: = - values: - - arn:aws:iam:::role/ - - property: /providers/oidcCredentials/region - operator: = - values: - - us-east-1 - - property: /providers/resources/type - operator: = - values: - - DIRECT_CONNECT - - VPC - - SUBNET - IssueLoaOnCageWithCageId: - value: - type: CAGE_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - expirationDateTime: 2026-12-31T23:59:59Z - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - demarcationPoint: - cageUniqueSpaceId: AM7:0G:0202 - IssueLoaOnPatchPanelPort: - value: - type: PATCH_PANEL_PORT_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for patch panel port access to Equinix at SV1 - authorizedProductType: XC - expirationDateTime: 2026-12-31T23:59:59Z - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 23 - patchPanelPortB: 24 - connectorType: SC - IssueLoaOnPatchPanel: - value: - type: PATCH_PANEL_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for patch panel access to Equinix at SV1 - authorizedProductType: XC - expirationDateTime: 2026-12-31T23:59:59Z - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - RequestLoaOnCage: - value: - type: CAGE_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for patch panel port access to Equinix at SV1 - authorizedProductType: XC - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - location: - ibxCode: SV11 - RequestLoaOnPatchPanel: - value: - type: PATCH_PANEL_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for patch panel port access to Equinix at SV1 - authorizedProductType: XC - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - location: - ibxCode: SV11 - RequestLoaOnPatchPanelPort: - value: - type: PATCH_PANEL_PORT_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for patch panel port access to Equinix at SV1 - authorizedProductType: XC - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - location: - ibxCode: SV11 - LoaCreateResponseByRequestor: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: PATCH_PANEL_PORT_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - state: PENDING_AUTHORIZATION - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - location: - ibxCode: SV1 - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org1.com - LoaCreateResponseByIssuerWithCageType: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: CAGE_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - state: PENDING_ACCEPTANCE - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - demarcationPoint: - cageUniqueSpaceId: SV1:01:10:200 - location: - ibxCode: SV1 - changeLog: - createdDateTime: 2025-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - LoaCreateResponseByIssuerWithPatchPanelPortType: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: PATCH_PANEL_PORT_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - state: PENDING_ACCEPTANCE - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 23 - patchPanelPortB: 23 - connectorType: SC - location: - ibxCode: SV1 - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - LoaCreateResponseByIssuerWithPatchPanelType: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: PATCH_PANEL_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - state: PENDING_ACCEPTANCE - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - location: - ibxCode: SV1 - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - Loa_400: - value: - - errorCode: EQ-3070103 - errorMessage: Loa does not exist. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - additionalInfo: - - property: uuid - reason: Loa does not exist. Please check Loa UUID - Loa_401: - value: - - errorCode: EQ-3070106 - errorMessage: User not found in request or invalid. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - Loa_403: - value: - - errorCode: EQ-3070102 - errorMessage: Operation not allowed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: Operation not allowed for current user - Loa_404: - value: - - errorCode: EQ-3070101 - errorMessage: Loa not found - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: uuid - reason: Loa does not exist. Please check Loa UUID - Loa_500: - value: - - errorCode: EQ-3070104 - errorMessage: Internal Server Error - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: An unexpected error occurred while processing the request - LoaResponse: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: PATCH_PANEL_PORT_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - state: INACTIVE - expirationDateTime: 2024-12-31T23:59:59Z - operation: - consumersCount: 10 - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - demarcationPoint: - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0105 - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 23 - patchPanelPortB: 23 - connectorType: SC - location: - ibxCode: SV1 - changeLog: - createdDateTime: 2025-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - LoaPatchRequest: - value: - - op: replace - path: /demarcationPoint/patchPanelId - value: CP:Demarc:1259685 - LoaPatchResponse: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: PATCH_PANEL_PORT_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - state: INACTIVE - operation: - consumersCount: 1 - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 23 - patchPanelPortB: 23 - connectorType: SC - location: - ibxCode: SV1 - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - AuthorizeLoaActionRequest: - value: - type: LOA_ISSUER_AUTHORIZATION - data: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 23 - patchPanelPortB: 23 - connectorType: SC - expirationDateTime: 2026-08-07T07:00:00Z - AcceptLoaActionRequest: - value: - type: LOA_REQUESTOR_ACCEPTANCE - CopyLoaActionRequest: - value: - type: LOA_COPY_LINK - SendLoaActionRequest: - value: - type: LOA_SEND_EMAIL_NOTIFICATION - CancelLoaActionRequest: - value: - type: LOA_CANCEL - AuthorizeLoaActionResponse: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: LOA_ISSUER_AUTHORIZATION - state: COMPLETED - data: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 23 - patchPanelPortB: 23 - connectorType: SC - expirationDateTime: 2026-08-07T07:00:00Z - changeLog: - createdDateTime: 2026-06-24T06:50:46Z - createdBy: user - createdByEmail: user@org1.com - AcceptLoaActionResponse: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: LOA_REQUESTOR_ACCEPTANCE - state: COMPLETED - changeLog: - createdDateTime: 2025-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - SendLoaActionResponse: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: LOA_SEND_EMAIL_NOTIFICATION - state: COMPLETED - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - CopyLoaActionResponse: - value: - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: LOA_COPY_LINK - state: COMPLETED - data: - portalUrl: https://portal.equinix.com/fabric/loa/inventory/issuer/29cc7878-54e3-4e1a-8651-87a61354bac2/authorize - changeLog: - createdDateTime: 2026-06-24T06:50:46Z - createdBy: user - createdByEmail: user@org1.com - Loa_Action_400: - value: - - errorCode: EQ-3070107 - errorMessage: Loa Action does not exist. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - additionalInfo: - - property: uuid - reason: Loa Action does not exist. Please check Loa UUID - Loa_Action_404: - value: - - errorCode: EQ-3070101 - errorMessage: Loa Action not found - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: uuid - reason: Loa 3070101 does not exist. Please check Loa UUID - LoaSearchByNameWithType: - summary: A named loa of a given type - value: - filter: - and: - - property: /name - operator: ILIKE - values: - - LOA-Equinix-SV1 - - property: /type - operator: = - values: - - PATCH_PANEL_PORT_LOA - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - LoaSearchStateWithPartnerOrIbx: - summary: Partial match on state with partner name or with ibx code - value: - filter: - and: - - property: /state - operator: = - values: - - PENDING_ACCEPTANCE - - or: - - property: /requestor/orgName - operator: ILIKE - values: - - abc - - property: /location/ibxCode - operator: ILIKE - values: - - MB - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - LoaSearchResponse: - value: - pagination: - offset: 0 - limit: 25 - total: 1 - sort: - - property: /changeLog/createdDateTime - direction: DESC - data: - - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: PATCH_PANEL_PORT_LOA - name: LOA-Equinix-SV1-2026 - description: Authorization for cage access to Equinix at SV1 - authorizedProductType: XC - state: INACTIVE - expirationDateTime: 2026-12-31T23:59:59Z - operation: - consumersCount: 1 - requestor: - email: user@org1.com - orgId: 95900 - orgName: organizationName1 - issuer: - email: user@org2.com - orgId: 95901 - orgName: organizationName2 - demarcationPoint: - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0105 - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 23 - patchPanelPortB: 23 - connectorType: SC - location: - ibxCode: SV1 - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - LoaActionSearchByActionType: - value: - filter: - and: - - property: /type - operator: = - values: - - LOA_REQUESTOR_ACCEPTANCE - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/createdDateTime - direction: DESC - LoaSearchActionResponse: - value: - pagination: - offset: 0 - limit: 25 - total: 1 - sort: - - property: /changeLog/createdDateTime - direction: DESC - data: - - href: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: LOA_ISSUER_AUTHORIZATION - state: COMPLETED - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: user - createdByEmail: user@org2.com - LoaConsumersResponse: - value: - pagination: - offset: 0 - limit: 25 - total: 2 - data: - - href: https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2 - uuid: 29cc7878-54e3-4e1a-8651-87a61354bac2 - type: XF_PORT - changeLog: - createdDateTime: 2025-07-24T06:50:46Z - - href: https://api.equinix.com/fabric/v4/ports/b7e14c2d-93f8-4a61-8d5b-c29f71e4a306 - uuid: b7e14c2d-93f8-4a61-8d5b-c29f71e4a306 - type: XF_PORT - changeLog: - createdDateTime: 2025-07-26T06:50:46Z - LoaNotesResponse: - value: - data: - - type: ISSUER - href: https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - comments: test note from issuer - createdDateTime: 2026-07-24T06:50:46Z - - type: REQUESTOR - href: https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/a41f485e-3094-42de-8797-0ef19a51df81 - uuid: a41f485e-3094-42de-8797-0ef19a51df81 - comments: test note from requestor - createdDateTime: 2026-07-25T06:50:46Z - LoaNoteRequest: - value: - comments: LOA under review by our team. Expected response within 2 business days. - CreateLoaNoteResponse: - value: - type: ISSUER - href: https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - comments: LOA under review by our team. Expected response within 2 business days. - createdDateTime: 2026-06-24T06:50:46Z - StandardCrossConnectRequest: - summary: Standard Cross Connect - description: Minimal Cross Connect request with only the required fields. - value: - type: XC - name: My-CC-service - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 12 - patchPanelPortB: 24 - connectorType: SC - schedule: - code: STANDARD - requestedDateTime: 2026-02-27T07:21:39Z - StandardCCWithServicesRequest: - summary: Standard Cross Connect With Services - description: Standard Cross Connect with additional services - link light verification and patch equipment. - value: - type: XC - name: My-CC-service - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 12 - patchPanelPortB: 24 - connectorType: SC - schedule: - code: STANDARD - requestedDateTime: 2026-02-27T07:21:39Z - services: - - type: XC_LINK_LIGHT_VERIFICATION - - type: XC_PATCH_EQUIPMENT - device: - cabinetUniqueSpaceId: SV2:00:000000:0100 - port: 32 - connectorType: SC - description: device description - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - customerReferenceId: "12345" - StandardCCByPatchPanelRequest: - summary: Standard Cross Connect By Patch Panel - description: Standard Cross Connect using patch panel demarcation points on both sides. - value: - type: XC - name: My-CC-service - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 12 - patchPanelPortB: 24 - connectorType: SC - schedule: - code: STANDARD - requestedDateTime: 2026-02-27T07:21:39Z - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - purchaseOrder: - number: "1233" - amount: "10000" - startDate: 2026-02-26 - endDate: 2027-02-26 - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - type: NEW - customerReferenceId: "12345" - notes: - - comments: test note - attachments: - - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - StandardCCByLoaRequest: - summary: Standard Cross Connect By LOA - description: Standard Cross Connect where the z-side is specified via a Letter of Authorization. - value: - type: XC - name: My-CC-service - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - zSide: - loa: - uuid: c61f485e-3094-42de-8797-0ef19a51df79 - schedule: - code: STANDARD - requestedDateTime: 2026-02-27T07:21:39Z - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - customerReferenceId: "12345" - notes: - - comments: test note - attachments: - - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - ExtendedCCEquinixManagedRequest: - summary: Extended Cross Connect Equinix Managed - description: "Extended Cross Connect with Equinix-managed meet-me room (bmmrType: EQUINIX)." - value: - type: XC - name: My-CC-service - bmmrType: EQUINIX - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - zSide: - location: - ibxCode: SV11 - loa: - uuid: c61f485e-3094-42de-8797-0ef19a51df79 - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - customerReferenceId: "12345" - notes: - - comments: test note - attachments: - - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - ExtendedCCSelfManagedRequest: - summary: Extended Cross Connect Self Managed - description: "Extended Cross Connect with self-managed meet-me room (bmmrType: SELF)." - value: - type: XC - name: My-CC-service - bmmrType: SELF - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - zSide: - location: - ibxCode: SV11 - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - customerReferenceId: "12345" - notes: - - comments: test note - attachments: - - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - DiverseWithExistingCCRequest: - summary: Diverse with Existing Cross Connect - description: Add a SECONDARY Cross Connect to an existing PRIMARY by providing the PRIMARY's redundancy group identifier, or its serial number, as the redundancy group. - value: - type: XC - name: My-CC-service-SEC - redundancy: - priority: SECONDARY - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 14 - patchPanelPortB: 15 - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 22 - patchPanelPortB: 23 - connectorType: SC - schedule: - code: STANDARD - requestedDateTime: 2026-02-27T07:21:39Z - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - customerReferenceId: "12345" - StandardCCByPatchPanelResponse: - summary: Standard Cross Connect By Patch Panel - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - name: My-CC-service - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - state: PROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 45 - patchPanelPortB: 32 - connectorType: SC - cageUniqueSpaceId: SV2:00:000000 - cabinetUniqueSpaceId: SV2:00:000000:0100 - location: - ibxCode: SV1 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - StandardCCByLoaResponse: - summary: Standard Cross Connect By LOA - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - name: My-CC-service - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - state: PROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - loa: - href: https://api.equinix.com/fabric/v4/loas/b51f485e-3094-42de-8797-0ef19a51df79 - uuid: c61f485e-3094-42de-8797-0ef19a51df79 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - ExtendedCCEquinixManagedResponse: - summary: Extended Cross Connect Equinix Managed - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - name: My-CC-service - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - bmmrType: EQUINIX - state: PROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV11 - loa: - href: https://api.equinix.com/fabric/v4/loas/c61f485e-3094-42de-8797-0ef19a51df79 - uuid: c61f485e-3094-42de-8797-0ef19a51df79 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - ExtendedCCSelfManagedResponse: - summary: Extended Cross Connect Self Managed - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - name: My-CC-service - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - bmmrType: SELF - state: PROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - location: - ibxCode: SV11 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - DiverseWithExistingCCResponse: - summary: Diverse with Existing Cross Connect - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - name: My-CC-service-SEC - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - state: PROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: SECONDARY - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 14 - patchPanelPortB: 15 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 22 - patchPanelPortB: 23 - connectorType: SC - cageUniqueSpaceId: SV2:00:000000 - cabinetUniqueSpaceId: SV2:00:000000:0100 - location: - ibxCode: SV1 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - CrossConnect_400: - value: - - errorCode: EQ-3071100 - errorMessage: Bad request. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - additionalInfo: - - property: type - reason: Cross Connect type is required. - CrossConnect_401: - value: - - errorCode: EQ-3071101 - errorMessage: User not found in request or invalid. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - CrossConnect_403: - value: - - errorCode: EQ-3071102 - errorMessage: Operation not allowed. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - additionalInfo: - - property: projectId - reason: User does not have access to the specified project. - CrossConnect_404: - value: - - errorCode: EQ-3071103 - errorMessage: Cross Connect does not exist. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - additionalInfo: - - property: uuid - reason: Cross Connect does not exist. Please check Cross Connect UUID. - CrossConnect_500: - value: - - errorCode: EQ-3071199 - errorMessage: Internal server error. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - DiverseCCPairRequest: - summary: Diverse pair - description: Two Cross Connects placed at the same time on separate patch panels - one PRIMARY and one SECONDARY. - value: - data: - - type: XC - name: My-CC-service-PRI - redundancy: - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 12 - patchPanelPortB: 24 - connectorType: SC - schedule: - code: STANDARD - requestedDateTime: 2026-02-27T07:21:39Z - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - customerReferenceId: "12345" - - type: XC - name: My-CC-service-SEC - redundancy: - priority: SECONDARY - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 14 - patchPanelPortB: 15 - connectorType: SC - zSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 22 - patchPanelPortB: 23 - connectorType: SC - schedule: - code: STANDARD - requestedDateTime: 2026-02-27T07:21:39Z - notifications: - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - order: - customerReferenceId: "12345" - DiverseCCPairResponse: - summary: Diverse Cross Connect Pair - value: - data: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - name: My-CC-service-PRI - state: PROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 12 - patchPanelPortB: 24 - connectorType: SC - cageUniqueSpaceId: SV2:00:000000 - cabinetUniqueSpaceId: SV2:00:000000:0100 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603 - type: XC - uuid: a6f77b33-96c6-4eeb-8d79-76374d950603 - name: My-CC-service-SEC - state: PROVISIONING - serialNumber: "234567891" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: SECONDARY - aSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 14 - patchPanelPortB: 15 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - demarcationPoint: - patchPanelId: PP:Demarc:1260379 - patchPanelPortA: 22 - patchPanelPortB: 23 - connectorType: SC - cageUniqueSpaceId: SV2:00:000000 - cabinetUniqueSpaceId: SV2:00:000000:0100 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567891 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - CrossConnect_400_diverse: - summary: Invalid diverse pair - value: - - errorCode: EQ-3071106 - errorMessage: Invalid diverse Cross Connect request - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - details: A diverse pair order must contain exactly two Cross Connects, one PRIMARY and one SECONDARY. - additionalInfo: - - property: /data - reason: Expected two entries with complementary redundancy priorities. - CrossConnectSearchByNameWithState: - value: - filter: - and: - - property: /name - operator: LIKE - values: - - My-CC-service - - property: /state - operator: IN - values: - - PENDING - - PENDING_ACTION - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - CrossConnectSearchByIbxWithType: - value: - filter: - and: - - property: /type - operator: = - values: - - XC - - or: - - property: /aSide/location/ibxCode - operator: = - values: - - SV1 - - property: /zSide/location/ibxCode - operator: = - values: - - SV1 - pagination: - limit: 25 - offset: 0 - sort: - - property: /name - direction: ASC - CrossConnectSearchResponse: - value: - pagination: - offset: 0 - limit: 25 - total: 1 - sort: - - property: /changeLog/updatedDateTime - direction: DESC - data: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - name: My-CC-service - state: PROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: PRIMARY - aSide: - demarcationPoint: - patchPanelId: CP:Demarc:1259684 - patchPanelPortA: 35 - patchPanelPortB: 32 - connectorType: SC - cageUniqueSpaceId: SV1:00:000000 - cabinetUniqueSpaceId: SV1:00:000000:0100 - location: - ibxCode: SV1 - zSide: - loa: - href: https://api.equinix.com/fabric/v4/loas/b51f485e-3094-42de-8797-0ef19a51df79 - uuid: c61f485e-3094-42de-8797-0ef19a51df79 - location: - ibxCode: SV1 - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-26T07:21:39Z - createdBy: testuser - updatedDateTime: 2026-02-28T07:21:39Z - updatedBy: "1234" - CCDeleteRequest: - summary: Delete a Cross Connect - description: The notification contacts are appended to the ones already held on the Cross Connect, while the purchase order and the customer reference identifier replace the existing ones. - value: - schedule: - code: STANDARD - requestedDateTime: 2021-06-14T17:21:25.586Z - deinstallationDateTime: 2021-06-14T17:21:25.586Z - notifications: - - type: TECHNICAL - emails: - - abc@test.com - order: - purchaseOrder: - number: "1233" - amount: "23" - startDate: 2026-02-26 - endDate: 2027-02-26 - customerReferenceId: "12345" - CCDeleteResponse: - summary: Delete a Cross Connect - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743 - type: XC - uuid: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - name: My-CC-service-PRI - state: DEPROVISIONING - serialNumber: "234567890" - redundancy: - group: 7cf39156-9dec-40f7-a254-9bb401342e83 - priority: PRIMARY - account: - accountNumber: 123456 - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - order: - orderNumber: 1-1234567890 - customerReferenceId: "12345" - links: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules - rel: getCrossConnectSchedulesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services - rel: getCrossConnectServicesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes - rel: getCrossConnectNotesByUuid - method: GET - contentType: application/json - authenticate: true - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments - rel: getCrossConnectAttachmentsByUuid - method: GET - contentType: application/json - authenticate: true - changeLog: - createdDateTime: 2026-02-28T07:21:39Z - createdBy: testuser - CrossConnect_400_bulk_delete: - summary: Invalid bulk delete request - value: - - errorCode: EQ-3071100 - errorMessage: Invalid bulk Cross Connect delete request - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - details: One or more Cross Connects in the request cannot be deleted. - additionalInfo: - - property: /data/0/uuid - reason: Cross Connect is not in a state that allows deletion. - CrossConnectSchedulesResponse: - value: - data: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - type: XC_INSTALL_SCHEDULE - code: EXPEDITE - state: COMPLETED - autoConvertToStandard: true - readinessDateTime: 2026-08-23T07:21:39Z - requestedDateTime: 2026-08-24T07:21:39Z - equinixProposedDateTime: 2026-08-25T07:21:39Z - installationDateTime: 2026-08-25T09:21:39Z - changeLog: - createdBy: testuser - createdDateTime: 2026-08-22T07:21:39Z - updatedBy: "124" - updatedDateTime: 2026-08-25T09:21:39Z - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/a11f485e-3094-42de-8797-0ef19a51df79 - uuid: a11f485e-3094-42de-8797-0ef19a51df79 - type: XC_DEINSTALL_SCHEDULE - code: STANDARD - state: PENDING - requestedDateTime: 2026-09-14T17:21:25.586Z - deinstallationDateTime: 2026-09-16T17:21:25.586Z - changeLog: - createdBy: testuser - createdDateTime: 2026-09-12T07:21:39Z - CrossConnectServicesResponse: - value: - data: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - type: XC_LINK_LIGHT_VERIFICATION - state: PENDING - changeLog: - createdBy: testuser - createdDateTime: 2026-02-28T07:21:39Z - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/a11f485e-3094-42de-8797-0ef19a51df79 - uuid: a11f485e-3094-42de-8797-0ef19a51df79 - type: XC_PATCH_EQUIPMENT - state: PENDING - device: - cabinetUniqueSpaceId: SV2:00:000000:0100 - port: 32 - connectorType: SC - description: additional notes for patch equipment - changeLog: - createdBy: testuser - createdDateTime: 2026-02-28T07:21:39Z - CrossConnectAttachmentsResponse: - summary: Cross Connect attachments - value: - data: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - type: ATTACHMENT - source: CUSTOMER - attachmentId: a11f485e-3094-42de-8797-0ef19a51df79 - downloadHref: https://api.equinix.com/ecp/attachments/a11f485e-3094-42de-8797-0ef19a51df79 - changeLog: - createdBy: "123" - createdDateTime: 2026-02-28T07:21:39Z - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/a41f485e-3094-42de-8797-0ef19a51df81 - uuid: a41f485e-3094-42de-8797-0ef19a51df81 - type: ATTACHMENT - source: EQUINIX - attachmentId: b21f485e-3094-42de-8797-0ef19a51df80 - downloadHref: https://api.equinix.com/ecp/attachments/b21f485e-3094-42de-8797-0ef19a51df80 - changeLog: - createdBy: EQUINIX - createdDateTime: 2026-02-27T07:21:39Z - CreateAttachmentRequest: - value: - attachmentId: a11f485e-3094-42de-8797-0ef19a51df79 - CreateAttachmentResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - type: ATTACHMENT - source: CUSTOMER - attachmentId: a11f485e-3094-42de-8797-0ef19a51df79 - downloadHref: https://api.equinix.com/ecp/attachments/a11f485e-3094-42de-8797-0ef19a51df79 - changeLog: - createdBy: "123" - createdDateTime: 2026-02-28T07:21:39Z - CrossConnectNotesResponse: - summary: Cross Connect notes - value: - pagination: - offset: 0 - limit: 10 - total: 2 - data: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - type: NOTE - source: CUSTOMER - comments: Additional note to EQUINIX technician. - changeLog: - createdBy: "124" - createdDateTime: 2026-02-28T07:21:39Z - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79 - uuid: a11f485e-3094-42de-8797-0ef19a51df79 - type: NOTE - source: EQUINIX - comments: Please confirm the patch panel port before the scheduled installation. - changeLog: - createdBy: SYSTEM - createdDateTime: 2026-02-27T07:21:39Z - CreateNoteRequest: - value: - comments: test note - CreateNoteResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - type: NOTE - source: CUSTOMER - comments: test note - changeLog: - createdBy: "124" - createdDateTime: 2026-02-28T07:21:39Z - SendSignatureQuoteActionRequest: - value: - type: XC_SIGNATURE_SUBMISSION - AcceptProposedDateTimeActionRequest: - value: - type: XC_PROPOSED_DATE_TIME_ACCEPTANCE - RejectProposedDateTimeActionRequest: - value: - type: XC_PROPOSED_DATE_TIME_REJECTION - CancelCrossConnectActionRequest: - value: - type: XC_CANCEL - DeinstallCrossConnectActionRequest: - summary: Deinstall a Cross Connect - description: Removal of a provisioned Cross Connect, along with the patch equipment. The notification contacts are appended to the ones already held on the Cross Connect, while the purchase order and the customer reference identifier replace the existing ones. - value: - type: XC_DEINSTALL - data: - schedule: - code: STANDARD - requestedDateTime: 2026-06-14T17:21:25.586Z - deinstallationDateTime: 2026-06-16T17:21:25.586Z - liveTrafficConsentProvided: true - services: - - type: XC_PATCH_EQUIPMENT - device: - cabinetUniqueSpaceId: SV2:00:000000:0100 - port: 32 - connectorType: SC - description: device description - notifications: - - type: TECHNICAL - emails: - - abc@test.com - attachments: - - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - order: - purchaseOrder: - number: "1233" - amount: "23" - startDate: 2026-02-26 - endDate: 2027-02-26 - customerReferenceId: "12345" - UpdateInformationActionRequest: - value: - type: XC_INFORMATION_UPDATE - data: - notes: - - parentNote: - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - comments: Please proceed - attachments: - - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - SendSignatureQuoteActionResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/30cc7878-54e3-4e1a-8651-87a61354bad4 - uuid: 30cc7878-54e3-4e1a-8651-87a61354bad4 - type: XC_SIGNATURE_SUBMISSION - state: COMPLETED - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - AcceptProposedDateTimeActionResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/41dd8989-65f4-4f2b-9762-98b72465cbe5 - uuid: 41dd8989-65f4-4f2b-9762-98b72465cbe5 - type: XC_PROPOSED_DATE_TIME_ACCEPTANCE - state: COMPLETED - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - RejectProposedDateTimeActionResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/52ee9090-76a5-4a3c-a873-a9c83576dcf6 - uuid: 52ee9090-76a5-4a3c-a873-a9c83576dcf6 - type: XC_PROPOSED_DATE_TIME_REJECTION - state: COMPLETED - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - CancelCrossConnectActionResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/63ffa1a1-87b6-4b4d-b984-bad94687edf7 - uuid: 63ffa1a1-87b6-4b4d-b984-bad94687edf7 - type: XC_CANCEL - state: PENDING - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - DeinstallCrossConnectActionResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/74ffa1a1-87b6-4b4d-b984-bad94687edf8 - uuid: 74ffa1a1-87b6-4b4d-b984-bad94687edf8 - type: XC_DEINSTALL - state: PENDING - data: - attachments: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 - uuid: b41f485e-3094-42de-8797-0ef19a51df82 - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - schedule: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/c51f485e-3094-42de-8797-0ef19a51df83 - uuid: c51f485e-3094-42de-8797-0ef19a51df83 - type: XC_DEINSTALL_SCHEDULE - code: STANDARD - state: PENDING - requestedDateTime: 2026-06-14T17:21:25.586Z - deinstallationDateTime: 2026-06-16T17:21:25.586Z - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - liveTrafficConsentProvided: true - services: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/d61f485e-3094-42de-8797-0ef19a51df84 - uuid: d61f485e-3094-42de-8797-0ef19a51df84 - type: XC_PATCH_EQUIPMENT - state: PENDING - device: - cabinetUniqueSpaceId: SV2:00:000000:0100 - port: 32 - connectorType: SC - description: device description - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - notifications: - - type: ORDERING - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: TECHNICAL - emails: - - abc@test.com - phone: - - type: MOBILE - number: 14085551234 - contactPreference: - timezone: PST - availability: ANYTIME - - type: NOTIFICATION - emails: - - abc@test.com - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - UpdateInformationActionResponse: - value: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/7400b2b2-98c7-4c5e-ca95-cbea5798fe08 - uuid: 7400b2b2-98c7-4c5e-ca95-cbea5798fe08 - type: XC_INFORMATION_UPDATE - state: COMPLETED - data: - notes: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - parentNote: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79 - uuid: a11f485e-3094-42de-8797-0ef19a51df79 - comments: Please proceed - attachments: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 - uuid: b41f485e-3094-42de-8797-0ef19a51df82 - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - CrossConnect_Action_400: - value: - - errorCode: EQ-3071104 - errorMessage: Bad request. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - additionalInfo: - - property: type - reason: Cross Connect Action type is not one of the allowedActions of the Cross Connect. - CrossConnect_Action_404: - value: - - errorCode: EQ-3071105 - errorMessage: Cross Connect Action does not exist. - correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec - additionalInfo: - - property: uuid - reason: Cross Connect Action does not exist. Please check the Action UUID. - CrossConnectActionSearchByActionType: - value: - filter: - and: - - property: /type - operator: = - values: - - XC_INFORMATION_UPDATE - pagination: - limit: 25 - offset: 0 - sort: - - property: /changeLog/createdDateTime - direction: DESC - CrossConnectActionSearchResponse: - value: - pagination: - offset: 0 - limit: 25 - total: 1 - sort: - - property: /changeLog/createdDateTime - direction: DESC - data: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/7400b2b2-98c7-4c5e-ca95-cbea5798fe08 - uuid: 7400b2b2-98c7-4c5e-ca95-cbea5798fe08 - type: XC_INFORMATION_UPDATE - state: COMPLETED - data: - notes: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79 - uuid: e41f485e-3094-42de-8797-0ef19a51df79 - parentNote: - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79 - uuid: a11f485e-3094-42de-8797-0ef19a51df79 - comments: Please proceed - attachments: - - href: https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82 - uuid: b41f485e-3094-42de-8797-0ef19a51df82 - attachmentId: e41f485e-3094-42de-8797-0ef19a51df79 - changeLog: - createdDateTime: 2026-07-24T06:50:46Z - createdBy: testuser - SearchInstallSchedulesRequest: - summary: Installation schedule windows - value: - filter: - and: - - property: /type - operator: = - values: - - XC_INSTALL_SCHEDULE - - property: /code - operator: IN - values: - - EXPEDITE - - FLEXIBLE - - STANDARD - - property: /aSide/location/ibxCode - operator: = - values: - - SV11 - - property: /zSide/location/ibxCode - operator: = - values: - - SV11 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /startDateTime - SearchInstallSchedulesResponse: - summary: Installation schedule windows - value: - pagination: - offset: 0 - limit: 20 - total: 3 - data: - - href: https://api.equinix.com/fabric/v4/crossConnectSchedules/EXPEDITE - type: XC_INSTALL_SCHEDULE - code: EXPEDITE - aSide: - location: - ibxCode: SV11 - zSide: - location: - ibxCode: SV11 - startDateTime: 2026-03-05T17:00:00Z - endDateTime: 2026-03-10T17:24:00Z - unavailableDates: - - 2026-03-07 - - 2026-03-08 - - href: https://api.equinix.com/fabric/v4/crossConnectSchedules/STANDARD - type: XC_INSTALL_SCHEDULE - code: STANDARD - aSide: - location: - ibxCode: SV11 - zSide: - location: - ibxCode: SV11 - startDateTime: 2026-03-10T18:00:00Z - endDateTime: 2026-04-10T17:24:00Z - unavailableDates: - - 2026-03-27 - - 2026-03-28 - - 2026-03-29 - - href: https://api.equinix.com/fabric/v4/crossConnectSchedules/FLEXIBLE - type: XC_INSTALL_SCHEDULE - code: FLEXIBLE - aSide: - location: - ibxCode: SV11 - zSide: - location: - ibxCode: SV11 - startDateTime: 2026-04-10T18:00:00Z - endDateTime: 2026-06-10T17:24:00Z - unavailableDates: - - 2026-04-17 - - 2026-04-18 - - 2026-04-19 - AppDomainCreate: - value: - type: APP_DOMAIN - name: atlassian.net - description: Atlassian Domain - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppDomainPostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - description: Atlassian Domain - state: PENDING_VERIFICATION - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - AppDomain_400_InvalidName: - value: - - errorCode: EQ-3810022 - errorMessage: Domain name is invalid - correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e - details: Domain name is invalid - additionalInfo: - - property: /name - reason: Domain name is invalid - AppDomain_401: - value: - - errorCode: EQ-3810001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - AppDomain_403: - value: - - errorCode: EQ-3810002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - AppDomain_415: - value: - - errorCode: EQ-3810016 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - AppDomain_500: - value: - - errorCode: EQ-3810030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - AppDomainGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - description: Atlassian Domain - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppDomain_404: - value: - - errorCode: EQ-3810020 - errorMessage: App Domain not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: App Domain not found or already deleted - AppDomainDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - description: Atlassian Domain - state: DEPROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - deletedBy: test - deletedDateTime: 2026-06-29T04:20:55.471Z - AppDomain_400_InvalidState: - value: - - errorCode: EQ-3810030 - errorMessage: Cannot delete App Domain in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete App Domain in transient state. - AppDomainUpdateDescription: - value: - - op: replace - path: /description - value: Updated Atlassian Domain - AppDomainPatchResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - description: Updated Atlassian Domain - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - change: - uuid: 531c4ab5-43b0-4352-8975-ee9045325841 - type: APP_DOMAIN_UPDATE - status: REQUESTED - createdDateTime: 2026-06-27T04:20:55.471Z - updatedDateTime: 2026-06-28T04:20:55.471Z - data: - - op: replace - path: /description - value: Updated Atlassian Domain - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppDomain_400_InvalidOperation: - value: - - errorCode: EQ-3810022 - errorMessage: Invalid Argument passed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - AppDomainSearchFilterByStatus: - value: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONED - - property: /project/projectId - operator: IN - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppDomainSearchFilterByName: - value: - filter: - and: - - property: /name - operator: = - values: - - test- - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppDomainSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /name - operator: LIKE - values: - - abc% - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppDomainSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - description: Atlassian Domain - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppDomain_400_InvalidSorting: - value: - - errorCode: EQ-3810039 - errorMessage: Invalid value for sorting direction. - correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - AppDomainAttachedAppLinksGetResponseExample: - value: - pagination: - limit: 20 - offset: 0 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - type: APP_LINK - uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: Atlassian App Link - description: Atlassian App Link in SV - state: PROVISIONED - router: - href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - type: XF_ROUTER - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - bandwidth: 1000 - ipv4Subnet: 192.168.10.0/29 - ipv4Address: 192.168.10.3 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppLinkCreate: - value: - type: APP_LINK - name: Atlassian App Link - description: Atlassian App Link in SV - router: - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - ipv4Subnet: 192.168.10.0/29 - bandwidth: 1000 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppLinkPostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - type: APP_LINK - name: Atlassian App Link - description: Atlassian App Link in SV - state: PROVISIONING - router: - href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - type: XF_ROUTER - ipv4Subnet: 192.168.10.0/29 - ipv4Address: 192.168.10.3 - bandwidth: 1000 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - AppLink_400_InvalidName: - value: - - errorCode: EQ-3820022 - errorMessage: Name is minimum 0 and up to 50 characters in length - correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e - details: Name is minimum 0 and up to 50 characters in length - additionalInfo: - - property: /name - reason: Name is minimum 0 and up to 50 characters in length - AppLink_401: - value: - - errorCode: EQ-3820001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - AppLink_403: - value: - - errorCode: EQ-3820002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - AppLink_415: - value: - - errorCode: EQ-3820016 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - AppLink_500: - value: - - errorCode: EQ-3820030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - AppLinkGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - type: APP_LINK - name: Atlassian App Link - description: Atlassian App Link in SV - state: PROVISIONED - router: - href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - type: XF_ROUTER - ipv4Subnet: 192.168.10.0/29 - ipv4Address: 192.168.10.3 - bandwidth: 1000 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLink_404: - value: - - errorCode: EQ-3820020 - errorMessage: AppLink not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: AppLink not found or already deleted - AppLinkDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - type: APP_LINK - name: Atlassian App Link - description: Atlassian App Link in SV - state: DEPROVISIONING - router: - href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - type: XF_ROUTER - ipv4Subnet: 192.168.10.0/29 - ipv4Address: 192.168.10.3 - bandwidth: 1000 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - deletedBy: test - deletedDateTime: 2026-06-29T04:20:55.471Z - AppLink_400_InvalidState: - value: - - errorCode: EQ-3820030 - errorMessage: Cannot delete App Link in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete App Link in transient state. - AppLinkUpdateName: - value: - - op: replace - path: /name - value: Updated Atlassian App Link - AppLinkPatchResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - type: APP_LINK - name: Updated Atlassian App Link - description: Atlassian App Link in SV - state: REPROVISIONING - router: - href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - type: XF_ROUTER - ipv4Subnet: 192.168.10.0/29 - ipv4Address: 192.168.10.3 - bandwidth: 1000 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - change: - uuid: 531c4ab5-43b0-4352-8975-ee9045325841 - type: APP_LINK_UPDATE - status: REQUESTED - createdDateTime: 2026-06-27T04:20:55.471Z - updatedDateTime: 2026-06-28T04:20:55.471Z - data: - - op: replace - path: /name - value: Updated Atlassian App Link - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLink_400_InvalidOperation: - value: - - errorCode: EQ-3040054 - errorMessage: Invalid Argument passed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - AppLinkSearchFilterByStatus: - value: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONED - - property: /project/projectId - operator: IN - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppLinkSearchFilterByName: - value: - filter: - and: - - property: /name - operator: = - values: - - test- - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppLinkSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /name - operator: LIKE - values: - - abc% - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppLinkSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - type: APP_LINK - name: Atlassian App Link - description: Atlassian App Link in SV - state: PROVISIONED - router: - href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - type: XF_ROUTER - ipv4Subnet: 192.168.10.0/29 - ipv4Address: 192.168.10.3 - bandwidth: 1000 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppLink_400_InvalidSorting: - value: - - errorCode: EQ-3820039 - errorMessage: Invalid value for sorting direction. - correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - AppLinkAttachDomainResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - attachmentStatus: ATTACHED - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachDomainAttachResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - attachmentStatus: ATTACHING - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-27T04:20:55.471Z - AppLink_400_InvalidAttachState: - value: - - errorCode: EQ-3820030 - errorMessage: Cannot perform attach or detach operation in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot perform attach or detach operation in transient state. - AppLinkAttachDomainDetachResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - attachmentStatus: DETACHING - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachDomainSearchFilterByStatus: - value: - filter: - and: - - property: /attachmentStatus - operator: = - values: - - ATTACHED - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppLinkAttachDomainSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /uuid - operator: = - values: - - 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - AppLinkAttachDomainSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - attachmentStatus: ATTACHED - AppLinkAttachDomainGetExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_DOMAIN - name: atlassian.net - description: Atlassian Domain - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - attachmentStatus: ATTACHED - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachServiceResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - geoScope: GLOBAL - destinationIp: 10.10.1.110 - attachmentStatus: ATTACHED - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachService: - value: - geoScope: GLOBAL - destinationIp: 10.10.1.110 - AppLinkAttachServiceAttachResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - geoScope: GLOBAL - destinationIp: 10.10.1.110 - attachmentStatus: ATTACHING - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-27T04:20:55.471Z - AppLinkAttachServiceDetachResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - geoScope: GLOBAL - destinationIp: 10.10.1.110 - attachmentStatus: DETACHING - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachServicePatchDestinationIp: - value: - - op: replace - path: /destinationIp - value: 10.10.1.120 - AppLinkAttachServicePatchResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - geoScope: GLOBAL - destinationIp: 10.10.1.120 - attachmentStatus: ATTACHING - change: - uuid: 531c4ab5-43b0-4352-8975-ee9045325841 - type: APP_SERVICE_UPDATE - status: REQUESTED - createdDateTime: 2026-06-27T04:20:55.471Z - updatedDateTime: 2026-06-27T04:20:55.471Z - data: - - op: replace - path: /destinationIp - value: 10.10.1.120 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-27T04:20:55.471Z - AppLinkAttachServiceSearchFilterByStatus: - value: - filter: - and: - - property: /attachmentStatus - operator: = - values: - - ATTACHED - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppLinkAttachServiceSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /uuid - operator: = - values: - - 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - AppLinkAttachServiceSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - geoScope: GLOBAL - destinationIp: 10.10.1.110 - attachmentStatus: ATTACHED - AppLinkAttachServiceGetExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - name: Atlassian App Service - description: Atlassian App Service in SV - state: PROVISIONED - endpoint: equinixjira.atlassian.net - sourceDomains: - - equinix.com - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - geoScope: GLOBAL - destinationIp: 10.10.1.110 - attachmentStatus: ATTACHED - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachProcessorGetResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - uuid: 90ee425c-9988-454c-96d9-1128bc16350f - type: APP_PROCESSOR - config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... - endpoint: 123456.privateai.link - attachmentStatus: ATTACHED - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachProcessor: - value: - config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... - AppLinkAttachProcessorAttachResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - uuid: 90ee425c-9988-454c-96d9-1128bc16350f - type: APP_PROCESSOR - config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... - endpoint: 123456.privateai.link - attachmentStatus: ATTACHING - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-27T04:20:55.471Z - AppLinkAttachProcessorDetachResponse: - value: - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - uuid: 90ee425c-9988-454c-96d9-1128bc16350f - type: APP_PROCESSOR - config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... - endpoint: 123456.privateai.link - attachmentStatus: DETACHING - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppLinkAttachProcessorSearchFilterByStatus: - value: - filter: - and: - - property: /attachmentStatus - operator: = - values: - - ATTACHED - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppLinkAttachProcessorSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - uuid: 90ee425c-9988-454c-96d9-1128bc16350f - type: APP_PROCESSOR - config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... - endpoint: 123456.privateai.link - attachmentStatus: ATTACHED - AppLinkAttachProcessorListExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /appProcessors?offset=1&limit=20 - previous: /appProcessors?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - uuid: 90ee425c-9988-454c-96d9-1128bc16350f - type: APP_PROCESSOR - attachmentStatus: ATTACHED - config: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA... - endpoint: 123456.privateai.link - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppProcessorGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - uuid: 90ee425c-9988-454c-96d9-1128bc16350f - type: APP_PROCESSOR - name: agent-gateway - description: llm-routing, a2a-routing, mcp-routing - registryId: agentgateway/agentgateway:1.3.0 - marketplace: - visibility: PUBLIC - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-09-08T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-09-08T04:20:55.471Z - AppProcessor_401: - value: - - errorCode: EQ-3850001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - AppProcessor_403: - value: - - errorCode: EQ-3850002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - AppProcessor_404: - value: - - errorCode: EQ-3850020 - errorMessage: AppProcessor not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: AppProcessor not found or already deleted - AppProcessor_500: - value: - - errorCode: EQ-3850030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - AppProcessorSearchFilterByStatus: - value: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONED - - property: /project/projectId - operator: IN - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppProcessorSearchFilterByName: - value: - filter: - and: - - property: /name - operator: = - values: - - agent- - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppProcessorSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /name - operator: LIKE - values: - - agent% - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppProcessorSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f - uuid: 90ee425c-9988-454c-96d9-1128bc16350f - type: APP_PROCESSOR - name: agent-gateway - description: llm-routing, a2a-routing, mcp-routing - registryId: agentgateway/agentgateway:1.3.0 - marketplace: - visibility: PUBLIC - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppProcessor_400_InvalidSorting: - value: - - errorCode: EQ-3850039 - errorMessage: Invalid value for sorting direction. - correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - AppProcessor_415: - value: - - errorCode: EQ-3850016 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - AppServiceCreate: - value: - type: APP_SERVICE - name: Atlassian App Service - description: Atlassian App Service in SV - endpoint: equinixjira.atlassian.net - sourceDomains: - - equinix.com - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppServicePostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - name: Atlassian App Service - description: Atlassian App Service in SV - state: PROVISIONING - endpoint: equinixjira.atlassian.net - sourceDomains: - - equinix.com - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - AppService_400_InvalidName: - value: - - errorCode: EQ-3830022 - errorMessage: Name is minimum 0 and up to 50 characters in length - correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e - details: Name is minimum 0 and up to 50 characters in length - additionalInfo: - - property: /name - reason: Name is minimum 0 and up to 50 characters in length - AppService_401: - value: - - errorCode: EQ-3830001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - AppService_403: - value: - - errorCode: EQ-3830002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - AppService_415: - value: - - errorCode: EQ-3830016 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - AppService_500: - value: - - errorCode: EQ-3830030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - AppServiceGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - name: Atlassian App Service - description: Atlassian App Service in SV - state: PROVISIONED - endpoint: equinixjira.atlassian.net - sourceDomains: - - equinix.com - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - account: - organizationName: atlassian - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppService_404: - value: - - errorCode: EQ-3830020 - errorMessage: App Service not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: App Service not found or already deleted - AppServiceDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - name: Atlassian App Service - description: Atlassian App Service in SV - state: DEPROVISIONING - endpoint: equinixjira.atlassian.net - sourceDomains: - - equinix.com - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - deletedBy: test - deletedDateTime: 2026-06-29T04:20:55.471Z - AppService_400_InvalidState: - value: - - errorCode: EQ-3830030 - errorMessage: Cannot delete App Service in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete App Service in transient state. - AppServiceUpdateName: - value: - - op: replace - path: /name - value: Updated Atlassian App Service - AppServicePatchResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - name: Updated Atlassian App Service - description: Atlassian App Service in SV - state: REPROVISIONING - endpoint: equinixjira.atlassian.net - sourceDomains: - - equinix.com - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - change: - uuid: 531c4ab5-43b0-4352-8975-ee9045325841 - type: APP_SERVICE_UPDATE - status: REQUESTED - createdDateTime: 2026-06-27T04:20:55.471Z - updatedDateTime: 2026-06-28T04:20:55.471Z - data: - - op: replace - path: /name - value: Updated Atlassian App Service - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppService_400_InvalidOperation: - value: - - errorCode: EQ-3040054 - errorMessage: Invalid Argument passed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - AppServiceSearchFilterByStatus: - value: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONED - - property: /project/projectId - operator: IN - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppServiceSearchFilterByName: - value: - filter: - and: - - property: /name - operator: = - values: - - test- - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppServiceSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /name - operator: LIKE - values: - - abc% - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppServiceSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 - uuid: 5008a109-9d1c-485c-b0ba-de9736f283c2 - type: APP_SERVICE - name: Atlassian App Service - description: Atlassian App Service in SV - state: PROVISIONED - endpoint: equinixjira.atlassian.net - sourceDomains: - - equinix.com - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - account: - organizationName: atlassian - AppService_400_InvalidSorting: - value: - - errorCode: EQ-3830039 - errorMessage: Invalid value for sorting direction. - correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - AppServiceAttachedAppLinksGetResponseExample: - value: - pagination: - limit: 20 - offset: 0 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914 - type: APP_LINK - uuid: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: Atlassian App Link - description: Atlassian App Link in SV - state: PROVISIONED - router: - href: https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6 - type: XF_ROUTER - uuid: 36204584-2ae1-44f6-980f-08ecd555d9c6 - bandwidth: 1000 - ipv4Subnet: 192.168.10.0/29 - ipv4Address: 192.168.10.3 - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppServiceAttachedAppSubscriptionsGetResponseExample: - value: - pagination: - limit: 20 - offset: 0 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_SUBSCRIPTION - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - state: PROVISIONED - account: - organizationName: equinix - AppServiceAttachedAppSubscriptionSearchExample: - value: - pagination: - limit: 20 - offset: 0 - total: 1 - data: - - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_SUBSCRIPTION - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - state: PROVISIONED - account: - organizationName: equinix - AppSubscriptionCreate: - value: - type: APP_SUBSCRIPTION - source: - appLink: - uuid: e32c9c7a-0149-4582-8345-192b82aef972 - ipSubnets: - - 192.168.100.0/24 - target: - appService: - uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d - geoScope: GLOBAL - prioritization: LATENCY - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppSubscriptionPostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_SUBSCRIPTION - source: - appLink: - uuid: e32c9c7a-0149-4582-8345-192b82aef972 - ipSubnets: - - 192.168.100.0/24 - target: - appService: - uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d - geoScope: GLOBAL - prioritization: LATENCY - state: PROVISIONING - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - AppSubscription_401: - value: - - errorCode: EQ-3840001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - AppSubscription_403: - value: - - errorCode: EQ-3840002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - AppSubscription_415: - value: - - errorCode: EQ-3840016 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - AppSubscription_500: - value: - - errorCode: EQ-3840030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - AppSubscriptionGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_SUBSCRIPTION - source: - appLink: - uuid: e32c9c7a-0149-4582-8345-192b82aef972 - ipSubnets: - - 192.168.100.0/24 - target: - appService: - uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d - geoScope: GLOBAL - prioritization: LATENCY - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppSubscription_404: - value: - - errorCode: EQ-3840020 - errorMessage: App Subscription not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: App Subscription not found or already deleted - AppSubscriptionDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_SUBSCRIPTION - source: - appLink: - uuid: e32c9c7a-0149-4582-8345-192b82aef972 - ipSubnets: - - 192.168.100.0/24 - target: - appService: - uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d - geoScope: GLOBAL - prioritization: LATENCY - state: DEPROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - deletedBy: test - deletedDateTime: 2026-06-29T04:20:55.471Z - AppSubscription_400_InvalidState: - value: - - errorCode: EQ-3840030 - errorMessage: Cannot delete App Subscription in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete App Subscription in transient state. - AppSubscriptionUpdateSourceIpSubnets: - value: - - op: add - path: /source/ipSubnets - value: - - 192.168.200.0/24 - AppSubscriptionPatchResponseExample: - value: - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_SUBSCRIPTION - source: - appLink: - uuid: e32c9c7a-0149-4582-8345-192b82aef972 - ipSubnets: - - 192.168.100.0/24 - - 192.168.200.0/24 - target: - appService: - uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d - geoScope: GLOBAL - prioritization: LATENCY - state: PROVISIONING - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - change: - uuid: 531c4ab5-43b0-4352-8975-ee9045325841 - type: APP_SUBSCRIPTION_UPDATE - status: REQUESTED - createdDateTime: 2026-06-27T04:20:55.471Z - updatedDateTime: 2026-06-28T04:20:55.471Z - data: - - op: add - path: /source/ipSubnets - value: - - 192.168.200.0/24 - changeLog: - createdBy: test - createdDateTime: 2026-06-27T04:20:55.471Z - updatedBy: test - updatedDateTime: 2026-06-28T04:20:55.471Z - AppSubscription_400_InvalidOperation: - value: - - errorCode: EQ-3040054 - errorMessage: Invalid Argument passed - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - AppSubscriptionSearchFilterByStatus: - value: - filter: - and: - - property: /state - operator: IN - values: - - PROVISIONED - - property: /project/projectId - operator: IN - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - AppSubscriptionSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /uuid - operator: = - values: - - 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - - property: /project/projectId - operator: = - values: - - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppSubscriptionSearchExample: - value: - pagination: - offset: 0 - limit: 20 - total: 1 - next: /search?offset=1&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3 - uuid: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - type: APP_SUBSCRIPTION - source: - appLink: - uuid: e32c9c7a-0149-4582-8345-192b82aef972 - ipSubnets: - - 192.168.100.0/24 - target: - appService: - uuid: e18c15f4-c8aa-4c18-9e35-a7e9b288201d - geoScope: GLOBAL - prioritization: LATENCY - state: PROVISIONED - project: - projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 - AppSubscription_400_InvalidSorting: - value: - - errorCode: EQ-3840039 - errorMessage: Invalid value for sorting direction. - correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - thumbs-up-response: - value: - response_id: resp_69f6f816-799f-4aa2-8e63-77fec55524d1 - reaction: thumbs_up - category: other - comment: Looking good - submitted_at: 2024-11-21T10:30:00Z - user: test-user-123 - thumbs-down-response: - value: - response_id: resp_69f6f816-799f-4aa2-8e63-77fec55524d1 - reaction: thumbs_down - category: accuracy - comment: Is that true? - submitted_at: 2024-11-21T10:30:00Z - user: test-user-123 - 400-missing-required-header: - value: - - errorCode: EQ-3222001 - errorMessage: Missing X-AUTH-USERNAME header - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 400-invalid-auth-format: - value: - - errorCode: EQ-3222003 - errorMessage: Invalid Authorization header format - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 400-missing-token: - value: - - errorCode: EQ-3222004 - errorMessage: Authorization header is missing the token - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 401-missing-auth-header: - value: - - errorCode: EQ-3222001 - errorMessage: Missing Authorization header - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 401-empty-auth: - value: - - errorCode: EQ-3222003 - errorMessage: Missing or empty Authorization header - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 401-malformed-jwt: - value: - - errorCode: EQ-3222005 - errorMessage: Malformed JWT token - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 401-invalid-jwt: - value: - - errorCode: EQ-3222006 - errorMessage: Invalid JWT token - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 403-feature-disabled: - value: - - errorCode: EQ-3222002 - errorMessage: ENA is disabled for this user and/or user's organization - correlationId: 123e4567-e89b-12d3-a456-426614174000 - 500-reactions-internal-server-error: - value: - - errorCode: EQ-3222100 - errorMessage: Failed to store reaction - correlationId: 123e4567-e89b-12d3-a456-426614174000 - standard-request: - value: - input: - - content: - - text: Which of my connections are at risk of exceeding their bandwidth limits? - type: input_text - role: user - type: message - string-input: - value: - input: Which of my connections are at risk of exceeding their bandwidth limits? - standard-streaming-request: - value: - input: - - content: - - text: Use the equinix_intelligence_search_docs tool to answer my questions about What is VPN - type: input_text - role: user - type: message - stream: true - response-chaining: - value: - input: - - content: - - text: Which of my connections are at risk of exceeding their bandwidth limits? - type: input_text - role: user - type: message - previous_response_id: resp_08b22a5f-63c6-4892-8cd6-2a4b1ef591c0 - related-prompts-request: - value: - input: - - content: - - text: Use the equinix_intelligence_search_docs tool to answer my questions about What is VPN - type: input_text - role: user - type: message - metadata: - prompt_source: user/related_prompt - include_related_prompts: "true" - structured-output: - value: - input: Can you show me metrics for port bb1ad009-4dcc-445 - text: - format: - name: final_output - schema: - $schema: https://json-schema.org/draft/2020-12/schema - type: object - properties: - component: - type: string - const: observability_chart - asset_type: - type: string - const: port - asset_id: - type: string - const: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - asset_name: - type: string - const: Equinix-SV-CX-port-L-Dot1q-100G-PRI - title: - type: string - indexKey: - type: string - const: time - data: - type: array - items: - type: object - properties: - time: - type: string - format: date-time - pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - bandwidth_rx: - type: number - description: Mbps - bandwidth_tx: - type: number - description: Mbps - required: - - time - - bandwidth_rx - - bandwidth_tx - additionalProperties: false - series: - minItems: 2 - type: array - items: - type: object - properties: - dataKey: - type: string - name: - type: string - color: - type: string - required: - - dataKey - - name - - color - additionalProperties: false - required: - - component - - asset_type - - asset_id - - asset_name - - title - - indexKey - - data - - series - additionalProperties: false - type: json_schema - response_created: - summary: response.created - value: - response: - id: resp_4542cc2f-7e4c-4694-a5fb-7797a150d0e0 - created_at: 1765358850.078279 - model: fsa-agent - object: response - output: - - id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - content: - - annotations: [] - text: "" - type: output_text - role: assistant - status: in_progress - type: message - parallel_tool_calls: false - tool_choice: none - tools: [] - status: in_progress - sequence_number: 0 - type: response.created - response_in_progress: - summary: response.in_progress - value: - response: - id: resp_4542cc2f-7e4c-4694-a5fb-7797a150d0e0 - created_at: 1765358850.078279 - model: fsa-agent - object: response - output: - - id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - content: - - annotations: [] - text: "" - type: output_text - role: assistant - status: in_progress - type: message - parallel_tool_calls: false - tool_choice: none - tools: [] - status: in_progress - sequence_number: 1 - type: response.in_progress - response_output_item_added: - summary: response.output_item.added - value: - item: - id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - content: - - annotations: [] - text: "" - type: output_text - role: assistant - status: in_progress - type: message - output_index: 0 - sequence_number: 2 - type: response.output_item.added - response_content_part_added: - summary: response.content_part.added - value: - content_index: 0 - item_id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - output_index: 0 - part: - annotations: [] - text: "" - type: output_text - sequence_number: 3 - type: response.content_part.added - response_output_text_delta: - summary: response.output_text.delta - value: - content_index: 0 - delta: I can retrieve that — I just need one - item_id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - logprobs: [] - output_index: 0 - sequence_number: 5 - type: response.output_text.delta - response_output_text_done: - summary: response.output_text.done - value: - content_index: 0 - item_id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - logprobs: [] - output_index: 0 - sequence_number: 24 - text: |- - I can retrieve that — I just need one detail from you. - - What I need - - Provide the stream UUID (preferred) — e.g., the stream's unique ID. - - Or, if you don't have the UUID, tell me the stream name (or confirm you want me to list your streams so you can pick one). - - Options I can perform for you - - If you give a stream UUID → I'll fetch the stream details and return the stream state and project ID. - - If you give a stream name → I can search/list streams matching that name (you may need to pick the correct one) and then fetch details. - - If you ask me to list streams now → I can return a paged list of your streams so you can choose which to inspect. - - Tell me which option you prefer and, if available, paste the stream UUID (or stream name). - type: response.output_text.done - response_content_part_done: - summary: response.content_part.done - value: - content_index: 0 - item_id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - output_index: 0 - part: - annotations: [] - text: |- - I can retrieve that — I just need one detail from you. - - What I need - - Provide the stream UUID (preferred) — e.g., the stream's unique ID. - - Or, if you don't have the UUID, tell me the stream name (or confirm you want me to list your streams so you can pick one). - - Options I can perform for you - - If you give a stream UUID → I'll fetch the stream details and return the stream state and project ID. - - If you give a stream name → I can search/list streams matching that name (you may need to pick the correct one) and then fetch details. - - If you ask me to list streams now → I can return a paged list of your streams so you can choose which to inspect. - - Tell me which option you prefer and, if available, paste the stream UUID (or stream name). - type: output_text - sequence_number: 25 - type: response.content_part.done - response_output_item_done: - summary: response.output_item.done - value: - item: - id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - content: - - annotations: [] - text: |- - I can retrieve that — I just need one detail from you. - - What I need - - Provide the stream UUID (preferred) — e.g., the stream's unique ID. - - Or, if you don't have the UUID, tell me the stream name (or confirm you want me to list your streams so you can pick one). - - Options I can perform for you - - If you give a stream UUID → I'll fetch the stream details and return the stream state and project ID. - - If you give a stream name → I can search/list streams matching that name (you may need to pick the correct one) and then fetch details. - - If you ask me to list streams now → I can return a paged list of your streams so you can choose which to inspect. - - Tell me which option you prefer and, if available, paste the stream UUID (or stream name). - type: output_text - role: assistant - status: completed - type: message - output_index: 0 - sequence_number: 26 - type: response.output_item.done - response_completed: - summary: response.completed - value: - response: - id: resp_4542cc2f-7e4c-4694-a5fb-7797a150d0e0 - created_at: 1765358850.078279 - metadata: - related_prompt_1: List streams - related_prompt_2: Get stream stream state & project - related_prompt_3: Search streams by name '' stream - model: fsa-agent - object: response - output: - - id: msg_155f9af1-2931-4258-ae22-c34d2b138e4d - content: - - annotations: [] - text: |- - I can retrieve that — I just need one detail from you. - - What I need - - Provide the stream UUID (preferred) — e.g., the stream's unique ID. - - Or, if you don't have the UUID, tell me the stream name (or confirm you want me to list your streams so you can pick one). - - Options I can perform for you - - If you give a stream UUID → I'll fetch the stream details and return the stream state and project ID. - - If you give a stream name → I can search/list streams matching that name (you may need to pick the correct one) and then fetch details. - - If you ask me to list streams now → I can return a paged list of your streams so you can choose which to inspect. - - Tell me which option you prefer and, if available, paste the stream UUID (or stream name). - type: output_text - role: assistant - status: completed - type: message - parallel_tool_calls: false - tool_choice: none - tools: [] - status: completed - sequence_number: 27 - type: response.completed - standard-response: - value: - id: resp_08b22a5f-63c6-4892-8cd6-2a4b1ef591c0 - created_at: 1765339923 - model: fsa-agent - object: response - output: - - id: msg_14af23c6-15ea-4f11-8fa6-0cc80ffba850 - content: - - annotations: [] - text: Output data from Equinix Networking Assistant in response to prompt - type: output_text - role: assistant - status: completed - type: message - parallel_tool_calls: false - tool_choice: none - tools: [] - safety_identifier: - status: completed - text: - format: - type: text - usage: - input_tokens: 86146 - input_tokens_details: - cached_tokens: 0 - output_tokens: 1803 - output_tokens_details: - reasoning_tokens: 960 - total_tokens: 87949 - user: - response-with-related-prompt: - value: - id: resp_08b22a5f-63c6-4892-8cd6-2a4b1ef591c0 - created_at: 1765339923 - metadata: - related_prompt_1: Get Network Edge service IPsec/IKE example - related_prompt_2: Pair Network Edge service VPN with FCR router BGP config - related_prompt_3: Compare Equinix Fabric service vs VPN for metro SV (cost/latency/SLAs) - model: fsa-agent - object: response - output: - - id: msg_14af23c6-15ea-4f11-8fa6-0cc80ffba850 - content: - - annotations: [] - text: Output data from Equinix Networking Assistant in response to prompt - type: output_text - role: assistant - status: completed - type: message - parallel_tool_calls: false - tool_choice: none - tools: [] - safety_identifier: - status: completed - text: - format: - type: text - usage: - input_tokens: 86146 - input_tokens_details: - cached_tokens: 0 - output_tokens: 1803 - output_tokens_details: - reasoning_tokens: 960 - total_tokens: 87949 - user: - response-with-annotations: - value: - id: resp_08b22a5f-63c6-4892-8cd6-2a4b1ef591c0 - created_at: 1765339923 - model: fsa-agent - object: response - output: - - id: msg_14af23c6-15ea-4f11-8fa6-0cc80ffba850 - content: - - annotations: - - start_index: 0 - end_index: 0 - type: url_citation - title: "" - url: https://docs.equinix.com/managed-solutions/regional/united-kingdom/gms-uk-ips-infrastructure-platform-service - - start_index: 0 - end_index: 0 - type: url_citation - title: "" - url: https://docs.equinix.com/connecting-to-service-provider/fabric-connect-akamai - text: Output data from Equinix Networking Assistant in response to prompt - type: output_text - role: assistant - status: completed - type: message - parallel_tool_calls: false - tool_choice: none - tools: [] - safety_identifier: - status: completed - text: - format: - type: text - usage: - input_tokens: 86146 - input_tokens_details: - cached_tokens: 0 - output_tokens: 1803 - output_tokens_details: - reasoning_tokens: 960 - total_tokens: 87949 - user: - structured-output-response: - value: - id: resp_03490546-ddd4-4082-897d-c4b25076100f - created_at: 1778016085 - model: fsa-agent - object: response - output: - - id: msg_0beaa595b63725bd0069fa5f57871c819493aaf9bf91a686c3 - content: - - annotations: [] - text: |- - { - "component": "observability_chart", - "asset_type": "port", - "asset_id": "757400f8-d360-11e9-bb65-2a2ae2dbcce6", - "asset_name": "Equinix-SV-CX-port-L-Dot1q-100G-PRI", - "title": "Port metrics", - "indexKey": "time", - "error": { - "type": "ResourceNotFound", - "message": "I couldn't find a port with UUID bb1ad009-4dcc-4459-88b1-02df653d3004, so I can't return metrics for it." - }, - "data": [], - "series": [ - { - "dataKey": "bandwidth_rx", - "name": "Inbound bandwidth", - "color": "#1f77b4" - }, - { - "dataKey": "bandwidth_tx", - "name": "Outbound bandwidth", - "color": "#ff7f0e" - }, - { - "dataKey": "drops_erred", - "name": "Dropped/erred packets", - "color": "#d62728" - } - ] - } - type: output_text - logprobs: [] - role: assistant - status: completed - type: message - parallel_tool_calls: false - tool_choice: none - tools: [] - 500-responses-internal-server-error: - value: - - errorCode: EQ-3222201 - errorMessage: | - I'm so sorry, we were unable to process your prompt due to a system level issue. Equinix Networking Assistant needs some tender, loving care. Please report this error to maintainers with error code EQ-3222201. - correlationId: 123e4567-e89b-12d3-a456-426614174000 - response-deleted: - value: - id: resp_08b22a5f-63c6-4892-8cd6-2a4b1ef591c0 - deleted: true - object: response - input-items: - summary: Standard input items response - value: - data: - - id: msg_16fb930e-c71a-4cfc-9b5d-4871c6a98aef - content: - - annotations: [] - text: |- - Results — connections in DC with Fabric Cloud Router (FCR), active (limit 20) - ..... - type: output_text - role: assistant - status: completed - type: message - - id: msg_3920f72c-5172-42d1-8f5b-7eafd490411e - content: - text: Show connections in DC with FCRs; active, either side, limit 20 - type: input_text - role: user - first_id: msg_16fb930e-c71a-4cfc-9b5d-4871c6a98aef - has_more: false - last_id: msg_3920f72c-5172-42d1-8f5b-7eafd490411e - object: list - GatewayCreate: - value: - type: VPN_GW - name: My-VPN-Gateway - description: my test gateway - package: - code: LAB - haEnabled: true - localAsn: 65432 - router: - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - type: XF_ROUTER - project: - projectId: b1baecec-b7e7-453b-89fc-b35757bfcdbf - account: - accountNumber: 12345678 - order: - purchaseOrderNumber: 1-129105284100 - notifications: - - type: ALL - emails: - - test@test.com - GatewayPostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/gateways/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - uuid: c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - type: VPN_GW - name: My-VPN-Gateway - description: my test gateway - state: PROVISIONING - package: - code: LAB - router: - href: https://api.equinix.com/fabric/v4/routers/6658cc3b-18e0-437c-b972-62b51a419a1e - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - type: XF_ROUTER - localAsn: 65432 - ipv4: - primaryIp: 192.168.127.12/30 - secondaryIp: 192.168.127.13/30 - project: - projectId: b1baecec-b7e7-453b-89fc-b35757bfcdbf - account: - accountNumber: 12345678 - order: - purchaseOrderNumber: 1-129105284100 - notifications: - - type: ALL - emails: - - test@test.com - changeLog: - createdBy: abc@xyz.com - createdByEmail: abc@xyz.com - createdDateTime: 2025-04-21T01:11:11.117Z - updatedBy: abc@xyz.com - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-04-22T02:22:22.227Z - Gateway_400_InvalidName: - value: - - errorCode: EQ-8010022 - errorMessage: Name is minimum 3 and up to 24 characters in length - correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e - 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 - Gateway_401: - value: - - errorCode: EQ-8010001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - Gateway_403: - value: - - errorCode: EQ-8010002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - Gateway_415: - value: - - errorCode: EQ-8010016 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - Gateway_500: - value: - - errorCode: EQ-8010030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - GatewaySearchFilterByStatus: - value: - filter: - and: - - property: /state - operator: = - values: - - PROVISIONED - - property: /project/projectId - operator: IN - values: - - b1baecec-b7e7-453b-89fc-b35757bfcdbf - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - GatewaySearchFilterByName: - value: - filter: - and: - - property: /name - operator: = - values: - - test- - - property: /project/projectId - operator: = - values: - - 6658cc3b-18e0-437c-b972-62b51a419a1e - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - GatewaySearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /name - operator: LIKE - values: - - abc% - - property: /name - operator: = - values: - - test-vpn - - property: /project/projectId - operator: = - values: - - b1baecec-b7e7-453b-89fc-b35757bfcdbf - GatewaySearchExample: - value: - pagination: - offset: 20 - limit: 20 - total: 1 - next: /search?offset=40&limit=20 - previous: /search?offset=0&limit=20 - data: - - href: https://api.equinix.com/fabric/v4/gateways/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - uuid: c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - type: VPN_GW - name: My-VPN-Gateway - description: my test gateway - state: PROVISIONED - package: - code: LAB - router: - href: https://api.equinix.com/fabric/v4/routers/6658cc3b-18e0-437c-b972-62b51a419a1e - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - type: XF_ROUTER - localAsn: 65432 - ipv4: - primaryIp: 192.168.127.12/30 - secondaryIp: 192.168.127.13/30 - project: - projectId: b1baecec-b7e7-453b-89fc-b35757bfcdbf - account: - accountNumber: 12345678 - notifications: - - type: ALL - emails: - - test@test.com - changeLog: - createdBy: abc@xyz.com - createdByEmail: abc@xyz.com - createdDateTime: 2025-04-21T01:11:11.117Z - updatedBy: abc@xyz.com - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-04-22T02:22:22.227Z - Gateway_400_InvalidSorting: - value: - - errorCode: EQ-8010039 - errorMessage: Invalid value for sorting direction. - correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - GatewayGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/gateways/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - uuid: c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - type: VPN_GW - name: My-VPN-Gateway - description: my test gateway - state: PROVISIONED - package: - code: LAB - router: - href: https://api.equinix.com/fabric/v4/routers/6658cc3b-18e0-437c-b972-62b51a419a1e - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - type: XF_ROUTER - localAsn: 65432 - ipv4: - primaryIp: 192.168.127.12/30 - secondaryIp: 192.168.127.13/30 - project: - projectId: b1baecec-b7e7-453b-89fc-b35757bfcdbf - account: - accountNumber: 12345678 - notifications: - - type: ALL - emails: - - test@test.com - changeLog: - createdBy: abc@xyz.com - createdByEmail: abc@xyz.com - createdDateTime: 2025-04-21T01:11:11.117Z - updatedBy: abc@xyz.com - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-04-22T02:22:22.227Z - Gateway_404: - value: - - errorCode: EQ-8010020 - errorMessage: Gateway not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: Gateway not found or already deleted - GatewayDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/gateways/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - uuid: c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - type: VPN_GW - name: My-VPN-Gateway - description: my test gateway - state: DEPROVISIONING - package: - code: LAB - router: - href: https://api.equinix.com/fabric/v4/routers/6658cc3b-18e0-437c-b972-62b51a419a1e - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - type: XF_ROUTER - localAsn: 65432 - ipv4: - primaryIp: 192.168.127.12/30 - secondaryIp: 192.168.127.13/30 - project: - projectId: b1baecec-b7e7-453b-89fc-b35757bfcdbf - account: - accountNumber: 12345678 - notifications: - - type: ALL - emails: - - test@test.com - changeLog: - createdBy: abc@xyz.com - createdByEmail: abc@xyz.com - createdDateTime: 2025-04-21T01:11:11.117Z - updatedBy: abc@xyz.com - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-04-22T02:22:22.227Z - deletedBy: abc@xyz.com - deletedByEmail: abc@xyz.com - deletedDateTime: 2025-04-23T03:33:33.337Z - Gateway_400_InvalidState: - value: - - errorCode: EQ-8010030 - errorMessage: Cannot delete Gateway in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete Gateway in transient state. - GatewayUpdateNameRequest: - value: - - op: replace - path: /name - value: Gw-Name-2 - GatewayUpdatePackageRequest: - value: - - op: replace - path: /package/code - value: LAB - GatewayUpdateResponseExample: - value: - href: https://api.equinix.com/fabric/v4/gateways/c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - uuid: c93a9ca0-bb56-490b-8bce-4b2bdaeb4d46 - type: VPN_GW - name: Gw-Name-2 - description: my test gateway - state: REPROVISIONING - package: - code: LAB - router: - href: https://api.equinix.com/fabric/v4/routers/6658cc3b-18e0-437c-b972-62b51a419a1e - uuid: 6658cc3b-18e0-437c-b972-62b51a419a1e - type: XF_ROUTER - localAsn: 65432 - ipv4: - primaryIp: 192.168.127.12/30 - secondaryIp: 192.168.127.13/30 - project: - projectId: b1baecec-b7e7-453b-89fc-b35757bfcdbf - account: - accountNumber: 12345678 - notifications: - - type: ALL - emails: - - test@test.com - changeLog: - createdBy: abc@xyz.com - createdByEmail: abc@xyz.com - createdDateTime: 2025-04-21T01:11:11.117Z - updatedBy: abc@xyz.com - updatedByEmail: abc@xyz.com - updatedDateTime: 2025-04-22T02:22:22.227Z - ListGatewayPackagesResponse: - value: - pagination: - offset: 0 - limit: 2 - total: 2 - data: - - href: https://api.equinix.com/fabric/v4/gatewayPackages/LAB - type: GW_PACKAGE - code: LAB - description: string - totalIPv4RoutesMax: 50 - totalIPv6RoutesMax: 50 - totalTunnelsMax: 4 - bandwidth: 50 - - href: https://api.equinix.com/fabric/v4/gatewayPackages/STANDARD - type: GW_PACKAGE - code: STANDARD - description: string - totalIPv4RoutesMax: 250 - totalIPv6RoutesMax: 250 - totalTunnelsMax: 10 - bandwidth: 1000 - GetGatewayPackageResponse: - value: - href: https://api.equinix.com/fabric/v4/gatewayPackages/LAB - type: GW_PACKAGE - code: LAB - description: string - totalIPv4RoutesMax: 50 - totalIPv6RoutesMax: 50 - totalTunnelsMax: 4 - bandwidth: 50 - TunnelRoutingProtocolGetAllResponseExample: - value: - pagination: - offset: 0 - limit: 10 - total: 1 - previous: "" - next: "" - data: - - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656/routingProtocols/80932bb5-1d3e-457a-b067-0ace6a3a0268 - uuid: 80932bb5-1d3e-457a-b067-0ace6a3a0268 - type: BGP - name: testBgpPeer1 - state: PROVISIONED - ipv4: - enabled: true - localPeerIp: 192.168.1.1 - remotePeerIp: 192.168.1.2 - localAsn: 65432 - remoteAsn: 65219 - authentication: - type: MD5 - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - TunnelRoutingProtocol_401: - value: - - errorCode: EQ-3047304 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - TunnelRoutingProtocol_403: - value: - - errorCode: EQ-3047305 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - TunnelRoutingProtocol_404: - value: - - errorCode: EQ-3047306 - errorMessage: Tunnel Routing Protocol not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: Tunnel Routing Protocol not found or already deleted - TunnelRoutingProtocol_500: - value: - - errorCode: EQ-3047308 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - TunnelRoutingProtocolCreate: - value: - type: BGP - name: testBgpPeer1 - ipv4: - enabled: true - authentication: - type: MD5 - key: 8a9d5f3ca2b4a5fd7e8b6d8a9c5f3e2b1a7 - remoteAsn: 65219 - TunnelRoutingProtocolPostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656/routingProtocols/80932bb5-1d3e-457a-b067-0ace6a3a0268 - uuid: 80932bb5-1d3e-457a-b067-0ace6a3a0268 - type: BGP - name: My-BgpPeer - ipv4: - enabled: true - localPeerIp: 192.168.1.1 - remotePeerIp: 192.168.1.2 - localAsn: 65432 - remoteAsn: 65219 - authentication: - type: MD5 - state: PROVISIONED - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - TunnelRoutingProtocol_400_InvalidName: - value: - - errorCode: EQ-3047301 - errorMessage: Name is minimum 0 and up to 50 characters in length - correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e - details: Name is minimum 0 and up to 50 characters in length - additionalInfo: - - property: /name - reason: Name is minimum 0 and up to 50 characters in length - TunnelRoutingProtocol_415: - value: - - errorCode: EQ-3047307 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - TunnelRoutingProtocolGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656/routingProtocols/80932bb5-1d3e-457a-b067-0ace6a3a0268 - uuid: 80932bb5-1d3e-457a-b067-0ace6a3a0268 - type: BGP - name: My-BgpPeer - ipv4: - enabled: true - localPeerIp: 192.168.1.1 - remotePeerIp: 192.168.1.2 - localAsn: 65432 - remoteAsn: 65219 - authentication: - type: MD5 - state: PROVISIONED - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-03-10T05:00:00Z - TunnelRoutingProtocolDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656/routingProtocols/80932bb5-1d3e-457a-b067-0ace6a3a0268 - uuid: 80932bb5-1d3e-457a-b067-0ace6a3a0268 - type: BGP - name: My-BgpPeer - ipv4: - enabled: true - localPeerIp: 192.168.1.1 - remotePeerIp: 192.168.1.2 - localAsn: 65432 - remoteAsn: 65219 - authentication: - type: MD5 - state: DEPROVISIONING - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-03-10T05:00:00Z - deletedBy: testBuyer - deletedDateTime: 2025-03-15T12:20:06Z - TunnelRoutingProtocol_400_InvalidState: - value: - - errorCode: EQ-3047303 - errorMessage: Cannot delete Tunnel Routing Protocol in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete Tunnel Routing Protocol in transient state. - TunnelRoutingProtocolUpdateNameRequest: - value: - - op: replace - path: /name - value: testBgpPeer1-new-name - TunnelRoutingProtocolUpdateEnabledRequest: - value: - - op: replace - path: /ipv4/enabled - value: false - TunnelRoutingProtocolUpdateResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656/routingProtocols/80932bb5-1d3e-457a-b067-0ace6a3a0268 - uuid: 80932bb5-1d3e-457a-b067-0ace6a3a0268 - type: BGP - name: testBgpPeer1-new-name - state: REPROVISIONING - ipv4: - enabled: true - localPeerIp: 192.168.1.1 - remotePeerIp: 192.168.1.2 - localAsn: 65432 - remoteAsn: 65219 - authentication: - type: MD5 - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-04-28T04:12:36.607Z - GatewayTunnelCreate: - value: - type: IPSEC_TUNNEL - name: My-Tunnel - description: My IPSec tunnel - gateway: - uuid: 01e1218a-8ed4-493e-a5e9-8e54806894b9 - ipv4: - tunnelRemoteIp: 192.168.1.1/30 - tunnelLocalIp: 192.168.1.2/30 - mtu: 1500 - enabled: true - remoteBranchIp: 1.2.3.43 - authentication: - type: PSK - ikeVersion: IKEV2 - preSharedKey: my_secret_key_123456 - phase1DhGroup: "14" - phase1EncryptAlgorithm: AES128_GCM16 - phase1IntegrityAlgorithm: SHA256 - phase2DhGroup: "14" - phase2EncryptAlgorithm: AES128_GCM16 - phase2IntegrityAlgorithm: SHA256 - ikeLifetime: 28800 - espLifetime: 3600 - GatewayTunnelPostResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656 - uuid: aee72df9-dec8-4c89-8f18-c4d0ef203656 - type: IPSEC_TUNNEL - name: My-Tunnel - description: My IPSec tunnel - state: PROVISIONING - gateway: - href: https://api.equinix.com/fabric/v4/gateways/01e1218a-8ed4-493e-a5e9-8e54806894b9 - type: VPN_GW - uuid: 01e1218a-8ed4-493e-a5e9-8e54806894b9 - ipv4: - tunnelRemoteIp: 192.168.1.1/30 - tunnelLocalIp: 192.168.1.2/30 - mtu: 1500 - enabled: true - remoteBranchIp: 1.2.3.43 - authentication: - type: PSK - ikeVersion: IKEV2 - preSharedKey: "********" - phase1DhGroup: "14" - phase1EncryptAlgorithm: AES128_GCM16 - phase1IntegrityAlgorithm: SHA256 - phase2DhGroup: "14" - phase2EncryptAlgorithm: AES128_GCM16 - phase2IntegrityAlgorithm: SHA256 - ikeLifetime: 28800 - espLifetime: 3600 - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-03-29T05:00:00.000Z - GatewayTunnel_400_InvalidName: - value: - - errorCode: EQ-8030022 - errorMessage: Name is minimum 0 and up to 50 characters in length - correlationId: fc7a32c8-2b99-4915-bb4b-eb42bbba668e - details: Name is minimum 0 and up to 50 characters in length - additionalInfo: - - property: /name - reason: Name is minimum 0 and up to 50 characters in length - GatewayTunnel_401: - value: - - errorCode: EQ-8030001 - errorMessage: User not found in request or invalid. - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - reason: You are unauthorized to perform this operation - GatewayTunnel_403: - value: - - errorCode: EQ-8030002 - errorMessage: Operation not allowed - correlationId: 8a72af9d-23f7-4b90-8237-0987130b42dd - details: Operation not allowed for current user - GatewayTunnel_415: - value: - - errorCode: EQ-8030016 - errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding - correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 - additionalInfo: - - property: contentType - reason: The payload format is in an unsupported format - GatewayTunnel_500: - value: - - errorCode: EQ-8030030 - errorMessage: Internal Server Error - correlationId: f9018571-1001-4422-978b-bfa38ed6b92e - details: Internal Server Error - GatewayTunnelGetResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656 - uuid: aee72df9-dec8-4c89-8f18-c4d0ef203656 - type: IPSEC_TUNNEL - name: My-Tunnel - description: My IPSec tunnel - state: PROVISIONED - gateway: - href: https://api.equinix.com/fabric/v4/gateways/01e1218a-8ed4-493e-a5e9-8e54806894b9 - type: VPN_GW - uuid: 01e1218a-8ed4-493e-a5e9-8e54806894b9 - ipv4: - tunnelRemoteIp: 192.168.1.1/30 - tunnelLocalIp: 192.168.1.2/30 - mtu: 1500 - enabled: true - remoteBranchIp: 1.2.3.43 - authentication: - type: PSK - ikeVersion: IKEV2 - preSharedKey: "********" - phase1DhGroup: "14" - phase1EncryptAlgorithm: AES128_GCM16 - phase1IntegrityAlgorithm: SHA256 - phase2DhGroup: "14" - phase2EncryptAlgorithm: AES128_GCM16 - phase2IntegrityAlgorithm: SHA256 - ikeLifetime: 28800 - espLifetime: 3600 - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-03-10T05:00:00Z - GatewayTunnel_404: - value: - - errorCode: EQ-8030020 - errorMessage: Gateway Tunnel not found or already deleted - correlationId: 9b6baf30-3eb0-458c-af8b-fff3fae32bc7 - details: Gateway Tunnel not found or already deleted - GatewayTunnelDeleteResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656 - uuid: aee72df9-dec8-4c89-8f18-c4d0ef203656 - type: IPSEC_TUNNEL - name: My-Tunnel - description: My IPSec tunnel - state: DEPROVISIONING - gateway: - href: https://api.equinix.com/fabric/v4/gateways/01e1218a-8ed4-493e-a5e9-8e54806894b9 - type: VPN_GW - uuid: 01e1218a-8ed4-493e-a5e9-8e54806894b9 - ipv4: - tunnelRemoteIp: 192.168.1.1/30 - tunnelLocalIp: 192.168.1.2/30 - mtu: 1500 - enabled: true - remoteBranchIp: 1.2.3.43 - authentication: - type: PSK - ikeVersion: IKEV2 - preSharedKey: "********" - phase1DhGroup: "14" - phase1EncryptAlgorithm: AES128_GCM16 - phase1IntegrityAlgorithm: SHA256 - phase2DhGroup: "14" - phase2EncryptAlgorithm: AES128_GCM16 - phase2IntegrityAlgorithm: SHA256 - ikeLifetime: 28800 - espLifetime: 3600 - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-03-10T05:00:00Z - deletedBy: testBuyer - deletedDateTime: 2025-03-15T12:20:06Z - GatewayTunnel_400_InvalidState: - value: - - errorCode: EQ-8030030 - errorMessage: Cannot delete Gateway Tunnel in transient state - correlationId: 09fbe616-e563-438e-9b1b-56632d1611ff - details: Cannot delete Gateway Tunnel in transient state. - GatewayTunnelUpdateEnabled: - value: - - op: replace - path: /enabled - value: true - GatewayTunnelUpdateName: - value: - - op: replace - path: /name - value: updated-tunnel - GatewayTunnelUpdateDescription: - value: - - op: replace - path: /description - value: updated tunnel description - GatewayTunnelUpdatePreSharedKey: - value: - - op: replace - path: /authentication/preSharedKey - value: my_new_secret_key_123456 - GatewayTunnelUpdateLifetimes: - value: - - op: replace - path: /authentication/ikeLifetime - value: 14400 - - op: replace - path: /authentication/espLifetime - value: 1800 - GatewayTunnelUpdateResponseExample: - value: - href: https://api.equinix.com/fabric/v4/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656 - uuid: aee72df9-dec8-4c89-8f18-c4d0ef203656 - type: IPSEC_TUNNEL - name: My-Tunnel - description: My IPSec tunnel - state: REPROVISIONING - gateway: - href: https://api.equinix.com/fabric/v4/gateways/01e1218a-8ed4-493e-a5e9-8e54806894b9 - type: VPN_GW - uuid: 01e1218a-8ed4-493e-a5e9-8e54806894b9 - ipv4: - tunnelRemoteIp: 192.168.1.1/30 - tunnelLocalIp: 192.168.1.2/30 - mtu: 1500 - enabled: true - remoteBranchIp: 1.2.3.43 - authentication: - type: PSK - ikeVersion: IKEV2 - preSharedKey: "********" - phase1DhGroup: "14" - phase1EncryptAlgorithm: AES128_GCM16 - phase1IntegrityAlgorithm: SHA256 - phase2DhGroup: "14" - phase2EncryptAlgorithm: AES128_GCM16 - phase2IntegrityAlgorithm: SHA256 - ikeLifetime: 28800 - espLifetime: 3600 - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-03-29T05:00:00.000Z - GatewayTunnelSearchFilterByStatus: - value: - filter: - and: - - property: /state - operator: IN - values: - - PROVISIONED - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - GatewayTunnelSearchFilterByName: - value: - filter: - and: - - property: /name - operator: = - values: - - test- - pagination: - offset: 0 - limit: 20 - sort: - - direction: DESC - property: /changeLog/createdDateTime - GatewayTunnelSearchFilterOrAnd: - value: - filter: - and: - - or: - - property: /name - operator: LIKE - values: - - abc% - - property: /state - operator: = - values: - - PROVISIONED - GatewayTunnelSearchExample: - 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/tunnels/aee72df9-dec8-4c89-8f18-c4d0ef203656 - uuid: aee72df9-dec8-4c89-8f18-c4d0ef203656 - type: IPSEC_TUNNEL - name: My-Tunnel - description: My IPSec tunnel - state: PROVISIONED - gateway: - href: https://api.equinix.com/fabric/v4/gateways/01e1218a-8ed4-493e-a5e9-8e54806894b9 - type: VPN_GW - uuid: 01e1218a-8ed4-493e-a5e9-8e54806894b9 - ipv4: - tunnelRemoteIp: 192.168.1.1/30 - tunnelLocalIp: 192.168.1.2/30 - mtu: 1500 - enabled: true - remoteBranchIp: 1.2.3.43 - authentication: - type: PSK - ikeVersion: IKEV2 - preSharedKey: "********" - phase1DhGroup: "14" - phase1EncryptAlgorithm: AES128_GCM16 - phase1IntegrityAlgorithm: SHA256 - phase2DhGroup: "14" - phase2EncryptAlgorithm: AES128_GCM16 - phase2IntegrityAlgorithm: SHA256 - ikeLifetime: 28800 - espLifetime: 3600 - changeLog: - createdBy: testBuyer - createdDateTime: 2025-03-28T04:12:36.607Z - updatedBy: testBuyer - updatedDateTime: 2025-03-10T05:00:00Z - GatewayTunnel_400_InvalidSorting: - value: - - errorCode: EQ-8030039 - errorMessage: Invalid value for sorting direction. - correlationId: 11091aa7-322a-461e-b6af-40fd10543c94 - additionalInfo: - - reason: Only accept DESC and ASC for sorting direction. - TermPostFCRRequestExample: - value: - accountNumber: ACCT-123456 - product: CLOUD_ROUTER_PRODUCT - type: BCD_FIXED_TERM - delayDuration: P30D - startDateTime: 2026-09-24T06:59:46Z - quantityEntitled: 1 - name: Q3 FCR Trial — Advanced & Premium - comSolCaseId: CS-98765 - notes: text1 - selector: - and: - - property: /router/package/code - operator: IN - values: - - ADVANCED - - PREMIUM - TermPostVCRequestExample: - value: - accountNumber: ACCT-654321 - product: VIRTUAL_CONNECTION_PRODUCT - type: BCD_FIXED_TERM - delayDuration: P60D - startDateTime: 2026-07-01T00:00:00Z - quantityEntitled: 1 - name: Q3 VC Trial — Up to 1G - comSolCaseId: CS-98766 - selector: - and: - - property: /connection/bandwidth - operator: <= - values: - - "1000" - TermPostFCRResponseExample: - value: - href: https://api.equinix.com/fabric/v4/terms/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - accountNumber: ACCT-123456 - type: BCD_FIXED_TERM - product: CLOUD_ROUTER_PRODUCT - state: ACTIVE - startDateTime: 2026-09-24T06:59:46Z - delayDuration: P30D - commencementDateTime: 2026-12-24T06:59:46Z - quantityEntitled: 1 - name: Q3 FCR Trial — Advanced & Premium - comSolCaseId: CS-98765 - notes: text1 - selector: - and: - - property: /router/package/code - operator: IN - values: - - ADVANCED - - PREMIUM - changeLog: - createdId: 1222 - createdDateTime: 2026-06-15T10:00:00Z - TermPostVCResponseExample: - value: - href: https://api.equinix.com/fabric/v4/terms/b2c3d4e5-f6a7-8901-bcde-f12345678901 - uuid: b2c3d4e5-f6a7-8901-bcde-f12345678901 - accountNumber: ACCT-654321 - type: BCD_FIXED_TERM - product: VIRTUAL_CONNECTION_PRODUCT - state: ACTIVE - startDateTime: 2026-07-01T00:00:00Z - delayDuration: P60D - commencementDateTime: 2026-08-30T00:00:00Z - quantityEntitled: 1 - name: Q3 VC Trial — Up to 1G - comSolCaseId: CS-98766 - selector: - and: - - property: /connection/bandwidth - operator: <= - values: - - "1000" - changeLog: - createdId: 1223 - createdDateTime: 2026-06-15T10:05:00Z - Terms_400: - value: - - errorCode: EQ-3073002 - errorMessage: Invalid argument - correlationId: req-abc-123 - details: accountNumber is required - additionalInfo: - - property: accountNumber - reason: required - Terms_400_TermStartDateInPast: - value: - - errorCode: EQ-3073010 - errorMessage: startDateTime cannot be in the past - correlationId: req-abc-123 - details: startDateTime cannot be in the past - additionalInfo: - - property: startDateTime - reason: must be today or a future date - Terms_500: - value: - - errorCode: EQ-3073001 - errorMessage: Internal error - correlationId: req-abc-123 - details: Internal system error - TermGetByIdFCRResponseExample: - value: - href: https://api.equinix.com/fabric/v4/terms/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - accountNumber: ACCT-123456 - type: BCD_FIXED_TERM - product: CLOUD_ROUTER_PRODUCT - state: ACTIVE - startDateTime: 2026-09-24T06:59:46Z - delayDuration: P30D - commencementDateTime: 2026-12-24T06:59:46Z - quantityEntitled: 1 - name: Q3 FCR Trial — Advanced & Premium - comSolCaseId: CS-98765 - notes: text1 - selector: - and: - - property: /router/package/code - operator: IN - values: - - ADVANCED - - PREMIUM - changeLog: - createdId: 1222 - createdDateTime: 2026-06-15T10:00:00Z - TermGetByIdVCResponseExample: - value: - href: https://api.equinix.com/fabric/v4/terms/b2c3d4e5-f6a7-8901-bcde-f12345678901 - uuid: b2c3d4e5-f6a7-8901-bcde-f12345678901 - accountNumber: ACCT-654321 - type: BCD_FIXED_TERM - product: VIRTUAL_CONNECTION_PRODUCT - state: ACTIVE - startDateTime: 2026-07-01T00:00:00Z - delayDuration: P60D - commencementDateTime: 2026-08-30T00:00:00Z - quantityEntitled: 1 - name: Q3 VC Trial — Up to 1G - comSolCaseId: CS-98766 - selector: - and: - - property: /connection/bandwidth - operator: <= - values: - - "1000" - changeLog: - createdId: 1223 - createdDateTime: 2026-06-15T10:05:00Z - Terms_404: - value: - - errorCode: EQ-3073004 - errorMessage: Resource not found - correlationId: req-abc-123 - details: "Term not found: a1b2c3d4-e5f6-7890-abcd-ef1234567890" - TermDeleteFCRResponseExample: - value: - href: https://api.equinix.com/fabric/v4/terms/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - accountNumber: ACCT-123456 - type: BCD_FIXED_TERM - product: CLOUD_ROUTER_PRODUCT - state: DELETED - startDateTime: 2026-09-24T06:59:46Z - delayDuration: P30D - commencementDateTime: 2026-12-24T06:59:46Z - quantityEntitled: 1 - name: Q3 FCR Trial — Advanced & Premium - comSolCaseId: CS-98765 - notes: text1 - selector: - and: - - property: /router/package/code - operator: IN - values: - - ADVANCED - - PREMIUM - changeLog: - createdId: 1222 - createdDateTime: 2026-06-15T10:00:00Z - deletedId: 1222 - deletedDateTime: 2026-07-29T09:00:00Z - TermDeleteVCResponseExample: - value: - href: https://api.equinix.com/fabric/v4/terms/b2c3d4e5-f6a7-8901-bcde-f12345678901 - uuid: b2c3d4e5-f6a7-8901-bcde-f12345678901 - accountNumber: ACCT-654321 - type: BCD_FIXED_TERM - product: VIRTUAL_CONNECTION_PRODUCT - state: DELETED - startDateTime: 2026-07-01T00:00:00Z - delayDuration: P60D - commencementDateTime: 2026-08-30T00:00:00Z - quantityEntitled: 1 - name: Q3 VC Trial — Up to 1G - comSolCaseId: CS-98766 - selector: - and: - - property: /connection/bandwidth - operator: <= - values: - - "1000" - changeLog: - createdId: 1223 - createdDateTime: 2026-06-15T10:05:00Z - deletedId: 1223 - deletedDateTime: 2026-07-29T09:05:00Z - Terms_409: - value: - - errorCode: EQ-3073005 - errorMessage: Resource already deleted - correlationId: req-abc-123 - details: "Term already deleted: a1b2c3d4-e5f6-7890-abcd-ef1234567890" - TermSearchFCRRequestExample: - value: - filter: - and: - - property: accountNumber - operator: = - values: - - ACCT-123456 - - property: product - operator: = - values: - - CLOUD_ROUTER_PRODUCT - - property: state - operator: = - values: - - ACTIVE - sort: - - field: changeLog.createdDateTime - direction: DESC - pagination: - offset: 0 - limit: 20 - TermSearchVCRequestExample: - value: - filter: - and: - - property: accountNumber - operator: = - values: - - ACCT-654321 - - property: product - operator: = - values: - - VIRTUAL_CONNECTION_PRODUCT - - property: state - operator: IN - values: - - ACTIVE - - INACTIVE - sort: - - field: startDateTime - direction: ASC - pagination: - offset: 0 - limit: 20 - TermSearchResponseExample: - value: - data: - - uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - href: https://api.equinix.com/fabric/v4/terms/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - accountNumber: ACCT-123456 - type: BCD_FIXED_TERM - product: CLOUD_ROUTER_PRODUCT - state: ACTIVE - startDateTime: 2026-09-24T06:59:46Z - delayDuration: P30D - commencementDateTime: 2026-12-24T06:59:46Z - quantityEntitled: 1 - name: Q3 FCR Trial — Advanced & Premium - comSolCaseId: CS-98765 - changeLog: - createdId: 1222 - createdDateTime: 2026-06-15T10:00:00Z - pagination: - offset: 0 - limit: 20 - total: 1 + $ref: '#/components/schemas/AppSubscription' headers: ETag: description: response header - identifier for a specific version of a resource. schema: type: string - securitySchemes: - BearerAuth: - type: http - scheme: bearer - bearerFormat: JWT x-tagGroups: - name: Core Connectivity tags: diff --git a/spec/services/fabricv4/patches/20240909-connection_action-required-field-skip.patch b/spec/services/fabricv4/patches/20240909-connection_action-required-field-skip.patch index c2959273..7dc32d87 100644 --- a/spec/services/fabricv4/patches/20240909-connection_action-required-field-skip.patch +++ b/spec/services/fabricv4/patches/20240909-connection_action-required-field-skip.patch @@ -1,12 +1,12 @@ diff --git a/spec/services/fabricv4/oas3.patched/openapi.yaml b/spec/services/fabricv4/oas3.patched/openapi.yaml -index ff43d17..972a8cc 100644 +index bb19aab..906a78e 100644 --- a/spec/services/fabricv4/oas3.patched/openapi.yaml +++ b/spec/services/fabricv4/oas3.patched/openapi.yaml -@@ -12566,7 +12566,6 @@ components: - ConnectionAction: +@@ -56469,7 +56469,6 @@ components: + $ref: '#/components/schemas/Changelog' required: - - data -- - href - type +- - href - uuid - type: object \ No newline at end of file + - data + ConnectionRouteEntrySimpleExpression: diff --git a/spec/services/fabricv4/patches/20260624-internet_access_service-order-required-skip.patch b/spec/services/fabricv4/patches/20260624-internet_access_service-order-required-skip.patch index 64256a63..60d1732b 100644 --- a/spec/services/fabricv4/patches/20260624-internet_access_service-order-required-skip.patch +++ b/spec/services/fabricv4/patches/20260624-internet_access_service-order-required-skip.patch @@ -1,11 +1,12 @@ diff --git a/spec/services/fabricv4/oas3.patched/openapi.yaml b/spec/services/fabricv4/oas3.patched/openapi.yaml +index bb19aab..e7f8213 100644 --- a/spec/services/fabricv4/oas3.patched/openapi.yaml +++ b/spec/services/fabricv4/oas3.patched/openapi.yaml -@@ -16160,7 +16160,6 @@ components: - - changeLog - - href - - name -- - order +@@ -58245,7 +58245,6 @@ components: + - billing + - account - project - - routingProtocol - - state +- - order + - changeLog + - useCase + properties: