Equinix Connections API

Connections

OpenAPI Specification

equinix-connections-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Equinix API Authentication Connections API
  description: 'Equinix APIs use the OAuth 2.0 for authentication and authorization. Equinix supports the resource owner password and the client credentials flow.

    To begin, obtain OAuth 2.0 client credentials from the Equinix Developer Console under "My Apps". Then your client application  requests an access token from the Equinix API Authorization endpoint, extracts the access_token from the response, and sends the Bearer token to the API that you want to access'
  termsOfService: https://www.equinix.com/about/legal/terms
  contact:
    name: Equinix API Support
    url: https://docs.equinix.com/api-support.htm
  version: '1.2'
servers:
- url: https://api.equinix.com
tags:
- name: Connections
  description: Connections
paths:
  /fabric/v4/connections:
    post:
      tags:
      - Connections
      summary: Create Connection
      description: This API provides capability to create user's virtual connection
      operationId: createConnection
      parameters:
      - name: dryRun
        in: query
        description: option to verify that API calls will succeed
        required: false
        schema:
          type: boolean
          default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionPostRequest'
            examples:
              Colo2Colo-Dot1q2Dot1q:
                $ref: '#/components/examples/COLO2COLOwithDot1q-Dot1q'
              Colo2Colo-Dot1q2Dot1q-WithTerms:
                $ref: '#/components/examples/COLO2COLOwithDot1qAndTerms-Dot1q'
              Colo2Colo-Dot1q2Dot1q-CRH:
                $ref: '#/components/examples/COLO2COLOwithDot1q-Dot1q-CRH'
              Colo2Colo-Dot1q2Qinq:
                $ref: '#/components/examples/COLO2COLOwithDot1Q-QinQ'
              Colo2Colo-Qinq2Qinq:
                $ref: '#/components/examples/COLO2COLOwithQinq-Qinq'
              Colo2Colo-Qinq2Dot1q:
                $ref: '#/components/examples/COLO2COLOwithQinq-Dot1q'
              Colo2Colo-AsResellerForSubCustomer:
                $ref: '#/components/examples/COLO2COLO-AsReseller'
              Colo2Colo-MetroConnect:
                $ref: '#/components/examples/COLO2COLO-MetroConnect'
              Colo2Colo-Epl:
                $ref: '#/components/examples/COLO2COLO-EPL'
              Colo2Colo-Epl-With-Terms:
                $ref: '#/components/examples/COLO2COLO-EPL-Terms'
              Colo2Colo-AccessEpl:
                $ref: '#/components/examples/COLO2COLO-AccessEpl'
              Colo2Sp-Generic:
                $ref: '#/components/examples/COLO2SPwithDot1q'
              Colo2Sp-NetworkEdgeGeneric:
                $ref: '#/components/examples/COLO2SPwithDot1q'
              Colo2Sp-Alibaba:
                $ref: '#/components/examples/COLO2AlibabaSPwithDot1q'
              Colo2Sp-Aws-Primary:
                $ref: '#/components/examples/COLO2AWSSPwithDot1q-Primary'
              Colo2Sp-Azure-Primary:
                $ref: '#/components/examples/COLO2AzureSP-Primary'
              Colo2Sp-Google:
                $ref: '#/components/examples/COLO2GoogleSPwithDot1q'
              Colo2Sp-Ibm_1.0:
                $ref: '#/components/examples/COLO2IBM_1'
              Colo2Sp-Ibm_2.0:
                $ref: '#/components/examples/COLO2IBM_2'
              Colo2Sp-Oracle:
                $ref: '#/components/examples/COLO2OracleSPwithDot1q'
              Colo2ServiceToken:
                $ref: '#/components/examples/COLO2ServiceToken'
              Colo2Network-EVPLAN_VC:
                $ref: '#/components/examples/COLO2NETWORKwithDot1q'
              Colo2Network-EVPLAN_VC-With-Terms:
                $ref: '#/components/examples/COLO2NETWORKwithDot1qAndTerms'
              Colo2Network-EPLAN_VC:
                $ref: '#/components/examples/COLO2NETWORKwithEPL'
              Colo2Network-EPLAN_VC-With-Terms:
                $ref: '#/components/examples/COLO2NETWORKwithEPLAndTerms'
              Colo2Network-EVPTREE_VC:
                $ref: '#/components/examples/COLO2NETWORK_EVPTREE_withDot1q'
              Colo2Network-EVPTREE_VC-With-Terms:
                $ref: '#/components/examples/COLO2NETWORK_EVPTREE_withDot1qAndTerms'
              Colo2Network-EPTREE_VC:
                $ref: '#/components/examples/COLO2NETWORK_EPTREE_withEPL'
              Colo2Network-EPTREE_VC-With-Terms:
                $ref: '#/components/examples/COLO2NETWORK_EPTREE_withEPLAndTerms'
              Vd2Network:
                $ref: '#/components/examples/Vd2NETWORK'
              Vd2Sp-Aws:
                $ref: '#/components/examples/Vd2AwsSP'
              Vd2Sp-Azure:
                $ref: '#/components/examples/Vd2AzureSP'
              Vd2Sp-Oracle:
                $ref: '#/components/examples/Vd2OracleSP'
              Vd2Sp-IBM_1.0:
                $ref: '#/components/examples/Vd2Ibm_1'
              Vd2Sp-IBM_2.0:
                $ref: '#/components/examples/Vd2Ibm_2'
              Vd2Sp-Alibaba:
                $ref: '#/components/examples/Vd2AlibabaSP'
              Vd2Sp-Google:
                $ref: '#/components/examples/Vd2GoogleSP'
              Vd2Sp-Primary:
                $ref: '#/components/examples/Vd2Sp-Primary'
              Vd2Sp-Secondary:
                $ref: '#/components/examples/Vd2Sp-Secondary'
              Vd2Colo:
                $ref: '#/components/examples/Vd2Colo'
              Vd2Colo-vlanTag:
                $ref: '#/components/examples/Vd2Colo-VlanTag'
              Vd2Colo-vlanCTag:
                $ref: '#/components/examples/Vd2Colo-VlanCTag'
              Vd2ColoUntagged:
                $ref: '#/components/examples/Vd2ColoUntagged'
              Vd2ServiceToken:
                $ref: '#/components/examples/Vd2ServiceToken'
              Fcr2Colo:
                $ref: '#/components/examples/Fcr2Colo'
              Fcr2Sp-Google:
                $ref: '#/components/examples/Fcr2Sp-Google'
              Fcr2Sp-Azure:
                $ref: '#/components/examples/Fcr2Sp-Azure'
              Fcr2Sp-IBM:
                $ref: '#/components/examples/Fcr2Sp-IBM'
              Fcr2Sp-Generic:
                $ref: '#/components/examples/Fcr2Sp-Generic'
              Fcr2Sp-Generic-Redundant-Primary:
                $ref: '#/components/examples/Fcr2Sp-Generic'
              Fcr2Sp-Generic-Redundant-Secondary:
                $ref: '#/components/examples/Fcr2Sp-Generic-Redundant-Secondary'
              Fcr2Sp-Generic-Redundant-Primary-re-add:
                $ref: '#/components/examples/Fcr2Sp-Generic-Redundant-Primary'
              Fcr2Sp-Aws:
                $ref: '#/components/examples/Fcr2Sp-Aws'
              Fcr2Sp-Oracle:
                $ref: '#/components/examples/Fcr2Sp-Oracle'
              Fcr2Sp-Alibaba:
                $ref: '#/components/examples/Fcr2Sp-Alibaba'
              Fcr2Vd:
                $ref: '#/components/examples/Fcr2Vd'
              Fcr2Vd-Redundant-Secondary:
                $ref: '#/components/examples/Fcr2Vd-Redundant-Secondary'
              Fcr2IpWan:
                $ref: '#/components/examples/Fcr2IpWan'
              Fcr2Sp-Aws-Marketplace-subscription:
                $ref: '#/components/examples/Fcr2Sp-Aws-marketplaceSubscription'
              Fcr2MetalNetwork:
                $ref: '#/components/examples/Fcr2Metal-Network'
              Fcr2ServiceToken:
                $ref: '#/components/examples/Fcr2ServiceToken'
              AsideServiceToken2ColoWithDot1q:
                $ref: '#/components/examples/AsideServiceToken2PortWithDot1q'
              AsideServiceToken2ColoWithQinq:
                $ref: '#/components/examples/AsideServiceToken2PortWithQinq'
              AsideServiceToken2PrivateSP-NE:
                $ref: '#/components/examples/AsideServiceToken2PrivateSP-NE'
              AsideServiceToken2ZsideServiceToken:
                $ref: '#/components/examples/AsideServiceToken2ZsideServiceToken'
              Metal2Sp-Aws:
                $ref: '#/components/examples/Metal2Sp-Aws'
              Metal2Sp-Azure:
                $ref: '#/components/examples/Metal2Sp-Azure'
              Metal2Sp-GCP:
                $ref: '#/components/examples/Metal2Sp-GCP'
              Metal2Sp-Oracle:
                $ref: '#/components/examples/Metal2Sp-Oracle'
              Metal2Sp-IBM:
                $ref: '#/components/examples/Metal2Sp-IBM'
              Metal2Port-Dot1Q:
                $ref: '#/components/examples/Metal2Port-Dot1q'
              Metal2Port-QinQ:
                $ref: '#/components/examples/Metal2Port-Qinq'
              Metal2Port-ZsideServiceToken:
                $ref: '#/components/examples/Metal2ServiceToken'
              Metal2Sp-Generic:
                $ref: '#/components/examples/Metal2Sp-Generic'
              Vd2IASp:
                $ref: '#/components/examples/Vd2IAProfile-Request'
              Fcr2Metal-Network:
                $ref: '#/components/examples/Fcr2Metal-Network'
              Connection-Colo2Sp-GenericDryRunCreate:
                $ref: '#/components/examples/CreateConnectionDryRunRequest'
              IX2Sp-PublicPeering_VC:
                $ref: '#/components/examples/IXDedicatedPublicPeeringConnection'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
              examples:
                ConnectionDryRun-Colo2AWS:
                  $ref: '#/components/examples/CreateConnectionDryRunResponse-Colo2AWS'
                ConnectionDryRun-Colo2Azure:
                  $ref: '#/components/examples/CreateConnectionDryRunResponse-Colo2Azure'
                ConnectionDryRun-Colo2Google:
                  $ref: '#/components/examples/CreateConnectionDryRunResponse-Colo2Google'
                ConnectionDryRun-Colo2IBM:
                  $ref: '#/components/examples/CreateConnectionDryRunResponse-Colo2IBM'
                ConnectionDryRun-Colo2Network-EPLAN_VC:
                  $ref: '#/components/examples/CreateConnectionDryRunResponse-Colo2Network-EPLAN_VC'
                ConnectionDryRun-Colo2Network-EVPLAN_VC:
                  $ref: '#/components/examples/CreateConnectionDryRunResponse-Colo2Network-EVPLAN_VC'
                ConnectionDryRun-Colo2Sp-Generic:
                  $ref: '#/components/examples/CreateConnectionDryRunResponse-Colo2Sp-Generic'
                ConnectionDryRun-Fcr2Colo:
                  $ref: '#/components/examples/CreateConnectionDryRunResponse-Fcr2Colo'
                ConnectionDryRun-Fcr2Ipwan:
                  $ref: '#/components/examples/CreateConnectionDryRunResponse-Fcr2Ipwan'
                ConnectionDryRun-Fcr2Sp-Generic:
                  $ref: '#/components/examples/CreateConnectionDryRunResponse-Fcr2Sp-Generic'
                ConnectionDryRun-PortServiceToken2Port:
                  $ref: '#/components/examples/CreateConnectionDryRunResponse-PortServiceToken2Port'
        '201':
          description: Accept Connection Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
              examples:
                Colo2Sp:
                  $ref: '#/components/examples/ConnectionCreateResponse'
                Colo2Colo-MetroConnect:
                  $ref: '#/components/examples/COLO2COLO-MetroConnect-Response'
                Colo2Sp-Azure-Primary:
                  $ref: '#/components/examples/COLO2AzureSP-Primary-Response'
                Colo2Sp-Google:
                  $ref: '#/components/examples/COLO2GoogleSPwithDot1q-Response'
                Colo2Sp-Alibaba:
                  $ref: '#/components/examples/COLO2AlibabaSP-Response'
                Colo2Sp-IBM_1.0:
                  $ref: '#/components/examples/COLO2IBM_1'
                Colo2Sp-IBM_2.0:
                  $ref: '#/components/examples/COLO2IBM_2'
                Colo2Sp-Oracle:
                  $ref: '#/components/examples/COLO2OracleSP-Response'
                Vd2Sp:
                  $ref: '#/components/examples/Vd2Sp-Response'
                Vd2Token:
                  $ref: '#/components/examples/Vd2ServiceToken-Response'
                Vd2Colo:
                  $ref: '#/components/examples/Vd2Colo-Response'
                Vd2Colo-tag:
                  $ref: '#/components/examples/Vd2Colo-VlanTagResponse'
                Vd2ColoUntagged:
                  $ref: '#/components/examples/Vd2ColoUntagged-Response'
                Fcr2Sp:
                  $ref: '#/components/examples/Fcr2Sp-Response'
                Fcr2Colo:
                  $ref: '#/components/examples/Fcr2Colo-ResponseExample'
                Fcr2IpWan:
                  $ref: '#/components/examples/Fcr2IpWan-response'
                Fcr2Sp-Marketplace-subscription:
                  $ref: '#/components/examples/Fcr2Sp-marketplaceSubscription-Response'
                ServiceToken2PortResponseDot1Q:
                  $ref: '#/components/examples/AsideServiceToken2PortResponseWithDot1q'
                ServiceToken2PortResponseQinQ:
                  $ref: '#/components/examples/AsideServiceToken2PortResponseWithQinq'
                Metal2Sp-Aws:
                  $ref: '#/components/examples/Metal2Sp-Aws-Response'
                Metal2Sp-Azure:
                  $ref: '#/components/examples/Metal2Sp-Azure-Response'
                Metal2Sp-GCP:
                  $ref: '#/components/examples/Metal2Sp-GCP-Response'
                Metal2Sp-Oracle:
                  $ref: '#/components/examples/Metal2Sp-Oracle-Response'
                Metal2Sp-IBM:
                  $ref: '#/components/examples/Metal2Sp-IBM-Response'
                Metal2Port-Dot1Q:
                  $ref: '#/components/examples/Metal2Port-Dot1q-Response'
                Metal2Port-QinQ:
                  $ref: '#/components/examples/Metal2Port-Qinq-Response'
                Metal2Port-ZsideServiceToken:
                  $ref: '#/components/examples/Metal2ServiceToken-Response'
                Metal2Sp-Generic:
                  $ref: '#/components/examples/Metal2Sp-Generic-Response'
                Fcr2Metal-Network:
                  $ref: '#/components/examples/Fcr2Metal-Network'
                Colo2Network-EVPLAN_VC:
                  $ref: '#/components/examples/COLO2NETWORKwithDot1q-Response'
                Colo2Network-EVPLAN_VC-WithTerms:
                  $ref: '#/components/examples/COLO2NETWORKwithDot1qAndTerms-Response'
                Colo2Network-EPLAN_VC:
                  $ref: '#/components/examples/COLO2NETWORKwithEPL-Response'
                Colo2Network-EPLAN_VC-WithTerms:
                  $ref: '#/components/examples/COLO2NETWORKwithEPLAndTerms-Response'
                Colo2Network-EVPTREE_VC:
                  $ref: '#/components/examples/COLO2NETWORK_EVPTREE_withDot1q-Response'
                Colo2Network-EVPTREE_VC-WithTerms:
                  $ref: '#/components/examples/COLO2NETWORK_EVPTREE_withDot1qAndTerms-Response'
                Colo2Network-EPTREE_VC:
                  $ref: '#/components/examples/COLO2NETWORK_EPTREE_withEPL-Response'
                Colo2Network-EPTREE_VC-WithTerms:
                  $ref: '#/components/examples/COLO2NETWORK_EPTREE_withEPLAndTerms-Response'
                Vd2IASp:
                  $ref: '#/components/examples/Vd2IAProfile-Response'
                Vd2Network:
                  $ref: '#/components/examples/Vd2NETWORK-Response'
                Vd2Sp-Aws:
                  $ref: '#/components/examples/Vd2AwsSP-Response'
                Vd2Sp-Azure:
                  $ref: '#/components/examples/Vd2AzureSP-Response'
                Vd2Sp-Oracle:
                  $ref: '#/components/examples/Vd2OracleSP-Response'
                Vd2Sp-IBM_1.0:
                  $ref: '#/components/examples/Vd2Ibm_1'
                Vd2Sp-IBM_2.0:
                  $ref: '#/components/examples/Vd2Ibm_2'
                Vd2Sp-Alibaba:
                  $ref: '#/components/examples/Vd2AlibabaSP-Response'
                Vd2Sp-Google:
                  $ref: '#/components/examples/Vd2GoogleSP-Response'
                IX2Sp-PublicPeering_VC:
                  $ref: '#/components/examples/IXDedicatedPublicPeeringConnectionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/400'
                dryRun:
                  $ref: '#/components/examples/400_dry_run'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404'
        '405':
          description: Method not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/405'
  /fabric/v4/connections/{connectionId}:
    get:
      tags:
      - Connections
      summary: Get Connection by ID
      description: The API provides capability to get user's virtual connection details (Service Tokens, Access Points, Link Protocols, etc) by it's connection ID (UUID)
      operationId: getConnectionByUuid
      parameters:
      - name: connectionId
        in: path
        description: Connection Id
        required: true
        schema:
          $ref: '#/components/schemas/ConnectionId'
      - name: direction
        in: query
        description: Connection Direction
        required: false
        schema:
          $ref: '#/components/schemas/ConnectionDirection'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
              examples:
                nonGenericConnectionResponse:
                  $ref: '#/components/examples/NonGenericConnectionResponseExample'
                genericConnectionResponse:
                  $ref: '#/components/examples/GenericConnectionResponseExample'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/400_Invalid_id'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
              - errorCode: EQ-300005
                errorMessage: You don't have permissions to perform READ operation. Please contact your master administrator to get the right permissions through Equinix Customer Portal or contact Equinix Support (support@equinix.com).
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404'
    delete:
      tags:
      - Connections
      summary: Delete by ID
      description: Delete Connection by ID
      operationId: deleteConnectionByUuid
      parameters:
      - name: connectionId
        in: path
        description: Connection UUID
        required: true
        schema:
          $ref: '#/components/schemas/VirtualCircuitId'
      responses:
        '200':
          description: Delete Connection Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
              examples:
                connectionExample:
                  $ref: '#/components/examples/ConnectionDeletionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/400-delete'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403-delete'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404'
        '405':
          description: Method not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/405'
    patch:
      tags:
      - Connections
      summary: Update by ID
      description: Update Connection by ID
      operationId: updateConnectionByUuid
      parameters:
      - name: connectionId
        in: path
        description: Connection Id
        required: true
        schema:
          $ref: '#/components/schemas/ConnectionId'
      - name: dryRun
        in: query
        description: option to verify that API calls will succeed
        required: false
        schema:
          type: boolean
          default: false
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ConnectionUpdateRequest'
            examples:
              ConnectionUpdateNameRequest:
                $ref: '#/components/examples/ConnectionUpdateNameRequest'
              ConnectionUpdateBandwidthRequest:
                $ref: '#/components/examples/ConnectionUpdateBandwidthRequest'
              ConnectionUpdateTermLengthRequest:
                $ref: '#/components/examples/ConnectionUpdateTermLengthRequest'
              ConnectionAddAccessAndSecretKeyAWSRequest:
                $ref: '#/components/examples/ConnectionAddAccessAndSecretKeyAWSRequest'
              ConnectionMigrationAsideRequest:
                $ref: '#/components/examples/ConnectionMigrationAsideRequest'
              ConnectionUpdateNotificationEmailRequest:
                $ref: '#/components/examples/ConnectionUpdateNotificationEmailRequest'
              ConnectionMigrationAsideRequestForVirtualDevice:
                $ref: '#/components/examples/ConnectionMigrationAsideVirtualDeviceRequest'
              ConnectionUpdateBandwidthRequestDryRun:
                $ref: '#/components/examples/ConnectionUpdateBandwidthRequest'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
              examples:
                connectionPatchExampleDryRun:
                  $ref: '#/components/examples/ConnectionPatchResponseDryRun'
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
              examples:
                connectionPatchExample:
                  $ref: '#/components/examples/ConnectionPatchResponse'
                connectionUpdateTermLength:
                  $ref: '#/components/examples/ConnectionUpdateTermLengthResponse'
          links:
            Get Connection Details:
              operationId: getConnectionByUuid
              parameters:
                connectionId: $response.body#/uuid
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/400'
                dryRun:
                  $ref: '#/components/examples/400_dry_run'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404'
  /fabric/v4/connections/{connectionId}/actions:
    post:
      tags:
      - Connections
      summary: Connection Actions
      description: This API provides capability to accept/reject user's virtual connection
      operationId: createConnectionAction
      parameters:
      - name: connectionId
        in: path
        description: Connection Id
        required: true
        schema:
          $ref: '#/components/schemas/ConnectionId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionActionRequest'
            examples:
              ApproveGenericConnection:
                $ref: '#/components/examples/Connection_Creation_Acceptance'
              RejectGenericConnection:
                $ref: '#/components/examples/Connection_Creation_Rejection'
              ApproveBandwidthUpdate:
                $ref: '#/components/examples/Connection_Update_Acceptance'
              RejectBandwidthUpdate:
                $ref: '#/components/examples/Connection_Update_Rejection'
              AcceptDeleteConnection:
                $ref: '#/components/examples/Connection_Deletion_Acceptance'
              VcMigrationZSide:
                $ref: '#/components/examples/Connection_Update_Request_VC_Migration'
              BGPSync:
                $ref: '#/components/examples/Connection_Provider_Status_Request'
              GetProviderBandwidth:
                $ref: '#/components/examples/Connection_Provider_Bandwidth_Request'
              AcceptZSide-NetworkEdge:
                $ref: '#/components/examples/AcceptZSide_NetworkEdge_Request'
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionAction'
              examples:
                connectionActionExample:
                  $ref: '#/components/examples/ConnectionActionResponse'
                GetProviderBandwidth:
                  $ref: '#/components/examples/Connection_Provider_Bandwidth_Response'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/400'
                dryRun:
                  $ref: '#/components/examples/400_dry_run'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404'
  /fabric/v4/connections/search:
    post:
      tags:
      - Connections
      summary: Search connections
      description: The API provides capability to get list of user's virtual connections using search criteria, including optional filtering, pagination and sorting
      operationId: searchConnections
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
            examples:
              ConnectionSearchDirection:
                $ref: '#/components/examples/ConnectionSearchDirection'
              ConnectionSearchIsremote:
                $ref: '#/components/examples/ConnectionSearchIsremote'
              ConnectionSearchName:
                $ref: '#/components/examples/ConnectionSearchName'
              ConnectionSearchUuid:
                $ref: '#/components/examples/ConnectionSearchUuid'
              ConnectionSearchCustorg:
                $ref: '#/components/examples/ConnectionSearchCustorg'
              ConnectionSearchAccountname:
                $ref: '#/components/examples/ConnectionSearchAccountname'
              ConnectionSearchCloudRouteruuid:
                $ref: '#/components/examples/ConnectionSearchCloudRouteruuid'
              ConnectionSearchAsidevlanstagctag:
                $ref: '#/components/examples/ConnectionSearchAsidevlanstagctag'
              ConnectionSearchAsidemetrocodemetroname:
                $ref: '#/components/examples/ConnectionSearchAsidemetrocodemetroname'
              ConnectionSearchAsideaccesspointname:
                $ref: '#/components/examples/ConnectionSearchAsideaccesspointname'
              ConnectionSearchAsideaccesspointuuid:
                $ref: '#/components/examples/ConnectionSearchAsideaccesspointuuid'
              ConnectionSearchAsideaccesspointtype:
                $ref: '#/components/examples/ConnectionSearchAsideaccesspointtype'
              ConnectionSearchAsidevirtualdevicename:
                $ref: '#/components/examples/ConnectionSearchAsidevirtualdevicename'
              ConnectionSearchAsidevirtualdeviceuuid:
                $ref: '#/components/examples/ConnectionSearchAsidevirtualdeviceuuid'
              ConnectionSearchAsideservicetokenuuid:
                $ref: '#/components/examples/ConnectionSearchAsideservicetokenuuid'
              ConnectionSearchChangestatus:
                $ref: '#/components/examples/ConnectionSearchChangestatus'
              ConnectionSearchUpdatedatetime:
                $ref: '#/components/examples/ConnectionSearchUpdatedatetime'
              ConnectionSearchEquinixstatus:
                $ref: '#/components/examples/ConnectionSearchEquinixstatus'
              ConnectionSearchProviderstatus:
                $ref: '#/components/examples/ConnectionSearchProviderstatus'
              ConnectionSearchProjectid:
                $ref: '#/components/examples/ConnectionSearchProjectidOPtional-CRH'
              ConnectionSearchRedundancygroup:
                $ref: '#/components/examples/ConnectionSearchRedundancygroup'
              ConnectionSearchRedundancypriority:
                $ref: '#/components/examples/ConnectionSearchRedundancypriority'
              ConnectionSearchZsidevlanstagctag:
                $ref: '#/components/examples/ConnectionSearchZsidevlanstagctag'
              ConnectionSearchZsidemetrocodemetroname:
                $ref: '#/components/examples/ConnectionSearchZsidemetrocodemetroname'
              ConnectionSearchZsideaccesspointname:
                $ref: '#/components/examples/ConnectionSearchZsideaccesspointname'
              ConnectionSearchZsideaccesspointuuid:
                $ref: '#/components/examples/Connect

# --- truncated at 32 KB (298 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/equinix/refs/heads/main/openapi/equinix-connections-api-openapi.yml