Get Specified Service Profile - Parameters Mapping
This API returns a specified service profile.
Buyer perspective
v3 request
curl -X
GET 'https://api.equinix.com/ecx/v3/l2/serviceprofiles/services/3c5d81c1-4301-4d7a-aba1-3a0bf237f6c1'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
v4 request
curl -X
GET 'https://api.equinix.com/fabric/v4/serviceProfiles/3c5d81c1-4301-4d7a-aba1-3a0bf237f6c1&viewPoint=aSide'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'ic-version: v4.2'
| v3 API request | v4 API request | Description |
| GET /ecx/v3/l2/serviceprofiles/services/{uuid} | GET /fabric/v4/serviceProfiles/{uuid} | Request: v3 API uses a dedicated endpoint to return service profile details relevant for subscribers while the v4 API introduces the viewPoint parameter that specifies the relevant data set. The v4 API requires the ic-version header parameter. Response: The v3 and the v4 service profile objects have different structure and parameters' names. |
Seller perspective
v3 request
curl -X
GET 'https://api.equinix.com/ecx/v3/l2/serviceprofiles/3c5d81c1-4301-4d7a-aba1-3a0bf237f6c1'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
v4 request
curl -X
GET 'https://api.equinix.com/fabric/v4/serviceProfiles/3c5d81c1-4301-4d7a-aba1-3a0bf237f6c1&viewPoint=zSide'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'ic-version: v4.2'
| v3 API request | v4 API request | Description |
| GET /ecx/v3/l2/serviceprofiles/{uuid} | GET /fabric/v4/serviceProfiles/{uuid} | Request: v3 API uses a dedicated endpoint to return service profile details relevant for service providers while the v4 API introduces the viewPoint parameter that specifies the relevant data set. The v4 API requires the ic-version header parameter. Response: The v3 and the v4 service profile objects have different structure and parameters' names. |
Response
v3 request
{
"uuid": "3c5d81c1-4301-4d7a-aba1-3a0bf237f6c1",
"name": "NVK-PDS-SP-255",
"connectionNameLabel": "Connection",
"requiredRedundancy": false,
"allowCustomSpeed": false,
"speedBands": [
{
"speed": 50,
"unit": "MB"
},
{
"speed": 200,
"unit": "MB"
},
{
"speed": 500,
"unit": "MB"
},
{
"speed": 1000,
"unit": "MB"
}
],
"metros": [
{
"code": "SV",
"name": "Silicon Valley",
"ibxs": [
"SV5"
],
"displayName": "Silicon Valley"
},
{
"code": "DC",
"name": "Ashburn",
"ibxs": [
"DC11"
],
"displayName": "Ashburn"
}
],
"createdDate": "2018-12-07T13:31:58.525Z",
"createdBy": "John-Doe",
"lastUpdatedDate": "2018-12-07T13:58:28.258Z",
"lastUpdatedBy": "John-Doe",
"vlanSameAsPrimary": false,
"tagType": "CTAG",
"apiAvailable": false,
"selfProfile": false,
"speedFromAPI": false,
"profileEncapsulation": "Qinq",
"authorizationKey": "[a-z|A-z|0-9]",
"organizationName": "John-Doe-Corp",
"private": false,
"features": {
"cloudReach": true,
"testProfile": false
}
}
v4 request
{
"data": [
{
"state": "ACTIVE",
"account": {
"organizationName": "John-Doe-Corp",
"globalOrgId": "0016u000003JZ4xAAG"
},
"changeLog": {
"createdBy": "John-Doe",
"createdByFullName": "John Doe",
"createdByEmail": "jd@equinix.com",
"createdDateTime": "2022-04-05T20:50:36.236Z",
"updatedBy": "eqx-admin",
"updatedByFullName": "eqx-admin eqx-admin",
"updatedByEmail": "eqx-admin@equinix.com",
"updatedDateTime": "2022-04-05T20:54:15.139Z"
},
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/3c5d81c1-4301-4d7a-aba1-3a0bf237f6c1?viewPoint=aSide",
"type": "L2_PROFILE",
"name": "NVK-PDS-SP-255",
"uuid": "3c5d81c1-4301-4d7a-aba1-3a0bf237f6c1",
"description": "<p>QA3 TEST</p>",
"visibility": "PUBLIC",
"accessPointTypeConfigs": [
{
"type": "COLO",
"uuid": "c85e5938-988b-494d-8d66-cd03a7883fca",
"supportedBandwidths": [
50,
200,
500,
1000
],
"allowRemoteConnections": true,
"allowCustomBandwidth": false,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {
"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "QINQ"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"apiConfig": {
"apiAvailable": false,
"integrationId": "",
"bandwidthFromApi": false
},
"connectionLabel": "Connection",
"authenticationKey": {
"required": false
}
},
{
"type": "COLO",
"uuid": "c85e5938-988b-494d-8d66-cd03a7883fca",
"supportedBandwidths": [
50,
200,
500,
1000
],
"allowRemoteConnections": true,
"allowCustomBandwidth": false,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {
"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "QINQ"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"apiConfig": {
"apiAvailable": false,
"bandwidthFromApi": false
},
"connectionLabel": "Connection",
"authenticationKey": {
"required": false
}
}
],
"marketingInfo": {
"promotion": true
},
"metros": [
{
"code": "SV",
"name": "Silicon Valley",
"ibxs": [
"SV5"
],
"displayName": "Singapore"
},
{
"code": "DC",
"name": "Ashburn",
"ibxs": [
"DC11"
],
"displayName": "Ashburn"
}
],
"selfProfile": false
}
],
"pagination": {
"offset": 0,
"limit": 2,
"total": 51,
"next": "/serviceProfiles?offset=2&limit=2"
}
}
| v3 parameter | v4 parameter | Example | Description |
| - | state | ACTIVE | New parameter specifying the service profile lifecycle stage. |
| - | account | - | New container object for billing account information. |
| organizationName | account.organizationName | pmSuveer-270163 | Equinix-assigned organization name. |
| - | account.globalOrgId | 0016u000003JZ4xAAG | Equinix-assigned top-level organization identifier. |
| - | changeLog | - | New container object for changelog information. |
| createdBy | changeLog.createdBy | pmSuveer | Identity of the asset creator. |
| - | changeLog.createdByFullName | pmSuveer pmSuveer | Full name of the asset creator. |
| - | changeLog.createdByEmail | pmSuveer@equinix.com | Email address of the asset creator. |
| createdDate | changeLog.createdDateTime | 2022-04-05T20:50:36.236Z | Asset creation timestamp in the IETF ISO 8601 extended date/time format. |
| lastUpdatedBy | changeLog.updatedBy | eqx-admin | Identity of the person who updated the asset. |
| - | changeLog.updatedByFullName | eqx-admin eqx-admin | Full name of the person who updated the asset. |
| - | changeLog.updatedByEmail | eqx-admin@equinix.com | Email address of the person who updated the asset. |
| lastUpdatedDate | changeLog.updatedDateTime | 2022-04-05T20:54:15.139Z | Asset update timestamp in the IETF ISO 8601 extended date/time format. |
| - | href | https://api.equinix.com/fabric/v4/serviceProfiles/ 3c5d81c1-4301-4d7a-aba1-3a0bf237f6c1?viewPoint=aSide | New parameter specifying the absolute URL that returns details of the given asset. |
| - | type | L2_PROFILE | New parameter defining connection type, introduced to support new use cases. L2_PROFILE - layer 2 service profile for establishing connections in layer 2 of the OSI networking model. L3_PROFILE - layer 3 service profile for establishing connections in layer 2 of the OSI networking model. |
| name | name | NVK-PDS-SP-255 | Service profile name. |
| uuid | uuid | 3c5d81c1-4301-4d7a-aba1-3a0bf237f6c1 | Equinix-assigned service profile identifier. |
| - | description | <p>QA3 TEST</p> | Service description. |
| private | visibility | PUBLIC | New parameter for specifying service profile's accessability. PUBLIC - Public service profiles are listed on the Equinix Fabric portal allowing anyone to establish connections to advertised services. PRIVATE - Establishing a connection based on a private service profile requires provider's authorization. |
| - | accessPointTypeConfigs | - | New container object supporting multiple access points definitions. |
| - | accessPointTypeConfigs[0].type | COLO | New parameter for specifying access point type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. |
| - | accessPointTypeConfigs[0].uuid | c85e5938-988b-494d-8d66-cd03a7883fca | Access point identifier. |
| speedBands | accessPointTypeConfigs[0].supportedBandwidths | [50,200,500,1000] | In the v4 API, available connection bandwidths is specified in an array of integers while the v3 API defines available values as an array of objects. |
| speedBands[0].speed | - | 50 | - |
| speedBands[0].unit | - | MB | In the v4 API, the connection bandwidth is specified in Mbps while in the v3 API, the connection bandwidth unit was specified in a separate parameter. |
| features | - | - | An object containing feature-related information such as cloudReach, testProfile, etc. |
| features.cloudReach | accessPointTypeConfigs[0].allowRemoteConnections | true | Authorization to establish connections from remote locations. |
| features.testProfile | - | false | The v4 API introduces type parameter with TEST being one of the applicable values. |
| allowCustomSpeed | accessPointTypeConfigs[0].allowCustomBandwidth | false | Authorization to set a custom connection bandwidth. |
| - | accessPointTypeConfigs[0].allowBandwidthAutoApproval | false | New parameter indicating if bandwidth change requests are approved automatically. |
| - | accessPointTypeConfigs[0].linkProtocolConfig | - | New container object for settings and preferences for the link protocol used at the access point. |
| tagType | accessPointTypeConfigs[0].linkProtocolConfig.encapsulationStrategy | CTAGED | Specifies additional tagging information required by the service provider. |
| - | accessPointTypeConfigs[0].linkProtocolConfig.reuseVlanSTag | false | Automatically accept subsequent DOT1Q to QINQ connections that use the same authentication key. These connections will have the same VLAN S-tag assigned as the initial connection. |
| profileEncapsulation | accessPointTypeConfigs[0].linkProtocolConfig.encapsulation | QINQ | Data frames encapsulation standard. |
| - | accessPointTypeConfigs[0].enableAutoGenerateServiceKey | false | Applicable to Verizon Software Defined Interconnect service profile. |
| requiredRedundancy | accessPointTypeConfigs[0].connectionRedundancyRequired | false | Indicates if connecting to the service requires creating a pair of redundant connections. |
| - | accessPointTypeConfigs[0].apiConfig | - | New object container for API specific configuration. |
| apiAvailable | accessPointTypeConfigs[0].apiConfig.apiAvailable | false | Indicates whether the service profile has been integrated via APIs with Equinix for automated provisioning of connections. |
| speedFromAPI | accessPointTypeConfigs[0].apiConfig.bandwidthFromApi | false | Indicates whether the bandwidth of the connection can be obtained directly from the cloud service provider. |
| connectionNameLabel | accessPointTypeConfigs[0].connectionLabel | Connection | An alternative term for connection in case it's different in your organization. |
| authorizationKey | accessPointTypeConfigs[0].authenticationKey | - | Authentication key configuration. |
| - | accessPointTypeConfigs[0].authenticationKey.required | false | Requirement to provide an authentication key. |
| - | marketingInfo | - | New object container for optional service profile branding, such as the customer's logo. |
| - | marketingInfo.promotion | true | New parameter for authorization to promote the given service profile on Equinix website and other products. |
| metros | metros | - | Locations where subscribers can access services available through the given service profile. |
| metros[0].code | metros[0].code | SV | Metropolitan area identifier. |
| metros[0].name | metros[0].name | Silicon Valley | Metropolitan area name. |
| metros[0].ibxs | metros[0].ibxs | ["SV5"] | List of IBX data centers within the given metro where subscribers can access services provided by the given service profile. |
| metros[0].displayName | metros[0].displayName | Silicon Valley | Metropoiltan area name displayed on the service profile in the Equinix Fabric portal. |
| selfProfile | selfProfile | false | Indicates if the service profile and the user interacting with the API belong to the same organization. |
| vlanSameAsPrimary | - | false | Indicates whether the same VLAN can be used for both primary and secondary connections, not present in the v4 API. |