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 contact: name: Equinix API Support url: https://docs.equinix.com/api-support.htm license: name: Equinix Inc url: https://developer.equinix.com/agreement servers: - url: https://api.equinix.com description: Equinix Inc security: - BearerAuth: [] tags: - name: ASNs description: Autonomous System Number (ASN) Beta - name: Application Domains description: Application Domains Beta - name: Application Links description: Application Links Beta - name: Application Processors description: Application Processors Beta - name: Application Services description: Application Services Beta - name: Application Subscriptions description: Application Subscriptions Beta - name: Events description: Events - name: Cloud Router Packages description: Cloud Router Packages - name: Cloud Routers description: Cloud Routers - name: Company Profiles description: Company Profiles Beta - name: Connections description: Connections - name: Cross Connects description: Cross Connects Beta - name: Health description: Health - name: Internet Exchange Services description: Internet Exchange Services Beta - name: Internet Access Services description: Equinix Internet Access (EIA) Beta - name: IP Blocks description: IP Blocks Beta - name: Loas description: Loas Beta - name: Logos description: Logos Beta - name: Marketplace Subscriptions description: Marketplace Subscriptions - name: Metrics description: Metrics - name: Metros description: Metros - name: Networks description: Networks - name: Optical Metro Connects description: Optical Metro Connects Beta - name: Port Packages description: Port Packages Beta - name: Ports description: Ports - name: Precision Time Packages description: Precision Time Packages - name: Precision Time Services description: Precision Time Services - name: Prices description: Prices - name: Route Aggregation Rules description: Route Aggregation Rules - name: Route Aggregations description: Route Aggregations - name: Route Filter Rules description: Route Filter Rules - name: Route Filters description: Route Filters - name: Routing Protocols description: Routing Protocols - name: Service Profiles description: Service Profiles - name: Service Tokens description: Service Tokens - name: Statistics description: Statistics - name: Stream Alert Rules description: Stream Alert Rules - name: Stream Subscriptions description: Stream Subscriptions - name: Streams 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: - Events 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' - name: assetId in: path description: asset UUID required: true schema: 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' - name: toDateTime in: query description: End date and time required: false schema: $ref: '#/components/schemas/EndDateTime' - name: offset in: query description: offset required: false schema: $ref: '#/components/schemas/Offset' - name: limit in: query description: limit required: false schema: $ref: '#/components/schemas/Limit' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetCloudEventsByAssetResponse' examples: Example: 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' 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: 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' examples: example: value: - errorCode: EQ-3045004 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/cloudevents/{cloudEventId}: get: tags: - Events summary: Get Cloud Event description: This API provides capability to retrieve a cloud event by uuid operationId: getCloudEvent parameters: - name: cloudEventId in: path description: Cloud Event UUID required: true schema: description: Cloud Event UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Cloud Event object content: application/json: schema: $ref: '#/components/schemas/CloudEvent' examples: CloudEventResponseExample: 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' 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: 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' examples: example: value: - errorCode: EQ-3045004 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/cloudevents/search: post: tags: - Events summary: Search Cloud Events description: This API provides capability to search cloud events from a filtered query operationId: searchCloudEvents requestBody: content: application/json: schema: $ref: '#/components/schemas/CloudEventSearchRequest' examples: CloudEventSearchRequestExample: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetCloudEventsByAssetResponse' examples: Example: 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' 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: 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' examples: example: value: - errorCode: EQ-3045004 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/liveEvents/search: post: tags: - Events summary: Search last Operational Cloud Events description: This API provides capability to search last operational cloud events from a filtered query operationId: searchLastOpEvents requestBody: content: application/json: schema: $ref: '#/components/schemas/LiveEventSearchRequest' examples: LiveEventSearchRequestExample: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/SearchLiveEventResponse' examples: Example: 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' 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: 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' examples: example: 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: - Metrics 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' - name: assetId in: path description: asset UUID required: true schema: description: Asset UUID type: string format: uuid example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 - name: name in: query description: | 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` required: true schema: type: string pattern: ^equinix\.fabric\.(connection|port|metro)\..+ examples: connectionRxUsageExample: value: equinix.fabric.connection.bandwidth_rx.usage connectionTxUsageExample: value: equinix.fabric.connection.bandwidth_tx.usage connectionRxPacketAsideDroppedExample: value: equinix.fabric.connection.packets_dropped_rx_aside_rateexceeded.count connectionTxPacketAsideDroppedExample: value: equinix.fabric.connection.packets_dropped_tx_aside_rateexceeded.count connectionRxPacketZsideDroppedExample: value: equinix.fabric.connection.packets_dropped_rx_zside_rateexceeded.count connectionTxPacketZsideDroppedExample: value: equinix.fabric.connection.packets_dropped_tx_zside_rateexceeded.count connectionRxByteCountExample: value: equinix.fabric.connection.byte_rx.count connectionTxByteCountExample: value: equinix.fabric.connection.byte_tx.count connectionRxBandwidthUsageSummaryExample: value: equinix.fabric.connection.bandwidth_rx.usage_summary connectionTxBandwidthUsageSummaryExample: value: equinix.fabric.connection.bandwidth_tx.usage_summary portRxUsageExample: value: equinix.fabric.port.bandwidth_rx.usage portTxUsageExample: value: equinix.fabric.port.bandwidth_tx.usage portRxPacketDroppedExample: value: equinix.fabric.port.packets_dropped_rx.count portTxPacketDroppedExample: value: equinix.fabric.port.packets_dropped_tx.count portRxPacketErredExample: value: equinix.fabric.port.packets_erred_rx.count portTxPacketErredExample: value: equinix.fabric.port.packets_erred_tx.count metroLatencyExample: value: equinix.fabric.metro.sv_dc.latency metroJitterExample: value: equinix.fabric.metro.sv_dc.jitter_avg - name: fromDateTime in: query description: Start date and time required: false schema: $ref: '#/components/schemas/StartDateTime' - name: toDateTime in: query description: End date and time required: false schema: $ref: '#/components/schemas/EndDateTime' - name: offset in: query description: offset required: false schema: $ref: '#/components/schemas/Offset' - name: limit in: query description: limit required: false schema: $ref: '#/components/schemas/Limit-2' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetMetricsByAssetResponse' examples: Example: 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' 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: 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' examples: example: value: - errorCode: EQ-3045004 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/metrics: get: tags: - Metrics summary: Get Metrics by Name description: This API provides capability to retrieve Metrics by specific wildcard metric types operationId: getMetricByName parameters: - name: name in: query description: | Name of the metric types with wildcard: - `equinix.fabric.metro.*.latency` - `equinix.fabric.metro.*.jitter_avg` required: true schema: type: string pattern: ^equinix\.fabric\.metro\.\*\..+ examples: metroLatencyExample: value: equinix.fabric.metro.*.latency metroJitterExample: value: equinix.fabric.metro.*.jitter_avg - name: value in: query description: value required: true schema: $ref: '#/components/schemas/Value' - name: offset in: query description: offset required: false schema: $ref: '#/components/schemas/Offset' - name: limit in: query description: limit required: false schema: $ref: '#/components/schemas/Limit-2' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetMetricsByNameResponse' examples: Example: 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' 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: 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' examples: example: value: - errorCode: EQ-3045004 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/metrics/search: post: tags: - Metrics summary: Search Metrics description: This API provides capability to search metrics from a filtered query operationId: searchMetrics requestBody: content: application/json: schema: $ref: '#/components/schemas/MetricsSearchRequest' examples: MetricSearchRequestExample: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetMetricsByAssetResponse' examples: Example: 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' 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: 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' examples: example: value: - errorCode: EQ-3045004 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/connections: post: tags: - Connections summary: Create Connection description: This API provides capability to create user's virtual connection operationId: createConnection parameters: - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectionPostRequest' examples: Colo2Colo-Dot1q2Dot1q: 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-AsResellerForSubCustomer: 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 Colo2Sp-Generic: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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 Colo2Network-EVPLAN_VC: 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: 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: 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: 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 Vd2Sp-Aws: 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: 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: 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: 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: 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: 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: 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-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-Primary: 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-re-add: 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-Marketplace-subscription: 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: 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 AsideServiceToken2ColoWithDot1q: 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: 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 Metal2Port-ZsideServiceToken: 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 Vd2IASp: 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: 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: 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: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Connection' examples: ConnectionDryRun-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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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 '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-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: 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: - Connections summary: Get Connection by ID description: The API provides capability to get user's virtual connection details (Service Tokens, Access Points, Link Protocols, etc) by it's connection ID (UUID) operationId: getConnectionByUuid parameters: - name: connectionId in: path description: Connection Id required: true schema: 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' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Connection' examples: nonGenericConnectionResponse: 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: 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: 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: 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' examples: example: 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' 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: 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 summary: Update Connection by ID description: Update Connection by ID operationId: updateConnectionByUuid parameters: - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/ConnectionUpdateRequest' examples: ConnectionUpdateNameRequest: 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 ConnectionMigrationAsideRequestForVirtualDevice: value: - op: replace path: /aSide/accessPoint value: virtualDevice: type: EDGE uuid: 207667ba-3211-452c-b0a8-8b9046e122a5 interface: type: CLOUD id: 4 ConnectionUpdateBandwidthRequestDryRun: value: - op: replace path: /bandwidth value: 1000 ConnectionPriorityMigrationAsideRequestForVirtualDevice: value: - op: replace path: /aSide/accessPoint/fabricEdgePriority value: PRIMARY required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Connection' examples: connectionPatchExampleDryRun: 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' examples: connectionPatchExample: 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: 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': description: Bad request content: application/json: schema: $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: 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' 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-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' 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: 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: - Connections summary: Create Connection Action description: This API provides capability to accept/reject user's virtual connection operationId: createConnectionAction parameters: - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectionActionRequest' examples: ApproveGenericConnection: 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: value: type: CONNECTION_CREATION_REJECTION description: Invalid connection request ApproveBandwidthUpdate: value: type: CONNECTION_UPDATE_ACCEPTANCE RejectBandwidthUpdate: value: type: CONNECTION_UPDATE_REJECTION description: Invalid connection update request AcceptDeleteConnection: value: type: CONNECTION_DELETION_ACCEPTANCE VcMigrationZSide: value: type: CONNECTION_UPDATE_REQUEST data: zSide: accessPoint: type: COLO port: uuid: c791f8cb-5a47-a470-8ce0-306a5c00a4ee BGPSync: value: type: CONNECTION_PROVIDER_STATUS_REQUEST GetProviderBandwidth: value: type: CONNECTION_PROVIDER_BANDWIDTH_REQUEST AcceptZSide-NetworkEdge: value: type: CONNECTION_CREATION_ACCEPTANCE data: zSide: accessPoint: virtualDevice: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: CLOUD id: 8 ProviderStatusUpdate: value: type: CONNECTION_PROVIDER_STATUS_UPDATE_REQUEST data: operation: providerStatus: QUOTING required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ConnectionAction' examples: connectionActionExample: 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: 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: 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: 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' /fabric/v4/connections/{connectionId}/advertisedRoutes/search: post: tags: - Cloud Routers summary: Search Advertised Routes description: The API provides capability to get list of user's advertised routes using search criteria, including optional filtering, pagination and sorting operationId: searchConnectionAdvertisedRoutes parameters: - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectionRouteSearchRequest' examples: ConnectionRoutesSearchType: 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 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ConnectionRouteTableEntrySearchResponse' examples: advertisedRoutes: 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: 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: 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: 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' /fabric/v4/connections/{connectionId}/receivedRoutes/search: post: tags: - Cloud Routers summary: Search Received Routes description: The API provides capability to get list of received routes using search criteria, including optional filtering, pagination and sorting operationId: searchConnectionReceivedRoutes parameters: - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectionRouteSearchRequest' examples: ConnectionRoutesSearchType: value: filter: and: - property: /type operator: '=' values: - IPv4_BGP_ROUTE pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime ConnectionRoutesSearchByState: value: filter: and: - property: /state operator: '=' values: - ACTIVE pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime ConnectionRoutesSearchByMed: value: filter: and: - property: /med operator: '=' values: - '200' pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ConnectionRouteTableEntrySearchResponse' examples: advertisedRoutes: 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: 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: 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: 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' /fabric/v4/connections/{connectionId}/routingProtocols: get: tags: - Routing Protocols summary: Get Routing Protocols description: This API provides capability to get Routing Protocols for connections operationId: getConnectionRoutingProtocols parameters: - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetResponse' examples: getAllRoutingProtocols: 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: 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' 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: Connection ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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 summary: Create Routing Protocol description: This API provides capability to create Routing Protocol for connections operationId: createConnectionRoutingProtocol parameters: - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: $ref: '#/components/schemas/RoutingProtocolBase' examples: Fcr2ColoDirectRoutingOnly: value: type: DIRECT directIpv4: equinixIfaceIp: 192.168.100.1/30 directIpv6: equinixIfaceIp: 2001:7a9::34f4:0:f3dd:1/126 Fcr2ColoBGPRoutingOnly: 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: value: type: DIRECT directIpv4: equinixIfaceIp: 169.254.100.1/30 Fcr2GcpBGPRoutingOnly: value: type: BGP bgpIpv4: enabled: true customerPeerIp: 169.254.100.2 equinixPeerIp: 169.254.100.1 outboundASPrependCount: 3 customerAsn: 100 required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RoutingProtocolData' examples: bgpCreateResponse: 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: 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: 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' 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: Connection ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Routing Protocols summary: Bulk Create Routing Protocols description: This API provides capability to create Routing Protocol for connections operationId: createConnectionRoutingProtocolsInBulk parameters: - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectionRoutingProtocolPostRequest' examples: DirectRoutingOnly: value: data: - type: DIRECT directIpv4: equinixIfaceIp: 192.168.100.1/30 directIpv6: equinixIfaceIp: 2001:7a9::34f4:0:f3dd:1/126 BGPRoutingOnly: 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: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetResponse' examples: getAllRoutingProtocols: 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: 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' 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: Connection ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Routing Protocols summary: Get Protocol description: This API provides capability to accept/reject user's virtual connection operationId: getConnectionRoutingProtocolByUuid parameters: - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: description: Routing Protocol UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RoutingProtocolData' examples: bgpCreateResponse: 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: 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: 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' 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: Connection ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: 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: description: Routing Protocol UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RoutingProtocolData' examples: 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: 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' 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: Connection ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: 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: description: Routing Protocol UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: connectionId in: path description: Connection Id required: true schema: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RoutingProtocolData' examples: 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: 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' 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: Connection ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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 summary: Patch Protocol description: This API provides capability to partially update Routing Protocols on a virtual connection operationId: patchConnectionRoutingProtocolByUuid parameters: - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: description: Routing Protocol UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectionRoutingProtocolPatchRequest' examples: EnableIPv4PatchExample: value: - op: replace path: /bgpIpv4/enabled value: true EnableIPv6PatchExample: value: - op: replace path: /bgpIpv6/enabled value: true DisableIPv4PatchExample: value: - op: replace path: /bgpIpv4/enabled value: false DisableIPv6PatchExample: value: - op: replace path: /bgpIpv6/enabled value: false application/json-patch+json: schema: $ref: '#/components/schemas/ConnectionRoutingProtocolPatchRequest' examples: EnableIPv4PatchExample: value: - op: replace path: /bgpIpv4/enabled value: true EnableIPv6PatchExample: value: - op: replace path: /bgpIpv6/enabled value: true DisableIPv4PatchExample: value: - op: replace path: /bgpIpv4/enabled value: false DisableIPv6PatchExample: value: - op: replace path: /bgpIpv6/enabled value: false required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RoutingProtocolData' examples: EnableBGPResponse: 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: 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: 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' 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: Connection ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: post: tags: - Routing Protocols summary: Clear/Reset BGP description: This API provides capability to clear/reset Routing Protocols BGP session operationId: postConnectionRoutingProtocolBgpActionByUuid parameters: - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: description: Routing Protocol UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: connectionId in: path description: Connection Id required: true schema: 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: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/BGPActionData' examples: 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: 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' 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: Connection ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: 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: description: Routing Protocol UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: connectionId in: path description: Connection Id required: true schema: 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: '200': description: Fabric BGP Action object content: application/json: schema: $ref: '#/components/schemas/BGPActionsBulkData' examples: 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: 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' 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: Connection ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Routing Protocols summary: Get BGP Action description: This API provides capability to retrieve specific BGP action operationId: getConnectionRoutingProtocolsBgpActionByUuid parameters: - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: 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: description: BGP Action UUID type: string format: uuid example: 86534014-34b4-53f6-45d6-4b94a92d8623 responses: '200': description: Fabric BGP Action object content: application/json: schema: $ref: '#/components/schemas/BGPActionData' examples: BGPActionResponse: 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' examples: example: 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' 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: Connection ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Routing Protocols summary: Get Change By ID description: This API provides capability to retrieve specific Routing Protocol Change operationId: getConnectionRoutingProtocolsChangeByUuid parameters: - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: 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: description: Routing Protocol Change UUID type: string format: uuid example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: '200': description: Fabric Routing Protocol Change object content: application/json: schema: $ref: '#/components/schemas/RoutingProtocolChangeData' examples: RoutingProtocolChangeResponse: 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' examples: example: 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' 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: Connection ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Routing Protocols summary: Get Routing Protocol Changes description: This API provides capability to retrieve user's Routing Protocol Changes operationId: getConnectionRoutingProtocolsChanges parameters: - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: description: Routing Protocol UUID type: string format: uuid 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: '200': description: Fabric Routing Protocol Change object content: application/json: schema: $ref: '#/components/schemas/RoutingProtocolChangeDataResponse' examples: RoutingProtocolChangesResponse: 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' examples: example: 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' 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: Connection ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Internet Exchange Services summary: Create Internet Exchange Service description: This API provides capability to create Internet Exchange Service operationId: createExchangeService requestBody: content: application/json: schema: $ref: '#/components/schemas/ExchangeServiceCreateRequest' 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ExchangeServiceResponse' examples: CreateExchangeServiceResponse: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3067104 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/exchangeServices/{exchangeServiceId}: get: tags: - Internet Exchange Services summary: Get Internet Exchange Service description: The API provides capability to get Internet Exchange Service operationId: getExchangeServiceById parameters: - name: exchangeServiceId in: path description: Internet Exchange Service Id required: true schema: description: Internet Exchange Service UUID type: string format: uuid example: a8ba52de-faae-43b5-b0b1-6904d37ee011 responses: '200': description: Successful Operation content: application/json: schema: $ref: '#/components/schemas/ExchangeServiceResponse' examples: GetExchangeServiceResponse: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3067104 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error patch: tags: - Internet Exchange Services summary: Update Internet Exchange Service description: The API provides capability to update Internet Exchange Service operationId: updateExchangeServiceById parameters: - name: exchangeServiceId in: path description: Internet Exchange Service Id required: true schema: 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' examples: 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 required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ExchangeServiceResponse' examples: PatchExchangeServiceResponse: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3067104 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/exchangeServices/search: post: tags: - Internet Exchange Services 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/ExchangeServiceSearchRequest' 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: 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: value: filter: and: - property: /state operator: '=' values: - PROVISIONING pagination: limit: 10 offset: 0 sort: - property: /changeLog/updatedDateTime direction: DESC ExchangeServiceMultiStateSearch: value: filter: and: - property: /state operator: IN values: - PROVISIONING - REPROVISIONING pagination: limit: 10 offset: 0 sort: - property: /changeLog/updatedDateTime direction: DESC ExchangeServiceMetroCodeSearch: value: filter: and: - property: /location/metroCode operator: '=' values: - SV pagination: limit: 25 offset: 0 sort: - property: /changeLog/updatedDateTime direction: DESC ExchangeServiceMultiMetroCodeSearch: value: filter: and: - property: /location/metroCode operator: IN values: - SV - NY pagination: limit: 25 offset: 0 sort: - property: /changeLog/updatedDateTime direction: DESC ExchangeServiceBandwidthSearch: value: filter: and: - property: /bandwidth operator: '=' values: - '500' pagination: limit: 25 offset: 0 sort: - property: /changeLog/updatedDateTime direction: DESC ExchangeServiceMultiBandwidthSearch: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ExchangeServiceSearchResponse' examples: example: 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' example: - errorCode: EQ-3000035 errorMessage: Invalid request body '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' example: - errorCode: EQ-3000197 errorMessage: User not authorized to perform given action '500': description: Internal Server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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: - Internet Exchange Services summary: Create Internet Exchange Service Action description: This API provides capability to perform actions on Internet Exchange Service operationId: createExchangeServiceAction parameters: - name: exchangeServiceId in: path description: Internet Exchange Service Id required: true schema: description: Internet Exchange Service UUID type: string format: uuid example: a8ba52de-faae-43b5-b0b1-6904d37ee011 requestBody: content: application/json: schema: $ref: '#/components/schemas/ExchangeServiceActionRequest' examples: ActivateExchangeServiceRequest: value: type: EXCHANGE_SERVICE_ACTIVATE ValidateExchangeServiceRequest: value: type: EXCHANGE_SERVICE_VALIDATE RetryExchangeServiceRequest: value: type: EXCHANGE_SERVICE_RETRY_PROVISION required: true responses: '202': description: Successful Operation content: application/json: schema: $ref: '#/components/schemas/ExchangeServiceActionResponse' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3067104 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/internetAccessServices: post: tags: - Internet Access Services summary: Create Internet Access Service description: Creates Internet Access Service operationId: createEiaService requestBody: content: application/json: schema: $ref: '#/components/schemas/InternetAccessPostRequest' examples: CreateInternetAccess: 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': description: EIA Service creation or update accepted content: application/json: schema: $ref: '#/components/schemas/InternetAccessService' examples: internetAccessServiceAccepted: 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': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/internetAccessServices/search: post: tags: - Internet Access Services summary: Search Internet Access Services description: Search for Internet Access Services operationId: searchEiaServices requestBody: content: application/json: schema: $ref: '#/components/schemas/InternetAccessSearchRequest' examples: SearchByProject: 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': description: EIA Services retrieved successfully content: application/json: schema: $ref: '#/components/schemas/InternetAccessServices' examples: internetAccessServicesRetrieved: 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': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/internetAccessServices/{uuid}: get: tags: - Internet Access Services summary: Get Internet Access Service by ID description: Retrieve Internet Access Service by UUID operationId: getEiaService parameters: - name: uuid in: path description: UUID of the EIA Service required: true schema: type: string format: uuid responses: '200': description: EIA Service retrieved successfully content: application/json: schema: $ref: '#/components/schemas/InternetAccessService' examples: internetAccessServiceRetrieved: 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' patch: tags: - Internet Access Services summary: Update Internet Access Service by ID description: Patch Internet Access Service by UUID operationId: patchEiaService parameters: - name: uuid in: path description: UUID of the EIA Service required: true 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': description: EIA Service creation or update accepted content: application/json: schema: $ref: '#/components/schemas/InternetAccessService' examples: internetAccessServiceAccepted: 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' delete: tags: - Internet Access Services summary: Delete Internet Access Service by ID description: Delete Internet Access Service by UUID operationId: deleteEiaService parameters: - name: uuid in: path description: UUID of the EIA Service required: true schema: type: string format: uuid responses: '202': description: EIA Service creation or update accepted content: application/json: schema: $ref: '#/components/schemas/InternetAccessService' examples: internetAccessServiceAccepted: 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' /fabric/v4/ipBlocks: post: tags: - IP Blocks summary: Create IP Block description: Submits new Equinix owned or customer owned IP Block request operationId: submitIpBlock requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitIpBlockRequestBody' examples: EquinixOwnedApacWithRegulations: 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: value: prefix: 128.112.4.0/24 type: IPV4_IP_BLOCK project: projectId: 52cb19be-63c4-434d-bec8-5e94636291fc required: true responses: '202': description: IP Block submitted, patched, or deletion accepted content: application/json: schema: $ref: '#/components/schemas/IpBlock' examples: EquinixOwnedAccepted: 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: 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': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/ipBlocks/{uuid}: get: tags: - IP Blocks summary: Retrieve IP Block by ID description: Retrieve IP Block by UUID operationId: getIpBlock parameters: - name: uuid in: path description: UUID of the IP Block required: true schema: type: string format: uuid responses: '200': description: IP Block retrieved successfully content: application/json: schema: $ref: '#/components/schemas/IpBlock' examples: EquinixOwnedRetrieved: 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: 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': description: IP Block not found content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' delete: tags: - IP Blocks summary: Delete IP Block by ID description: Delete IP Block by UUID operationId: deleteIpBlockById parameters: - name: uuid in: path description: UUID of the IP Block required: true schema: type: string format: uuid responses: '202': description: IP Block submitted, patched, or deletion accepted content: application/json: schema: $ref: '#/components/schemas/IpBlock' examples: EquinixOwnedAccepted: 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: 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': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: IP Block not found content: application/json: schema: $ref: '#/components/schemas/ErrorList' '409': description: IP Block cannot be deleted due to active products content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' patch: tags: - IP Blocks summary: Update IP Block by ID description: patch IP Block by UUID operationId: patchIpBlockById parameters: - name: uuid in: path description: UUID of the IP Block required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchIpBlockRequestBody' required: true responses: '202': description: IP Block submitted, patched, or deletion accepted content: application/json: schema: $ref: '#/components/schemas/IpBlock' examples: EquinixOwnedAccepted: 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: 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': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/ipBlocks/search: post: tags: - IP Blocks summary: Search IP Blocks description: Search for IP Blocks based on criteria operationId: searchIpBlocks requestBody: content: application/json: schema: $ref: '#/components/schemas/IpBlocksSearchRequestBody' required: true responses: '200': description: IP Blocks found successfully content: application/json: schema: $ref: '#/components/schemas/IpBlockSearchResponseBody' '400': description: Invalid input parameter content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/connections/search: post: tags: - Connections summary: Search Connections description: The API provides capability to get list of user's virtual connections using search criteria, including optional filtering, pagination and sorting operationId: searchConnections requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchRequest' examples: 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 ConnectionSearchProjectid: 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 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ConnectionSearchResponse' example: pagination: offset: 0 limit: 20 total: 1 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 bandwidth: 1000 direction: OUTGOING isRemote: true redundancy: priority: PRIMARY group: 7cf39156-9dec-40f7-a254-9bb401342e83 aSide: accessPoint: type: COLO uuid: b840a1db-5639-639f-97e0-328a5c00a874 name: exmapple-access-point-name-aside port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 zSide: accessPoint: type: SP uuid: b840a1db-5639-639f-97e0-328a5c00a875 name: exmapple-access-point-name-zside profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c location: metroCode: MX metroName: Mexico City sellerRegion: us-west-1 routingProtocols: - type: EBGP seqId: 03f7294b-42ce-42b6-9cc8-1e1b46d8183a state: ACTIVE customerAsn: 65500 providerAsn: 65000 bgpAuthKey: testAuthKey ipv4: customerPeerIp: 169.254.255.2/30 providerPeerIp: 169.254.255.1/30 operation: providerStatus: PROVISIONING equinixStatus: PROVISIONED maintenanceStatus: SCHEDULED lockEnabled: true changeLog: createdDateTime: '2020-05-21T10:30:00Z' updatedDateTime: '2020-05-21T10:30:00Z' project: projectId: 2c10d60e-29c1-4721-ad1a-b531f4e04717 '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' example: - errorCode: EQ-3000035 errorMessage: Invalid request body '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorList' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' example: - errorCode: EQ-3000197 errorMessage: User not authorized to perform given action '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' /fabric/v4/prices/search: post: tags: - Prices summary: Search Prices description: Search prices by search criteria operationId: searchPrices requestBody: content: application/json: schema: $ref: '#/components/schemas/FilterBody' 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: 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 virtualConnectionProductFcrVcTypeFromGWToSP: 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: 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: 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 virtualConnectionProductOfflineEvpLanVcTypeFromColoToNetwork: 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 cloudRouterProduct: 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 precisionTimeProductNtpStandardPackageCode: 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: 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: 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: 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 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/PriceSearchResponse' 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: 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: 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': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/PriceErrorList' examples: example: 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' examples: example: 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 in: path description: Port UUID required: true schema: 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' - name: endDateTime in: query description: endDateTime required: true schema: $ref: '#/components/schemas/endDateTime' example: '2020-11-10T07:00:00Z' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Statistics' examples: statsExample: 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' 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/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 in: path description: Connection UUID required: true schema: 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' - name: endDateTime in: query description: endDateTime required: true schema: $ref: '#/components/schemas/endDateTime' example: '2020-11-10T07:00:00Z' - name: viewPoint in: query description: viewPoint required: true schema: $ref: '#/components/schemas/viewPoint' example: aSide responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Statistics' examples: statsExample: 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' 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 /fabric/v4/serviceProfiles: get: tags: - Service Profiles summary: List Service Profiles description: The API request returns all Equinix Fabric Service Profiles in accordance with the view point requested operationId: listServiceProfiles parameters: - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 - name: viewPoint in: query description: flips view between buyer and seller representation schema: type: string default: aSide enum: - aSide - zSide responses: '200': description: Successful operation content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/ServiceProfiles' examples: ASideServiceProfile: 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: 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: 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' examples: example: value: - errorCode: EQ-3001207 errorMessage: Unauthorized user '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceProfileRequest' 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: 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 required: true responses: '201': description: Successful Create operation content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/ServiceProfile' examples: ServiceProfile: 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: 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: 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' examples: example: value: - errorCode: EQ-3001207 errorMessage: Unauthorized user '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: value: - errorCode: EQ-3001206 errorMessage: Internal Server Error /fabric/v4/serviceProfiles/search: post: tags: - Service Profiles summary: Search Service Profiles description: Search service profiles by search criteria operationId: searchServiceProfiles parameters: - name: viewPoint in: query description: flips view between buyer and seller representation schema: type: string default: aSide enum: - aSide - zSide requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceProfileSearchRequest' examples: ServiceProfileSearchWithUuid: 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 ServiceProfileSearchWithProject: 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 ServiceProfileSearchWithMultipleFilter: 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 required: true responses: '200': description: Successful operation content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/ServiceProfiles' examples: ServiceProfile: 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: 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' examples: example: value: - errorCode: EQ-3001207 errorMessage: Unauthorized user '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3001206 errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}: get: tags: - Service Profiles summary: Get Service Profile description: Get service profile by UUID. View Point parameter if set to zSide will give seller's view of the profile otherwise buyer's view operationId: getServiceProfileByUuid parameters: - name: serviceProfileId in: path description: Service Profile UUID required: true schema: description: Service Profile UUID type: string format: uuid - name: viewPoint in: query description: flips view between buyer and seller representation schema: type: string default: aSide enum: - aSide - zSide responses: '200': description: Successful operation content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/ServiceProfile' examples: ASideServiceProfile: 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: 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: 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: 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' examples: example: value: - errorCode: EQ-3001207 errorMessage: Unauthorized user '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: value: - errorCode: EQ-3001206 errorMessage: Internal Server Error put: tags: - Service Profiles summary: Replace Service Profile description: This API request replaces a service profile definition operationId: putServiceProfileByUuid parameters: - name: serviceProfileId in: path description: Service Profile UUID required: true schema: description: Service Profile UUID type: string format: uuid - name: If-Match in: header description: conditional request required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceProfileRequest' 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': description: Successful Put operation content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/ServiceProfile' examples: ServiceProfile: 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: 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' examples: example: value: - errorCode: EQ-3001207 errorMessage: Unauthorized user '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: value: - errorCode: EQ-3001011 errorMessage: Invalid uuid '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3001206 errorMessage: Internal Server Error patch: tags: - Service Profiles summary: Update Service Profile description: Update Service Profile by UUID operationId: updateServiceProfileByUuid parameters: - name: serviceProfileId in: path description: Service Profile UUID required: true schema: 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 Patch operation content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/ServiceProfile' examples: ServiceProfile: 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: 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' examples: example: value: - errorCode: EQ-3001207 errorMessage: Unauthorized user '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: value: - errorCode: EQ-3001011 errorMessage: Invalid uuid '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3001206 errorMessage: Internal Server Error delete: tags: - Service Profiles summary: Delete Service Profile description: delete Service Profile by UUID operationId: deleteServiceProfileByUuid parameters: - name: serviceProfileId in: path description: Service Profile UUID required: true schema: description: Service Profile UUID type: string format: uuid responses: '200': description: Successful Delete operation content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/ServiceProfile' examples: ServiceProfile: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3001207 errorMessage: Unauthorized user '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: value: - errorCode: EQ-3001011 errorMessage: Invalid uuid '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3001206 errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}/actions: post: tags: - Service Profiles summary: Create Service Profile Action description: This API provides capability to accept/reject service profile update requests operationId: createServiceProfileAction parameters: - name: serviceProfileId in: path description: Service Profile UUID required: true schema: description: Service Profile UUID type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceProfileActionRequest' examples: AcceptProfileUpdate: value: type: PROFILE_UPDATE_ACCEPTANCE description: Approved to migrate to public RejectProfileUpdate: value: type: PROFILE_UPDATE_REJECTION description: Rejected the migration to public required: true responses: '201': description: Successful operation content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/ServiceProfileActionResponse' examples: 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' '400': description: Bad request content: application/json: schema: $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' examples: example: value: - errorCode: EQ-3001207 errorMessage: Unauthorized user '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: value: - errorCode: EQ-3001011 errorMessage: Invalid uuid '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3001206 errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}/environments: get: tags: - Service Profiles summary: Get Service Profile Environments description: Get service profile provider environments by UUID Beta operationId: getServiceProfileEnvironmentsByUuid parameters: - name: serviceProfileId in: path description: Service Profile UUID required: true schema: description: Service Profile UUID type: string format: uuid - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: '200': description: Successful operation content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/ProviderEnvironments' examples: ServiceProfileEnvironments: 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: 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' examples: example: value: - errorCode: EQ-3001207 errorMessage: Unauthorized user '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: value: - errorCode: EQ-3001206 errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}/environments/{environmentId}/actions: post: tags: - Service Profiles summary: Create Service Profile Environment Action description: This API provides capability to perform actions on a service profile environment, such as validating an activation key.Beta operationId: serviceProfileEnvironmentAction parameters: - name: serviceProfileId in: path description: Service Profile UUID required: true schema: description: Service Profile UUID type: string format: uuid - name: environmentId in: path description: Provider Environment Reference required: true schema: description: Provider Environment Reference type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnvironmentActionRequest' examples: ValidateActivationKey: value: type: VALIDATE_ACTIVATION_KEY keyDetails: value: key_here required: true responses: '201': description: Successful service profile environment action operation content: application/json: schema: $ref: '#/components/schemas/EnvironmentActionResponse' '400': description: Bad request content: application/json: schema: $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' examples: example: value: - errorCode: EQ-3001207 errorMessage: Unauthorized user '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: value: - errorCode: EQ-3001206 errorMessage: Internal Server Error /fabric/v4/serviceProfiles/{serviceProfileId}/metros: get: tags: - Service Profiles summary: Get Service Profile Metros description: Get service profile metros by UUID operationId: getServiceProfileMetrosByUuid parameters: - name: serviceProfileId in: path description: Service Profile UUID required: true schema: description: Service Profile UUID type: string format: uuid - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: '200': description: Successful operation content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/ServiceMetros' examples: ServiceProfileMetros: 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: 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' examples: example: value: - errorCode: EQ-3001207 errorMessage: Unauthorized user '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: value: - errorCode: EQ-3001206 errorMessage: Internal Server Error /fabric/v4/serviceTokens/{serviceTokenId}: get: tags: - Service Tokens summary: Get Service Token by ID description: Get Specified Service Tokens uses the uuid of an Equinix Fabric service token to return details about the token's type, state, location, bandwidth, and other key properties. operationId: getServiceTokenByUuid parameters: - name: serviceTokenId in: path description: Service Token UUID required: true schema: description: Service Token UUID type: string format: uuid responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ServiceToken' examples: tokenExample: 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: 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: 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: 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' examples: example: value: - errorCode: EQ-3034016 errorMessage: Token not found correlationId: 0963d003-ecda-4391-b166-8ccbf31d2d82 additionalInfo: - property: tokenUuid reason: Token not found dryRunExample: 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' 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 delete: tags: - Service Tokens summary: Delete Service Token by ID description: Delete Service Tokens removes an Equinix Fabric service token corresponding to the specified uuid which are in INACTIVE state operationId: deleteServiceTokenByUuid parameters: - name: serviceTokenId in: path description: Service Token UUID required: true schema: description: Service Token UUID type: string format: uuid responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ServiceToken' examples: tokenExample: 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: 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: 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: 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' examples: example: value: - errorCode: EQ-3034016 errorMessage: Token not found correlationId: 0963d003-ecda-4391-b166-8ccbf31d2d82 additionalInfo: - property: tokenUuid reason: Token not found dryRunExample: 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' 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 patch: tags: - Service Tokens summary: Update Token By ID description: This API provides capability to update user's Service Token operationId: updateServiceTokenByUuid parameters: - name: serviceTokenId in: path description: Service Token UUID required: true schema: description: Service Token UUID type: string format: uuid - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/ServiceTokenUpdateRequest' examples: UpdateExpirationDate: 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 UpdateAsideTokenBandwidthDryRun: value: - op: replace path: /connection/bandwidthLimit value: 100 UpdateZsideTokenBandwidthDryRun: value: - op: replace path: /connection/supportedBandwidths value: - 50 - 1000 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ServiceToken' examples: tokenExample: 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: 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: 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: 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' examples: example: value: - errorCode: EQ-3034016 errorMessage: Token not found correlationId: 0963d003-ecda-4391-b166-8ccbf31d2d82 additionalInfo: - property: tokenUuid reason: Token not found dryRunExample: 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' 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/serviceTokens: post: tags: - Service Tokens summary: Create Service Token description: Create Service Tokens generates Equinix Fabric™ service tokens. These tokens authorize users to access protected resources and services. operationId: createServiceToken parameters: - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceToken' examples: AsideTokenWithQnQ: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ServiceToken' examples: ServiceTokenDryRun: 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' examples: tokenExample: 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: 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: 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' examples: example: 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: 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' 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 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' examples: example: 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: - Service Tokens summary: Create Service Token Action description: This API provides capability to accept/reject user's servicetokens operationId: createServiceTokenAction parameters: - name: serviceTokenId in: path description: Service Token UUID required: true schema: description: Service Token UUID type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceTokenActionRequest' examples: ResendServiceToken: value: type: RESEND_EMAIL_NOTIFICATION required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ServiceToken' examples: connectionActionExample: 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: 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: 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': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: value: - errorCode: EQ-3034016 errorMessage: Token not found correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/serviceTokens/search: post: tags: - Service Tokens summary: Search Service Tokens description: The API provides capability to get list of user's servicetokens using search criteria, including optional filtering, pagination and sorting operationId: searchServiceTokens parameters: - name: offset in: query description: offset schema: type: number - name: limit in: query description: number of records to fetch schema: type: number requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceTokenSearchRequest' examples: ServiceTokenRequest: value: filter: and: - property: /uuid operator: '=' values: - 407f8239-254c-4fe2-a378-458f197e17c4 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ServiceTokens' examples: servicetokenSearchExample: 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: 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: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Optical Metro Connects summary: Create Optical Metro Connect Service description: | Create a single Optical Metro Connect circuit. operationId: createOpticalConnect requestBody: content: application/json: schema: $ref: '#/components/schemas/OpticalConnectPostRequest' examples: COLOToCOLO: 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: 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: 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': description: Accepted Operation content: application/json: schema: $ref: '#/components/schemas/OpticalConnectResponse' examples: COLOToCOLO: 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: 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: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Optical Metro Connects summary: Create Dual Diverse Optical Metro Connect Service description: | Create a dual diverse pair of circuits on separate optical paths. operationId: createBulkOpticalConnect requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkOpticalConnectRequest' examples: COLOToCOLO: 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: 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: 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': description: Accepted Operation content: application/json: schema: $ref: '#/components/schemas/OpticalConnectBulk' examples: COLOToCOLO: 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: 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: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Optical Metro Connects summary: Get Optical Metro Connect Service description: | Get a single Optical Metro Connect by UUID. operationId: getOpticalConnectByUuid parameters: - name: opticalConnectId in: path description: Unique identifier of an Optical Connect. required: true schema: description: Unique identifier of an Optical Connect. type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Successful Operation content: application/json: schema: $ref: '#/components/schemas/OpticalConnectResponse' examples: COLOToCOLO: 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: 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: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Optical Metro Connects summary: Search Optical Metro Connect Services description: | Get Optical Metro Connects matching the supplied criteria, with optional filtering, pagination and sorting. operationId: searchOpticalConnect requestBody: content: application/json: schema: $ref: '#/components/schemas/OpticalConnectSearchRequest' examples: SearchFilterByStatus: summary: All provisioned connections value: filter: and: - property: /state operator: '=' values: - PROVISIONED pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/updatedDateTime SearchFilterByName: 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: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/OpticalConnectServiceSearchResponse' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Metros summary: Get Metros description: GET All Subscriber Metros with an option query parameter to return all Equinix Fabric metros in which the customer has a presence, as well as latency data for each location operationId: getMetros parameters: - name: presence in: query description: User On Boarded Metros based on Fabric resource availability required: false schema: $ref: '#/components/schemas/Presence' - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/MetroResponse' examples: metroExample: 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' 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_PORTS '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/MetroErrorList' examples: example: 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' examples: example: 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: - Metros summary: Get Metro by Code description: GET Metros retrieves all Equinix Fabric metros, as well as latency data between each metro location operationId: getMetroByCode parameters: - name: metroCode in: path description: Metro Code required: true schema: description: Metro Code type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Metro' examples: metroExample: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Ports summary: Get All Ports description: Get All Ports returns details of all assigned and available ports for the specified user credentials. The metro attribute in the response shows the origin of the proposed connection operationId: getPorts parameters: - name: name in: query description: port name to be provided if specific port(s) to be retrieved schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AllPortsResponse' examples: portExample: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3046117 errorMessage: Unauthorized user. correlationId: TEST '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: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: portExample: value: - errorCode: EQ-3046030 errorMessage: Internal error. details: Internal system error userFailureExample: value: - errorCode: IC-USR-014-01 errorMessage: Error in getting user's profile post: tags: - Ports summary: Create Port description: Creates Equinix Fabric™ Port operationId: createPort parameters: - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false requestBody: content: application/json: schema: $ref: '#/components/schemas/PortRequest' 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Port' examples: portDryRunExample: 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: 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: 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' examples: COLOSinglePortNonLag: 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: 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: 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: 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: 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: 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' examples: validationError: 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: 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' examples: example: 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' examples: example: 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: - Ports summary: Add to Lag description: Add Physical Ports to Virtual Port. Preview operationId: addToLag parameters: - name: portId in: path description: Port UUID required: true schema: description: Port UUID type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkPhysicalPort' 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: 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 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AllPhysicalPortsResponse' examples: COLOAddToLag: 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: 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': 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' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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: - Ports summary: Get Port by ID description: Get Port by ID returns details of assigned and available Equinix Fabric port for the specified user credentials. The metro code attribute in the response shows the origin of the proposed connection operationId: getPortByUuid parameters: - name: portId in: path description: Port UUID required: true schema: description: Port UUID type: string format: uuid responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Port' examples: portExample: 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: 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' examples: example: 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' 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 delete: tags: - Ports summary: Delete Port description: The API provides capability to delete a single port operationId: deletePort parameters: - name: portId in: path description: Port UUID required: true schema: description: Port UUID type: string format: uuid - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Port' examples: portDryRunExample: 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' examples: portExample: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3046117 errorMessage: Unauthorized user. correlationId: TEST '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' patch: tags: - Ports summary: Update Port by ID description: Update Port by UUID operationId: updatePortByUuid parameters: - name: portId in: path description: Port UUID required: true schema: description: Port UUID type: string format: uuid - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/PortUpdateRequest' examples: PortUpdateNameRequest: value: - op: replace path: /name value: 1234-ibx-port PortUpdateEncapsulationAndTagprotocolIdRequest: value: - op: replace path: /encapsulation value: type: DOT1Q tagProtocolId: '0x8100' PortUpdateNameDryRunRequest: value: - op: replace path: /name value: 1234-ibx-port PortUpdateLagEnabledRequest: value: - op: replace path: /lagEnabled value: true required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AllPortsResponse' examples: portDryRunExample: 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' examples: portExample: 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' examples: InvalidUUID: value: - errorCode: EQ-3046115 errorMessage: Invalid Path Parameter correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 additionalInfo: - property: pathparameter-portUuid reason: Provide valid port Uuid ResourceUsedError: 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' 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/Error' examples: example: 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: - Ports summary: Get Vlans description: The API provides capability to retrieve Vlans for a Port operationId: getVlans parameters: - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 - name: portUuid in: path description: Port UUID required: true schema: description: Port UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Get Vlans content: application/json: schema: $ref: '#/components/schemas/LinkProtocolGetResponse' examples: LinkProtocolQ1NQResponse: 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: 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: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3035002 errorMessage: Access Forbidden correlationId: UnAuthorized User- Cannot perform action /fabric/v4/ports/search: post: tags: - Ports summary: Search Ports description: The API provides capability to get list of user's virtual ports using search criteria, including optional filtering, pagination and sorting operationId: searchPorts requestBody: content: application/json: schema: $ref: '#/components/schemas/PortV4SearchRequest' examples: PortSearchDirection: 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: 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 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AllPortsResponse' examples: portExample: 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' examples: invalidUuid: value: - errorCode: EQ-3046115 errorMessage: Invalid Path Parameter correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 additionalInfo: - property: pathparameter-portUuid reason: Provide valid port Uuid invalidProjectIdRequest: 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: 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: value: - errorCode: EQ-3046116 errorMessage: JSON syntax error. details: Please refer the contracts for correct fields correlationId: TEST invalidSearchFieldArgument: 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' examples: example: value: - errorCode: EQ-3046117 errorMessage: Unauthorized user. correlationId: TEST '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: portExample: value: - errorCode: EQ-3046030 errorMessage: Internal error. details: Internal system error userFailureExample: value: - errorCode: IC-USR-014-01 errorMessage: Error in getting user's profile /fabric/v4/portPackages: get: tags: - Port Packages summary: List Port Packages description: Get All Port Packages returns details of all available port packages for the specified user credentials operationId: getPortPackages responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AllPortPackagesResponse' examples: portPackagesExample: 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' 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: 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: portPackagesInternalErrorExample: value: - errorCode: EQ-3143001 errorMessage: Internal Error details: Internal system error correlationId: 80066c00-0f20-11f0-8367-d5075ee362a7 /fabric/v4/connections/{connectionId}/routeAggregations: get: tags: - Route Aggregations summary: Get Connection Route Aggregations description: This API provides capability to view all Route Aggregations attached to a Connection operationId: getConnectionRouteAggregations parameters: - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetAllConnectionRouteAggregationsResponse' examples: ConnectionRouteAggregationsResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044305 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: type InvalidId: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Aggregations summary: Get Aggregation description: This API provides capability to view a specific Route Aggregation attached to a Connection operationId: getConnectionRouteAggregationByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ConnectionRouteAggregationData' examples: ConnectionRouteAggregationAttachResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044305 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: type InvalidId: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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 summary: Attach Aggregation description: This API provides capability to attach a Route Aggregation to a Connection operationId: attachConnectionRouteAggregation parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ConnectionRouteAggregationData' examples: ConnectionRouteAggregationAttachResponse: 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' examples: TransientState: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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 summary: Detach Aggregation description: This API provides capability to detach a Route Aggregation from a Connection operationId: detachConnectionRouteAggregation parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ConnectionRouteAggregationData' examples: ConnectionRouteAggregationDetachResponse: 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' examples: example: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Filters summary: Get Connection Route Filters description: This API provides capability to view all Route Filters attached to a Connection operationId: getConnectionRouteFilters parameters: - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetAllConnectionRouteFiltersResponse' examples: ConnectionRouteFiltersResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044101 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: /type InvalidId: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Filters summary: Get Route Filter description: This API provides capability to view a specific Route Filter attached to a Connection operationId: getConnectionRouteFilterByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ConnectionRouteFilterData' examples: ConnectionRouteFilterAttachResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044101 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: /type InvalidId: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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 summary: Attach Route Filter description: This API provides capability to attach a Route Filter to a Connection operationId: attachConnectionRouteFilter parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectionRouteFiltersBase' examples: ConnectionRouteFilterAttachInboundExample: value: direction: INBOUND ConnectionRouteFilterAttachOutboundExample: value: direction: OUTBOUND required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ConnectionRouteFilterData' examples: ConnectionRouteFilterAttachResponse: 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' examples: InvalidDirection: value: - errorCode: EQ-3044001 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: direction TransientState: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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 summary: Detach Route Filter description: This API provides capability to detach a Route Filter from a Connection operationId: detachConnectionRouteFilter parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: connectionId in: path description: Connection Id required: true schema: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ConnectionRouteFilterData' examples: ConnectionRouteFilterDetachInboundResponse: 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: 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' examples: example: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Filters summary: Create Route Filter description: This API provides capability to create a Route Filter operationId: createRouteFilter requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteFiltersBase' examples: RouteFilterBgpIpv4Prefix: value: type: BGP_IPv4_PREFIX_FILTER name: My-route-filter-v4 description: Test filter project: projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 RouteFilterBgpIpv6Prefix: value: type: BGP_IPv6_PREFIX_FILTER name: My-route-filter-v6 description: Test filter project: projectId: '567' required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteFiltersData' examples: GetSpecificRouteFilterResponse: 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' examples: TransientState: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Filters summary: Get Route Filter by ID description: This API provides capability to view a Route Filter by UUID operationId: getRouteFilterByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteFiltersData' examples: GetSpecificRouteFilterResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044101 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: /type InvalidId: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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 summary: Delete Route Filter description: This API provides capability to delete a Route Filter operationId: deleteRouteFilterByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteFiltersData' examples: 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': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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 summary: Update Route Filter description: This API provides capability to partially update a Route Filter operationId: patchRouteFilterByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteFiltersPatchRequest' examples: RouteFilterNamePatchExample: value: - op: replace path: /name value: My-route-filter-v4-updated application/json-patch+json: schema: $ref: '#/components/schemas/RouteFiltersPatchRequest' examples: RouteFilterNamePatchExample: value: - op: replace path: /name value: My-route-filter-v4-updated required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteFiltersData' examples: 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': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Filters summary: Get Route Filter Changes description: This API provides capability to retrieve all of a Route Filter's Changes operationId: getRouteFilterChanges parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: '200': description: Fabric Route Filter Change object content: application/json: schema: $ref: '#/components/schemas/RouteFilterChangeDataResponse' examples: RouteFilterChangesResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044101 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: /type InvalidId: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Route Filters summary: Get Change By ID description: This API provides capability to retrieve a specific Route Filter's Changes operationId: getRouteFilterChangeByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: changeId in: path description: Routing Protocol Change UUID required: true schema: description: Route Filters Change UUID type: string format: uuid example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: '200': description: Fabric Route Filter Change object content: application/json: schema: $ref: '#/components/schemas/RouteFilterChangeData' examples: RouteFilterChangeResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044101 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: /type InvalidId: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Route Filters summary: Get All Connections on Route Filter description: This API provides capability to view all Connections using the Route Filter operationId: getRouteFilterConnections parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetRouteFilterGetConnectionsResponse' examples: 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 '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: InvalidInput: value: - errorCode: EQ-3044101 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: /type InvalidId: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Filters summary: Search Route Filters description: This API provides capability to search Route Filters operationId: searchRouteFilters requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteFiltersSearchRequest' 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: 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 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteFiltersSearchResponse' examples: 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' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: InvalidInput: value: - errorCode: EQ-3044101 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: /type InvalidId: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Filter Rules summary: Get Route Filter Rules description: This API provides capability to get all Route Filters Rules for Fabric operationId: getRouteFilterRules parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetRouteFilterRulesResponse' examples: getAllRouteFilterRules: 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' examples: example: 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' 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: Route Filter Rule ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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 summary: Create Route Filter Rule description: This API provides capability to create a Route Filter Rule operationId: createRouteFilterRule parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteFilterRulesBase' examples: RouteFilterRuleBgpIpv4Prefix: value: name: Private-subnet-filter description: Test rule prefix: 192.168.0.0/24 prefixMatch: exact RouteFilterRuleBgpIpv6Prefix: value: name: Private-subnet-filter description: Test rule prefix: 2001:7a9::34f4:0:f3dd:1/126 prefixMatch: orlonger required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteFilterRulesData' examples: GetSpecificRouteFilterRuleIpv4Response: 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: 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' examples: 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-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' 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: Route Filter Rule ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' '415': description: Unsupported Media Type content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Route Filter Rules summary: Get Route Filter Rule by ID description: This API provides capability to view a Route Filter Rule by UUID operationId: getRouteFilterRuleByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: description: Route Filter Rule UUID type: string example: 65b025ef-022b-4180-85cf-82cfc1ab655b responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteFilterRulesData' examples: GetSpecificRouteFilterRuleIpv4Response: 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: 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' examples: 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-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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: 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: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: description: Route Filter Rule UUID type: string example: 65b025ef-022b-4180-85cf-82cfc1ab655b responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteFilterRulesData' examples: 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' examples: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: 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: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteFilterRulesData' examples: 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' examples: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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 summary: Update Route Filter Rule description: This API provides capability to partially update a Route Filter Rule operationId: patchRouteFilterRuleByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: description: Route Filter Rule UUID type: string example: 65b025ef-022b-4180-85cf-82cfc1ab655b requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteFilterRulesPatchRequest' examples: RouteFilterRuleName: value: - op: replace path: /name value: test-route-filter-name-patch RouteFilterRulePrefix: value: - op: replace path: /prefix value: 192.168.0.0/30 RouteFilterRulePrefixMatch: value: - op: replace path: /prefixMatch value: orlonger application/json-patch+json: schema: $ref: '#/components/schemas/RouteFilterRulesPatchRequest' examples: RouteFilterRuleName: value: - op: replace path: /name value: test-route-filter-name-patch RouteFilterRulePrefix: value: - op: replace path: /prefix value: 192.168.0.0/30 RouteFilterRulePrefixMatch: value: - op: replace path: /prefixMatch value: orlonger required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteFilterRulesData' examples: 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' examples: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Filter Rules summary: Get Route Filter Rule Changes description: This API provides capability to retrieve all of a Route Filter Rule's Changes operationId: getRouteFilterRuleChanges parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: description: Route Filter Rule UUID type: string example: 65b025ef-022b-4180-85cf-82cfc1ab655b - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: '200': description: Fabric Route Filter Rule Change object content: application/json: schema: $ref: '#/components/schemas/RouteFilterRulesChangeDataResponse' examples: RouteFilterRuleChangesResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044101 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: /type InvalidId: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Route Filter Rules summary: Get Change By ID description: This API provides capability to retrieve a specific Route Filter Rule's Changes operationId: getRouteFilterRuleChangeByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: 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: description: Route Filter Rule Change UUID type: string format: uuid example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: '200': description: Fabric Route Filter Change object content: application/json: schema: $ref: '#/components/schemas/RouteFilterRulesChangeData' examples: RouteFilterChangeResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044101 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: /type InvalidId: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Route Filter Rules summary: Bulk Create Route Filter Rules description: This API provides capability to create bulk route filter rules operationId: createRouteFilterRulesInBulk parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteFilterRulesPostRequest' required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetRouteFilterRulesResponse' examples: getAllRouteFilterRules: 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' examples: example: 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' 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 '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: 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' examples: example: 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: - Route Filter Rules summary: Search Route Filter Rules description: This API provides capability to search Route Filter Rules operationId: searchRouteFilterRules parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: description: Route Filters UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteFilterRulesSearchRequest' 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: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteFilterRulesSearchResponse' examples: 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' '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: value: - errorCode: EQ-3000039 errorMessage: 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: Route Filter Rule ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' '415': description: Unsupported Media Type content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Route Aggregations summary: Create Route Aggregation description: This API provides capability to create a Route Aggregation operationId: createRouteAggregation requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteAggregationsBase' examples: RouteAggregationBgpIpv4Prefix: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteAggregationsData' examples: GetSpecificRouteAggregationResponse: 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' examples: TransientState: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Aggregations summary: Get Aggregation description: This API provides capability to view a Route Aggregation by UUID operationId: getRouteAggregationByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteAggregationsData' examples: GetSpecificRouteAggregationResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044305 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: type InvalidId: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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 summary: Delete Aggregation description: This API provides capability to delete a Route Aggregation operationId: deleteRouteAggregationByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteAggregationsData' examples: 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' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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 summary: Update Route Aggregation description: This API provides capability to partially update a Route Aggregation operationId: patchRouteAggregationByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteAggregationsPatchRequest' examples: RouteAggregationNamePatchExample: value: - op: replace path: /name value: My-route-aggregation-v4-updated application/json-patch+json: schema: $ref: '#/components/schemas/RouteAggregationsPatchRequest' examples: RouteAggregationNamePatchExample: value: - op: replace path: /name value: My-route-aggregation-v4-updated required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteAggregationsData' examples: 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' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Aggregations summary: Get Route Aggregation Changes description: This API provides capability to retrieve all of a Route Aggregation's Changes operationId: getRouteAggregationChanges parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: '200': description: Fabric Route Aggregation Change object content: application/json: schema: $ref: '#/components/schemas/RouteAggregationChangeDataResponse' examples: RouteAggregationChangesResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044305 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: type InvalidId: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Route Aggregations summary: Get Change By ID description: This API provides capability to retrieve a specific Route Aggregation's Changes operationId: getRouteAggregationChangeByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: changeId in: path description: Routing Protocol Change UUID required: true schema: description: Route Aggregations Change UUID type: string format: uuid example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: '200': description: Fabric Route Aggregation Change object content: application/json: schema: $ref: '#/components/schemas/RouteAggregationChangeData' examples: RouteAggregationChangeResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044305 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: type InvalidId: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Route Aggregations summary: Get Route Aggregation Connections description: This API provides capability to view all Connections using the Route Aggregation operationId: getRouteAggregationConnections parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetRouteAggregationGetConnectionsResponse' examples: 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 '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: InvalidInput: value: - errorCode: EQ-3044305 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: type InvalidId: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Aggregations summary: Search Route Aggregations description: This API provides capability to search Route Aggregations operationId: searchRouteAggregations requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteAggregationsSearchRequest' 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: 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 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteAggregationsSearchResponse' examples: 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' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: InvalidInput: value: - errorCode: EQ-3044305 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: type InvalidId: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Aggregation Rules summary: Get Route Aggregation Rules description: This API provides capability to get all Route Aggregations Rules for Fabric operationId: getRouteAggregationRules parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetRouteAggregationRulesResponse' examples: getAllRouteAggregationRules: 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' examples: example: 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' 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: Route Aggregation Rule ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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 summary: Create Route Aggregation Rule description: This API provides capability to create a Route Aggregation Rule operationId: createRouteAggregationRule parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteAggregationRulesBase' examples: RouteAggregationRuleBgpIpv4Prefix: value: name: Private-subnet-aggregation description: Test rule prefix: 192.168.0.0/24 required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteAggregationRulesData' examples: GetSpecificRouteAggregationRuleIpv4Response: 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' examples: 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' 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: Route Aggregation Rule ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' '415': description: Unsupported Media Type content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Route Aggregation Rules summary: Get Route Aggregation Rule by ID description: This API provides capability to view a Route Aggregation Rule by UUID operationId: getRouteAggregationRuleByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: description: Route Aggregation Rule UUID type: string example: 65b025ef-022b-4180-85cf-82cfc1ab655b responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteAggregationRulesData' examples: GetSpecificRouteAggregationRuleIpv4Response: 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' examples: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: 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: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: description: Route Aggregation Rule UUID type: string example: 65b025ef-022b-4180-85cf-82cfc1ab655b responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteAggregationRulesData' examples: 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' examples: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: 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: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteAggregationRulesData' examples: 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' examples: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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 summary: Update Route Aggregation Rule description: This API provides capability to partially update a Route Aggregation Rule operationId: patchRouteAggregationRuleByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: description: Route Aggregation Rule UUID type: string example: 65b025ef-022b-4180-85cf-82cfc1ab655b requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteAggregationRulesPatchRequest' examples: RouteaggregationRuleName: value: - op: replace path: /name value: test-route-aggregation-name-patch RouteaggregationRulePrefix: value: - op: replace path: /prefix value: 192.168.0.0/30 application/json-patch+json: schema: $ref: '#/components/schemas/RouteAggregationRulesPatchRequest' examples: RouteaggregationRuleName: value: - op: replace path: /name value: test-route-aggregation-name-patch RouteaggregationRulePrefix: value: - op: replace path: /prefix value: 192.168.0.0/30 required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteAggregationRulesData' examples: 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' examples: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Aggregation Rules summary: Get Route Aggregation Rule Changes description: This API provides capability to retrieve all of a Route Aggregation Rule's Changes operationId: getRouteAggregationRuleChanges parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: description: Route Aggregation Rule UUID type: string example: 65b025ef-022b-4180-85cf-82cfc1ab655b - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: '200': description: Fabric Route Aggregation Rule Change object content: application/json: schema: $ref: '#/components/schemas/RouteAggregationRulesChangeDataResponse' examples: RouteAggregationRuleChangesResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044305 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: type InvalidId: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Route Aggregation Rules summary: Get Change By ID description: This API provides capability to retrieve a specific Route Aggregation Rule's Changes operationId: getRouteAggregationRuleChangeByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: 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: description: Route Aggregation Rule Change UUID type: string format: uuid example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: '200': description: Fabric Route Aggregation Change object content: application/json: schema: $ref: '#/components/schemas/RouteAggregationRulesChangeData' examples: RouteAggregationChangeResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044305 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: type InvalidId: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Route Aggregation Rules summary: Bulk Create Route Aggregation Rules description: This API provides capability to create bulk route aggregation rules operationId: createRouteAggregationRulesInBulk parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteAggregationRulesPostRequest' required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetRouteAggregationRulesResponse' examples: getAllRouteAggregationRules: 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' examples: example: 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' 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 '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: 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' examples: example: 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: - Route Aggregation Rules summary: Search Route Aggregation Rules description: This API provides capability to search Route Aggregation Rules operationId: searchRouteAggregationRules parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: description: Route Aggregations UUID type: string example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteAggregationRulesSearchRequest' 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: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteAggregationRulesSearchResponse' examples: 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' '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: value: - errorCode: EQ-3000039 errorMessage: 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: Route Aggregation Rule ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' '415': description: Unsupported Media Type content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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: - Cloud Routers summary: Create Router description: This API provides capability to create user's Cloud Router operationId: createCloudRouter parameters: - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false requestBody: content: application/json: schema: $ref: '#/components/schemas/CloudRouterPostRequest' examples: CreateLabPackage: 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: 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 required: true responses: '200': description: Fabric Cloud Router object content: application/json: schema: $ref: '#/components/schemas/CloudRouter' examples: cloudRouterResponse: 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: 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: 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' examples: invalidPackage: value: - errorCode: EQ-3040028 errorMessage: Package not found correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: package must be of type LAB or PRO invalidName: 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: 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: 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' 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-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' examples: example: 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' examples: example: value: - errorCode: EQ-3040030 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/routers/{routerId}: get: tags: - Cloud Routers summary: Get Router description: This API provides capability to retrieve user's Cloud Router operationId: getCloudRouterByUuid parameters: - name: routerId in: path description: Cloud Router UUID required: true schema: description: Cloud Router UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Fabric Cloud Router object content: application/json: schema: $ref: '#/components/schemas/CloudRouterReadResponse' examples: cloudRouterResponse: 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: 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' 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-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' examples: example: 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' examples: example: value: - errorCode: EQ-3040030 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error delete: tags: - Cloud Routers summary: Delete Router description: This API provides capability to delete user's Cloud Router operationId: deleteCloudRouterByUuid parameters: - name: routerId in: path description: Cloud Router UUID required: true schema: description: Cloud Router UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '204': description: Deleted Cloud Router Successfully '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: invalidState: 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: 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' 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-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' examples: example: 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' examples: example: value: - errorCode: EQ-3040030 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error patch: tags: - Cloud Routers summary: Update Router description: This API provides capability to update user's Cloud Router operationId: updateCloudRouterByUuid parameters: - name: routerId in: path description: Cloud Router UUID required: true schema: 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' examples: UpdatePackage: value: - op: replace path: /package/code value: PREMIUM UpdateName: value: - op: replace path: /name value: Router-name-2 UpdateNotificationEmail: 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 required: true responses: '200': description: Fabric Cloud Router object content: application/json: schema: $ref: '#/components/schemas/CloudRouter' examples: cloudRouterResponse: 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' examples: example: 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' 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-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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3040030 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/routers/{routerId}/actions: post: tags: - Cloud Routers summary: Create Route Table Action description: This API provides capability to refresh route table and bgp session summary information operationId: createCloudRouterAction parameters: - name: routerId in: path description: Router UUID required: true schema: description: Cloud Router UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: $ref: '#/components/schemas/CloudRouterActionRequest' examples: 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 required: true responses: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/CloudRouterActionResponse' examples: cloudRouterActionExample: value: type: ROUTE_TABLE_ENTRY_UPDATE uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 state: PENDING changeLog: createdDateTime: '2020-05-21T10:30:00Z' receivedRouteEntriesExample: 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: 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' examples: example: 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' 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 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: 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': 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-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' 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/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: - Cloud Routers summary: Get Route Table Action by ID description: This API provides capability to fetch action status operationId: getCloudRouterActionsByUuid parameters: - name: routerId in: path description: Router UUID required: true schema: description: Cloud Router UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: actionId in: path description: Action UUID required: true schema: description: Action UUID type: string format: uuid example: 457400f8-d360-11e9-bb65-2a2ae2dbcced - name: state in: query description: Action state schema: $ref: '#/components/schemas/CloudRouterActionState' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/CloudRouterActionResponse' examples: searchResponseExample: 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' examples: example: 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' 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}/commands: post: tags: - Cloud Routers summary: Create Command description: This API provides capability to initiate Command operationId: createCloudRouterCommand 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/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: '202': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/CloudRouterCommand' examples: 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' examples: example: 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' 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 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' 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 get: tags: - Cloud Routers summary: Get Commands description: This API provides capability to fetch all commands operationId: getAllCloudRouterCommands parameters: - name: routerId in: path description: Router UUID required: true schema: description: Cloud Router UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetAllCloudRouterCommands' examples: 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' examples: example: 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' 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 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' 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}/commands/search: post: tags: - Cloud Routers summary: Search Commands description: This API provides capability to search commands operationId: searchCloudRouterCommands parameters: - name: routerId in: path description: Router UUID required: true schema: description: Cloud Router UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: $ref: '#/components/schemas/CloudRouterCommandSearchRequest' examples: SearchByState: value: filter: and: - property: /state operator: '=' values: - SUCCEEDED 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/CloudRouterCommandSearchResponse' examples: searchCommandsExample: 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' examples: example: 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' 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 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' 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}/commands/{commandId}: get: tags: - Cloud Routers summary: Get Command description: This API provides capability to fetch command using command Id operationId: getCloudRouterCommand parameters: - name: routerId in: path description: Router UUID required: true schema: description: Cloud Router UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: commandId in: path description: Command UUID required: true schema: description: Command UUID type: string format: uuid example: 37c10edc-ba2e-4240-a850-8a48f9c47d00 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/CloudRouterCommand' examples: getCommandExample: 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: 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' examples: example: 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' 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 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' 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 delete: tags: - Cloud Routers summary: Delete Command description: This API provides capability to delete command based on command Id operationId: deleteCloudRouterCommandByUuid parameters: - name: routerId in: path description: Router UUID required: true schema: description: Cloud Router UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: commandId in: path description: Command UUID required: true schema: description: Command UUID type: string format: uuid example: 37c10edc-ba2e-4240-a850-8a48f9c47d00 responses: '204': description: Deleted command successfully '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' 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 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' examples: example: 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: - Cloud Routers summary: Search Route Tables description: The API provides capability to get list of user's Fabric Cloud Router route table entries using search criteria, including optional filtering, pagination and sorting operationId: searchCloudRouterRoutes parameters: - name: routerId in: path description: Router UUID required: true schema: description: Cloud Router UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteTableEntrySearchRequest' 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: 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 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RouteTableEntrySearchResponse' examples: activeRoutesResponse: 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' 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}/validate: post: tags: - Routing Protocols summary: Validate Subnet description: This API provides capability to validate all subnets associated with any connection in the given FCR operationId: validateRoutingProtocol parameters: - name: routerId in: path description: Cloud Router UUID required: true schema: description: Cloud Router UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: $ref: '#/components/schemas/ValidateRequest' examples: ValidateDirectIpv4: value: filter: and: - property: /directIpv4/equinixIfaceIp operator: '=' values: - 10.1.1.1/30 - property: /connection/uuid operator: '=' values: - a96f16d3-e504-44a7-a628-4916b5750008 ValidateDirectIpv6: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ValidateSubnetResponse' examples: ValidateSubnet: value: additionalInfo: - key: message value: The provided subnet is valid. '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: Bad Request: value: - errorCode: EQ-2041022 errorMessage: Invalid argument value passed. correlationId: 5f9f9ab9-a6cb-4e8a-aa34-105cd4cb6cc8 Subnet Overlapping: 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: - Route Filters summary: Search Cloud Router Route Filter Attachments description: This API provides capability to search route filter attachments for a given cloud router Beta operationId: searchCloudRouterRouteFilterAttachments parameters: - name: routerId in: path description: Cloud 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/CloudRouterRouteFiltersSearchBase' examples: searchRouteFiltersRequest: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/CloudRouterRouteFiltersSearchResponse' examples: SearchRouteFiltersResponse: 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' examples: InvalidInput: value: - errorCode: EQ-3044101 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: /type InvalidId: 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' 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: Route Filter ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Route Aggregations summary: Search Cloud Router Route Aggregation Attachments description: This API provides capability to search route aggregation attachments for a given cloud router Beta operationId: searchCloudRouterRouteAggregationAttachments parameters: - name: routerId in: path description: Cloud 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/CloudRouterRouteAggregationsSearchBase' examples: searchRouteAggregationsRequest: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/CloudRouterRouteAggregationsSearchResponse' examples: 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/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' examples: InvalidInput: value: - errorCode: EQ-3044305 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: type InvalidId: 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' 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: Route Aggregation ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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: - Cloud Routers summary: Search Routers description: The API provides capability to get list of user's Cloud Routers using search criteria, including optional filtering, pagination and sorting operationId: searchCloudRouters requestBody: content: application/json: schema: $ref: '#/components/schemas/CloudRouterSearchRequest' 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: 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: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/SearchResponse' examples: 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' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' 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-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' examples: example: 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' examples: example: value: - errorCode: EQ-3040030 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/routerPackages: get: tags: - Cloud Router Packages summary: List Packages description: This API provides capability to retrieve user's Cloud Routers Packages operationId: getCloudRouterPackages parameters: - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: '200': description: Fabric Cloud Router Packages content: application/json: schema: $ref: '#/components/schemas/PackageResponse' examples: Example: 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' 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-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' examples: example: 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' examples: example: value: - errorCode: EQ-3040030 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/routerPackages/{routerPackageCode}: get: tags: - Cloud Router Packages summary: Get Package Details description: This API provides capability to retrieve user's Cloud Routers Package Details operationId: getCloudRouterPackageByCode parameters: - name: routerPackageCode in: path description: Equinix-assigned Cloud Router package identifier required: true schema: $ref: '#/components/schemas/RouterPackageCode' responses: '200': description: Fabric Cloud Router Package details content: application/json: schema: $ref: '#/components/schemas/CloudRouterPackage' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: invalidPackage: value: - errorCode: EQ-3040028 errorMessage: Package not found correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: package must be of type LAB or PRO invalidName: 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: 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: 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' 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-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' examples: example: 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' examples: example: value: - errorCode: EQ-3040030 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/health: get: tags: - Health 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 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/HealthResponse' examples: metroExample: 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: - Connections summary: Validate Connection description: This API provides capability to validate by auth key operationId: validateConnections requestBody: content: application/json: schema: $ref: '#/components/schemas/ValidateRequest' examples: Alibaba-ValidateAuthKey: 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: 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: value: filter: and: - property: /zSide/accessPoint/authenticationKey operator: '=' values: - xxx-xxx-xxx - property: /zSide/accessPoint/profile/uuid operator: '=' values: - xxx-xxx-xxx Google-ValidateAuthKey: 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: 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: 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: 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: 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: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ConnectionResponse' examples: Alibaba-ValidateAuthKey: value: additionalInfo: - key: message value: Authorization key provided is valid Aws-ValidateAuthKey: value: additionalInfo: - key: message value: Authorization key provided is valid Azure-ValidateAuthKey-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: 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: 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: 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: value: additionalInfo: - key: message value: Authorization key provided is valid IBM-1.0-ValidateAuthKey: value: additionalInfo: - key: message value: Authorization key provided is valid IBM-2.0-ValidateAuthKey: value: additionalInfo: - key: message value: Authorization key provided is valid Oracle-ValidateAuthKey: value: additionalInfo: - key: message value: Authorization key provided is valid data: - bandwidth: 1000 Dot1q-ValidateAuthKey: value: additionalInfo: - key: message value: vlanTag(s) provided is available Qinq-ValidateAuthKey: value: additionalInfo: - key: message value: vlanTag(s) provided is available '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: Bad Request: value: - errorCode: EQ-3142308 errorMessage: Authentication key is required additionalInfo: - property: /zSide/accessPoint/authenticationKey /fabric/v4/networks: post: tags: - Networks summary: Create Network description: This API provides capability to create user's Fabric Network operationId: createNetwork parameters: - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkPostRequest' examples: Create-Global-EVPLAN-Network: 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 NetworkDryRunCreate: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Network' examples: EVPLAN-Global-Network: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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' examples: networkResponse: 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' examples: example: 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' 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: 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' 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/networks/{networkId}: get: tags: - Networks summary: Get Network By ID description: This API provides capability to retrieve user's Fabric Network operationId: getNetworkByUuid parameters: - name: networkId in: path description: Network UUID required: true schema: description: Network UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Fabric Network Access point object content: application/json: schema: $ref: '#/components/schemas/Network' examples: networkResponse: 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' 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-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 summary: Delete Network By ID description: This API provides capability to delete user's Fabric Network operationId: deleteNetworkByUuid parameters: - name: networkId in: path description: Network UUID required: true schema: description: Network UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '202': description: Fabric Network Access point object content: application/json: schema: $ref: '#/components/schemas/Network' examples: networkResponse: 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' examples: example: 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' 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-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 summary: Update Network By ID description: This API provides capability to update user's Fabric Network operationId: updateNetworkByUuid parameters: - name: networkId in: path description: Network UUID required: true schema: description: Network UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/NetworkUpdateRequest' examples: UpdateName: value: - op: replace path: /name value: NewName UpdateNotificationEmail: value: - op: replace path: /notifications value: - type: ALL emails: - test1@test.com - test2@test.com required: true responses: '200': description: Fabric Network Access point object content: application/json: schema: $ref: '#/components/schemas/Network' examples: networkResponse: 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' examples: example: 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' 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-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' examples: example: 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: - Networks 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkSearchRequest' 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: 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': description: Fabric Network Access point object content: application/json: schema: $ref: '#/components/schemas/NetworkSearchResponse' examples: networkResponse: 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' examples: example: 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' 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: 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: - Networks summary: Get Connections description: The API provides capability to get list of user's Fabric Network connections operationId: getConnectionsByNetworkUuid parameters: - name: networkId in: path description: Network UUID required: true schema: description: Network UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Fabric Network Access point object content: application/json: schema: $ref: '#/components/schemas/NetworkConnections' examples: networkResponse: 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' examples: example: 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' 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: 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: - Networks summary: Get Network Changes description: The API provides capability to get list of user's Fabric Network changes operationId: getNetworkChanges parameters: - name: networkId in: path description: Network UUID required: true schema: description: Network UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Fabric Network Access point object content: application/json: schema: $ref: '#/components/schemas/NetworkChangeResponse' examples: networkResponse: 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' examples: example: 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' 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: 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: - Networks summary: Get Change By ID description: This API provides capability to retrieve user's Fabric Network Change operationId: getNetworkChangeByUuid parameters: - name: networkId in: path description: Network UUID required: true schema: description: Network UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 - name: changeId in: path description: Network Change UUID required: true schema: description: Network Change UUID type: string format: uuid example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 responses: '200': description: Fabric Network Access point object content: application/json: schema: $ref: '#/components/schemas/NetworkChange' examples: networkResponse: 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' examples: example: 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' 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-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: - Precision Time Services summary: Create Time Service description: The API provides capability to create Precision Time service operationId: createTimeServices requestBody: content: application/json: schema: $ref: '#/components/schemas/precisionTimeServiceRequest' examples: ntpStandard: 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: 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: 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: 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= required: true responses: '202': description: Successful Accepted operation 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: 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: 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: 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: 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' examples: InvalidName: value: - errorCode: EQ-4800010 errorMessage: Validation Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 additionalInfo: - property: /name reason: Invalid name provided ValidateName: 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: value: - errorCode: EQ-4800101 errorMessage: Service name is already in use correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryConnectionUuid: value: - errorCode: EQ-4800011 errorMessage: Mandatory field ConnectionUUid is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionUuidFormat: value: - errorCode: EQ-4800023 errorMessage: Invalid connection uuid format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionStatus: value: - errorCode: EQ-4800102 errorMessage: Connection should be in Pending Approval state correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateConnectionUuid: value: - errorCode: EQ-4800103 errorMessage: Connection does not belong to this user correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionLocation: value: - errorCode: EQ-4800104 errorMessage: Connection location is not supported by EPT correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackageType: value: - errorCode: EQ-4800011 errorMessage: Mandatory field Package Type is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackageType: value: - errorCode: EQ-4800010 errorMessage: Invalid Package Type - Allowed types are PTP, NTP correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackageType: value: - errorCode: EQ-4800105 errorMessage: Connection Package type is different correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackage: value: - errorCode: EQ-4800011 errorMessage: Mandatory field Package is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackage: value: - errorCode: EQ-4800010 errorMessage: Invalid Package - Allowed packages are STANDARD, ENTERPRISE correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackage: value: - errorCode: EQ-4800106 errorMessage: Connection Package is different correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPrimaryIP: value: - errorCode: EQ-4800011 errorMessage: Mandatory field PrimaryIP is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPrimaryIPFormat: value: - errorCode: EQ-4800023 errorMessage: Invalid PrimaryIP format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePrimaryIP: 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: value: - errorCode: EQ-4800011 errorMessage: Mandatory field SecondaryIP is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidSecondaryIPFormat: value: - errorCode: EQ-4800023 errorMessage: Invalid SecondaryIP format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateSecondaryIP: 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: value: - errorCode: EQ-4800108 errorMessage: Primary and Secondary IPs should be in the same subnet correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryNetworkMask: value: - errorCode: EQ-4800011 errorMessage: Mandatory field NetworkMask is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidNetworkMaskFormat: value: - errorCode: EQ-4800023 errorMessage: Invalid NetworkMask format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateNetworkMask: 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: value: - errorCode: EQ-4800023 errorMessage: Invalid DefaultGateway correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateDefaultGateway: value: - errorCode: EQ-4800110 errorMessage: Invalid DefaultGateway- Default Gateway cannot be same as Primary/Secondary IP correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidTimeScale: value: - errorCode: EQ-4800010 errorMessage: Invalid TimeScale - Allowed values are ARB, PTP correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidDomain: value: - errorCode: EQ-4800010 errorMessage: Invalid Domain- Allowed values are from 0 to 127 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority1: value: - errorCode: EQ-4800010 errorMessage: Invalid Priority1 - Allowed values are 0 to 248 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority2: value: - errorCode: EQ-4800010 errorMessage: Invalid Priority2 - Allowed values are 0 to 248 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogAnnounceInterval: value: - errorCode: EQ-4800010 errorMessage: Invalid LogAnnounceInterval correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogAnnounceIntervalRange: value: - errorCode: EQ-4800111 errorMessage: Invalid LogAnnounceInterval range - Allowed range is -3 to 1 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogSyncInterval: value: - errorCode: EQ-4800010 errorMessage: Invalid LogSyncInterval correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogSyncIntervalRange: value: - errorCode: EQ-4800112 errorMessage: Invalid LogSyncInterval range - Allowed range is -5 to 1 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogDelayReqInterval: value: - errorCode: EQ-4800010 errorMessage: Invalid logDelayReqInterval correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogDelayReqIntervalRange: value: - errorCode: EQ-4800112 errorMessage: Invalid logDelayReqInterval range - Allowed range is -5 to 1 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidTransportMode: value: - errorCode: EQ-4800010 errorMessage: Invalid TransportMode - Allowed values are Multicast, Unicast, Hybrid correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidGrantTime: value: - errorCode: EQ-4800010 errorMessage: Invalid GrantTime correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateGrantTimeRange: value: - errorCode: EQ-4800113 errorMessage: Invalid GrantTime range - Allowed range is 30 to 7200 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidType: value: - errorCode: EQ-4800010 errorMessage: Invalid Type - Allowed values are ASCII, HEX correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidId: value: - errorCode: EQ-4800010 errorMessage: Invalid Id - Only Integers are allowed correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPassword: value: - errorCode: EQ-4800010 errorMessage: Invalid Password correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePassword: 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 '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 /fabric/v4/timeServices/{serviceId}: put: tags: - Precision Time Services summary: Update Time Service description: The API provides capability to Configure/Fulfill the Precision Time Service operationId: fulfillTimeServices parameters: - name: serviceId in: path description: Service UUID required: true schema: description: Precision Time Service UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: $ref: '#/components/schemas/precisionTimeServiceRequest' examples: ntpStandard: 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: 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: 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: 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': description: Successful Accepted operation 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: 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' examples: InvalidName: value: - errorCode: EQ-4800010 errorMessage: Validation Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 additionalInfo: - property: /name reason: Invalid name provided ValidateName: 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: value: - errorCode: EQ-4800101 errorMessage: Service name is already in use correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryConnectionUuid: value: - errorCode: EQ-4800011 errorMessage: Mandatory field ConnectionUUid is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionUuidFormat: value: - errorCode: EQ-4800023 errorMessage: Invalid connection uuid format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionStatus: value: - errorCode: EQ-4800102 errorMessage: Connection should be in Pending Approval state correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateConnectionUuid: value: - errorCode: EQ-4800103 errorMessage: Connection does not belong to this user correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionLocation: value: - errorCode: EQ-4800104 errorMessage: Connection location is not supported by EPT correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackageType: value: - errorCode: EQ-4800011 errorMessage: Mandatory field Package Type is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackageType: value: - errorCode: EQ-4800010 errorMessage: Invalid Package Type - Allowed types are PTP, NTP correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackageType: value: - errorCode: EQ-4800105 errorMessage: Connection Package type is different correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackage: value: - errorCode: EQ-4800011 errorMessage: Mandatory field Package is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackage: value: - errorCode: EQ-4800010 errorMessage: Invalid Package - Allowed packages are STANDARD, ENTERPRISE correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackage: value: - errorCode: EQ-4800106 errorMessage: Connection Package is different correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPrimaryIP: value: - errorCode: EQ-4800011 errorMessage: Mandatory field PrimaryIP is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPrimaryIPFormat: value: - errorCode: EQ-4800023 errorMessage: Invalid PrimaryIP format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePrimaryIP: 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: value: - errorCode: EQ-4800011 errorMessage: Mandatory field SecondaryIP is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidSecondaryIPFormat: value: - errorCode: EQ-4800023 errorMessage: Invalid SecondaryIP format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateSecondaryIP: 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: value: - errorCode: EQ-4800108 errorMessage: Primary and Secondary IPs should be in the same subnet correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryNetworkMask: value: - errorCode: EQ-4800011 errorMessage: Mandatory field NetworkMask is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidNetworkMaskFormat: value: - errorCode: EQ-4800023 errorMessage: Invalid NetworkMask format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateNetworkMask: 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: value: - errorCode: EQ-4800023 errorMessage: Invalid DefaultGateway correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateDefaultGateway: value: - errorCode: EQ-4800110 errorMessage: Invalid DefaultGateway- Default Gateway cannot be same as Primary/Secondary IP correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidTimeScale: value: - errorCode: EQ-4800010 errorMessage: Invalid TimeScale - Allowed values are ARB, PTP correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidDomain: value: - errorCode: EQ-4800010 errorMessage: Invalid Domain- Allowed values are from 0 to 127 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority1: value: - errorCode: EQ-4800010 errorMessage: Invalid Priority1 - Allowed values are 0 to 248 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority2: value: - errorCode: EQ-4800010 errorMessage: Invalid Priority2 - Allowed values are 0 to 248 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogAnnounceInterval: value: - errorCode: EQ-4800010 errorMessage: Invalid LogAnnounceInterval correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogAnnounceIntervalRange: value: - errorCode: EQ-4800111 errorMessage: Invalid LogAnnounceInterval range - Allowed range is -3 to 1 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogSyncInterval: value: - errorCode: EQ-4800010 errorMessage: Invalid LogSyncInterval correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogSyncIntervalRange: value: - errorCode: EQ-4800112 errorMessage: Invalid LogSyncInterval range - Allowed range is -5 to 1 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogDelayReqInterval: value: - errorCode: EQ-4800010 errorMessage: Invalid logDelayReqInterval correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogDelayReqIntervalRange: value: - errorCode: EQ-4800112 errorMessage: Invalid logDelayReqInterval range - Allowed range is -5 to 1 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidTransportMode: value: - errorCode: EQ-4800010 errorMessage: Invalid TransportMode - Allowed values are Multicast, Unicast, Hybrid correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidGrantTime: value: - errorCode: EQ-4800010 errorMessage: Invalid GrantTime correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateGrantTimeRange: value: - errorCode: EQ-4800113 errorMessage: Invalid GrantTime range - Allowed range is 30 to 7200 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidType: value: - errorCode: EQ-4800010 errorMessage: Invalid Type - Allowed values are ASCII, HEX correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidId: value: - errorCode: EQ-4800010 errorMessage: Invalid Id - Only Integers are allowed correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPassword: value: - errorCode: EQ-4800010 errorMessage: Invalid Password correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePassword: 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 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: description: Precision Time Service UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/precisionTimeServiceResponse' examples: 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' 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 patch: tags: - Precision Time Services summary: Update Time Service by ID description: The API provides capability to update Precision Time Service by service id operationId: updateTimeServicesById parameters: - name: serviceId in: path description: Service UUID required: true schema: description: Precision Time Service UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json-patch+json: schema: type: array minItems: 1 maxItems: 1 items: $ref: '#/components/schemas/precisionTimeChangeOperation' examples: 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= required: true responses: '202': description: Successful Accepted operation 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: 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' examples: InvalidName: value: - errorCode: EQ-4800010 errorMessage: Validation Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 additionalInfo: - property: /name reason: Invalid name provided ValidateName: 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: value: - errorCode: EQ-4800101 errorMessage: Service name is already in use correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryConnectionUuid: value: - errorCode: EQ-4800011 errorMessage: Mandatory field ConnectionUUid is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionUuidFormat: value: - errorCode: EQ-4800023 errorMessage: Invalid connection uuid format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionStatus: value: - errorCode: EQ-4800102 errorMessage: Connection should be in Pending Approval state correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateConnectionUuid: value: - errorCode: EQ-4800103 errorMessage: Connection does not belong to this user correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionLocation: value: - errorCode: EQ-4800104 errorMessage: Connection location is not supported by EPT correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackageType: value: - errorCode: EQ-4800011 errorMessage: Mandatory field Package Type is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackageType: value: - errorCode: EQ-4800010 errorMessage: Invalid Package Type - Allowed types are PTP, NTP correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackageType: value: - errorCode: EQ-4800105 errorMessage: Connection Package type is different correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPackage: value: - errorCode: EQ-4800011 errorMessage: Mandatory field Package is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPackage: value: - errorCode: EQ-4800010 errorMessage: Invalid Package - Allowed packages are STANDARD, ENTERPRISE correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidConnectionPackage: value: - errorCode: EQ-4800106 errorMessage: Connection Package is different correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryPrimaryIP: value: - errorCode: EQ-4800011 errorMessage: Mandatory field PrimaryIP is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPrimaryIPFormat: value: - errorCode: EQ-4800023 errorMessage: Invalid PrimaryIP format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePrimaryIP: 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: value: - errorCode: EQ-4800011 errorMessage: Mandatory field SecondaryIP is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidSecondaryIPFormat: value: - errorCode: EQ-4800023 errorMessage: Invalid SecondaryIP format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateSecondaryIP: 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: value: - errorCode: EQ-4800108 errorMessage: Primary and Secondary IPs should be in the same subnet correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 MandatoryNetworkMask: value: - errorCode: EQ-4800011 errorMessage: Mandatory field NetworkMask is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidNetworkMaskFormat: value: - errorCode: EQ-4800023 errorMessage: Invalid NetworkMask format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateNetworkMask: 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: value: - errorCode: EQ-4800023 errorMessage: Invalid DefaultGateway correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateDefaultGateway: value: - errorCode: EQ-4800110 errorMessage: Invalid DefaultGateway- Default Gateway cannot be same as Primary/Secondary IP correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidTimeScale: value: - errorCode: EQ-4800010 errorMessage: Invalid TimeScale - Allowed values are ARB, PTP correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidDomain: value: - errorCode: EQ-4800010 errorMessage: Invalid Domain- Allowed values are from 0 to 127 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority1: value: - errorCode: EQ-4800010 errorMessage: Invalid Priority1 - Allowed values are 0 to 248 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPriority2: value: - errorCode: EQ-4800010 errorMessage: Invalid Priority2 - Allowed values are 0 to 248 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogAnnounceInterval: value: - errorCode: EQ-4800010 errorMessage: Invalid LogAnnounceInterval correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogAnnounceIntervalRange: value: - errorCode: EQ-4800111 errorMessage: Invalid LogAnnounceInterval range - Allowed range is -3 to 1 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogSyncInterval: value: - errorCode: EQ-4800010 errorMessage: Invalid LogSyncInterval correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogSyncIntervalRange: value: - errorCode: EQ-4800112 errorMessage: Invalid LogSyncInterval range - Allowed range is -5 to 1 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidLogDelayReqInterval: value: - errorCode: EQ-4800010 errorMessage: Invalid logDelayReqInterval correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateLogDelayReqIntervalRange: value: - errorCode: EQ-4800112 errorMessage: Invalid logDelayReqInterval range - Allowed range is -5 to 1 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidTransportMode: value: - errorCode: EQ-4800010 errorMessage: Invalid TransportMode - Allowed values are Multicast, Unicast, Hybrid correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidGrantTime: value: - errorCode: EQ-4800010 errorMessage: Invalid GrantTime correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidateGrantTimeRange: value: - errorCode: EQ-4800113 errorMessage: Invalid GrantTime range - Allowed range is 30 to 7200 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidType: value: - errorCode: EQ-4800010 errorMessage: Invalid Type - Allowed values are ASCII, HEX correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidId: value: - errorCode: EQ-4800010 errorMessage: Invalid Id - Only Integers are allowed correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 InvalidPassword: value: - errorCode: EQ-4800010 errorMessage: Invalid Password correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ValidatePassword: 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' 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 /fabric/v4/timeServices/search: post: tags: - Precision Time Services 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/TimeServicesSearchRequest' 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 SearchFilterByNameAndProtocol: 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: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ServiceSearchResponse' examples: 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/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' examples: example: 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' 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: 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/timeServices/{serviceId}/connections: get: tags: - Precision Time Services summary: Get Connection Links description: The API provides capability to get prevision timing service's details operationId: getTimeServicesConnectionsByServiceId parameters: - name: serviceId in: path description: Service UUID required: true schema: description: Precision Time Service UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Return Time Service Connection content: application/json: schema: $ref: '#/components/schemas/precisionTimeServiceConnectionsResponse' examples: example: 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' 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: 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/timeServicePackages: get: tags: - Precision Time Packages summary: Get Packages description: The API provides capability to get timing service's packages operationId: getTimeServicesPackages responses: '200': description: Successful operation content: application/json: schema: $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' 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 /fabric/v4/timeServicePackages/{packageCode}: get: tags: - Precision Time Packages summary: Get Package By Code description: The API provides capability to get timing service's package by code operationId: getTimeServicesPackageByCode parameters: - name: packageCode in: path description: Package Code required: true schema: type: string enum: - NTP_STANDARD - NTP_ENTERPRISE - PTP_STANDARD - PTP_ENTERPRISE responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/precisionTimePackageResponse' examples: example: 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' 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 /fabric/v4/marketplaceSubscriptions/{subscriptionId}: get: tags: - Marketplace Subscriptions summary: Get Subscription description: The API provides capability to get subscription operationId: getSubscriptionById parameters: - name: subscriptionId in: path description: Subscription UUID required: true schema: description: Subscription Id type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Successful operation content: application/json: schema: $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: 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' 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 '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' examples: example: value: - errorCode: EQ-3045004 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error get: tags: - Streams summary: Get Streams description: This API provides capability to retrieve streams operationId: getStreams parameters: - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetAllStreamResponse' examples: Example: 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' 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/search: post: tags: - Streams summary: Search Streams description: This API provides capability to search streams operationId: searchStreams requestBody: content: application/json: schema: $ref: '#/components/schemas/StreamSearchRequest' examples: SearchStreams: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/SearchStreamResponse' examples: 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' '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}: get: tags: - Streams summary: Get Stream description: This API provides capability to get user's stream operationId: getStreamByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: description: Stream UUID type: string format: uuid example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 responses: '200': 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' 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 delete: tags: - Streams summary: Delete Stream description: This API provides capability to delete user's stream operationId: deleteStreamByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: description: Stream UUID type: string format: uuid example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 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 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': 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 put: tags: - Streams summary: Update Stream description: This API provides capability to update user's stream operationId: updateStreamByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: 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': description: Stream object content: application/json: schema: $ref: '#/components/schemas/Stream' examples: 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': 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 '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' examples: example: value: - errorCode: EQ-3045004 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error /fabric/v4/streamAssets/search: post: tags: - Streams summary: Search Stream Assets description: This API provides capability to search stream assets operationId: searchStreamAssets requestBody: content: application/json: schema: $ref: '#/components/schemas/StreamAssetSearchRequest' examples: SearchStreamAssets: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/SearchStreamAssetResponse' examples: 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 '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: value: - errorCode: EQ-3000039 errorMessage: 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}/{asset}/{assetId}: get: tags: - Streams summary: Get Asset description: This API provides capability to get user's assets attached to a stream operationId: getStreamAssetByUuid parameters: - name: assetId in: path description: asset UUID required: true schema: 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' - name: streamId in: path description: Stream UUID required: true schema: description: Stream UUID type: string format: uuid example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 responses: '200': description: Stream asset object content: application/json: schema: $ref: '#/components/schemas/StreamAsset' examples: StreamSubscriptionResponse: 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': 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 put: tags: - Streams summary: Attach Asset description: This API provides capability to attach an asset to a stream operationId: updateStreamAssetByUuid parameters: - name: assetId in: path description: asset UUID required: true schema: 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' - name: streamId in: path description: Stream UUID required: true schema: description: Stream UUID type: string format: uuid example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 requestBody: content: application/json: schema: $ref: '#/components/schemas/StreamAssetPutRequest' examples: UpdateStream: value: metricsEnabled: false required: true responses: '202': description: Stream object content: application/json: schema: $ref: '#/components/schemas/StreamAsset' examples: StreamAssetResponse: 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': 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 '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' examples: example: value: - errorCode: EQ-3045004 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error delete: tags: - Streams summary: Detach Asset description: This API provides capability to detach an asset from a stream operationId: deleteStreamAssetByUuid parameters: - name: assetId in: path description: asset UUID required: true schema: 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' - name: streamId in: path description: Stream UUID required: true schema: description: Stream UUID type: string format: uuid example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 responses: '202': description: Stream object content: application/json: schema: $ref: '#/components/schemas/StreamAsset' examples: StreamAssetResponse: 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': 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}/devices/{deviceId}: get: tags: - Streams summary: Get Network Edge Device description: This API provides capability to get a Network Edge Device and its interfaces attached to a stream operationId: getStreamDevice 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: deviceId in: path description: Network Edge Device UUID required: true schema: description: Network Edge Device UUID type: string format: uuid example: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d responses: '200': description: Stream Network Edge Device asset object content: application/json: schema: $ref: '#/components/schemas/StreamAsset' examples: StreamDeviceAssetResponse: 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': 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 put: tags: - Streams summary: Attach Network Edge Device Interfaces description: | This API provides capability to attach a Network Edge Device and its interfaces to a stream. The provided interfaces list is the complete desired set: interfaces not in the list are detached, new interfaces are attached. An empty or absent interfaces list detaches all currently attached interfaces. metricsEnabled must be true when interfaces are provided. operationId: updateStreamDevice 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: deviceId in: path description: Network Edge Device UUID required: true schema: description: Network Edge Device UUID type: string format: uuid example: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d requestBody: content: application/json: schema: $ref: '#/components/schemas/StreamDevicePutRequest' examples: UpdateStreamDevice: value: metricsEnabled: true interfaces: - id: 3 - id: 5 required: true responses: '202': description: Stream Network Edge Device asset object content: application/json: schema: $ref: '#/components/schemas/StreamAsset' examples: StreamDeviceAssetResponse: 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': 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 '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' examples: example: value: - errorCode: EQ-3045004 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error delete: tags: - Streams summary: Detach Network Edge Device description: This API provides capability to detach a Network Edge Device and all of its interfaces from a stream operationId: deleteStreamDevice 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: deviceId in: path description: Network Edge Device UUID required: true schema: description: Network Edge Device UUID type: string format: uuid example: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d responses: '202': description: Stream Network Edge Device asset object content: application/json: schema: $ref: '#/components/schemas/StreamAsset' examples: StreamDeviceAssetResponse: 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': 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}/subscriptions: post: tags: - Stream Subscriptions summary: Create Subscription description: This API provides capability to create user's Stream Subscriptions operationId: createStreamSubscriptions parameters: - name: streamId in: path description: Stream UUID required: true schema: description: Stream UUID type: string format: uuid example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 requestBody: content: application/json: schema: $ref: '#/components/schemas/StreamSubscriptionPostRequest' examples: CreateStreamSubscription_Splunk_Simple: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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': description: Stream Subscription object content: application/json: schema: $ref: '#/components/schemas/StreamSubscription' examples: 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': 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 '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' examples: example: value: - errorCode: EQ-3045004 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error 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: 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: Successful operation content: application/json: schema: $ref: '#/components/schemas/GetAllStreamSubscriptionResponse' examples: 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' 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}/subscriptions/{subscriptionId}: get: tags: - Stream Subscriptions summary: Get Subscription description: This API provides capability to delete user's get Stream Subscriptions operationId: getStreamSubscriptionByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: 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 responses: '200': description: Stream Subscription object content: application/json: schema: $ref: '#/components/schemas/StreamSubscription' examples: 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': 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 delete: tags: - Stream Subscriptions summary: Delete Subscription description: This API provides capability to delete user's Stream Subscriptions operationId: deleteStreamSubscriptionByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: 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 responses: '202': description: Stream Subscription object content: application/json: schema: $ref: '#/components/schemas/StreamSubscription' examples: 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: 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': 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 put: tags: - Stream Subscriptions summary: Update Subscription description: This API provides capability to update user's Stream Subscriptions operationId: updateStreamSubscriptionByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: 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/StreamSubscriptionPutRequest' examples: 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: '202': description: Stream Subscription object content: application/json: schema: $ref: '#/components/schemas/StreamSubscription' examples: 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': 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 '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' examples: example: 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 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: Successful operation content: application/json: schema: $ref: '#/components/schemas/SearchStreamSubscriptionResponse' examples: 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' 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: post: tags: - Stream Alert Rules summary: Create Stream Alert Rule description: This API provides capability to create user's Stream Alert Rules operationId: createStreamAlertRules parameters: - name: streamId in: path description: Stream UUID required: true schema: description: Stream UUID type: string format: uuid example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertRulePostRequest' examples: CreateStreamAlertRules: 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: 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': description: Stream Alert Rules object content: application/json: schema: $ref: '#/components/schemas/StreamAlertRule' examples: StreamAlertRuleRequestResponse: 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': 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 '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' examples: example: 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: - Stream Alert Rules summary: Get Stream Alert Rule description: This API provides capability to get user's stream alert rule operationId: getStreamAlertRuleByUuid 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: alertRuleId in: path description: alert rule UUID required: true schema: description: Stream Alert Rule UUID type: string format: uuid example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 responses: '200': description: Stream Alert Rules object content: application/json: schema: $ref: '#/components/schemas/StreamAlertRule' examples: StreamAlertRuleResponse: 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': 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 put: tags: - Stream Alert Rules summary: Update Stream Alert Rule description: This API provides capability to update a user's stream alert rule operationId: updateStreamAlertRuleByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: description: Stream UUID type: string format: uuid example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: alertRuleId in: path description: alert rule UUID required: true schema: description: Stream Alert Rule UUID type: string format: uuid example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertRulePutRequest' examples: UpdateStreamAlertRules: 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': description: Stream Alert Rules object content: application/json: schema: $ref: '#/components/schemas/StreamAlertRule' examples: StreamAlertRuleRequestResponse: 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': 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 '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' examples: example: value: - errorCode: EQ-3045004 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error delete: tags: - Stream Alert Rules summary: Delete Stream Alert Rule description: This API provides capability to delete a user's stream alert rule operationId: deleteStreamAlertRuleByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: description: Stream UUID type: string format: uuid example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 - name: alertRuleId in: path description: alert rule UUID required: true schema: description: Stream Alert Rule UUID type: string format: uuid example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 responses: '202': description: Stream Alert Rules object content: application/json: schema: $ref: '#/components/schemas/StreamAlertRule' examples: StreamAlertRuleDeleteResponse: 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': 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/companyProfiles: post: tags: - Company Profiles summary: Create Company Profile description: Create a new company profile Beta operationId: createCompanyProfile requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanyProfileRequest' required: true responses: '202': description: Company profile created and pending for approval content: application/json: schema: $ref: '#/components/schemas/CompanyProfileResponse' '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' /fabric/v4/companyProfiles/{companyProfileId}: get: tags: - Company Profiles summary: Get Company Profile by ID description: Get company profile details by UUID Beta operationId: getCompanyProfile parameters: - name: companyProfileId in: path description: Company Profile UUID required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/CompanyProfileResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorList' delete: tags: - Company Profiles summary: Delete Company Profile description: Delete company profile by UUID Beta operationId: deleteCompanyProfile parameters: - name: companyProfileId in: path description: Company Profile UUID required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/CompanyProfileResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/search: post: tags: - Company Profiles summary: Search Company Profiles description: Search company profiles based on filter criteria Beta operationId: searchCompanyProfile parameters: - name: viewPoint in: query description: Viewpoint for the request, either 'aSide' or 'zSide' required: false schema: type: string default: aSide requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanyProfileSearchRequest' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/CompanyProfileSearchResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/serviceProfiles: get: tags: - Company Profiles summary: Get Service Profiles description: Get all service profiles attached to a company profile Beta operationId: getCompanyProfileServiceProfiles parameters: - name: companyProfileId in: path description: Company Profile UUID required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ServiceProfileListResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/serviceProfiles/{serviceProfileId}: put: tags: - Company Profiles summary: Attach Service Profile description: Attach a service profile to a company profile Beta operationId: attachServiceProfileToProfile parameters: - name: companyProfileId in: path description: Company Profile UUID required: true schema: type: string - name: serviceProfileId in: path description: Service Profile UUID required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AttachServiceProfileResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorList' delete: tags: - Company Profiles summary: Detach Service Profile description: Detach a service profile from a company profile Beta operationId: detachServiceProfileFromProfile parameters: - name: companyProfileId in: path description: Company Profile UUID required: true schema: type: string - name: serviceProfileId in: path description: Service Profile UUID required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AttachServiceProfileResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/tags: get: tags: - Company Profiles summary: Get Tags description: Get all tags attached to a company profile Beta operationId: getTags parameters: - name: companyProfileId in: path description: Company Profile UUID required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/TagListResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/tags/{tagId}: put: tags: - Company Profiles summary: Attach Tag description: Attach a tag to a company profile Beta operationId: attachTagToProfile parameters: - name: companyProfileId in: path description: Company Profile UUID required: true schema: type: string - name: tagId in: path description: Tag UUID required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AttachTagResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorList' delete: tags: - Company Profiles summary: Detach Tag description: Detach a tag from a company profile Beta operationId: detachTagFromProfile parameters: - name: companyProfileId in: path description: Company Profile UUID required: true schema: type: string - name: tagId in: path description: Tag UUID required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AttachTagResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/privateServices: get: tags: - Company Profiles summary: Get Private Services description: Get all private services attached to a company profile Beta operationId: getCompanyProfilePrivateServices parameters: - name: companyProfileId in: path description: Company Profile UUID required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/PrivateServiceListResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/companyProfiles/{companyProfileId}/privateServices/{privateServiceId}: put: tags: - Company Profiles summary: Attach Private Service description: Attach a private service to a company profile Beta operationId: attachPrivateServiceToProfile parameters: - name: companyProfileId in: path description: Company Profile UUID required: true schema: type: string - name: privateServiceId in: path description: Private Service UUID required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AttachPrivateServiceResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorList' delete: tags: - Company Profiles summary: Detach Private Service description: Detach a private service from a company profile Beta operationId: detachPrivateServiceFromProfile parameters: - name: companyProfileId in: path description: Company Profile UUID required: true schema: type: string - name: privateServiceId in: path description: Private Service UUID required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AttachPrivateServiceResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorList' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/logos: post: tags: - Logos summary: Create Logo description: Create Logo for Equinix Fabric™ Company Profile operationId: createLogo requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/LogoRequest' required: true responses: '201': description: Successful Create operation content: application/json: schema: $ref: '#/components/schemas/LogoResponse' '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' /fabric/v4/logos/{uuid}: get: tags: - Logos summary: Get Logo description: Get Logo by UUID operationId: getLogoByUuid parameters: - name: uuid in: path description: UUID of the Logo required: true schema: type: string format: uuid responses: '200': description: Successful Get operation content: multipart/mixed: schema: type: string format: binary '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' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorList' delete: tags: - Logos summary: Delete Logo description: Delete Logo by UUID operationId: deleteLogoByUuid parameters: - name: uuid in: path description: UUID of the Logo required: true schema: type: string format: uuid responses: '202': description: Successful Delete operation content: application/json; charset=UTF-8: schema: $ref: '#/components/schemas/LogoResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorList' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorList' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/loas: post: tags: - Loas summary: Create Loa description: The API provides capability to create a new Loa operationId: createLoa requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLoa' examples: IssueLoa-OnCageWithCageId: 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: 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: 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: 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: 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: 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': description: Accepted content: application/json: schema: $ref: '#/components/schemas/LoaResponse' examples: ByRequestor: 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: 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: 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: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Loas summary: Get Loa description: The API provides capability to get Loa details by Loa ID operationId: getLoaByUuid parameters: - name: loaId in: path description: Loa UUID required: true schema: description: Loa UUID type: string format: uuid example: 29cc7878-54e3-4e1a-8651-87a61354bac2 responses: '200': description: Successful Operation content: application/json: schema: $ref: '#/components/schemas/LoaResponse' examples: LoaExample: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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 summary: Update Loa description: The API provides capability to update Loa details by Loa ID operationId: updateLoaByUuid parameters: - name: loaId in: path description: Loa UUID required: true schema: description: Loa UUID type: string format: uuid example: 29cc7878-54e3-4e1a-8651-87a61354bac2 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/LoaUpdate' examples: LoaPatchRequest: value: - op: replace path: /demarcationPoint/patchPanelId value: CP:Demarc:1259685 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/LoaResponse' examples: PatchLoaResponse: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Loas summary: Create LOA Action description: The API provides capability to perform actions on Loa operationId: performLoaAction parameters: - name: loaId in: path description: Loa UUID required: true schema: description: Loa UUID type: string format: uuid example: 29cc7878-54e3-4e1a-8651-87a61354bac2 requestBody: content: application/json: schema: $ref: '#/components/schemas/LoaActionRequest' examples: AuthorizeLoa: value: type: LOA_ISSUER_AUTHORIZATION data: demarcationPoint: patchPanelId: CP:Demarc:1259684 patchPanelPortA: 23 patchPanelPortB: 23 connectorType: SC expirationDateTime: '2026-08-07T07:00:00Z' AcceptLoa: value: type: LOA_REQUESTOR_ACCEPTANCE CopyLoa: value: type: LOA_COPY_LINK SendLoa: value: type: LOA_SEND_EMAIL_NOTIFICATION CancelLoa: value: type: LOA_CANCEL required: true responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/LoaActionResponse' examples: AuthorizeLoa: 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: 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: 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: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Loas summary: Get Loa Action by Action ID description: This API provides capability to fetch action details operationId: getLoaActionsByUuid parameters: - name: loaId in: path description: Loa UUID required: true schema: description: Loa UUID type: string format: uuid example: 29cc7878-54e3-4e1a-8651-87a61354bac2 - name: actionId in: path description: Action UUID required: true schema: description: Action UUID type: string format: uuid example: 30cc7878-54e3-4e1a-8651-87a61354bad4 responses: '200': description: Successful Operation content: application/json: schema: $ref: '#/components/schemas/LoaActionResponse' examples: AuthorizeLoaActionExample: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Loas 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/LoaSearchRequest' examples: SearchByNameWithType: 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: 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': description: Successful operation content: application/json: schema: $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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Loas summary: Search Loa Actions description: The API provides capability to get list of user's Loa Actions using search criteria, including optional filtering, pagination and sorting operationId: searchLoaAction parameters: - name: loaId in: path description: Loa UUID required: true schema: description: Loa UUID type: string format: uuid example: 29cc7878-54e3-4e1a-8651-87a61354bac2 requestBody: content: application/json: schema: $ref: '#/components/schemas/LoaActionSearchRequest' examples: ActionTypeSearch: 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': description: Successful Operation content: application/json: schema: $ref: '#/components/schemas/LoaActionSearchResponse' examples: LoaActionSearchExample: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Loas summary: Get Loa Consumers description: The API provides capability to get Loa consumers by Loa ID operationId: getLoaConsumersByLoaId parameters: - name: loaId in: path description: Loa UUID required: true schema: description: Loa UUID type: string format: uuid example: 29cc7878-54e3-4e1a-8651-87a61354bac2 responses: '200': description: Successful Operation content: application/json: schema: $ref: '#/components/schemas/LoaConsumersResponse' examples: LoaConsumersExample: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Loas summary: Get Loa Notes description: The API provides capability to get Loa notes by Loa ID operationId: getLoaNotesByUuid parameters: - name: loaId in: path description: Loa UUID required: true schema: description: Loa UUID type: string format: uuid example: 29cc7878-54e3-4e1a-8651-87a61354bac2 responses: '200': description: Successful Operation content: application/json: schema: $ref: '#/components/schemas/LoaNotesResponse' examples: GetLoaNotesExample: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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 summary: Create Loa Note description: The API provides capability to create Loa note by Loa ID operationId: createLoaNoteByLoaId parameters: - name: loaId in: path description: Loa UUID required: true schema: description: Loa UUID type: string format: uuid example: 29cc7878-54e3-4e1a-8651-87a61354bac2 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLoaNote' examples: LoaNoteRequest: value: comments: LOA under review by our team. Expected response within 2 business days. required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/LoaNoteDetails' examples: CreateLoaNoteExample: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Cross Connects summary: Create Cross Connect description: The API provides capability to create a new Cross Connect. operationId: createCrossConnect requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCrossConnect' examples: StandardCrossConnect: 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: 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: 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: 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: 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: 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: 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': description: Accepted. content: application/json: schema: $ref: '#/components/schemas/CrossConnectResponse' examples: StandardCrossConnectByPatchPanel: 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: 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: 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: 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: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3071199 errorMessage: Internal server error. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/bulk: post: tags: - Cross Connects summary: Create Diverse Cross Connect 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/DiverseCrossConnectRequest' examples: DiverseCrossConnectPair: 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': description: Accepted. content: application/json: schema: $ref: '#/components/schemas/CrossConnectDiverse' examples: DiverseCrossConnectPair: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3071199 errorMessage: Internal server error. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/search: post: tags: - Cross Connects 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/CrossConnectSearchRequest' examples: SearchByNameWithState: 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: 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': description: Successful operation. content: application/json: schema: $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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3071199 errorMessage: Internal server error. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}: get: tags: - Cross Connects summary: Get Cross Connect description: The API provides capability to get Cross Connect details by Cross Connect ID. operationId: getCrossConnectByUuid parameters: - name: crossConnectId in: path description: Cross Connect UUID. required: true schema: description: Cross Connect UUID. type: string format: uuid example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 responses: '200': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/CrossConnectResponse' examples: StandardCrossConnectByPatchPanel: 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: 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: 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: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3071199 errorMessage: Internal server error. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/schedules: get: tags: - Cross Connects summary: Get Cross Connect Schedules description: The API provides capability to get the schedules of a Cross Connect by Cross Connect ID. operationId: getCrossConnectSchedulesByUuid parameters: - name: crossConnectId in: path description: Cross Connect UUID. required: true schema: description: Cross Connect UUID. type: string format: uuid example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 responses: '200': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/SchedulesResponse' examples: SchedulesExample: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3071199 errorMessage: Internal server error. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/services: get: tags: - Cross Connects summary: Get Cross Connect Services description: The API provides capability to get the services ordered alongside a Cross Connect by Cross Connect ID. operationId: getCrossConnectServicesByUuid parameters: - name: crossConnectId in: path description: Cross Connect UUID. required: true schema: description: Cross Connect UUID. type: string format: uuid example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 responses: '200': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/CrossConnectServicesResponse' examples: GetCrossConnectServices: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3071199 errorMessage: Internal server error. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/attachments: get: tags: - Cross Connects summary: Get Cross Connect Attachments description: The API provides capability to get the documents attached to a Cross Connect by Cross Connect ID. operationId: getCrossConnectAttachmentsByUuid parameters: - name: crossConnectId in: path description: Cross Connect UUID. required: true schema: description: Cross Connect UUID. type: string format: uuid example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 responses: '200': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/CrossConnectAttachmentsResponse' examples: GetCrossConnectAttachments: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3071199 errorMessage: Internal server error. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/notes: get: tags: - Cross Connects summary: Get Cross Connect Notes description: The API provides capability to get the notes added to a Cross Connect by Cross Connect ID. operationId: getCrossConnectNotesByUuid parameters: - name: crossConnectId in: path description: Cross Connect UUID. required: true schema: description: Cross Connect UUID. type: string format: uuid example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 - 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/CrossConnectNotesResponse' examples: GetCrossConnectNotes: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3071199 errorMessage: Internal server error. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/actions: post: tags: - Cross Connects summary: Cross Connect Actions description: | The API provides capability to perform an action on a Cross Connect that is in the PENDING_ACTION state. The applicable action types are listed in the allowedActions of the Cross Connect. operationId: performCrossConnectAction parameters: - name: crossConnectId in: path description: Cross Connect UUID. required: true schema: description: Cross Connect UUID. type: string format: uuid example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 requestBody: content: application/json: schema: $ref: '#/components/schemas/CrossConnectActionRequest' examples: SendSignatureQuote: value: type: XC_SIGNATURE_SUBMISSION AcceptProposedDateTime: value: type: XC_PROPOSED_DATE_TIME_ACCEPTANCE RejectProposedDateTime: value: type: XC_PROPOSED_DATE_TIME_REJECTION CancelCrossConnect: value: type: XC_CANCEL DeinstallCrossConnect: 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: 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': description: Accepted. content: application/json: schema: $ref: '#/components/schemas/CrossConnectActionResponse' examples: SendSignatureQuote: 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: 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: 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: 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: 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: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3071199 errorMessage: Internal server error. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/actions/{actionId}: get: tags: - Cross Connects summary: Get Cross Connect Action by Action ID description: The API provides capability to fetch Cross Connect action details by Action ID. operationId: getCrossConnectActionByUuid parameters: - name: crossConnectId in: path description: Cross Connect UUID. required: true schema: 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: description: Cross Connect Action UUID. type: string format: uuid example: 30cc7878-54e3-4e1a-8651-87a61354bad4 responses: '200': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/CrossConnectActionResponse' examples: SendSignatureQuote: 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: 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: 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: 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: 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: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3071199 errorMessage: Internal server error. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnects/{crossConnectId}/actions/search: post: tags: - Cross Connects summary: Search Cross Connect Actions description: The API provides capability to get list of Cross Connect Actions using search criteria, including optional filtering, pagination and sorting. operationId: searchCrossConnectAction parameters: - name: crossConnectId in: path description: Cross Connect UUID. required: true schema: description: Cross Connect UUID. type: string format: uuid example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 requestBody: content: application/json: schema: $ref: '#/components/schemas/CrossConnectActionSearchRequest' examples: ActionTypeSearch: 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': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/CrossConnectActionSearchResponse' examples: CrossConnectActionSearchExample: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3071199 errorMessage: Internal server error. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec /fabric/v4/crossConnectSchedules/search: post: tags: - Cross Connects summary: Search Cross Connect Schedules description: | The API provides capability to search the Cross Connect schedule windows offered at an IBX, including optional filtering, pagination and sorting. operationId: searchCrossConnectSchedules requestBody: content: application/json: schema: $ref: '#/components/schemas/CrossConnectScheduleSearchRequest' examples: SearchInstallSchedules: 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': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/SearchSchedulesResponse' examples: SearchInstallSchedules: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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 summary: List Tags description: Get all Tags operationId: listTags parameters: - name: type in: query description: Filter by tag type required: false schema: type: array items: type: string - name: offset in: query description: Offset for pagination required: false schema: type: integer format: int32 default: 0 - name: limit in: query description: Limit for pagination required: false schema: type: integer format: int32 default: 20 maximum: 100 responses: '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' /fabric/v4/tags/{uuid}: get: tags: - Tags summary: Get Tag description: Get Tag by UUID operationId: getTagByUuid parameters: - name: uuid in: path description: UUID of the Tag required: true schema: type: string format: uuid responses: '200': description: Successful Get operation 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' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorList' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorList' /fabric/v4/appDomains: post: tags: - Application Domains summary: Create Domain description: This API provides capability to create user's App Domain operationId: createAppDomain requestBody: content: application/json: schema: $ref: '#/components/schemas/AppDomainPostRequest' examples: CreateAppDomain: value: type: APP_DOMAIN name: atlassian.net description: Atlassian Domain project: projectId: 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: '202': description: App Domain object content: application/json: schema: $ref: '#/components/schemas/AppDomain' examples: AppDomainResponse: 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' examples: 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 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3810030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appDomains/{appDomainId}: get: tags: - Application Domains summary: Get Domain description: This API provides capability to retrieve user's Domain operationId: getAppDomainByUuid parameters: - name: appDomainId in: path description: App Domain UUID required: true schema: description: App Domain UUID type: string format: uuid example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: '200': description: App Domain object content: application/json: schema: $ref: '#/components/schemas/AppDomain' examples: AppDomainResponse: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3810030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error delete: tags: - Application Domains summary: Delete Domain description: This API provides capability to delete user's Domain operationId: deleteAppDomainByUuid parameters: - name: appDomainId in: path description: App Domain UUID required: true schema: description: App Domain UUID type: string format: uuid example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: '202': description: App Domain object content: application/json: schema: $ref: '#/components/schemas/AppDomain' examples: AppDomainResponse: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3810030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error patch: tags: - Application Domains summary: Update Domain description: This API provides capability to update user's Domain operationId: updateAppDomainByUuid parameters: - name: appDomainId in: path description: App Domain UUID required: true schema: 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' examples: UpdateDescription: value: - op: replace path: /description value: Updated Atlassian Domain required: true responses: '202': description: App Domain object content: application/json: schema: $ref: '#/components/schemas/AppDomain' examples: AppDomainResponse: 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' examples: example: 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' 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-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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3810030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appDomains/search: post: tags: - Application Domains 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/AppDomainSearchRequest' examples: SearchFilterByStatus: 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: 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: value: filter: and: - or: - property: /name operator: LIKE values: - abc% - property: /project/projectId operator: '=' values: - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AppDomainSearchResponse' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Application Domains summary: Get Attached Links for Domain description: This API provides capability to retrieve App Links attached to an App Domain operationId: getAttachedAppLinksByAppDomainId parameters: - name: appDomainId in: path description: App Domain UUID required: true schema: description: App Domain UUID type: string format: uuid example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 - name: state in: query description: Filter attached App Links by one or more lifecycle states. required: false style: form explode: false schema: $ref: '#/components/schemas/AttachedAppLinkState' - name: order in: query description: Sort order for attached App Links. required: false schema: $ref: '#/components/schemas/AttachedAppLinkOrder' - name: style in: query description: Detail level of the response. required: false schema: $ref: '#/components/schemas/Style' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AppDomainAttachedAppLinks' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3810030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appLinks: post: tags: - Application Links summary: Create Link description: This API provides capability to create user's Link operationId: createAppLink requestBody: content: application/json: schema: $ref: '#/components/schemas/AppLinkPostRequest' examples: CreateAppLink: 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': description: App Link object content: application/json: schema: $ref: '#/components/schemas/AppLink' examples: AppLinkResponse: 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' examples: 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 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appLinks/{appLinkId}: get: tags: - Application Links summary: Get Link description: This API provides capability to retrieve user's Link operationId: getAppLinkByUuid parameters: - name: appLinkId in: path description: App Link UUID required: true schema: description: App Link UUID type: string format: uuid example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 responses: '200': description: App Link object content: application/json: schema: $ref: '#/components/schemas/AppLink' examples: AppLinkResponse: 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' examples: example: 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' examples: example: 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' 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 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error delete: tags: - Application Links summary: Delete Link description: This API provides capability to delete user's Link operationId: deleteAppLinkByUuid parameters: - name: appLinkId in: path description: App Link UUID required: true schema: description: App Link UUID type: string format: uuid example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 responses: '202': description: App Link object content: application/json: schema: $ref: '#/components/schemas/AppLink' examples: AppLinkResponse: 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' 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' examples: example: 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' examples: example: 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' 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 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error patch: tags: - Application Links summary: Update Link description: This API provides capability to update user's Link operationId: updateAppLinkByUuid parameters: - name: appLinkId in: path description: App Link UUID required: true schema: 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' examples: UpdateName: value: - op: replace path: /name value: Updated Atlassian App Link required: true responses: '202': description: App Link object content: application/json: schema: $ref: '#/components/schemas/AppLink' examples: AppLinkResponse: 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' examples: example: 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' 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-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' 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: 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' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appLinks/search: post: tags: - Application Links 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/AppLinkSearchRequest' examples: SearchFilterByStatus: 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: 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: value: filter: and: - or: - property: /name operator: LIKE values: - abc% - property: /project/projectId operator: '=' values: - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AppLinkSearchResponse' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appDomains/{appDomainId}: put: 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 parameters: - name: appLinkId in: path description: App Link UUID required: true schema: 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: description: App Domain UUID type: string format: uuid example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: '202': description: Attach App Domain object content: application/json: schema: $ref: '#/components/schemas/AppLinkAppDomainAttachment' examples: 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' examples: example: 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' examples: example: 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' 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 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error delete: tags: - Application Links 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: 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: 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: 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' 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' examples: example: 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' examples: example: 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' 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 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error get: 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 parameters: - name: appLinkId in: path description: App Link UUID required: true schema: 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: description: App Domain UUID type: string format: uuid example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: '200': description: Attached App Domain object content: application/json: schema: $ref: '#/components/schemas/AppLinkAppDomainAttachment' examples: 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' examples: example: 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' examples: example: 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' 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 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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: - Application Links summary: Search Attached Domains for Link description: The API provides capability to get list of user's attached App Domains using search criteria, including optional filtering, pagination and sorting operationId: searchAttachedAppDomains parameters: - name: appLinkId in: path description: App Link UUID required: true schema: description: App Link UUID type: string format: uuid example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 requestBody: content: application/json: schema: $ref: '#/components/schemas/AppLinkAttachDomainSearchRequest' examples: SearchAttachedDomainFilterByStatus: value: filter: and: - property: /attachmentStatus operator: '=' values: - ATTACHED pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime SearchAttachedDomainFilterOrAnd: value: filter: and: - or: - property: /uuid operator: '=' values: - 20f3ef8e-d670-4236-86fa-bb0038adcfc3 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AppLinkAttachDomainSearchResponse' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Application Links summary: Get Attached Domains for Link description: This API provides capability to retrieve App Domains attached to an App Link operationId: getAttachedAppDomainsByAppLinkId parameters: - name: appLinkId in: path description: App Link UUID required: true schema: description: App Link UUID type: string format: uuid example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 - name: attachmentStatus in: query description: Filter attached App Domains by one or more attachment lifecycle states. required: false style: form explode: false schema: $ref: '#/components/schemas/AttachedAppDomainAttachmentStatus' - name: order in: query description: Sort order for attached App Domains. required: false schema: $ref: '#/components/schemas/AttachedAppDomainOrder' - name: style in: query description: Detail level of the response. required: false schema: $ref: '#/components/schemas/Style' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AppLinkAttachedAppDomains' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' 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 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appServices/{appServiceId}: put: 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 parameters: - name: appLinkId in: path description: App Link UUID required: true schema: 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: 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: '202': description: Attach App Service object content: application/json: schema: $ref: '#/components/schemas/AppLinkAppServiceAttachment' examples: AppLinkResponse: 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' examples: example: 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' examples: example: 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' 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 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error delete: tags: - Application Links 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: 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: description: App Service UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '202': description: Detach App Service object content: application/json: schema: $ref: '#/components/schemas/AppLinkAppServiceAttachment' examples: AppLinkResponse: 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' examples: example: 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' examples: example: 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' 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 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error patch: 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 parameters: - name: appLinkId in: path description: App Link UUID required: true schema: 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: 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: Update App Service attachment object content: application/json: schema: $ref: '#/components/schemas/AppLinkAppServiceAttachment' examples: AppLinkResponse: 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' examples: example: 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' 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-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' 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: 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' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error get: 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 parameters: - name: appLinkId in: path description: App Link UUID required: true schema: 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: description: App Service UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: Attached App Service object content: application/json: schema: $ref: '#/components/schemas/AppLinkAppServiceAttachment' examples: AppLinkResponse: 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' examples: example: 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' examples: example: 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' 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 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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: - Application Links summary: Search Attached Services for Link description: The API provides capability to get list of user's attached App Services using search criteria, including optional filtering, pagination and sorting operationId: searchAttachedAppServices parameters: - name: appLinkId in: path description: App Link UUID required: true schema: description: App Link UUID type: string format: uuid example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 requestBody: content: application/json: schema: $ref: '#/components/schemas/AppLinkAttachServiceSearchRequest' examples: SearchAttachedServiceFilterByStatus: value: filter: and: - property: /attachmentStatus operator: '=' values: - ATTACHED pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime SearchAttachedServiceFilterOrAnd: value: filter: and: - or: - property: /uuid operator: '=' values: - 20f3ef8e-d670-4236-86fa-bb0038adcfc3 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AppLinkAttachServiceSearchResponse' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Application Links summary: Get Attached Services for Link description: This API provides capability to retrieve App Services attached to an App Link operationId: getAttachedAppServicesByAppLinkId parameters: - name: appLinkId in: path description: App Link UUID required: true schema: description: App Link UUID type: string format: uuid example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 - name: attachmentStatus in: query description: Filter attached App Services by one or more attachment lifecycle states. required: false style: form explode: false schema: $ref: '#/components/schemas/AttachedAppServiceAttachmentStatus' - name: order in: query description: Sort order for attached App Services. required: false schema: $ref: '#/components/schemas/AttachedAppServiceOrder' - name: style in: query description: Detail level of the response. required: false schema: $ref: '#/components/schemas/Style' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AppLinkAttachedAppServices' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' 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 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appLinks/{appLinkId}/appProcessors/{appProcessorId}: put: tags: - Application Links 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: 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: 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: '202': description: Attach App Processor object content: application/json: schema: $ref: '#/components/schemas/AppLinkAppProcessorAttachment' examples: 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' examples: example: 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' examples: example: 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' 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: 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' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error delete: 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 parameters: - name: appLinkId in: path description: App Link UUID required: true schema: 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: 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: 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' 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' examples: example: 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' examples: example: 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' 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 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error get: 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 parameters: - name: appLinkId in: path description: App Link UUID required: true schema: 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: description: App Processor UUID type: string format: uuid example: 90ee425c-9988-454c-96d9-1128bc16350f responses: '200': description: App Processor attachment object content: application/json: schema: $ref: '#/components/schemas/AppLinkAppProcessorAttachment' examples: 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' examples: example: 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' examples: example: 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' 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 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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: - Application Links summary: Search attached Processors to Link description: The API provides capability to get list of App Processors attached to an App Link using search criteria, including optional filtering, pagination and sorting operationId: searchAttachedAppProcessors parameters: - name: appLinkId in: path description: App Link UUID required: true schema: description: App Link UUID type: string format: uuid example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 requestBody: content: application/json: schema: $ref: '#/components/schemas/AppLinkAttachProcessorSearchRequest' examples: SearchAttachedProcessorFilterByStatus: value: filter: and: - property: /attachmentStatus operator: '=' values: - ATTACHED 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/AppLinkAttachProcessorSearchResponse' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Application Links summary: Get attached Processors for Link description: This API provides capability to retrieve App Processors attached to an App Link. operationId: getAttachedAppProcessorsByAppLinkId parameters: - name: appLinkId in: path description: App Link UUID required: true schema: description: App Link UUID type: string format: uuid example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 - name: attachmentStatus in: query description: Filter attached App Processors by one or more attachment lifecycle states. required: false style: form explode: false schema: $ref: '#/components/schemas/AttachedAppProcessorAttachmentStatus' - name: order in: query description: Sort order for attached App Processors. required: false schema: $ref: '#/components/schemas/AttachedAppProcessorOrder' - name: style in: query description: Detail level of the response. required: false schema: $ref: '#/components/schemas/Style' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AppLinkAttachedAppProcessors' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' 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 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: value: - errorCode: EQ-3820030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appProcessors/{appProcessorId}: get: tags: - Application Processors summary: Get Processor description: This API provides capability to retrieve user's App Processor operationId: getAppProcessorByUuid parameters: - name: appProcessorId in: path description: App Processor UUID required: true schema: description: App Processor UUID type: string format: uuid example: 90ee425c-9988-454c-96d9-1128bc16350f responses: '200': description: App Processor object content: application/json: schema: $ref: '#/components/schemas/AppProcessor' examples: AppProcessorResponse: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3850030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appProcessors/search: post: tags: - Application Processors 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/AppProcessorSearchRequest' examples: SearchFilterByStatus: 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: 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: value: filter: and: - or: - property: /name operator: LIKE values: - agent% - property: /project/projectId operator: '=' values: - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AppProcessorSearchResponse' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3850030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appServices: post: tags: - Application Services summary: Create Service description: This API provides capability to create user's Service operationId: createAppService requestBody: content: application/json: schema: $ref: '#/components/schemas/AppServicePostRequest' examples: CreateAppService: 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': description: App Service object content: application/json: schema: $ref: '#/components/schemas/AppService' examples: AppServiceResponse: 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' examples: 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 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorList' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3830030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appServices/{appServiceId}: get: tags: - Application Services summary: Get Service description: This API provides capability to retrieve user's Service operationId: getAppServiceByUuid parameters: - name: appServiceId in: path description: App Service UUID required: true schema: description: App Service UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '200': description: App Service object content: application/json: schema: $ref: '#/components/schemas/AppService' examples: AppServiceResponse: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3830030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error delete: tags: - Application Services summary: Delete Service description: This API provides capability to delete user's Service operationId: deleteAppServiceByUuid parameters: - name: appServiceId in: path description: App Service UUID required: true schema: description: App Service UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 responses: '202': description: App Service object content: application/json: schema: $ref: '#/components/schemas/AppService' examples: AppServiceResponse: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3830030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error patch: tags: - Application Services summary: Update Service description: This API provides capability to update user's Service operationId: updateAppServiceByUuid parameters: - name: appServiceId in: path description: App Service UUID required: true schema: 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' examples: UpdateName: value: - op: replace path: /name value: Updated Atlassian App Service required: true responses: '202': description: App Service object content: application/json: schema: $ref: '#/components/schemas/AppService' examples: AppServiceResponse: 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' examples: example: 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' 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-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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3830030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appServices/search: post: tags: - Application Services 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/AppServiceSearchRequest' examples: SearchFilterByStatus: 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: 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: value: filter: and: - or: - property: /name operator: LIKE values: - abc% - property: /project/projectId operator: '=' values: - 71b55fef-fd2e-402f-ae3c-01d5f00bf2d4 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AppServiceSearchResponse' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Application Services summary: Get Attached Links for Service description: This API provides capability to retrieve App Links attached to an App Service operationId: getAttachedAppLinksByAppServiceId parameters: - name: appServiceId in: path description: App Service UUID required: true schema: description: App Service UUID type: string format: uuid 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 - name: state in: query description: Filter attached App Links by one or more lifecycle states. required: false style: form explode: false schema: $ref: '#/components/schemas/AttachedAppLinkState' - name: order in: query description: Sort order for attached App Links. required: false schema: $ref: '#/components/schemas/AttachedAppLinkOrder' - name: style in: query description: Detail level of the response. required: false schema: $ref: '#/components/schemas/Style' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AppServiceAttachedAppLinks' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Application Services summary: Get Attached Subscriptions for Service description: This API provides capability to retrieve App Subscriptions attached to an App Service operationId: getAttachedAppSubscriptionsByAppServiceId parameters: - name: appServiceId in: path description: App Service UUID required: true schema: description: App Service UUID type: string format: uuid 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 - name: state in: query description: Filter attached App Subscriptions by one or more lifecycle states. required: false style: form explode: false schema: $ref: '#/components/schemas/AttachedAppSubscriptionState' - name: order in: query description: Sort order for attached App Subscriptions. required: false schema: $ref: '#/components/schemas/AttachedAppSubscriptionOrder' - name: style in: query description: Detail level of the response. required: false schema: $ref: '#/components/schemas/Style' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AppServiceAttachedAppSubscriptions' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: - Application Services summary: Search Attached Subscriptions description: The API provides capability to get list of App Subscriptions attached to an App Service using search criteria operationId: searchAttachedAppSubscriptionsByAppServiceId parameters: - name: appServiceId in: path description: App Service UUID required: true schema: description: App Service UUID type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 requestBody: content: application/json: schema: $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSearchRequest' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSearchResponse' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3830030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appSubscriptions: post: tags: - Application Subscriptions summary: Create Subscription description: This API provides capability to create user's Subscription operationId: createAppSubscription requestBody: content: application/json: schema: $ref: '#/components/schemas/AppSubscriptionPostRequest' examples: CreateAppSubscription: 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': description: App Subscription object content: application/json: schema: $ref: '#/components/schemas/AppSubscription' examples: AppSubscriptionResponse: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3840030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appSubscriptions/{appSubscriptionId}: get: tags: - Application Subscriptions summary: Get Subscription description: This API provides capability to retrieve user's Subscription operationId: getAppSubscriptionByUuid parameters: - name: appSubscriptionId in: path description: App Subscription UUID required: true schema: description: App Subscription UUID type: string format: uuid example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: '200': description: App Subscription object content: application/json: schema: $ref: '#/components/schemas/AppSubscription' examples: AppSubscriptionResponse: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3840030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error delete: tags: - Application Subscriptions summary: Delete Subscription description: This API provides capability to delete user's Subscription operationId: deleteAppSubscriptionByUuid parameters: - name: appSubscriptionId in: path description: App Subscription UUID required: true schema: description: App Subscription UUID type: string format: uuid example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 responses: '202': description: App Subscription object content: application/json: schema: $ref: '#/components/schemas/AppSubscription' examples: AppSubscriptionResponse: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3840030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error patch: tags: - Application Subscriptions summary: Update Subscription description: This API provides capability to update user's Subscription operationId: updateAppSubscriptionByUuid parameters: - name: appSubscriptionId in: path description: App Subscription UUID required: true schema: 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' examples: UpdateSourceIpSubnets: value: - op: add path: /source/ipSubnets value: - 192.168.200.0/24 required: true responses: '202': description: App Subscription object content: application/json: schema: $ref: '#/components/schemas/AppSubscription' examples: AppSubscriptionResponse: 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' examples: example: 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' 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-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' examples: example: 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' examples: example: 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' examples: example: value: - errorCode: EQ-3840030 errorMessage: Internal Server Error correlationId: f9018571-1001-4422-978b-bfa38ed6b92e details: Internal Server Error /fabric/v4/appSubscriptions/search: post: tags: - Application Subscriptions 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/AppSubscriptionSearchRequest' examples: SearchFilterByStatus: 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: 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': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/AppSubscriptionSearchResponse' examples: Example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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' examples: example: 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: 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/AsnPatchOperation' CloudEventAssetType: enum: - ports - connections - routers - metros - serviceTokens - networks - projects - organizations - timeServices - companyProfiles type: string StartDateTime: description: Start date and time type: string format: date-time example: '2024-07-11T18:06:21.000Z' EndDateTime: description: End date and time type: string format: date-time example: '2024-07-11T18:06:21.000Z' Offset: description: Pagination offset type: integer default: 0 example: 0 Limit: description: Pagination limit type: integer default: 100 example: 20 OperationalStatus: type: object properties: 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: description: Cloud Event Open Telemetry specification type: string readOnly: true source: description: Cloud Event source type: string id: description: Cloud Event identifier type: string format: uuid type: description: Equinix supported event type type: string subject: description: Cloud Event subject type: string time: description: Cloud Event time the event occurred type: string format: date-time dataschema: description: Cloud Event dataschema reference type: string datacontenttype: description: Cloud Event data content type type: string severitynumber: description: Cloud Event severity number type: string severitytext: description: Cloud Event severity text type: string equinixalert: description: Equinix alert type: string equinixorganization: description: Equinix organization identifier type: string equinixproject: description: Equinix project identifier type: string authtype: description: Cloud Event auth type type: string authid: description: Cloud Event user identifier type: string traceparent: description: Cloud Event traceparent type: string tracestate: description: Cloud Event tracestate type: string data: $ref: '#/components/schemas/CloudEventData' GetCloudEventsByAssetResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: Data returned from the API call. type: array items: $ref: '#/components/schemas/CloudEvent' CloudEventSimpleExpression: type: object properties: property: description: | Possible field names to use on filters: * `/id` - Cloud Event identifier * `/subject` - Cloud Event subject description * `/type` - Cloud Event type * `/time` - Time of Cloud Events * `/equinixproject` - Equinix Project of Cloud Events * `/equinixorganization` - Equinix Organization of Cloud Events * `/equinixalert` - Equinix Alert Identifier for raise/clear Cloud Events * `/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: 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 * `IN` - in * `LIKE` - like * `ILIKE` - like case-insensitive * `IS NULL` - is null * `IS NOT NULL` - is not null type: string example: '=' values: type: array items: type: string example: equinix.fabric.port.status.* CloudEventFilter: type: object anyOf: - $ref: '#/components/schemas/CloudEventSimpleExpression' CloudEventFilters: type: object properties: and: type: array items: $ref: '#/components/schemas/CloudEventFilter' CloudEventSearchRequest: type: object description: Search requests containing criteria required: - filter properties: filter: $ref: '#/components/schemas/CloudEventFilters' pagination: $ref: '#/components/schemas/PaginationRequest' LiveEventSimpleExpression: type: object properties: property: description: | Possible field names to use on filters: * `/subject` - Cloud Event subject description type: string example: /subject operator: description: | Possible operators to use on filters: * `=` - equal * `IN` - in 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' data: description: Data returned from the API call. type: array items: $ref: '#/components/schemas/CloudEvent' MetricAssetType: enum: - ports - connections - metros type: string Limit-2: description: Pagination limit 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' data: description: Data returned from the API call. type: array items: $ref: '#/components/schemas/Metric' Value: description: Which value to retrieve type: string example: last GetMetricsByNameResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: Data returned from the API call. type: array items: $ref: '#/components/schemas/Metric' MetricSimpleExpression: type: object properties: property: description: | Possible field names to use on filters: * `/subject` - Metric subject description (required and limited to 1 value) * `/name` - Metric names (required) * `/dataPoints/endDateTime` - Time of Metrics * `/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: description: | Possible operators to use on filters: * `=` - equal * `>` - greater than * `>=` - greater than or equal to * `<` - less than * `<=` - less than or equal to * `BETWEEN` - between * `IN` - in type: string example: '=' values: type: array items: type: string example: equinix.fabric.port.bandwidth_rx.usage MetricFilter: type: object anyOf: - $ref: '#/components/schemas/MetricSimpleExpression' MetricFilters: type: object properties: and: type: array items: $ref: '#/components/schemas/MetricFilter' MetricsSearchRequest: type: object description: Search requests containing criteria required: - 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: purchaseOrderNumber: description: Purchase order number type: string customerReferenceNumber: description: Customer reference number type: string billingTier: description: Billing tier for connection bandwidth type: string orderId: description: Order Identification type: string 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 minimum: 1 maximum: 60 contractedBandwidth: description: Contracted bandwidth type: integer ContactPreference: description: Contact preference for the phone number type: object properties: timezone: description: Timezone of the contact preference type: string availability: description: Availability of the contact preference type: string enum: - WORK_HOURS - ANYTIME Phone: type: object properties: type: description: Notification Type type: string enum: - MOBILE - OFFICE example: MOBILE number: description: Phone number type: string pattern: ^\+[1-9]\d{1,14}$ contactPreference: $ref: '#/components/schemas/ContactPreference' SimplifiedNotification: type: object properties: type: description: Notification Type type: string enum: - NOTIFICATION - BANDWIDTH_ALERT - CONNECTION_APPROVAL - PROFILE_LIFECYCLE - ALL - SALES_REP_NOTIFICATIONS - TECHNICAL - ORDERING - QUOTE_NOTIFICATIONS example: BANDWIDTH_ALERT sendInterval: type: string emails: description: Array of contact emails type: array items: type: string format: email registeredUsers: description: Array of registered users type: array items: type: string phone: description: Array of contact phone numbers type: array items: $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: group: description: Redundancy group identifier (UUID of primary connection) type: string priority: $ref: '#/components/schemas/ConnectionPriority' name: description: Customer-provided name for the redundancy group type: string description: description: Customer-provided description for the redundancy group type: string 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: href: type: string format: uri description: url to entity uuid: description: Equinix assigned Identifier type: string format: uuid type: description: Type of Port type: string 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 enum: - UNTAGGED - DOT1Q - QINQ - EVPN_VXLAN - VXLAN SimplifiedLinkProtocol: description: Connection link protocol Configuration type: object properties: 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: 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 format: uri description: url to entity uuid: description: Network Edge assigned Virtual Device Identifier type: string format: uuid name: description: Customer-assigned Virtual Device name type: string type: description: Type of Virtual Device type: string enum: - EDGE account: $ref: '#/components/schemas/SimplifiedAccount' cluster: description: Virtual Device Cluster Information type: string VirtualDeviceInterface: description: Virtual Device Interface Information type: object properties: type: description: Type of interface type: string enum: - NETWORK id: description: Network Edge assigned identifier type: integer uuid: description: Interface identifier type: string format: uuid SimplifiedTokenNetwork: type: object properties: href: type: string format: uri description: url to entity uuid: description: Network Identifier type: string format: uuid type: description: Type of Network type: string enum: - EVPLAN - EPLAN - IPWAN - EVPTREE - EPTREE name: description: Network Name type: string 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: 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/AccessPointSelector' ServiceTokenConnection: description: Service Token Connection Type Information type: object properties: type: description: Type of Connection type: string enum: - 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 format: uri readOnly: true uuid: description: Equinix-assigned connection identifier type: string 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 items: 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 format: uri readOnly: true expiry: deprecated: true type: integer uuid: description: Equinix-assigned service token identifier type: string format: uuid issuerSide: deprecated: true description: information about token side type: string name: description: Customer-provided service token name type: string description: description: Customer-provided service token description type: string expirationDateTime: description: Expiration date and time of the service token. type: string 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 items: $ref: '#/components/schemas/SimplifiedNotification' account: description: AM-CRH customers can provide Account number example: 272010 $ref: '#/components/schemas/SimplifiedAccount' changelog: $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 enum: - VD - VG - SP - IGW - COLO - SUBNET - CLOUD_ROUTER - NETWORK - METAL_NETWORK - VPIC_INTERFACE - APP_LINK - IC PortType: description: Type of Port type: string enum: - XF_PORT PortState: description: Port lifecycle state type: string 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: 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: group: description: Device redundancy group type: string priority: description: Device redundancy priority type: string enum: - PRIMARY - SECONDARY PortDevice: description: Port device type: object properties: 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: type: description: Port interface type type: string PortTether: description: Port physical connection type: object properties: crossConnectId: description: Port cross connect identifier type: string cabinetNumber: description: Port cabinet number type: string 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: 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: enabled: description: Access point redundancy type: boolean group: deprecated: true description: Port UUID of respective primary port type: string priority: $ref: '#/components/schemas/PortPriority' PortEncapsulation: description: Port encapsulation configuration type: object properties: type: description: Port encapsulation protocol type type: string enum: - DOT1Q - QINQ - UNTAGGED tagProtocolId: description: Port encapsulation tag protocol identifier type: string Package: description: Package settings for port type: object properties: code: type: string description: Type of Port Package enum: - STANDARD - UNLIMITED - UNLIMITED_PLUS PortSettings: description: Port configuration settings type: object properties: 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: key: description: Key type: string value: description: Value type: string PhysicalPortType: description: Type of Port type: string enum: - XF_PHYSICAL_PORT PortNotification: type: object properties: type: description: Notification Type type: string enum: - NOTIFICATION - TECHNICAL - PEERING - ESCALATION registeredUsers: description: Array of registered users type: array items: type: string required: - type - registeredUsers PortOrderPurchaseOrder: description: Purchase Order information associate to the account type: object properties: number: type: string description: purchase order number amount: type: string description: purchase order amount startDate: type: string endDate: type: string attachmentId: type: string format: uuid 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: firstName: description: first name of delegate type: string lastName: description: last Name of delegate type: string email: description: email of delegate type: string PortOrderSignature: description: Port signature details type: object properties: signatory: description: Port signature Type type: string 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 type: description: Loa type type: string example: DIGITAL_LOA PhysicalPort: description: Physical 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/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 uuid: description: Equinix assigned response attribute for physical port identifier type: string 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 format: uri readOnly: true type: $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 format: uuid name: description: Equinix assigned response attribute for Port name type: string description: description: Equinix assigned response attribute for Port description type: string physicalPortsSpeed: description: Physical Ports Speed in Mbps type: integer minimum: 0 connectionsCount: description: Equinix assigned response attribute for Connection count type: integer minimum: 0 project: $ref: '#/components/schemas/Project' state: $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 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 x-eqx-api-linter-skip-rules: - 40 enum: - L2_PROFILE - L3_PROFILE - IA_PROFILE - IX_PROFILE - IC_PROFILE - LMAAS_PROFILE example: L2_PROFILE Tags: type: array items: type: string ServiceProfileVisibilityEnum: type: string enum: - 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: encapsulationStrategy: description: was tagType - missing on wiki type: string enum: - CTAGED - BOTH - NAMED namedTags: type: array maxItems: 64 items: 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: 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: - type type: object properties: uuid: type: string type: $ref: '#/components/schemas/ServiceProfileAccessPointTypeEnum' supportedBandwidths: $ref: '#/components/schemas/Bandwidths' allowRemoteConnections: type: boolean description: Setting to allow or prohibit remote connections to the service profile. example: true default: false allowCustomBandwidth: type: boolean description: Setting to enable or disable the ability of the buyer to customize the bandwidth. example: true default: false bandwidthAlertThreshold: type: number description: percentage of port bandwidth at which an allocation alert is generated - missing on wiki. allowBandwidthAutoApproval: type: boolean description: Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller. default: false allowBandwidthUpgrade: type: boolean description: Availability of a bandwidth upgrade. The default is false. linkProtocolConfig: $ref: '#/components/schemas/ServiceProfileLinkProtocolConfig' enableAutoGenerateServiceKey: 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: - type type: object additionalProperties: false properties: uuid: type: string type: $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 oneOf: - $ref: '#/components/schemas/ServiceProfileAccessPointTypeCOLO' - $ref: '#/components/schemas/ServiceProfileAccessPointTypeVD' CustomField: description: Define Custom Attributes required: - label - required - dataType 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 ProcessStep: type: object description: Definition of customized step while making connection properties: title: type: string description: Service profile custom step title subTitle: type: string description: Service profile custom step sub title description: type: string description: Service profile custom step description MarketingInfo: type: object properties: logo: type: string description: Logo file name promotion: type: boolean description: Profile promotion on marketplace processSteps: type: array maxItems: 3 items: $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: type: type: string enum: - VD uuid: type: string format: uuid example: 94662143-e21b-4098-bfcf-e9416f47eae1 location: $ref: '#/components/schemas/SimplifiedLocation' interfaceUuid: type: string format: uuid example: 94662143-e21b-4098-bfcf-e9416f47eae1 ServiceMetro: type: object properties: code: type: string description: metro code name: type: string description: metro name vcBandwidthMax: type: integer description: max VC speed supported in Mbps ibxs: type: array items: type: string description: ibx codes inTrail: type: boolean displayName: type: string description: service metro display name sellerRegions: type: object additionalProperties: type: string ProviderEnvironmentTypeEnum: description: Provider environment type type: string enum: - IC_ENV ProviderEnvironment: description: Provider Environment associated with an IC_PROFILE service profile Beta type: object properties: href: description: Provider Environment URI type: string format: uri readOnly: true uuid: description: Equinix-assigned provider environment identifier type: string 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: integer example: - 1000 - 10000 - 100000 metros: type: array description: Derived response attribute. items: $ref: '#/components/schemas/ServiceMetro' supportedFeatures: type: array description: Supported Feature Types items: type: string example: - FEATURE_TYPE_L3_BASE changeLog: $ref: '#/components/schemas/Changelog' ServiceProfileLastMileApiIntegration: type: object description: Last-mile API integration details. 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. ServiceProfileLastMileDeliveryDateRange: type: object description: Range details for delivery window. properties: unit: 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 ServiceProfileLastMilePriceRange: type: object description: Range details for price or delivery window. properties: unit: type: string description: Unit for this range, such as USD or DAYS. example: USD min: type: number format: double description: Minimum value for the range. example: 10 max: type: number format: double description: Maximum value for the range. example: 100 ServiceProfileLastMileOffering: type: object description: Last-mile offering details. properties: 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: 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: 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. type: object properties: href: description: Service Profile URI response attribute type: string format: uri readOnly: true type: $ref: '#/components/schemas/ServiceProfileTypeEnum' name: description: Customer-assigned service profile name type: string maxLength: 50 example: Sample Service Profile uuid: description: Equinix-assigned service profile identifier type: string format: uuid description: 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' tags: $ref: '#/components/schemas/Tags' visibility: $ref: '#/components/schemas/ServiceProfileVisibilityEnum' allowedEmails: type: array items: type: string format: email accessPointTypeConfigs: type: array minItems: 1 items: $ref: '#/components/schemas/ServiceProfileAccessPointType' customFields: type: array items: $ref: '#/components/schemas/CustomField' marketingInfo: $ref: '#/components/schemas/MarketingInfo' ports: type: array items: $ref: '#/components/schemas/ServiceProfileAccessPointCOLO' virtualDevices: type: array items: $ref: '#/components/schemas/ServiceProfileAccessPointVD' metros: type: array description: Derived response attribute. items: $ref: '#/components/schemas/ServiceMetro' environments: type: array description: Provider environments associated with this IC_PROFILE service profile. Beta items: $ref: '#/components/schemas/ProviderEnvironment' selfProfile: type: boolean readOnly: true description: response attribute indicates whether the profile belongs to the same organization as the api-invoker. projectId: type: string lastMileConfig: 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: metroHref: description: The Canonical URL at which the resource resides. 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 required: - metroCode CloudRouterPostRequestPackage: description: Fabric Cloud Router Package Type type: object properties: href: description: Fabric Cloud Router URI type: string format: uri example: https://api.equinix.com/fabric/v4/routerPackages/LAB type: description: Cloud Router package type type: string enum: - ROUTER_PACKAGE example: ROUTER_PACKAGE code: description: Cloud Router package code type: string enum: - LAB - BASIC - STANDARD - ADVANCED - PREMIUM example: LAB required: - code marketplaceSubscription: description: Equinix Fabric Entity for Marketplace Subscription type: object properties: href: description: Marketplace Subscription URI type: string format: uri readOnly: true example: https://api.equinix.com/fabric/v4/marketplaceSubscriptions/20d32a80-0d61-4333-bc03-707b591ae2f5 type: description: Marketplace Subscription type type: string enum: - AWS_MARKETPLACE_SUBSCRIPTION - GCP_MARKETPLACE_SUBSCRIPTION - AZURE_MARKETPLACE_SUBSCRIPTION example: AWS_MARKETPLACE_SUBSCRIPTION uuid: description: Equinix-assigned Marketplace Subscription identifier type: string example: 20d32a80-0d61-4333-bc03-707b591ae2f5 CloudRouterPostRequestBase: type: object description: Create Cloud Router properties: type: type: string enum: - 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' 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: op: description: Handy shortcut for operation name type: string enum: - replace - add - remove path: description: path inside document leading to updated parameter type: string value: description: new value for updated parameter required: - 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: - ROUTER_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: '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: type: array items: $ref: '#/components/schemas/CloudRouterChangeOperation' required: - type - updatedDateTime CloudRouter: description: Fabric Cloud Router object type: object allOf: - $ref: '#/components/schemas/CloudRouterPostRequestBase' properties: href: description: Cloud Routers URI type: string 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: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 name: description: Customer-provided Cloud Router name type: string 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: href: description: Virtual Device URI type: string format: uri readOnly: true uuid: description: Equinix-assigned Virtual Device identifier type: string format: uuid name: description: Customer-assigned Virtual Device name type: string type: description: Virtual Device type type: string 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 format: uri readOnly: true uuid: description: Equinix-assigned Interface identifier type: string format: uuid id: description: Interface id type: integer type: description: Interface type type: string enum: - CLOUD - NETWORK projectId: description: Interface Project ID type: string NetworkState: description: Network status type: string example: ACTIVE enum: - 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: 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: equinixStatus: $ref: '#/components/schemas/NetworkEquinixStatus' Link: type: object properties: href: description: Resource URI type: string format: uri readOnly: true rel: description: OperationId from Swagger hub spec type: string 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: 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 name: description: Customer-assigned network name type: string 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 readOnly: true items: $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: href: description: The Canonical URL at which the resource resides. type: string format: uri readOnly: true uuid: description: Equinix-assigned Virtual Network identifier type: string format: uuid MetalInterconnection: description: Metal Interconnection type: object properties: uuid: description: Equinix Metal Interconnection type: string format: uuid ProductOffering: description: Product offering for connection. Applicable to zSide only. type: object properties: id: description: Product offering identifier type: string 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: 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: 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 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 enum: - 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 address: $ref: '#/components/schemas/Address' ConnectionSideAdditionalInfo: description: Additional information properties: key: description: Key type: string value: description: Value type: string ConnectionSide: description: Connection configuration object for each side of multi-segment connection type: object properties: 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/ConnectionSideAdditionalInfo' ConnectionPostRequest: required: - type - name - notifications - bandwidth - aSide - zSide type: object description: Create connection post request properties: type: $ref: '#/components/schemas/ConnectionType' name: description: Customer-provided connection name type: string order: $ref: '#/components/schemas/Order' notifications: description: Preferences for notifications on connection configuration or status changes type: array items: $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/ConnectionSideAdditionalInfo' marketplaceSubscription: $ref: '#/components/schemas/marketplaceSubscription' ConnectionChangeOperation: description: Connection change operation data type: object properties: op: description: Handy shortcut for operation name type: string example: add path: description: path inside document leading to updated parameter type: string example: /ipv6 value: description: new value for updated parameter required: - op - path - value Change: description: Current state of latest connection change type: object properties: uuid: description: Uniquely identifies a change type: string type: description: Type of change type: string enum: - CONNECTION_CREATION - CONNECTION_UPDATE - CONNECTION_DELETION - CONNECTION_PROVIDER_STATUS_REQUEST status: description: Current outcome of the change flow type: string enum: - 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: providerStatus: $ref: '#/components/schemas/ProviderStatus' equinixStatus: $ref: '#/components/schemas/EquinixStatus' operationalStatus: description: Connection operational status type: string enum: - UP - DOWN errors: type: array items: $ref: '#/components/schemas/Error' opStatusChangedAt: description: When connection transitioned into current operational status type: string 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 format: uri readOnly: true type: $ref: '#/components/schemas/ConnectionType' uuid: description: Equinix-assigned connection identifier type: string name: description: Customer-provided connection name type: string 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' 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/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: - type - 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 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: description: Connection acceptance data type: object properties: zSide: $ref: '#/components/schemas/ConnectionSide' providerBandwidth: description: Authorization key bandwidth in Mbps type: integer readOnly: true operation: $ref: '#/components/schemas/ConnectionOperation' ConnectionActionRequest: description: Connection action request type: object properties: type: $ref: '#/components/schemas/Actions' description: description: Connection rejection reason detail type: string data: $ref: '#/components/schemas/ConnectionAcceptanceData' required: - type ConnectionAction: description: Connection action type: object properties: type: $ref: '#/components/schemas/Actions' href: description: Connection action URI type: string format: uri readOnly: true uuid: description: Equinix-assigned connection identifier type: string state: description: Connection action response state type: string enum: - SUCCEEDED description: description: Connection rejection reason detail type: string data: $ref: '#/components/schemas/ConnectionAcceptanceData' changeLog: $ref: '#/components/schemas/Changelog' required: - type - href - uuid - data ConnectionRouteEntrySimpleExpression: type: object properties: property: 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 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 * `~*` - case-insensitive like type: string example: '=' values: type: array items: type: string example: IPv4_BGP_ROUTE ConnectionRouteEntryOrFilter: type: object properties: or: type: array maxItems: 3 items: $ref: '#/components/schemas/ConnectionRouteEntrySimpleExpression' ConnectionRouteEntryFilter: type: object anyOf: - $ref: '#/components/schemas/ConnectionRouteEntrySimpleExpression' - $ref: '#/components/schemas/ConnectionRouteEntryOrFilter' ConnectionRouteEntryFilters: type: object properties: and: type: array maxItems: 8 items: $ref: '#/components/schemas/ConnectionRouteEntryFilter' ConnectionRouteEntrySortDirection: description: Sorting direction default: DESC type: string enum: - DESC - ASC ConnectionRouteEntrySortBy: description: Possible field names to use on sorting default: /changeLog/updatedDateTime type: string enum: - /changeLog/createdDateTime - /changeLog/updatedDateTime - /med - /connection/name - /type - /prefix - /nextHop ConnectionRouteSortCriteria: type: object properties: 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/PaginationRequest' sort: type: array items: $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: type: $ref: '#/components/schemas/RouteTableEntryType' example: IPv4_BGP_SESSION protocolType: $ref: '#/components/schemas/RouteTableEntryProtocolType' example: BGP state: type: string enum: - ACTIVE - INACTIVE 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 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 items: $ref: '#/components/schemas/ConnectionRouteTableEntry' BGPConnectionOperation: description: BGP IPv4 or IPv6 Connection State operational data type: object properties: 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: customerPeerIp: description: Customer side peering ip type: string example: 10.1.1.2 equinixPeerIp: description: Equinix side peering ip type: string example: 10.1.1.3 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 BGPConnectionIpv6: type: object properties: customerPeerIp: description: Customer side peering ip type: string 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: enabled: type: boolean interval: type: string example: '100' required: - enabled RoutingProtocolOperation: type: object properties: 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 type: description: Type of change type: string enum: - ROUTING_PROTOCOL_UPDATE - ROUTING_PROTOCOL_CREATION - ROUTING_PROTOCOL_DELETION href: description: Routing Protocol Change URI type: string format: uri required: - uuid - type RoutingProtocolProject: description: The Routing Protocol's project type: object properties: projectId: description: Uniquely identifies a project type: string required: - projectId RoutingProtocolConnection: description: Connection specification type: object properties: uuid: description: Equinix-assigned connection identifier type: string platformUuid: description: Equinix-assigned platform connection identifier type: string RoutingProtocolBGPData: type: object properties: type: description: Routing protocol type type: string enum: - 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 format: int64 example: 65002 equinixAsn: description: Equinix asn type: integer format: int64 example: 65002 bgpAuthKey: description: BGP authorization key type: string example: testAuthKey asOverrideEnabled: description: Enable AS number override type: boolean bfd: $ref: '#/components/schemas/RoutingProtocolBFD' href: type: string 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 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' DirectConnectionIpv4: type: object properties: equinixIfaceIp: description: Equinix side Interface IP address type: string example: 192.168.100.0/30 DirectConnectionIpv6: type: object properties: equinixIfaceIp: description: Equinix side Interface IP address type: string 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 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 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' 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 items: $ref: '#/components/schemas/RoutingProtocolData' RoutingProtocolBGPType: type: object properties: type: description: Routing protocol type type: string enum: - 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 format: int64 bgpAuthKey: description: BGP authorization key type: string asOverrideEnabled: description: Enable AS number override type: boolean bfd: $ref: '#/components/schemas/RoutingProtocolBFD' required: - type RoutingProtocolDirectType: 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' required: - type RoutingProtocolBase: type: object properties: type: description: Routing protocol type type: string enum: - BGP - DIRECT required: - type oneOf: - $ref: '#/components/schemas/RoutingProtocolBGPType' - $ref: '#/components/schemas/RoutingProtocolDirectType' ConnectionRoutingProtocolPostRequest: type: object description: Create connection routing protocolpost request properties: data: description: Connection routing protocol configuration type: array items: $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 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 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/actions uuid: description: Routing protocol identifier type: string format: uuid example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: $ref: '#/components/schemas/BGPActions' description: type: string description: BGP action description state: $ref: '#/components/schemas/BGPActionStates' changelog: $ref: '#/components/schemas/Changelog' BGPActionsBulkData: description: List of BGP Actions type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: type: array items: $ref: '#/components/schemas/BGPActionData' BGPActionRequest: description: BGP action request type: object properties: type: $ref: '#/components/schemas/BGPActions' required: - type RoutingProtocolChangeOperation: description: Routing Protocol 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/RoutingProtocolBase' required: - op - path - value RoutingProtocolChangeData: description: Current state of latest Routing Protocol 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: $ref: '#/components/schemas/RoutingProtocolChangeOperation' allOf: - $ref: '#/components/schemas/RoutingProtocolChange' RoutingProtocolChangeDataResponse: description: List of network changes type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: type: array items: $ref: '#/components/schemas/RoutingProtocolChangeData' PublicPeeringConnectionRequest: type: object description: Public Peering Connection properties: uuid: type: string format: uuid description: connection id example: b44c6e6c-2c36-4488-b3f1-47064357b5b4 ExchangeServiceRequestBgp: type: object properties: 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 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 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 description: Ordering and billing reference details for this Exchange Service. properties: purchaseOrderNumber: type: string description: Purchase order number reference. example: '156576' orderId: description: Equinix-assigned order identifier. type: string readOnly: true customerReferenceId: description: Your own reference for this Exchange Service. type: string orderNumber: description: Equinix order reference number. type: string example: 1-129105284100 orderLineItemNumber: description: Order Reference Number for Sales Assisted Order type: string readOnly: true domainOrderNumber: description: product domain Order Number for Sales Assisted Order type: string readOnly: true uuid: description: Equinix-assigned order identifier, this is a derived response attribute type: string format: uuid 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: ix_exchange_service description: Customer-provided internet exchange service name minLength: 1 maxLength: 50 description: type: string 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 format: enum description: Connection type IX_VC example: IX_VC href: type: string format: string description: URI example: https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4 uuid: type: string format: uuid description: uuid example: b44c6e6c-2c36-4488-b3f1-47064357b5b4 ExchangeServiceResponseBgp: 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: 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: 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: asn: type: integer format: int64 description: Route Collector ASN example: 1238 ipV4: type: string 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 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 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 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: 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: 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/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: type: array items: $ref: '#/components/schemas/ExchangeServiceSearchExpression' ExchangeServiceOrExpression: type: object required: - or properties: or: type: array items: $ref: '#/components/schemas/ExchangeServiceSearchExpression' ExchangeServicePropertyExpression: type: object required: - property - operator - values properties: property: description: Possible field names to use on filters type: string enum: - /project/projectId - /uuid - /state - /name - /bandwidth - /changelog/createdDateTime - /changelog/updatedDateTime - /changelog/deletedDateTime - /location/metroCode operator: type: string enum: - '=' - '!=' - BETWEEN - < - <= - '>' - '>=' - LIKE - ILIKE - IN values: type: array minItems: 1 items: type: string ExchangeServiceSearchSortCriteria: 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 - /changeLog/createdDateTime - /changeLog/updatedDateTime ExchangeServiceSearchRequest: type: object description: Search requests containing criteria properties: filter: $ref: '#/components/schemas/ExchangeServiceSearchExpression' pagination: $ref: '#/components/schemas/PaginationRequest' sort: type: array items: $ref: '#/components/schemas/ExchangeServiceSearchSortCriteria' ExchangeServiceSearchResponse: description: List of Internet Exchange Service type: object properties: pagination: $ref: '#/components/schemas/Pagination' sort: type: array items: $ref: '#/components/schemas/ExchangeServiceSearchSortCriteria' data: type: array items: $ref: '#/components/schemas/ExchangeServiceResponse' ExchangeServiceActionRequest: type: object required: - type description: Internet Exchange Service Action Request properties: type: type: string enum: - EXCHANGE_SERVICE_ACTIVATE - EXCHANGE_SERVICE_VALIDATE - EXCHANGE_SERVICE_RETRY_PROVISION 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 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: type: $ref: '#/components/schemas/InternetAccessRoutingProtocolType' customerRoutes: type: array minItems: 1 maxItems: 100 items: $ref: '#/components/schemas/InternetAccessCustomerRouteRequest' discriminator: propertyName: type mapping: BGP: '#/components/schemas/InternetAccessRoutingProtocolBgpRequest' DIRECT: '#/components/schemas/InternetAccessRoutingProtocolDirectRequest' STATIC: '#/components/schemas/InternetAccessRoutingProtocolStaticRequest' InternetAccessConnectionBgpRequest: type: object required: - uuid properties: uuid: type: string format: uuid description: Unique identifier for the connection 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 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: 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 address of the Equinix peering IP 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 InternetAccessPeeringIpv6Request: type: object properties: equinixPeerIp: type: string 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 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: 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: 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: uuid: type: string format: uuid description: Unique identifier for the IP Block InternetAccessCustomerRouteRequest: type: object required: - ipBlock properties: ipBlock: $ref: '#/components/schemas/InternetAccessIpBlockRequest' InternetAccessOrderRequest: type: object properties: purchaseOrderNumber: type: string nullable: true description: Purchase order number orderNumber: type: string nullable: true description: Order Number orderLine: type: string nullable: true description: Order Line Number InternetAccessBillingType: type: string enum: - FIXED - USAGE_BASED - BURST_BASED x-enum-varnames: - FIXED - USAGE_BASED - BURST_BASED InternetAccessAccount: type: object required: - accountNumber properties: 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: - type - name - routingProtocol - billing - project - account properties: type: $ref: '#/components/schemas/InternetAccessServiceType' name: 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: type: object required: - type properties: type: $ref: '#/components/schemas/InternetAccessBillingType' project: $ref: '#/components/schemas/Project' account: $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 format: uri description: URI of the change object InternetAccessLocation: type: object required: - metroHref - metroCode - ibx - region properties: metroHref: type: string format: uri description: Metro URL path for the linked resource example: https://api.equinix.com/fabric/v4/metros/WA metroCode: type: string 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 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 format: uri description: URI of the IP block uuid: type: string format: uuid 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 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 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: 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 properties: type: $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: - href - type - uuid - 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/InternetAccessServiceType' uuid: type: string format: uuid description: Unique identifier for the EIA Service name: 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 state: $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' useCase: $ref: '#/components/schemas/InternetAccessUseCase' SearchSortItem: type: object required: - direction - property properties: direction: type: string enum: - ASC - DESC example: ASC property: type: string SearchSort: type: array items: $ref: '#/components/schemas/SearchSortItem' InternetAccessSearchRequest: type: object properties: pagination: $ref: '#/components/schemas/PaginationRequest' filter: $ref: '#/components/schemas/SearchExpression' sort: $ref: '#/components/schemas/SearchSort' InternetAccessServices: type: object required: - pagination - sort - data properties: pagination: $ref: '#/components/schemas/Pagination' sort: $ref: '#/components/schemas/SearchSort' data: type: array items: $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 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: 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: string example: WA TypeOfIpBlockProduct: type: string enum: - IPV4_IP_BLOCK - IPV6_IP_BLOCK x-enum-varnames: - IPV4_IP_BLOCK - IPV6_IP_BLOCK IpBlockProjectRequest: type: object required: - projectId properties: projectId: type: string description: project id IpBlockAccount: type: object required: - accountNumber properties: accountNumber: type: string description: account number IpBlockOrderRequest: type: object properties: purchaseOrderNumber: type: string nullable: true description: Purchase order number orderNumber: type: string nullable: true description: Order Number orderLine: type: string nullable: true description: Order Line Number IpBlockAddressingPlan: type: object required: - purpose - size properties: purpose: type: string description: purpose size: type: integer format: int32 description: size IpBlockRegulations: type: object required: - addressingPlans - questions properties: addressingPlans: type: array description: List of addressing plans items: $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: 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 enum: - PENDING - ACTIVE - DELETING - DELETED - FAILED description: Current state of the IP Block IpBlockOwnership: type: string enum: - EQUINIX - CUSTOMER description: IpBlockOwnership of the IP Block IpBlockOrderResponse: type: object required: - href - orderNumber properties: href: type: string format: uri description: Order URI example: https://api.equinix.com/colocations/v2/orders/1-34834234 orderNumber: type: string description: Order number IpBlockProject: type: object required: - projectId properties: href: type: string format: uri description: URI of the project projectId: type: string description: project id IpBlockProductType: type: string enum: - EIA - FABRIC - NE IpBlockAsset: type: object required: - type - uuid - href properties: 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: href: type: string format: uri description: URI of the IpBlockChange object IpBlockChangeLog: type: object required: - createdDateTime properties: 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: uuid: type: string format: uuid description: Unique identifier for the IP Block 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 items: $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: op: type: string description: operation enum: - add - remove path: type: string 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 operator: type: string enum: - '=' values: type: array items: type: string IpBlockFilter: type: object properties: and: type: array items: $ref: '#/components/schemas/IpBlockAndQuery' IpBlocksSearchRequestBody: properties: pagination: $ref: '#/components/schemas/PaginationRequest' filter: $ref: '#/components/schemas/IpBlockFilter' sort: $ref: '#/components/schemas/SearchSort' IpBlockSearchResponseBody: required: - pagination - data properties: pagination: $ref: '#/components/schemas/Pagination' sort: $ref: '#/components/schemas/SearchSort' data: type: array items: $ref: '#/components/schemas/IpBlock' Expression: type: object properties: and: $ref: '#/components/schemas/Expressions' or: $ref: '#/components/schemas/Expressions' property: $ref: '#/components/schemas/SearchFieldName' operator: type: string enum: - '=' - '!=' - '>' - '>=' - < - <= - LIKE - ILKE - IS NOT NULL - IS NULL - IN - BETWEEN values: type: array items: type: string Expressions: type: array items: $ref: '#/components/schemas/Expression' SearchFieldName: description: Possible field names to use on filters type: string 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 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' sort: type: array items: $ref: '#/components/schemas/SortCriteriaResponse' data: type: array items: $ref: '#/components/schemas/Connection' FilterBody: type: object description: Search requests containing criteria properties: filter: $ref: '#/components/schemas/SearchExpression' ProductType: description: Product type type: string enum: - 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: type: description: Price charge type type: string enum: - MONTHLY_RECURRING - NON_RECURRING price: description: Offering price type: number format: double minimum: 0 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: metroCode: type: string ibx: type: string VirtualConnectionPriceASide: type: object properties: 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 VirtualConnectionBridgePackageCode: description: Virtual Connection bridge package code type: string enum: - REGIONAL - GLOBAL VirtualConnectionPriceZSide: type: object properties: 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: uuid: description: Either uuid or rest of attributes are required type: string 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 enum: - IPv4 - IPv6 IpBlockPrice: description: IP Block Product configuration type: object properties: 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 enum: - 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 enum: - XF_PORT VirtualPortLocation: description: Geographic data for the port. type: object properties: 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: 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: 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 enum: - COLO - BMMR - REMOTE default: COLO ConnectivitySource: description: Physical or virtual port that houses the connection. type: object properties: type: $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 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 enum: - NTP_STANDARD - NTP_ENTERPRISE - PTP_STANDARD - PTP_ENTERPRISE description: Precision Time Service Level required: - 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 enum: - NTP - PTP description: Precision Time Service Type refers to the corresponding Protocol. package: $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 format: url type: $ref: '#/components/schemas/ProductType' code: description: Equinix-assigned product code type: string name: description: Full product name type: string description: description: Product description type: string account: $ref: '#/components/schemas/SimplifiedAccount' charges: type: array items: $ref: '#/components/schemas/PriceCharge' currency: description: Product offering price currency type: string termLength: description: In months. No value or value of 1 means on-demand type: integer 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' PriceSearchResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Price' pagination: $ref: '#/components/schemas/Pagination' PriceError: description: Error with details required: - errorCode - errorMessage type: object discriminator: propertyName: errorCode properties: errorCode: type: string enum: - EQ-3038010 - EQ-3038022 - EQ-3038030 errorMessage: type: string enum: - Validation failure - Invalid value - Internal Server Error correlationId: type: string details: type: string help: type: string additionalInfo: type: array items: 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: 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: 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: $ref: '#/components/schemas/Metrics' BandwidthUtilization: description: Bandwidth utilization statistics (octet counters-based) type: object properties: 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: 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 enum: - aSide - zSide ServiceProfileStateEnum: description: Equinix assigned state. type: string enum: - 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: 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: op: type: string enum: - remove path: $ref: '#/components/schemas/Path' ReplaceOperation: description: Replace attribute value or sub-resource in the existing model type: object required: - 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: uuid: description: Uniquely identifies a change type: string type: description: Type of change type: string example: SERVICE_PROFILE_VISIBILITY_UPDATE status: description: Current outcome of the change flow type: string enum: - 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/ServiceProfileUpdateRequest' required: - 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: state: $ref: '#/components/schemas/ServiceProfileStateEnum' account: description: Seller Account for Service Profile. $ref: '#/components/schemas/SimplifiedAccount' project: $ref: '#/components/schemas/Project' change: $ref: '#/components/schemas/ServiceProfileChange' changeLog: description: Seller Account for Service Profile. $ref: '#/components/schemas/Changelog' allOf: - $ref: '#/components/schemas/SimplifiedServiceProfile' ServiceProfiles: type: object description: Service Profiles properties: data: type: array items: $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: project: $ref: '#/components/schemas/Project' required: - name - description - type ServiceProfileSimpleExpression: type: object properties: property: 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 type: string example: /name operator: description: | Possible operators to use on filters: * `=` - equal type: string example: '=' values: type: array items: type: string example: ServiceProfile-1 ServiceProfileAndFilter: type: object properties: and: type: array items: $ref: '#/components/schemas/ServiceProfileSimpleExpression' ServiceProfileFilter: type: object anyOf: - $ref: '#/components/schemas/ServiceProfileSimpleExpression' - $ref: '#/components/schemas/ServiceProfileAndFilter' ServiceProfileSortDirection: description: Sorting direction default: DESC type: string enum: - DESC - ASC ServiceProfileSortBy: description: Possible field names to use on sorting default: /changeLog/updatedDateTime type: string enum: - /name - /state - /changeLog/createdDateTime - /changeLog/updatedDateTime ServiceProfileSortCriteria: type: object properties: direction: $ref: '#/components/schemas/ServiceProfileSortDirection' property: $ref: '#/components/schemas/ServiceProfileSortBy' ServiceProfileSearchRequest: type: object description: Search requests containing criteria properties: filter: $ref: '#/components/schemas/ServiceProfileFilter' pagination: $ref: '#/components/schemas/PaginationRequest' sort: type: array items: $ref: '#/components/schemas/ServiceProfileSortCriteria' ServiceProfileActionRequest: description: Service Profile Action Request type: object properties: type: description: 'Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION' type: string example: PROFILE_UPDATE_ACCEPTANCE description: description: Action description type: string example: Approved to migrate to public required: - type ServiceProfileActionResponse: description: Service Profile Action Response type: object properties: 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: data: type: array items: $ref: '#/components/schemas/ProviderEnvironment' pagination: $ref: '#/components/schemas/Pagination' EnvironmentActionTypeEnum: description: Environment action type type: string enum: - VALIDATE_ACTIVATION_KEY example: VALIDATE_ACTIVATION_KEY ActivationKeyDetails: description: Activation Key Details Beta type: object properties: value: description: Provider Encoded activation key type: string example: key_here providerId: description: AWS Connection identifier type: string accountId: description: Account identifier type: string bandwidth: description: Bandwidth in Mbps type: integer region: description: Cloud provider region identifier type: string EnvironmentActionRequest: description: Request payload for environment action type: object required: - type - keyDetails properties: type: $ref: '#/components/schemas/EnvironmentActionTypeEnum' keyDetails: $ref: '#/components/schemas/ActivationKeyDetails' EnvironmentActionStateEnum: description: Environment action state. ACTIVE - already used , INACTIVE - not used type: string enum: - ACTIVE - INACTIVE example: ACTIVE EnvironmentActionResponse: description: Response from environment action Beta type: object properties: 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: data: type: array items: $ref: '#/components/schemas/ServiceMetro' pagination: $ref: '#/components/schemas/Pagination' ServiceTokenChangeOperation: description: Service Token change operation data type: object properties: op: description: Handy shortcut for operation name type: string enum: - replace - add - remove path: description: path inside document leading to updated parameter type: string 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: data: description: List of Service Tokens type: array items: $ref: '#/components/schemas/ServiceToken' pagination: $ref: '#/components/schemas/Pagination' ServiceTokenActions: description: Service Token action type type: string enum: - RESEND_EMAIL_NOTIFICATION ServiceTokenActionRequest: description: Service Token action request type: object properties: type: $ref: '#/components/schemas/ServiceTokenActions' required: - type 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: 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: 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 example: PRIMARY enum: - PRIMARY - SECONDARY group: description: Redundancy group identifier type: string format: uuid OpticalConnectDemarcationPoint: description: | Specifies the demarcation point: the patch panel and ports at this side. type: object properties: patchPanelId: description: Unique identifier of the patch panel. type: string 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 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 example: '11' connectorType: description: Type of Connector type: string enum: - FC - SC - LC - ST example: SC OpticalConnectASideRequest: description: | A-Side configuration. Always a patch panel port from your cage. type: object properties: 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 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 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: Purchase order number reference. example: PO-156576 customerReferenceId: description: Your own reference for this connection. type: string orderNumber: description: Equinix order reference number. type: string 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: - NOTIFICATION - ORDERING - TECHNICAL example: NOTIFICATION emails: description: Email addresses to notify. type: array items: type: string format: email registeredUsers: description: Usernames of registered Equinix Portal users to notify. type: array items: 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: type: type: string description: OC - Optical Connect Type enum: - OC example: OC bandwidth: description: | 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 * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `ILIKE` - case-insensitive like type: string example: '=' values: type: array items: type: string example: 123456-SV1-SV2-01 OpticalConnectOrFilter: type: object properties: or: type: array maxItems: 3 items: $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: 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 OpticalConnectSortBy: 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 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/PaginationRequest' sort: type: array items: $ref: '#/components/schemas/OpticalConnectSortCriteria' OpticalConnectServiceSearchResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: Data returned from the API call. type: array items: $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 name: description: Name of a geographic zone. type: string description: description: Description of a geographic zone. type: string 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: 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 items: $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: pagination: $ref: '#/components/schemas/Pagination' data: description: List of Fabric Metros. type: array items: $ref: '#/components/schemas/Metro' MetroError: description: Error with details required: - errorCode - errorMessage type: object discriminator: propertyName: errorCode properties: errorCode: type: string enum: - EQ-3036001 - EQ-3036013 - EQ-3036030 - EQ-3036100 errorMessage: type: string enum: - Unauthorized - Invalid Query Parameter - Invalid Path Parameter - Invalid Query or Path Parameter - Internal Server Error - Metro Not Found correlationId: type: string details: type: string help: type: string additionalInfo: type: array items: 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: op: description: Handy shortcut for operation name type: string 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 type: description: Type of change type: string enum: - PORT_CREATION - PORT_UPDATE - PORT_DELETION status: description: Current outcome of the change flow type: string enum: - COMPLETED - FAILED - REQUESTED information: description: Additional information type: string 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 enabled: deprecated: true description: enabled type: boolean name: description: name type: string memberStatus: description: member status type: string 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 format: uuid name: description: Equinix assigned response attribute for Port name type: string description: description: Equinix assigned response attribute for Port description type: string 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 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: type: string enum: - SELF - EQUINIX project: $ref: '#/components/schemas/Project' state: $ref: '#/components/schemas/PortState' order: $ref: '#/components/schemas/PortOrder' operation: allOf: - $ref: '#/components/schemas/PortOperation' account: $ref: '#/components/schemas/SimplifiedAccount' change: $ref: '#/components/schemas/PortChange' changeLog: $ref: '#/components/schemas/Changelog' serviceType: 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 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 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: 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 items: $ref: '#/components/schemas/PortNotification' 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' loas: description: Port Loas type: array items: $ref: '#/components/schemas/PortLoa' marketplaceSubscription: $ref: '#/components/schemas/marketplaceSubscription' AllPortsResponse: description: GET All User Port Across Fabric Metros type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: GET All User Port Across Fabric Metros type: array items: $ref: '#/components/schemas/Port' SimplifiedAccountRequest: type: object properties: accountNumber: description: Account number type: integer format: int64 required: - accountNumber SimplifiedLocationRequest: type: object properties: metroCode: type: string example: AM required: - metroCode PortRequest: description: PortRequest is the Request Object for creating single and bulk fabric ports type: object properties: 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/PortNotification' physicalPorts: type: array description: Physical ports that implement this port items: $ref: '#/components/schemas/PhysicalPort' loas: description: Port Loas type: array items: $ref: '#/components/schemas/PortLoa' required: - type - 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/PhysicalPort' AllPhysicalPortsResponse: description: GET All Physical Ports type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: GET All Physical Ports type: array items: $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: name: deprecated: true description: name of subInterface of a port type: string unit: type: integer example: 200 LinkProtocolConnection: description: Connection details of Link Protocol type: object properties: href: description: Connection URI type: string 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 LinkProtocolServiceToken: description: Service Token details of Link Protocol type: object properties: href: description: Service Token URI type: string format: uri readOnly: true uuid: type: string format: uuid example: cd67f685-41b0-1b07-6de0-320a5c00eabe type: type: string example: TOKEN bandwidth: type: integer format: int64 example: 1000 LinkProtocolResponse: description: Link Protocol response type: object properties: href: description: LinkProtocol URI type: string format: uri readOnly: true uuid: description: Equinix-assigned network identifier type: string format: uuid example: 92dc376a-a932-43aa-a6a2-c806dedbd784 state: $ref: '#/components/schemas/LinkProtocolState' example: ACTIVE type: $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/Changelog' LinkProtocolGetResponse: description: List of Vlans type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: type: array items: $ref: '#/components/schemas/LinkProtocolResponse' PortExpression: type: object properties: and: $ref: '#/components/schemas/PortExpressions' or: $ref: '#/components/schemas/PortExpressions' property: 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 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: description: Possible field names to use on filters type: string 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 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 - /changeLog/createdDateTime - /bandwidth - /serviceCode - /operation/maintenanceStatus PortSortCriteria: type: object properties: 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/PortSortCriteria' required: - filter PortPackageSourceType: type: string description: Port Package Source Type enum: - COLO - REMOTE - BMMR PortPackage: type: object description: Port Package details properties: href: type: string description: Port Package URI readOnly: true type: type: string description: Port Package Type enum: - 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: type: string description: Port Package Service Type enum: - MSP supportedSourceTypes: type: array description: List of supported source types items: $ref: '#/components/schemas/PortPackageSourceType' supportedMetros: type: array description: List of supported metros items: type: string required: - type - code AllPortPackagesResponse: type: object description: Port Packages response properties: data: type: array description: List of Port Packages items: $ref: '#/components/schemas/PortPackage' required: - data ConnectionRouteAggregationData: type: object properties: 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: - BGP_IPv4_PREFIX_AGGREGATION uuid: description: Route Aggregation identifier type: string format: uuid example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d attachmentStatus: type: string enum: - ATTACHING - ATTACHED - DETACHED - DETACHING - FAILED - PENDING_BGP_CONFIGURATION changeLog: $ref: '#/components/schemas/Changelog' GetAllConnectionRouteAggregationsResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: List of Route Aggregations attached to a Connection type: array items: $ref: '#/components/schemas/ConnectionRouteAggregationData' ConnectionRouteFilterData: type: object properties: 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/ConnectionRouteFilterData' ConnectionRouteFiltersBase: type: object properties: direction: description: Route Filter direction to attach to a connection type: string enum: - INBOUND - OUTBOUND required: - direction RouteFiltersBase: type: object properties: type: description: Route Filter type type: string enum: - BGP_IPv4_PREFIX_FILTER - BGP_IPv6_PREFIX_FILTER name: type: string example: My-direct-route-1 description: description: Customer-provided connection description type: string project: $ref: '#/components/schemas/Project' required: - type - name - project RouteFiltersChange: description: Current state of latest route filter change type: object properties: uuid: description: Uniquely identifies a change type: string type: description: Type of change type: string 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 format: uri required: - uuid - type RouteFiltersData: type: object properties: href: type: string format: uri description: Route filter URI example: https://api.equinix.com/fabric/v4/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 name: type: string example: My-direct-route-1 description: description: Customer-provided connection description type: string change: $ref: '#/components/schemas/RouteFiltersChange' notMatchedRuleAction: type: string 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 example: replace path: description: path to change type: string example: /name value: description: new value for updated parameter required: - 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: $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 items: $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: pagination: $ref: '#/components/schemas/Pagination' data: description: List of Connections using a Route Filter type: array items: $ref: '#/components/schemas/RouteFilterConnectionsData' SearchAndExpression: type: object required: - and properties: and: type: array minItems: 1 maxItems: 8 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: type: object 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: type: string 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 - LIKE - ILIKE - BETWEEN - GREATER_THAN - GREATER_THAN_OR_EQUAL_TO - LESS_THAN - LESS_THAN_OR_EQUAL_TO - CASE_INSENSITIVE_REGEX values: type: array minItems: 1 maxItems: 8 items: type: string 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 enum: - /type - /uuid - /name - /project/projectId - /state - /changeLog/createdDateTime - /changeLog/updatedDateTime - /changeLog/deletedDateTime RouteFilterSortCriteria: type: object properties: 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/RouteFilterSortCriteria' RouteFiltersSearchResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: List of route filters type: array items: $ref: '#/components/schemas/RouteFiltersData' RouteFilterRuleState: description: Route filter rule status type: string enum: - PROVISIONING - REPROVISIONING - DEPROVISIONING - PROVISIONED - DEPROVISIONED - NOT_PROVISIONED - NOT_DEPROVISIONED RouteFilterRulesChange: description: Current state of latest route filter rule change type: object properties: uuid: description: Uniquely identifies a change type: string 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 format: uri 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 format: uuid example: 65b025ef-022b-4180-85cf-82cfc1ab655b name: type: string example: Private-subnet-filter-2 description: description: Customer-provided Route Filter Rule description type: string state: $ref: '#/components/schemas/RouteFilterRuleState' prefixMatch: description: prefix matching operator default: orlonger type: string example: exact change: $ref: '#/components/schemas/RouteFilterRulesChange' action: type: string enum: - PERMIT - DENY prefix: type: string example: 192.168.0.0/24 changelog: $ref: '#/components/schemas/Changelog' GetRouteFilterRulesResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: List of Route Filter Rules type: array items: $ref: '#/components/schemas/RouteFilterRulesData' RouteFilterRulesBase: type: object properties: name: type: string example: Private-subnet-filter description: description: Customer-provided Route Filter Rule description type: string prefix: type: string example: 192.168.0.0/24 prefixMatch: type: string default: orlonger example: orlonger, exact required: - prefix RouteFilterRulesPatchRequestItem: description: Route filter rule 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: /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: 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/RouteFilterRulesBase' required: - op - path - value RouteFilterRulesChangeData: description: Current state of latest route filter rules 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 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' data: type: array items: $ref: '#/components/schemas/RouteFilterRulesChangeData' RouteFilterRulesPostRequest: type: object description: Create Route Filter Rule POST request properties: data: description: Route Filter Rule configuration type: array items: $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/RouteFilterRuleExpression' RouteFilterRuleSimpleExpression: type: object description: Simple filter expression with property, operator, and values properties: property: 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: '=' values: type: array minItems: 1 maxItems: 8 items: type: string 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 enum: - /type - /uuid - /name - /state - /prefix - /prefixMatch - /changeLog/createdDateTime - /changeLog/updatedDateTime RouteFilterRuleSortCriteria: type: object properties: direction: $ref: '#/components/schemas/RouteFilterRuleSortDirection' property: $ref: '#/components/schemas/RouteFilterRuleSortBy' RouteFilterRulesSearchRequest: type: object description: Search route filter rules properties: filter: $ref: '#/components/schemas/RouteFilterRulesFilter' pagination: $ref: '#/components/schemas/PaginationRequest' sort: type: array items: $ref: '#/components/schemas/RouteFilterRuleSortCriteria' RouteFilterRulesSearchResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: List of route filter rules type: array items: $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: - 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 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 format: uri required: - uuid - type RouteAggregationsData: type: object properties: href: type: string format: uri description: Route Aggregation URI example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: description: Route Aggregation type type: string enum: - BGP_IPv4_PREFIX_AGGREGATION - BGP_IPv6_PREFIX_AGGREGATION uuid: description: Route Aggregation identifier type: string format: uuid example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: type: string example: My-direct-route-1 description: description: Customer-provided connection description type: string change: $ref: '#/components/schemas/RouteAggregationsChange' 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 required: - projectId changeLog: $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 minItems: 1 items: $ref: '#/components/schemas/RouteAggregationsPatchRequestItem' RouteAggregationsChangeOperation: description: Route Aggregation 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/RouteAggregationsBase' required: - op - path - value RouteAggregationChangeData: description: Current state of latest Route Aggregation 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: $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/RouteAggregationChangeData' RouteAggregationConnectionsData: 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 Aggregation identifier type: string format: uuid example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: type: string example: connection-1 GetRouteAggregationGetConnectionsResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: List of Connections using a Route Aggregation type: array items: $ref: '#/components/schemas/RouteAggregationConnectionsData' RouteAggregationSortDirection: description: Sorting direction default: DESC type: string enum: - DESC - ASC RouteAggregationSortBy: description: Possible field names to use on sorting default: /changeLog/updatedDateTime 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/PaginationRequest' sort: type: array items: $ref: '#/components/schemas/RouteAggregationSortCriteria' RouteAggregationsSearchResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: List of Route Aggregations type: array items: $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: uuid: description: Uniquely identifies a change type: string type: description: Type of change type: string 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 format: uri required: - uuid - type RouteAggregationRulesData: type: object properties: href: type: string format: uri 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: description: Route Aggregation type type: string enum: - BGP_IPv4_PREFIX_AGGREGATION_RULE uuid: description: Route Aggregation Rule identifier type: string format: uuid example: 65b025ef-022b-4180-85cf-82cfc1ab655b name: type: string example: Private-subnet-aggregation-2 description: description: Customer-provided Route Aggregation Rule description type: string state: $ref: '#/components/schemas/RouteAggregationRuleState' change: $ref: '#/components/schemas/RouteAggregationRulesChange' prefix: type: string example: 192.168.0.0/24 changeLog: $ref: '#/components/schemas/Changelog' GetRouteAggregationRulesResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: List of Route Aggregation Rules type: array items: $ref: '#/components/schemas/RouteAggregationRulesData' RouteAggregationRulesBase: type: object properties: name: type: string example: Private-subnet-Aggregation description: description: Customer-provided Route Aggregation Rule description type: string prefix: type: string example: 192.168.0.0/24 required: - prefix RouteAggregationRulesPatchRequestItem: description: Route Aggregation Rule 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: /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: 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: - op - path - value RouteAggregationRulesChangeData: description: Current state of latest Route Aggregation Rules 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 data: $ref: '#/components/schemas/RouteAggregationRulesChangeOperation' allOf: - $ref: '#/components/schemas/RouteAggregationRulesChange' RouteAggregationRulesChangeDataResponse: description: List of Route Aggregation Rule changes type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: type: array items: $ref: '#/components/schemas/RouteAggregationRulesChangeData' RouteAggregationRulesPostRequest: type: object description: Create Route Aggregation Rule POST request properties: data: description: Route Aggregation Rule configuration type: array items: $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/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: 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 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: '=' values: type: array minItems: 1 maxItems: 8 items: 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 RouteAggregationRuleSortBy: description: Possible field names to use on sorting default: /changeLog/updatedDateTime 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/PaginationRequest' sort: type: array items: $ref: '#/components/schemas/RouteAggregationRuleSortCriteria' RouteAggregationRulesSearchResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: List of route aggregation rules type: array items: $ref: '#/components/schemas/RouteAggregationRulesData' CloudRouterPostRequest: allOf: - $ref: '#/components/schemas/CloudRouterPostRequestBase' required: - 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 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: 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' change: $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: 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 example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 href: type: string 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: 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: 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/CloudRouterActionResponse' CloudRouterActionRequest: description: Cloud router action request type: object properties: type: $ref: '#/components/schemas/CloudRouterActionType' connection: $ref: '#/components/schemas/RouterActionsConnection' required: - type CloudRouterActionsSearchExpression: type: object properties: property: description: | Possible field names to use on filters: * `/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 * `>` - 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: ROUTE_TABLE_ENTRY_UPDATE CloudRouterActionsSearchOrFilter: type: object properties: or: type: array maxItems: 3 items: $ref: '#/components/schemas/CloudRouterActionsSearchExpression' CloudRouterActionsSearchFilter: type: object anyOf: - $ref: '#/components/schemas/CloudRouterActionsSearchExpression' - $ref: '#/components/schemas/CloudRouterActionsSearchOrFilter' CloudRouterActionsSearchFilters: type: object properties: and: type: array maxItems: 8 items: $ref: '#/components/schemas/CloudRouterActionsSearchFilter' CloudRouterActionsSearchSortDirection: description: Sorting direction default: DESC type: string enum: - DESC - ASC CloudRouterActionsSearchSortBy: description: Possible field names to use on sorting default: /changeLog/updatedDateTime type: string enum: - /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/PaginationRequest' sort: type: array items: $ref: '#/components/schemas/CloudRouterActionsSearchSortCriteria' CloudRouterCommandType: description: Fabric Cloud Router Command Type type: string 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: uuid: description: Connection UUID type: string example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 required: - uuid CloudRouterCommandRequestResponse: description: Fabric Cloud Router Command Request type: object properties: 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 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: 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: destinationIp: type: string example: 8.8.8.8 destinationName: type: string example: 8.8.8.8 dataBytes: type: integer example: 100 packetsTransmitted: type: integer example: 4 packetsReceived: type: integer example: 4 packetsLossPercent: type: number format: float example: 0 rttMin: type: number format: float example: 9.271 rttAvg: type: number format: float example: 15.483 rttMax: type: number format: float example: 26.771 rttStdDev: type: number format: float example: 7.039 responses: type: array items: $ref: '#/components/schemas/OutputStructuredPingResponseItem' CloudRouterCommandPingResponse: type: object properties: output: type: string outputStructuredPing: $ref: '#/components/schemas/OutputStructuredPing' errors: type: array items: $ref: '#/components/schemas/Error' Hop: type: object properties: hop: type: integer example: 1 probes: type: array items: 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: 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 items: $ref: '#/components/schemas/Hop' CloudRouterCommandTracerouteResponse: type: object properties: output: type: string outputStructuredTraceroute: $ref: '#/components/schemas/OutputStructuredTraceroute' errors: type: array items: $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 example: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/commands/1e9414f1-763e-4c0a-86c6-0bc8336048d9 type: $ref: '#/components/schemas/CloudRouterCommandType' uuid: type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 name: description: Customer-provided Cloud Router name type: string format: string example: test-fg-1 description: type: string example: description state: $ref: '#/components/schemas/CloudRouterCommandState' project: $ref: '#/components/schemas/Project' request: $ref: '#/components/schemas/CloudRouterCommandRequestResponse' response: $ref: '#/components/schemas/CloudRouterCommandResponse' changeLog: $ref: '#/components/schemas/Changelog' GetAllCloudRouterCommands: description: List of Fabric Cloud Router Command type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: type: array items: $ref: '#/components/schemas/CloudRouterCommand' CloudRouterCommandRequestPayload: description: Fabric Cloud Router Command Request type: object properties: 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 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: 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 type: string example: /state 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 * `~*` - case-insensitive like type: string example: '=' values: type: array items: type: string example: PING_COMMAND CloudRouterCommandSearchOrFilter: type: object properties: or: type: array maxItems: 3 items: $ref: '#/components/schemas/CloudRouterCommandSearchExpression' CloudRouterCommandSearchFilter: type: object anyOf: - $ref: '#/components/schemas/CloudRouterCommandSearchExpression' - $ref: '#/components/schemas/CloudRouterCommandSearchOrFilter' CloudRouterCommandSearchFilters: type: object properties: and: type: array maxItems: 8 items: $ref: '#/components/schemas/CloudRouterCommandSearchFilter' CloudRouterCommandSearchSortDirection: description: Sorting direction default: DESC type: string enum: - DESC - ASC CloudRouterCommandSearchSortBy: description: Possible field names to use on sorting default: /changeLog/updatedDateTime 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/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/CloudRouterCommand' RouteTableEntrySimpleExpression: type: object properties: property: 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 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 * `~*` - case-insensitive like type: string example: '=' values: type: array items: type: string example: IPv4_BGP_ROUTE RouteTableEntryOrFilter: type: object properties: or: type: array maxItems: 3 items: $ref: '#/components/schemas/RouteTableEntrySimpleExpression' RouteTableEntryFilter: type: object anyOf: - $ref: '#/components/schemas/RouteTableEntrySimpleExpression' - $ref: '#/components/schemas/RouteTableEntryOrFilter' RouteTableEntryFilters: type: object properties: and: type: array maxItems: 8 items: $ref: '#/components/schemas/RouteTableEntryFilter' RouteTableEntrySortDirection: description: Sorting direction default: DESC type: string enum: - DESC - ASC RouteTableEntrySortBy: description: Possible field names to use on sorting default: /changeLog/updatedDateTime type: string enum: - /changeLog/createdDateTime - /changeLog/updatedDateTime - /prefix - /nextHop - /connection/name - /type - /MED RouteTableEntrySortCriteria: type: object properties: 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/PaginationRequest' sort: type: array items: $ref: '#/components/schemas/RouteTableEntrySortCriteria' RouteTableEntryState: description: Route table entry state type: string enum: - 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' data: description: Data returned from the API call. type: array items: $ref: '#/components/schemas/RouteTableEntry' ValidateRequest: type: object description: Validate connection auth api key or vlan properties: filter: 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/ConnectionSideAdditionalInfo' CloudRouterRouteFilterAndExpression: type: object description: AND expression containing multiple filter expressions properties: and: type: array minItems: 1 maxItems: 8 items: $ref: '#/components/schemas/CloudRouterRouteFilterExpression' 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: 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 enum: - /type - /direction - /attachmentStatus - /changeLog/createdDateTime - /changeLog/updatedDateTime operator: type: string values: type: array minItems: 1 maxItems: 8 items: type: string 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: property: 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' sort: type: array minItems: 1 maxItems: 3 items: $ref: '#/components/schemas/RfAttachmentSortItem' CloudRouterRouteFiltersSearchResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: List of route filter attachments for a given cloud router type: array items: $ref: '#/components/schemas/ConnectionRouteFilterData' CloudRouterRouteAggregationAndExpression: type: object description: AND expression containing multiple filter expressions properties: and: type: array minItems: 1 maxItems: 8 items: $ref: '#/components/schemas/CloudRouterRouteAggregationExpression' 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 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 enum: - /type - /attachmentStatus - /changeLog/createdDateTime - /changeLog/updatedDateTime operator: type: string values: type: array items: type: string 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: 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/RaAttachmentSortItem' CloudRouterRouteAggregationsSearchResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: List of route aggregation attachments for a given cloud router type: array items: $ref: '#/components/schemas/ConnectionRouteAggregationData' CloudRouterExpression: type: object properties: 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: 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 CloudRouterSortBy: description: Possible field names to use on sorting default: /changeLog/updatedDateTime type: string enum: - /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/CloudRouterExpression' pagination: $ref: '#/components/schemas/PaginationRequest' sort: type: array items: $ref: '#/components/schemas/CloudRouterSortCriteria' SearchResponse: type: object properties: 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 enum: - LAB - BASIC - STANDARD - ADVANCED - PREMIUM example: LAB PackageChangeLog: description: Cloud Router package change log type: object properties: createdDateTime: type: string format: date-time example: '2020-11-06T07:00:00Z' updatedDateTime: type: string format: date-time example: '2020-11-06T07:00:00Z' CloudRouterPackage: description: Fabric Cloud Router Package type: object properties: href: description: Cloud Router package URI type: string format: uri readOnly: true example: https://api.equinix.com/fabric/v4/routerPackages/LAB type: description: Type of Router package type: string enum: - ROUTER_PACKAGE example: ROUTER_PACKAGE code: $ref: '#/components/schemas/code' description: description: Fabric Cloud Router Package description type: string 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 minimum: 0 example: 50 routeFilterSupported: description: CloudRouter package route filter support type: boolean vcCountMax: description: CloudRouter package Max Connection limit type: integer 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: 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 enum: - LAB - BASIC - STANDARD - ADVANCED - PREMIUM ApiServices: description: Available services details type: object properties: route: description: service routes type: string status: description: service status type: string changedDateTime: description: service status change date type: string HealthResponse: description: GET Services Health type: object properties: href: description: The Canonical URL at which the resource resides. type: string version: description: Indicator of a version type: string release: description: release details. type: string state: description: status of a service type: string apiServices: $ref: '#/components/schemas/ApiServices' ValidateConnectionResponse: description: Validate Connection specification type: object properties: uuid: description: Equinix-assigned connection identifier type: string 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: additionalInfo: description: Additional information type: array items: $ref: '#/components/schemas/ConnectionSideAdditionalInfo' data: description: Connection response data type: array items: $ref: '#/components/schemas/ValidateConnectionResponse' NetworkPostRequest: type: object description: Create Network properties: 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/SimplifiedNotification' required: - 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: op: description: Handy shortcut for operation name type: string 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 enum: - '=' - '!=' - '>' - '>=' - < - <= - BETWEEN - NOT BETWEEN - LIKE - NOT LIKE - ILIKE - NOT ILIKE - IN - NOT IN example: '=' values: type: array items: type: string example: Network-1 NetworkSimpleExpression: type: array items: $ref: '#/components/schemas/NetworkFilter' NetworkSearchFieldName: description: Possible field names to use on filters type: string 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 - /* 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: direction: $ref: '#/components/schemas/NetworkSortDirection' property: $ref: '#/components/schemas/NetworkSortBy' NetworkSearchRequest: type: object description: Search requests containing criteria properties: filter: $ref: '#/components/schemas/NetworkFilter' pagination: $ref: '#/components/schemas/PaginationRequest' sort: type: array items: $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: direction: $ref: '#/components/schemas/NetworkSortDirectionResponse' property: $ref: '#/components/schemas/NetworkSortByResponse' NetworkSearchResponse: description: List of networks type: object properties: pagination: $ref: '#/components/schemas/Pagination' sort: type: array items: $ref: '#/components/schemas/NetworkSortCriteriaResponse' data: type: array items: $ref: '#/components/schemas/Network' NetworkConnections: description: List of network changes type: object properties: 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 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 status: $ref: '#/components/schemas/NetworkChangeStatus' example: COMPLETED 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' data: type: array items: $ref: '#/components/schemas/NetworkChangeOperation' NetworkChangeResponse: description: List of network changes type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: type: array items: $ref: '#/components/schemas/NetworkChange' virtualConnectionUuid: title: fabricConnectionUuid type: object description: UUID of the Fabric Connection Instance example: uuid: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f properties: href: description: Connection URI type: string format: uri readOnly: true type: type: string description: Connection Type uuid: type: string format: uuid description: Connection UUID. required: - uuid ipv4: type: object description: EPT service network information title: ipv4 properties: primary: type: string format: ipv4 description: Primary Timing Server IP Address secondary: type: string 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: - primary - secondary - networkMask md5: type: object properties: type: type: string enum: - ASCII - HEX keyNumber: type: integer minimum: 1 maximum: 65535 example: 10 description: The authentication Key ID. key: type: string 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 enum: - ARB - PTP example: ARB description: Time Scale value, ARB denotes Arbitrary and PTP denotes Precision Time Protocol. domain: type: integer minimum: 0 maximum: 127 example: 0 description: The PTP domain value. priority1: type: integer minimum: 0 maximum: 248 example: 128 description: The priority1 value determines the best primary clock, Lower value indicates higher priority. priority2: type: integer 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: 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 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: 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: purchaseOrderNumber: description: Purchase order number type: string 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: type: type: string 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: - name - type - package - connections - ipv4 timeServiceOperation: description: time service operational data type: object properties: operationalStatus: description: time service operational status type: string enum: - UP - DOWN - DEGRADED precisionTimePackagePostResponse: title: precisionTimePackagePostResponse type: object example: href: https://api.equinix.com/fabric/v4/timeServicePackage/NTP_STANDARD code: NTP_STANDARD properties: href: type: string format: uri code: type: string 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 format: uri readOnly: true type: type: string description: Connection Type. uuid: type: string format: uuid 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: Precision Time Service type refers to the corresponding protocol. enum: - NTP - PTP name: type: string description: Precision Time Service Name. uuid: type: string format: uuid description: Precision Time Service UUID. state: description: Precision Time Service Status. type: string 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: 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/Project' account: $ref: '#/components/schemas/SimplifiedAccount' order: $ref: '#/components/schemas/precisionTimeOrder' changeLog: $ref: '#/components/schemas/Changelog' required: - uuid - href - type - state - package precisionTimeChangeOperation: type: object description: Fabric Precision Timing change operation data properties: op: type: string description: Handy shortcut for operation name enum: - replace - add - remove path: type: string description: path inside document leading to updated parameter enum: - /name - /package/code - /ipv4 - /ntpAdvancedConfiguration - /ptpAdvancedConfiguration value: description: new value for updated parameter required: - op - path - value TimeServiceSimpleExpression: type: object properties: 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 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 items: type: string example: FabricPrecisionTimeService-1 TimeServiceOrFilter: type: object properties: 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: 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: direction: $ref: '#/components/schemas/TimeServiceSortDirection' property: $ref: '#/components/schemas/TimeServiceSortBy' TimeServicesSearchRequest: type: object description: Search requests containing criteria properties: filter: $ref: '#/components/schemas/TimeServiceFilters' pagination: $ref: '#/components/schemas/PaginationRequest' sort: type: array items: $ref: '#/components/schemas/TimeServiceSortCriteria' ServiceSearchResponse: type: object properties: 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 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 precisionTimeServiceConnectionsResponse: title: precisionTimeServiceConnectionResponse type: object description: EPT service instance's L2 connections properties: 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 format: uri type: type: string enum: - TIME_SERVICE_PACKAGE code: type: string enum: - 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 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: - type - code - bandwidth precisionTimeServicePackagesResponse: title: precisionTimeServicePackagesResponse type: object description: Precision Packages properties: pagination: $ref: '#/components/schemas/Pagination' data: description: Data returned from the API call type: array items: $ref: '#/components/schemas/precisionTimePackageResponse' SubscriptionState: type: string description: Subscription State enum: - ACTIVE - EXPIRED - CANCELLED - GRACE_PERIOD SubscriptionTrial: type: object description: Free Trial Subscription properties: enabled: type: boolean description: Free Trial Enabled expiryDateTime: type: string format: date-time description: Free Trial Expiry Date SubscriptionRouterPackageType: type: object description: Cloud Router Package Type properties: code: type: string description: Cloud Router package code SubscriptionAsset: type: object description: Asset information properties: type: type: string description: Type of the subscription asset ( XF_ROUTER ,IP_VC, IPWAN_VC ) package: $ref: '#/components/schemas/SubscriptionRouterPackageType' bandwidth: type: integer description: Bandwidth of the asset in Mbps SubscriptionEntitlementResponse: type: object description: Subscription entitlement properties: uuid: type: string 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: href: type: string format: uri description: Subscription URL uuid: type: string format: uuid description: Unique identifier of the Subscription state: $ref: '#/components/schemas/SubscriptionState' marketplace: type: string description: Marketplace Type enum: - AWS - GCP - AZURE - REDHAT offerType: type: string description: Marketplace Offer Type enum: - PUBLIC - PRIVATE_OFFER isAutoRenew: type: boolean description: Is Auto Renewal Enabled example: true offerId: type: string description: Marketplace Offer Id trial: $ref: '#/components/schemas/SubscriptionTrial' metroCodes: type: array items: 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: - state - marketplace - entitlements Stream: description: Stream object type: object properties: href: description: Stream URI type: string format: uri readOnly: true example: https://api.equinix.com/fabric/v4/streams/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 uuid: description: Equinix-assigned access point identifier type: string format: uuid example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: description: type type: string enum: - TELEMETRY_STREAM name: description: Customer-provided stream name type: string description: description: Customer-provided stream description type: string 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 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: 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: type: type: string enum: - TELEMETRY_STREAM name: description: Customer-provided stream name type: string description: description: Customer-provided stream description type: string 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: 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 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 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 StreamSearchSortBy: description: Possible field names to use on sorting default: /changeLog/createdDateTime type: string enum: - /changeLog/createdDateTime - /changeLog/updatedDateTime StreamSearchSortCriteria: type: object required: - direction - property properties: direction: $ref: '#/components/schemas/StreamSearchSortDirection' property: $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: name: description: Customer-provided stream name type: string description: description: Customer-provided stream description type: string 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: 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 enum: - DESC - ASC StreamAssetSortBy: description: Possible field names to use on sorting default: /uuid type: string enum: - /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: href: description: Stream Asset URI type: string format: uri readOnly: true uuid: description: Equinix-assigned access point identifier type: string format: uuid 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 example: true attachmentStatus: description: asset status type: string enum: - ATTACHING - ATTACHED - DETACHED - DETACHING - FAILED projectId: description: project ic type: string 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: - ports - connections - routers - metros - organizations - projects - companyProfiles type: string StreamAsset: description: Stream object type: object properties: href: description: Stream Asset URI type: string format: uri readOnly: true uuid: description: Equinix-assigned access point identifier type: string format: uuid 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: metricsEnabled: description: enable metric type: boolean default: false example: false StreamDeviceInterfaceRequest: type: object description: Network Edge Device interface required: - 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: metricsEnabled: description: enable metric. Must be true when interfaces are provided type: boolean default: false example: true interfaces: 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. type: array items: $ref: '#/components/schemas/StreamDeviceInterfaceRequest' StreamSubscriptionSelectorExpression: 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.* StreamSubscriptionSelector: type: object properties: 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: type: type: string description: credential type 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: type: string description: passed as Authorization header value StreamSubscriptionSinkSetting: type: object description: Stream subscription sink settings properties: eventIndex: type: string description: event index metricIndex: type: string description: metric index source: type: string description: source applicationKey: type: string description: Application key eventUri: type: string description: event uri metricUri: type: string description: metric uri format: type: string description: webhook message format default: CLOUDEVENT enum: - CLOUDEVENT - OPENTELEMETRY StreamSubscriptionSinkResponse: type: object description: Create Stream destination properties: uri: description: any publicly reachable http endpoint type: string type: 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: description: sink host type: string StreamSubscriptionOperationAdditionalInfo: type: object description: External error information from subscription sink properties: property: description: Additional attribute for error information type: string statusCode: description: HTTP error status code response from sink type if error occurred type: string reason: description: HTTP error message response from sink type if error occurred type: string StreamSubscriptionOperationErrors: type: object description: Error information for stream subscription delivery properties: errorCode: description: Equinix Observability error code type: string errorMessage: description: Equinix Observability error message type: string 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: 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 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: List of error information for stream subscription delivery items: $ref: '#/components/schemas/StreamSubscriptionOperationErrors' StreamSubscription: description: Stream Subscription object type: object properties: href: description: Stream Subscription URI type: string 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 format: uuid example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: description: type type: string enum: - STREAM_SUBSCRIPTION name: description: Customer-provided subscription name type: string description: description: Customer-provided subscription description type: string state: description: Steam subscription provision state type: string 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: pagination: $ref: '#/components/schemas/Pagination' data: description: Data returned from the API call. type: array items: $ref: '#/components/schemas/StreamSubscription' StreamSubscriptionSink: type: object description: Create Stream destination required: - type properties: uri: description: any publicly reachable http endpoint type: string type: 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: description: sink host type: string StreamSubscriptionPostRequest: type: object description: Create Stream Subscription required: - type - name - sink properties: type: type: string enum: - STREAM_SUBSCRIPTION name: description: Customer-provided stream subscription name type: string description: description: Customer-provided stream subscription description type: string enabled: description: Stream subscription enabled status type: boolean 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 items: type: string StreamFilterOrFilter: type: object properties: or: type: array maxItems: 3 items: $ref: '#/components/schemas/StreamFilterSimpleExpression' StreamFilter: type: object anyOf: - $ref: '#/components/schemas/StreamFilterSimpleExpression' - $ref: '#/components/schemas/StreamFilterOrFilter' StreamSubscriptionFilter: type: object properties: and: type: array maxItems: 8 items: $ref: '#/components/schemas/StreamFilter' StreamSubscriptionPutRequest: type: object description: Update Stream Subscription required: - type - name - sink properties: type: type: string enum: - STREAM_SUBSCRIPTION name: description: Customer-provided stream subscription name type: string description: description: Customer-provided stream subscription description type: string 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: 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 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 example: '=' values: type: array minItems: 1 items: type: string example: 12f4d4a1-c7cb-4def-9f77-5ce93c19d999 StreamSubscriptionSearchOrFilter: type: object properties: 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: and: type: array minItems: 1 items: $ref: '#/components/schemas/StreamSubscriptionSearchFilter' StreamSubscriptionSearchSortDirection: description: Sorting direction default: DESC type: string enum: - DESC - ASC StreamSubscriptionSearchSortBy: description: Possible field names to use on sorting default: /changeLog/createdDateTime type: string enum: - /changeLog/createdDateTime - /changeLog/updatedDateTime StreamSubscriptionSearchSortCriteria: type: object required: - 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: 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 enum: - 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 format: uri 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: - 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: 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 enum: - 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 AlertRulePostRequest: type: object description: Create Stream Alert Rules required: - type - name - metricSelector - resourceSelector - detectionMethod properties: type: type: string enum: - METRIC_ALERT name: description: Customer-provided stream name type: string 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 - name - metricSelector - resourceSelector - detectionMethod properties: name: description: Customer-provided stream name type: string type: type: string enum: - METRIC_ALERT description: description: Customer-provided stream description type: string 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: type: description: Contact Type example: SUPPORT type: string 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 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: - type - name - summary - description - webUrl CompanyProfileState: type: string description: Company Profile State CompanyMetro: type: object properties: href: type: string metroCode: type: string 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 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 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 type: $ref: '#/components/schemas/ServiceProfileTypeEnum' PrivateService: type: object properties: href: type: string uuid: type: string CompanyProfileChangeItem: type: object properties: op: description: Handy shortcut for operation name type: string 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 CompanyProfileChange: type: object properties: uuid: type: string type: type: string status: type: string createdDateTime: type: string format: date-time updatedDateTime: type: string format: date-time data: type: array default: [] items: $ref: '#/components/schemas/CompanyProfileChangeItem' CompanyProfileResponse: type: object properties: href: type: string 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 example: COMPANY_PROFILE name: type: string 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: Searchable field names in company profile enum: - /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: - 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: 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: | 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 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 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: 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 required: - type - uuid PrivateServiceListResponse: type: object properties: data: type: array items: $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: 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 required: - type - uuid LogoRequest: description: Equinix Fabric Logo Request Object type: object required: - logo - name - type - description properties: logo: type: string format: binary description: Logo image file name: type: string 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: type: string description: Type of logo example: COMPANY_LOGO LogoResponse: description: Equinix Fabric Logo Response Object type: object properties: href: type: string 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 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: | Type of Letter of Authorization enum: - 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: type: $ref: '#/components/schemas/LoaType' name: type: string 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: Organization ID of the requestor. example: 9257 orgName: type: string description: Organization name of the requestor. example: ABC Inc. LoaPatchPanelConnectorType: type: string description: Connector Type enum: - 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: 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' IssueLoa: title: IssueLoa description: Issue Loa type: object 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: email: type: string format: email description: Email address of the issuer contact. 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. 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: Current lifecycle state of the LOA. enum: - PENDING - FAILED - PENDING_AUTHORIZATION - PENDING_ACCEPTANCE - CANCELLED - INACTIVE - ACTIVE - EXPIRED example: ACTIVE LoaChangelog: 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 LoaResponse: description: Loa Response type: object properties: href: type: string description: URI of this LOA resource. format: uri example: https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2 uuid: type: string description: Unique identifier of this LOA. format: uuid example: 29cc7878-54e3-4e1a-8651-87a61354bac2 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: 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 properties: op: $ref: '#/components/schemas/LoaOpEnum' path: $ref: '#/components/schemas/LoaPath' value: description: New value for updated parameter LoaUpdate: type: array items: $ref: '#/components/schemas/LoaReplaceOperation' LoaActionType: type: string description: Action to perform on the LOA. enum: - 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 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: 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: - type LoaActionState: description: Action State type: string enum: - COMPLETED - FAILED - PENDING LoaActionResponse: description: Action Response type: object properties: href: 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 uuid: type: string description: Action Identifier format: uuid 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: property: $ref: '#/components/schemas/LoaFieldName' operator: type: string enum: - '=' - '!=' - 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: - DESC - ASC property: description: Possible field names to use on sorting default: /changeLog/updatedDateTime type: string enum: - /name - /expirationDateTime - /changeLog/createdDateTime - /changeLog/updatedDateTime LoaSearchRequest: type: object description: Search loas based on filter criteria properties: 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: 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 enum: - '=' - '!=' - LIKE - ILIKE - BETWEEN - NOT BETWEEN - IN - NOT IN - '>' - < - '>=' - <= values: type: array items: type: string example: LOA_ACCEPTANCE LoaActionOrFilter: type: object properties: 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 enum: - DESC - ASC property: description: Possible field names to use on sorting default: /changeLog/createdDateTime type: string enum: - /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: 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' LoaConsumersResponse: description: List of Consumers associated with a LOA type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: type: array items: $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: type: type: string enum: - 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 format: uri 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 format: uuid description: Unique identifier of this note. example: e41f485e-3094-42de-8797-0ef19a51df79 comments: 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: type: string 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 enum: - 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: 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 format: uri readOnly: true description: LOA URI. example: https://api.equinix.com/fabric/v4/loas/c61f485e-3094-42de-8797-0ef19a51df79 uuid: type: string format: uuid 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: Schedule type. enum: - 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 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 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: 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' 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: 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: | 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: timezone: type: string description: Timezone. example: PST availability: $ref: '#/components/schemas/CrossConnectContactAvailability' CrossConnectPhone: description: Contact phone number. type: object properties: type: type: string description: Phone number type. enum: - MOBILE - OFFICE example: MOBILE number: type: string description: Phone number. pattern: ^\+[1-9]\d{1,14}$ example: '+14085551234' contactPreference: $ref: '#/components/schemas/CrossConnectContactPreference' CrossConnectNotification: description: Cross Connect Notification. 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 items: type: string format: email description: Email addresses for notifications. example: - abc@test.com registeredUsers: type: array items: type: string description: Registered users for notifications. phone: type: array items: $ref: '#/components/schemas/CrossConnectPhone' description: Contact phone numbers. required: - type - emails PurchaseOrder: description: Purchase Order information associated with the account. type: object properties: number: type: string description: Purchase Order number. example: '1233' amount: type: string description: Purchase Order amount. example: '10000' startDate: type: string format: date description: Date the Purchase Order takes effect. example: '2026-02-26' endDate: type: string format: date description: Date the Purchase Order expires. example: '2027-02-26' attachmentId: type: string format: uuid description: Identifier of the uploaded purchase order document. example: e41f485e-3094-42de-8797-0ef19a51df79 type: type: string description: Purchase Order type. enum: - EXEMPTION - EXISTING - NEW example: NEW OrderRequest: description: Cross Connect Order. 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' CrossConnectNoteRequest: description: Cross Connect Note. type: object properties: comments: type: string description: Note comments. example: test note maxLength: 4000 required: - comments CrossConnectAttachment: description: Cross Connect Attachment. type: object properties: attachmentId: type: string 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: type: $ref: '#/components/schemas/CrossConnectType' name: type: string 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 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/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 enum: - PENDING - PENDING_ACTION - PROVISIONING - PROVISIONED - DEPROVISIONING - DEPROVISIONED - CANCELLING - CANCELLED - FAILED example: PENDING CrossConnectActionType: 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. type: string enum: - XC_SIGNATURE_SUBMISSION - XC_PROPOSED_DATE_TIME_ACCEPTANCE - XC_PROPOSED_DATE_TIME_REJECTION - 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' location: $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' location: $ref: '#/components/schemas/CrossConnectLocation' loa: $ref: '#/components/schemas/CrossConnectLoaRef' CrossConnectAccount: description: Account the Cross Connect belongs to. type: object properties: accountNumber: type: integer format: int64 description: Account number. example: 123456 OrderResponse: description: Cross Connect Order. 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' CrossConnectLink: description: Link to a Cross Connect sub-resource. type: object properties: href: type: string 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 readOnly: true description: Operation identifier of the linked sub-resource. example: getCrossConnectSchedulesByUuid method: type: string readOnly: true description: HTTP method to use on the sub-resource. example: GET contentType: type: string readOnly: true description: Content type returned by the sub-resource. example: application/json authenticate: type: boolean readOnly: true description: Whether authentication is required. example: true CrossConnectChangelog: description: Cross Connect Change Log. type: object properties: createdDateTime: type: string format: date-time 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' updatedDateTime: type: string format: date-time 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' CrossConnectResponse: description: Cross Connect Response. type: object properties: href: type: string format: uri 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 format: uuid description: Cross Connect Identifier. example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 name: type: string description: A short, descriptive name for this Cross Connect. example: My-CC-service state: $ref: '#/components/schemas/CrossConnectState' allowedActions: type: array readOnly: true 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. items: type: object properties: type: $ref: '#/components/schemas/CrossConnectActionType' bmmrType: $ref: '#/components/schemas/BmmrType' mediaType: type: string description: Media type of the Cross Connect. example: SINGLE_MODE_FIBER mediaSubType: type: string description: Media sub-type of the Cross Connect. example: SINGLE_MODE_FIBER circuitId: type: string description: Circuit identifier of the Cross Connect. serialNumber: type: string readOnly: true 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 description: | Links to the Cross Connect sub-resources - schedules, services, notes and attachments. items: $ref: '#/components/schemas/CrossConnectLink' changeLog: $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. type: object properties: href: type: string format: uri readOnly: true 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 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/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/CrossConnectServiceType' readOnly: true state: allOf: - $ref: '#/components/schemas/CrossConnectServiceState' readOnly: true device: allOf: - $ref: '#/components/schemas/PatchEquipmentResponse' readOnly: true description: Patch equipment device details. Returned for the XC_PATCH_EQUIPMENT service. description: type: string readOnly: true description: Additional notes captured for the service. example: additional notes for patch equipment maxLength: 100 changeLog: $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 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 format: uuid readOnly: true description: Note Identifier. example: e41f485e-3094-42de-8797-0ef19a51df79 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: type: array maxItems: 1 items: $ref: '#/components/schemas/CrossConnectActionNote' description: Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. attachments: type: array maxItems: 5 items: $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. 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. example: true services: type: array items: $ref: '#/components/schemas/CrossConnectServiceRequest' description: | Applicable for XC_DEINSTALL. Only XC_PATCH_EQUIPMENT is supported for deinstall. 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. 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. CrossConnectActionRequest: description: Cross Connect Action Request. type: object properties: type: $ref: '#/components/schemas/CrossConnectActionType' data: $ref: '#/components/schemas/CrossConnectActionData' required: - type CrossConnectActionState: description: Cross Connect Action State. type: string enum: - PENDING - COMPLETED - FAILED example: COMPLETED CrossConnectActionNoteResponse: description: Note the action applies to. type: object properties: href: type: string 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 format: uuid readOnly: true description: Note Identifier. example: e41f485e-3094-42de-8797-0ef19a51df79 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. comments: type: string readOnly: true 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 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/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 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. enum: - XC_INSTALL_SCHEDULE example: XC_INSTALL_SCHEDULE code: allOf: - $ref: '#/components/schemas/ScheduleType' readOnly: true aSide: type: object readOnly: true description: A-Side of the schedule window. properties: location: $ref: '#/components/schemas/CrossConnectLocation' zSide: type: object readOnly: true description: Z-Side of the schedule window. properties: location: $ref: '#/components/schemas/CrossConnectLocation' startDateTime: type: string format: date-time readOnly: true description: Start of the schedule window. example: '2026-03-05T17:00:00Z' endDateTime: type: string format: date-time readOnly: true 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. items: type: string format: date 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: description: App Domain Type 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: description: App Domain lifecycle state type: string format: string enum: - PENDING_VERIFICATION - PROVISIONING_FAILED - PROVISIONED - DEPROVISIONING - DEPROVISIONING_FAILED - DEPROVISIONED example: PENDING_VERIFICATION x-order: 6 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: - op - path - value AppDomainChange: description: Current state of latest AppDomain change type: object properties: uuid: description: Uniquely identifies a change type: string type: description: Type of change type: string enum: - APP_DOMAIN_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 items: $ref: '#/components/schemas/AppDomainChangeOperation' required: - type - updatedDateTime AppDomain: description: App Domain object type: object properties: href: description: Resource URI type: string format: uri readOnly: true example: https://api.equinix.com/fabric/v4/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' changeLog: $ref: '#/components/schemas/Changelog' change: $ref: '#/components/schemas/AppDomainChange' required: - type - name - project AppDomainUpdateRequest: description: App Domain Update Request type: array minItems: 1 maxItems: 1 items: $ref: '#/components/schemas/AppDomainChangeOperation' AppDomainSimpleExpression: type: object properties: 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 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 AppDomainOrFilter: type: object properties: 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 format: string enum: - 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/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3/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: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 x-order: 3 name: description: Customer-provided App Link name type: string 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 example: 1000 x-order: 10 project: $ref: '#/components/schemas/Project' required: - type - uuid AppDomainAttachedAppLinks: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: Data returned from the API call. type: array items: $ref: '#/components/schemas/AppDomainAttachedAppLink' AppLinkPostRequestRouter: type: object description: Cloud Router reference for App Link properties: uuid: type: string description: Cloud Router UUID format: uuid example: 36204584-2ae1-44f6-980f-08ecd555d9c6 required: - uuid AppLinkPostRequest: type: object description: Create App Link properties: type: $ref: '#/components/schemas/AppLinkType' name: description: Customer-provided App Link name type: string format: string minLength: 1 maxLength: 50 example: Atlassian App Link description: description: Customer-provided App Link description type: string format: string 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 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' required: - type - name - router - ipv4Subnet - bandwidth - project AppLinkChangeOperation: description: App Link 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: - /name - /description - /bandwidth - /ipv4Subnet value: description: new value for updated parameter x-go-type: json.RawMessage required: - op - path - value AppLinkChange: description: Current state of latest AppLink change type: object properties: uuid: description: Uniquely identifies a change type: string type: description: Type of change type: string enum: - APP_LINK_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 items: $ref: '#/components/schemas/AppLinkChangeOperation' required: - type - updatedDateTime AppLink: 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 x-order: 1 type: $ref: '#/components/schemas/AppLinkType' uuid: description: Equinix-assigned access point identifier type: string format: uuid example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 x-order: 3 name: description: Customer-provided App Link name type: string 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 example: 1000 x-order: 10 project: $ref: '#/components/schemas/Project' changeLog: $ref: '#/components/schemas/Changelog' change: $ref: '#/components/schemas/AppLinkChange' required: - type - 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: 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/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 example: atlassian.net x-order: 4 attachmentStatus: $ref: '#/components/schemas/AppLinkAttachState' changeLog: $ref: '#/components/schemas/Changelog' required: - uuid AppLinkAttachDomainSimpleExpression: type: object properties: 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 items: type: string example: Gateway AppLinkAttachDomainOrFilter: type: object properties: 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: and: type: array maxItems: 8 items: $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: 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 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 - 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: description: Uniquely identifies a change type: string type: description: Type of change type: string enum: - APP_SERVICE_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 items: $ref: '#/components/schemas/AppLinkChangeOperation' required: - type - updatedDateTime AppLinkAppServiceAttachment: description: App Link Attached App Service 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/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2 x-order: 1 type: $ref: '#/components/schemas/AppServiceType' uuid: description: Equinix-assigned access point identifier type: string format: uuid example: 5008a109-9d1c-485c-b0ba-de9736f283c2 x-order: 3 geoScope: description: Geo scope for the App Service type: string 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: geoScope: description: Geo scope for the App Service type: string example: GLOBAL destinationIp: description: Target IP for forwarding API requests type: string format: ipv4 example: 10.10.1.110 required: - geoScope - destinationIp AppLinkAppServiceAttachmentChangeOperation: description: App Link 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: - /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: 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 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 items: type: string example: Gateway AppLinkAttachServiceOrFilter: type: object properties: 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: and: type: array maxItems: 8 items: $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: direction: $ref: '#/components/schemas/AppLinkAttachServiceSortDirection' property: $ref: '#/components/schemas/AppLinkAttachServiceSortBy' AppLinkAttachServiceSearchRequest: type: object description: Search requests containing criteria properties: filter: $ref: '#/components/schemas/AppLinkAttachServiceFilters' pagination: $ref: '#/components/schemas/PaginationRequest' sort: type: array items: $ref: '#/components/schemas/AppLinkAttachServiceSortCriteria' AppLinkAttachServiceSearchResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: Data returned from the API call. type: array items: $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: href: description: Resource URI type: string 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 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 project: $ref: '#/components/schemas/Project' geoScope: description: Geo scope for the App Service type: string 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' required: - 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 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 format: uuid example: 90ee425c-9988-454c-96d9-1128bc16350f x-order: 3 config: description: Base64-encoded configuration for the processor attachment type: string example: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwo= x-order: 4 endpoint: description: Endpoint DNS name assigned to the attached App Processor type: string 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: config: description: Base64-encoded configuration for the processor attachment type: string example: bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwo= required: - config AppLinkAttachProcessorSimpleExpression: type: object properties: 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 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 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: - 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 format: string example: /changeLog/updatedDateTime AppLinkAttachProcessorSortCriteria: type: object properties: 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 enum: - DESC - ASC default: DESC example: DESC AppLinkAttachedAppProcessors: type: object properties: 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: visibility: description: App Processor marketplace visibility type: string format: string enum: - PUBLIC - PRIVATE default: PUBLIC example: PUBLIC required: - visibility AppProcessorChangeOperation: description: App Processor 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: - /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 type: description: Type of change type: string enum: - 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 items: $ref: '#/components/schemas/AppProcessorChangeOperation' required: - type - updatedDateTime AppProcessor: description: App Processor object type: object properties: href: description: Resource URI type: string 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: | 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: | 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 AppProcessorOrFilter: type: object properties: 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: and: type: array maxItems: 8 items: $ref: '#/components/schemas/AppProcessorFilter' AppProcessorSortDirection: description: Sorting direction default: DESC type: string enum: - DESC - ASC AppProcessorSortBy: 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 default: /changeLog/updatedDateTime type: string format: string example: /changeLog/updatedDateTime AppProcessorSortCriteria: type: object properties: 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 format: string minLength: 1 maxLength: 50 example: Atlassian App Service description: description: Customer-provided App Service description type: string format: string example: Atlassian App Service in SV endpoint: description: Accessible endpoint through this service type: string 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 enum: - replace - add - remove path: description: path inside document leading to updated parameter type: string enum: - /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: uuid: description: Uniquely identifies a change type: string type: description: Type of change type: string enum: - APP_SERVICE_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 items: $ref: '#/components/schemas/AppServiceChangeOperation' required: - type - updatedDateTime AppService: description: App Service object type: object properties: href: description: Resource URI type: string 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 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 enum: - 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 format: string example: /changeLog/updatedDateTime AppServiceSortCriteria: type: object properties: direction: $ref: '#/components/schemas/AppServiceSortDirection' property: $ref: '#/components/schemas/AppServiceSortBy' AppServiceSearchRequest: type: object description: Search requests containing criteria properties: 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 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: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 x-order: 3 name: description: Customer-provided App Link name type: string 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 example: 1000 x-order: 10 project: $ref: '#/components/schemas/Project' required: - type - uuid AppServiceAttachedAppLinks: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: Data returned from the API call. type: array items: $ref: '#/components/schemas/AppServiceAttachedAppLink' AppSubscriptionState: description: App Subscription lifecycle state type: string enum: - PROVISIONING - PROVISIONING_FAILED - PROVISIONED - DEPROVISIONING - DEPROVISIONING_FAILED - DEPROVISIONED - 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 enum: - DESC - ASC default: DESC example: DESC AppSubscriptionType: description: App Subscription Type type: string enum: - APP_SUBSCRIPTION default: APP_SUBSCRIPTION example: APP_SUBSCRIPTION x-order: 2 AppServiceAttachedAppSubscription: description: App Subscription object attached to an App Service 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 x-order: 1 type: $ref: '#/components/schemas/AppSubscriptionType' uuid: 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' required: - type - uuid - state AppServiceAttachedAppSubscriptions: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: Data returned from the API call. type: array items: $ref: '#/components/schemas/AppServiceAttachedAppSubscription' AppServiceAttachedAppSubscriptionSimpleExpression: type: object properties: property: description: | Possible field names to use on filters: * `/uuid` - App Subscription UUID * `/state` - App Subscription lifecycle state type: string example: /state operator: description: | Possible operators to use on filters: * `=` - equal * `!=` - not equal * `IN` - in * `NOT IN` - not in type: string example: IN values: type: array items: type: string example: PROVISIONED AppServiceAttachedAppSubscriptionOrFilter: type: object properties: 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 enum: - DESC - ASC AppServiceAttachedAppSubscriptionSortBy: description: | 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: direction: $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSortDirection' property: $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSortBy' AppServiceAttachedAppSubscriptionSearchRequest: type: object description: Search requests containing criteria properties: filter: $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionFilters' pagination: $ref: '#/components/schemas/PaginationRequest' sort: type: array items: $ref: '#/components/schemas/AppServiceAttachedAppSubscriptionSortCriteria' AppServiceAttachedAppSubscriptionSearchResponse: type: object properties: 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: uuid: description: Equinix-assigned access point identifier type: string format: uuid example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 required: - uuid AppSubscriptionSourceRequest: description: Source details for the Subscription type: object x-order: 4 properties: 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: uuid: description: Equinix-assigned access point identifier type: string format: uuid example: 5008a109-9d1c-485c-b0ba-de9736f283c2 required: - uuid AppSubscriptionPrioritization: description: Prioritization strategy for forwarding API requests type: string enum: - LATENCY - PERFORMANCE - UTILIZATION - THRESHOLD - ANY_TAG example: LATENCY AppSubscriptionTargetRequest: description: Target details for the Subscription type: object x-order: 5 properties: appService: $ref: '#/components/schemas/AppSubscriptionTargetRequestAppService' geoScope: type: string description: Geo scope example: GLOBAL prioritization: $ref: '#/components/schemas/AppSubscriptionPrioritization' required: - prioritization - geoScope AppSubscriptionPostRequest: type: object description: Create App Subscription properties: 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 format: uri readOnly: true 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 format: uuid 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 format: uri readOnly: true 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 format: uuid 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: Geo scope example: GLOBAL prioritization: $ref: '#/components/schemas/AppSubscriptionPrioritization' required: - prioritization - geoScope AppSubscriptionChangeOperation: description: App Subscription 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 value: description: new value for updated parameter x-go-type: json.RawMessage required: - op - path - value AppSubscriptionChange: description: Current state of latest AppSubscription change type: object properties: uuid: description: Uniquely identifies a change type: string type: description: Type of change type: string enum: - APP_SUBSCRIPTION_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 items: $ref: '#/components/schemas/AppSubscriptionChangeOperation' required: - type - updatedDateTime AppSubscription: description: App Subscription 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 x-order: 1 type: $ref: '#/components/schemas/AppSubscriptionType' uuid: description: Equinix-assigned access point identifier type: string 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' required: - type - source - target - project AppSubscriptionUpdateRequest: description: App Subscription Update Request type: array minItems: 1 items: $ref: '#/components/schemas/AppSubscriptionChangeOperation' AppSubscriptionSimpleExpression: type: object properties: 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 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 AppSubscriptionOrFilter: type: object properties: or: type: array maxItems: 3 items: $ref: '#/components/schemas/AppSubscriptionSimpleExpression' AppSubscriptionFilter: type: object anyOf: - $ref: '#/components/schemas/AppSubscriptionSimpleExpression' - $ref: '#/components/schemas/AppSubscriptionOrFilter' AppSubscriptionFilters: type: object properties: and: type: array maxItems: 8 items: $ref: '#/components/schemas/AppSubscriptionFilter' AppSubscriptionSortDirection: description: Sorting direction default: DESC type: string enum: - 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 format: string example: /changeLog/updatedDateTime AppSubscriptionSortCriteria: type: object properties: direction: $ref: '#/components/schemas/AppSubscriptionSortDirection' property: $ref: '#/components/schemas/AppSubscriptionSortBy' AppSubscriptionSearchRequest: type: object description: Search requests containing criteria properties: filter: $ref: '#/components/schemas/AppSubscriptionFilters' pagination: $ref: '#/components/schemas/PaginationRequest' sort: type: array items: $ref: '#/components/schemas/AppSubscriptionSortCriteria' AppSubscriptionSearchResponse: type: object properties: pagination: $ref: '#/components/schemas/Pagination' data: description: Data returned from the API call. type: array items: $ref: '#/components/schemas/AppSubscription' headers: ETag: description: response header - identifier for a specific version of a resource. schema: type: string x-tagGroups: - name: Core Connectivity tags: - Ports - Port Packages - Connections - Networks - Service Tokens - name: Cloud Routing & Policy tags: - Cloud Routers - Cloud Router Packages - Routing Protocols - Route Filters - Route Filter Rules - Route Aggregations - Route Aggregation Rules - name: Precision Time tags: - Precision Time Packages - Precision Time Services - name: Internet Access tags: - Internet Access Services - IP Blocks - ASNs - name: Internet Exchange tags: - Internet Exchange Services - name: Cross Connect tags: - Cross Connects - Loas - name: Optical Metro Connect tags: - Optical Metro Connects - name: Application Connect tags: - Application Domains - Application Services - Application Links - Application Subscriptions - Application Processors - name: Marketplace & Discovery tags: - Prices - Metros - Service Profiles - Company Profiles - Logos - Tags - Marketplace Subscriptions - name: Insights tags: - Streams - Stream Subscriptions - Stream Alert Rules - Metrics - Statistics - Events - Health