Service Profiles
Create Service Profile
| POST /fabric/v4/serviceProfiles | |
|---|---|
| Method | POST |
| URL or Endpoint | /fabric/v4/serviceProfiles |
| Headers | authorization, content-type, ic-version |
| Path Parameters | Not applicable |
| Query Parameters | Not applicable |
| Body Parameters | type, name, description, notifications, visibility, allowedEmails, tags, accessPointTypeConfigs, customFields, marketingInfo, ports |
This API request creates a service profile, which enables other Platform Equinix participants to connect and subscribe to your services.
Sample curl request
Copy
curl -X
POST 'https://api.equinix.com/fabric/v4/serviceProfiles'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'content-type: application/json'
-H 'ic-version: v4.2'
-d '{
"name": "Service Profile 1",
"description": "Sample_description",
"type": "L2_PROFILE",
"notifications": [
{
"emails": [
"someone@sample.com"
],
"type": "BANDWIDTH_ALERT"
}
],
"visibility": "PUBLIC",
"allowedEmails": [
"test@equinix.com",
"testagain@equinix.com"
],
"ports": [
{
"uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
"type": "XF_PORT",
"location": {
"metroCode": "SY"
}
}
],
"marketingInfo": {
"promotion": true
},
"accessPointTypeConfigs": [
{
"type": "COLO",
"connectionRedundancyRequired": false,
"allowBandwidthAutoApproval": false,
"allowRemoteConnections": false,
"connectionLabel": "Connection",
"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
]
}
]
}' Header parameters
| Parameter | Mandatory | Data Type | Example Values | Applicable Values | Description |
|---|---|---|---|---|---|
| authorization | yes | string | Bearer qwErtY8zyW1abcdefGHI | - | API request authorization token. |
| content-type | yes | string | application/json | application/json | Specifies the resource media type. |
| ic-version | yes | string | v4.2 | v4.2 | API version specifier. |
Body parameters
| Parameter | Type | Mandatory | Example | Applicable values | Description |
| name | string | yes | A-to-Z |
Maximum: 50 characters Allowed characters: alpha-numeric, hyphens ('-'), underscores ('_') and white spaces (' '). |
Service profile name. |
| description | string | yes | A-to-Z services for your daily cloud needs. Han Solo approved. | Maximum: 375 characters | Service description. |
| type | string | yes | L2_PROFILE | L2_PROFILE L3_PROFILE |
Service profile type. 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. |
| notifications | object | no | - | - | Notification preferences and a list of recipients. |
| visibility | string | yes | PRIVATE | PRIVATE PUBLIC |
Service profile visibility. 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. |
| allowedEmails | array[string] | no | ["darth@vader.com","han@solo.com"] | - | Email addresses of users allowed to establish connections based on this service profile. Applicable to PRIVATE visibility service profiles. |
| tags | array[string] | no | SaaS | - | Labels identifying the type of the services advertised by given service profile. |
| ports | array[object] | no | - | - | Ports associated with the given service profile. |
| accessPointTypeConfigs | array[object] | yes | - | - | Available access points types. |
| customFields | array[object] | no | - | - | User-defined fields added to a service profile. |
| marketingInfo | object | no | - | - | Optional service profile branding, such as the customer's logo. |
| notifications | |||||
| emails | array[string] | no | ["l3qa1user1@equinix.com"] | - | List of receipients of a given type of notification. |
| type | string | no | BANDWIDTH_ALERT |
BANDWIDTH_ALERT CONNECTION_APPROVAL PROFILE_LIFECYCLE |
Notification type. BANDWIDTH_ALERT - Bandwidth alert threshold has been reached. CONNECTION_APPROVAL - Connection request awaiting approval. PROFILE_LIFECYCLE - Service profile lifecycle has changed. |
| ports | |||||
| type | string | yes | XF_PORT | COLO VD |
Port type. |
| uuid | string | yes | cecd1039-eadd-add3-31e0-387a5c00aeb9 | - | Equinix-assigned port identifier. |
| accessPointTypeConfigs | |||||
| type | string | no | COLO | COLO VD |
Connection endpoint type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. |
| connectionRedundancyRequired | boolean | no | false | - | Requirement to configure a redundant connection. |
| allowBandwidthAutoApproval | boolean | no | false | true false |
Parameter indicating if bandwidth change requests are approved automatically. |
| allowRemoteConnections | boolean | no | true | true false |
Authorization to establish connections from remote locations. |
| connectionLabel | string | no | Connection | - | An alternative term for connection in case it's different in your organization. |
| enableAutoGenerateServiceKey | boolean | no | false | true false |
Applicable to Verizon Software Defined Interconnect service profile. |
| bandwidthAlertThreshold | integer | no | 75 | Maximum: 100 | Send a bandwidth usage alert when the percentage value of the total bandwidth of the ports associated with the given service profile has been consumed by your subscribers. |
| allowCustomBandwidth | boolean | no | true | true false |
Authorization to set a custom connection bandwidth. |
| apiConfig | object | - | - | API configuration settings and preferences. | |
| authenticationKey | object | no | - | - | Authentication key configuration. |
| supportedBandwidths | array[integer] | no | [200,500,700,1000] | - | Allowed connection bandwidths (Mbps). |
| accessPointTypes.apiConfig | |||||
| apiAvailable | boolean | no | false | true false |
Authorization to establish connections with this service profile using API. |
| equinixManagedPort | boolean | no | false | true false |
Setting indicating that the port is managed by Equinix. |
| equinixManagedVlan | boolean | no | false | true false |
Setting indicating that the VLAN is managed by Equinix. |
| allowOverSubscription | boolean | no | false | true false |
Allow services sales to exceed the available network bandwidth. |
| overSubscriptionLimit | integer | no | 1 |
Minimum: 1 Maximum: 20 |
Port bandwidth multiplier that determines the total bandwidth that
can be allocated to users creating connections to your services. For example, a 10 Gbps port combined with an overSubscriptionLimit parameter value of 10 allows your subscribers to create connections with a total bandwidth of 100 Gbps. |
| bandwidthFromApi | boolean | no | false | true false |
Indicates if the connection bandwidth can be obtained directly from the cloud service provider. |
| accessPointTypeConfigs.authenticationKey | |||||
| required | boolean | no | true | true false |
Requirement to provide an authentication key. |
| label | string | no | Cloud Account ID | - | Name of the parameter that must be provided to authorize the connection. |
| description | string | no | XYZ | - | Description to help subscribers identify their authentication key. |
| customFields | |||||
| label | string | yes | ASN | - | Label under which a custom parameter is presented on the Equnix Fabric portal or exposed through an API. |
| description | string | yes | Excluded ASNs: 0, 13884, 36351, 64512, 64513, 65100, 65201–65234, 65402–65433, 65500, and 4201065000–4201065999. | - | Custom parameter description. |
| required | boolean | no | true | true false |
Indicates if a given custom field is mandatory. |
| dataType | string | yes | INTEGER | INTEGER STRING |
Custom field data type. INTEGER - Integer. STRING - String. |
| captureInEmail | boolean | no | false | true false |
Capture the input value and include it in the email notification. |
| marketingInfo | |||||
| promotion | boolean | no | true | true false |
Authorization to promote the given service profile on Equinix website and other products. |
| processSteps | array[object] | no | - | - | A data structure describing the steps necessary to establish connection to the given service provider. |
| marketingInfo.processSteps | |||||
| title | string | no | CreateEquinixFabricConnection | - | Step title. |
| subTitle | string | no | ontheEquinixFabric | - | Step's subtitle. |
| description | string | no | Some very creative and descriptive description. | - | Details of the actions which must be taken to complete the given step. |
If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.
Sample response
Copy
{
"state": "PENDING_APPROVAL",
"account": {
"orgId": 91785,
"globalOrgId": "0016u000003JZ4tAAG"
},
"changeLog": {
"createdDateTime": {}
},
"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"
]
}
],
"visibility": "PUBLIC",
"allowedEmails": [
"test@equinix.com",
"testagain@equinix.com"
],
"accessPointTypeConfigs": [
{
"type": "COLO",
"uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
"supportedBandwidths": [
100,
500
],
"allowRemoteConnections": false,
"allowCustomBandwidth": true,
"bandwidthAlertThreshold": 10,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {
"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"apiConfig": {
"apiAvailable": false,
"equinixManagedPort": true,
"equinixManagedVlan": true,
"allowOverSubscription": false,
"overSubscriptionLimit": 1,
"bandwidthFromApi": false
},
"connectionLabel": "true1",
"authenticationKey": {
"required": false,
"label": "Service Key"
}
}
],
"marketingInfo": {
"promotion": true
},
"ports": [
{
"type": "XF_PORT",
"uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
"location": {
"href": "https://api.equinix.com/fabric/v4/metros/SY",
"metroCode": "SY"
}
}
],
"metros": [
{
"code": "SY",
"ibxs": [
"SY4"
]
}
]
}Response payload body description
Response payload includes configuration parameters defined in the request body. The following table contains descriptions of additional information included in the response payload. For descriptions of the remaining fields, refer to the Body parameters section.
| Parameter | Type | Example | Description |
| state | string | PENDING_APPROVAL |
Service profile lifecycle stage. ACTIVE - Service profile is active and enables establishing connections. DELETED - Service profile has been deleted. PENDING APPROVAL - Service profile awaiting administrator approval. REJECTED - Service profile has been rejected by the administrator. |
| account | object | - | Customer account information. |
| changeLog | object | - | A permanent record of asset creation, modification, or deletion. |
| href | string | https://api.equinix.com/fabric/v4/serviceProfiles/ 57186196-505d-4075-80f5-60e819e30310 | An absolute URL that returns complete specification for the given entity. |
| uuid | string | 57186196-505d-4075-80f5-60e819e30310 | Equinix-assigned service profile identifier. |
| accessPointTypeConfigs | array[object] | - | Available access points types. |
| ports | array[object] | - | Ports associated with the given service profile. |
| metros | array[object] | - | Locations where subscribers can access services available through the given service profile. |
| account | |||
| orgId | string | 92214 | Equinix-assigned organization identifier. |
| organizationName | string | testBuyer-270001 | Equinix-assigned organization name. |
| globalOrgId | string | 0016C00000UlveoQAB | Equinix-assigned top-level organization identifier associated with the specified service profile. |
|
globalOrganizationName |
string | Cloud | Equinix-assigned top-level organization name associated with the specified service profile. |
| changeLog | |||
| createdDateTime | string | 2022-01-04T13:31:31.814Z | Asset creation timestamp. |
| accessPointTypeConfigs | |||
| uuid | string | f20c49cd-b022-4aeb-b3e4-49db4389aff3 | Equinix-assigned access point identifier. |
| ports | |||
| location | object | - | Attributes associated with the specified asset location. |
| ports.location | |||
| href | string | https://api.equinix.com/fabric/v4/metros/SY | An absolute URL that returns complete specification for the given entity. |
| metroCode | string | SY | Metropolitan area identifier. |
| metros | |||
| code | string | SV | Metropolitan area identifier. |
| name | string | Silicon Valley | Metropolitan area name. |
| ibxs | array[string] | ["SV5","SV1"] | List of IBX data centers within the given metro where subscribers can access services provided by the given service profile. |
| displayName | string | Silicon Valley | Metropoiltan area name displayed on the service profile in the Equinix Fabric portal. |
Get Service Profiles
| GET /fabric/v4/serviceProfiles | |
|---|---|
| Method | GET |
| URL or Endpoint | /fabric/v4/serviceProfiles |
| Headers | authorization, ic-version |
| Path Parameters | Not applicable |
| Query Parameters | offset, limit, viewPoint, style |
| Body Parameters | Not applicable |
This API request retrieves service profiles available on Equinix Platform. Service profiles define the services offered by service providers enabling other participants to find and connect to them.
Sample curl request
Copy
curl -X
GET 'https://api.equinix.com/fabric/v4/serviceProfiles'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'ic-version: v4.2'Header parameters
| Parameter | Mandatory | Data Type | Example Values | Applicable Values | Description |
|---|---|---|---|---|---|
| authorization | yes | string | Bearer qwErtY8zyW1abcdefGHI | - | API request authorization token. |
| ic-version | yes | string | v4.2 | v4.2 | API version specifier. |
Query parameters
| Parameter | Mandatory | Type | Example | Applicable values | Description |
|---|---|---|---|---|---|
| offset | no | integer | 2 | Default: 0 | Index of the first item returned in the response. |
| limit | no | integer | 30 | Default: 20 | Maximum number of items returned per page, starting from the index denoted by the offset item. |
| viewPoint | no | string | aSide | aSide zSide Default: aSide |
Returns service profile data set with parameters relevant to a buyer (aSide) or a seller (zSide). |
If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.
Sample response
Copy
{
"data": [
{
"state": "ACTIVE",
"account": {
"organizationName": "l3-qa-1-270253"
},
"changeLog": {
"createdBy": "l3qa1user1",
"createdByFullName": "l3qa1user1 l3qa1user1",
"createdByEmail": "l3qa1user1@equinix.com",
"createdDateTime": {},
"updatedBy": "eqx-admin",
"updatedByFullName": "eqx-admin eqx-admin",
"updatedByEmail": "eqx-admin@equinix.com",
"updatedDateTime": {}
},
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/c2ba267e-0168-4254-93a2-32487de4ed7c?viewPoint=aSide",
"type": "L2_PROFILE",
"name": "E2E-SPHL2Name-060422130614789",
"uuid": "c2ba267e-0168-4254-93a2-32487de4ed7c",
"description": "<p>E2E-This is SPH Description With <a href=\"https://qa3fabric.corp.equinix.com/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Hyperlink</a>-060422130617254</p>",
"tags": [
"SaaS",
"IaaS"
],
"visibility": "PUBLIC",
"accessPointTypeConfigs": [
{
"type": "COLO",
"uuid": "d68c95c1-f289-4b52-8aee-7f4e2660e070",
"supportedBandwidths": [
50,
200,
500,
1000
],
"allowRemoteConnections": true,
"allowCustomBandwidth": false,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {
"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"apiConfig": {
"apiAvailable": false,
"integrationId": "",
"bandwidthFromApi": false
},
"connectionLabel": "Connection",
"authenticationKey": {
"required": false
}
}
],
"marketingInfo": {
"promotion": true
},
"metros": [
{
"code": "DA",
"name": "Dallas",
"ibxs": [
"DA1"
],
"displayName": "Dallas"
}
],
"selfProfile": false
}
],
"pagination": {
"offset": 0,
"limit": 1,
"total": 52,
"next": "/serviceProfiles?offset=1&limit=1"
}
}Response payload body description
| Parameter | Type | Example | Description |
| data | object | - | Data array containing data model entities. |
| pagination | object | - | An absolute URL that returns the specified connection. |
| data | |||
| state | string | ACTIVE |
Service profile lifecycle stage. ACTIVE - Service profile is active and enables establishing connections. DELETED - Service profile has been deleted. PENDING APPROVAL - Service profile awaiting administrator approval. REJECTED - Service profile has been rejected by the administrator. |
| account | object | - | Customer account information. |
| changeLog | object | - | A permanent record of asset creation, modification, or deletion. |
| href | string | https://api.equinix.com/fabric/v4/serviceProfiles/ 57186196-505d-4075-80f5-60e819e30310 | An absolute URL that returns complete specification for the given entity. |
| type | string | L2_PROFILE |
Service profile type. 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 | string | E2E-SPHL2Name-040122133102496 | Service profile name. |
| uuid | string | d48daade-4c18-446d-9c4d-92f6e2f93f55 | Equinix-assigned service profile identifier. |
| description | string | E2E-This is SPH Description [...] | Service description. |
| notifications | object | - |
Notification preferences and a list of recipients. Applicable for viewPoint query parameter set to zSide. |
| tags | array[string] | SaaS | Labels identifying the type of the services advertised by given service profile. |
| visibility | string | PRIVATE |
Service profile visibility. 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. |
| allowedEmails | array[string] | ["darth@vader.com","han@solo.com"] | Email addresses of users allowed to establish connections based on this service profile. |
| accessPointTypeConfigs | array[object] | - | Available access points types. |
| customFields | array[object] | - | User-defined fields added to a service profile. |
| marketingInfo | object | - | Optional service profile branding, such as the customer's logo. |
| ports | array[object] | - |
Ports associated with the given service profile. Applicable for viewPoint query parameter set to zSide. |
| metros | array[object] | - | Locations where subscribers can access services available through the given service profile. |
| selfProfile | boolean | true |
Indicates if the service profile and the user interacting with the
API belong to the same organization. Applicable for viewPoint query parameter set to aSide. |
| data.account | |||
| orgId | string | 92214 |
Equinix-assigned organization identifier. Applicable for viewPoint query parameter set to zSide. |
| organizationName | string | testBuyer-270001 | Equinix-assigned organization name. |
| globalOrgId | string | 0016C00000UlveoQAB | Equinix-assigned top-level organization identifier associated with the specified service profile. |
|
globalOrganizationName |
string | Cloud | Equinix-assigned top-level organization name associated with the specified service profile. |
| data.changeLog | |||
| createdBy | string | testBuyer999 | Identity of the asset creator. |
| createdDateTime | string | 2022-01-04T13:31:31.814Z | Asset creation timestamp. |
| updatedBy | string | eqx-admin999 | Identity of the person who updated the asset. |
| updatedDateTime | string | 2022-01-04T13:31:45.981Z | Asset update request timestamp. |
| createdByEmail | string | testBuyer999@equinix.com | Email address of the asset creator. |
| updatedByEmail | string | eqx-admin999@equinix.com | Email address of the person who updated the asset. |
| createdByFullName | string | testBuyer999 testBuyer999 | First and last name of the asset creator. |
| updatedByFullName | string | eqx-admin999 eqx-admin999 | First and last name of the person who updated the asset. |
| data.notifications | |||
| emails | array[string] | ["l3qa1user1@equinix.com"] | List of receipients of a given type of notification. |
| type | string | BANDWIDTH_ALERT |
Notification type. BANDWIDTH_ALERT - Bandwidth alert threshold has been reached. CONNECTION_APPROVAL - Connection request awaiting approval. PROFILE_LIFECYCLE - Service profile lifecycle has changed. |
| data.accessPointTypeConfigs | |||
| type | string | COLO |
Access point type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. |
| uuid | string | f1d3b691-09cb-4570-8567-137ce1ca6328 | Equinix-assigned access point identifier. |
| supportedBandwidths | array[integer] | [200,500,700,1000] | Allowed connection bandwidths (Mbps). |
| allowRemoteConnections | boolean | true | Authorization to establish connections from remote locations. |
| allowCustomBandwidth | boolean | true | Authorization to set a custom connection bandwidth. |
| bandwidthAlertThreshold | integer | 75 |
Send a bandwidth usage alert when the percentage value of the total
bandwidth of the ports associated with the given service profile has
been consumed by your subscribers. Applicable for viewPoint query parameter set to zSide. |
| allowBandwidthAutoApproval | boolean | false | Parameter indicating if bandwidth change requests are approved automatically. |
| linkProtocolConfig | object | - | Settings and preferences for the link protocol used at the access point. |
| enableAutoGenerateServiceKey | boolean | false | Applicable to Verizon Software Defined Interconnect service profile. |
| connectionRedundancyRequired | boolean | false | Indicates if connecting to the service requires creating a pair of redundant connections. |
| apiConfig | object | - | API configuration settings and preferences. |
| connectionLabel | string | Connection | An alternative term for connection in case it's different in your organization. |
| authenticationKey | object | - | Authentication key configuration. |
| metadata | object | - | Additional connection information. |
| data.accessPointTypeConfigs.linkProtocolConfig | |||
| encapsulationStrategy | string | CTAGED | Additional tagging information required by the seller profile. |
| reuseVlanSTag | boolean | 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. |
| encapsulation | string | DOT1Q |
Data frames encapsulation standard. UNTAGGED - Untagged encapsulation for EPL connections. DOT1Q - DOT1Q encapsulation standard. QINQ - QINQ encapsulation standard. |
| data.accessPointTypeConfigs.apiConfig | |||
| apiAvailable | boolean | false | Indicates if it's possible to establish connections based on the given service profile using the Equinix Fabric API. |
| integrationId | string | AWS-DirectConnect-01 | A unique identifier issued during onboarding and used to integrate the customer's service profile with the Equinix Fabric API. |
| equinixManagedPort | boolean | false |
Setting indicating that the port is managed by Equinix. Applicable for viewPoint query parameter set to zSide. |
| equinixManagedVlan | boolean | false |
Setting indicating that the VLAN is managed by Equinix. Applicable for viewPoint query parameter set to zSide. |
| allowOverSubscription | boolean | false |
Allow services sales to exceed the available network bandwidth. Applicable for viewPoint query parameter set to zSide. |
| overSubscriptionLimit | integer | 1 |
Port bandwidth multiplier that determines the total bandwidth that
can be allocated to users creating connections to your services. For example, a 10 Gbps port combined with an overSubscriptionLimit parameter value of 10 allows your subscribers to create connections with a total bandwidth of 100 Gbps. Applicable for viewPoint query parameter set to zSide. |
| bandwidthFromApi | boolean | false | Indicates if the connection bandwidth can be obtained directly from the cloud service provider. |
| data.accessPointTypeConfigs.authenticationKey | |||
| required | boolean | true | Requirement to configure an authentication key. |
| label | string | Cloud Account ID | Name of the parameter that must be provided to authorize the connection. |
| data.accessPointTypeConfigs.metadata | |||
| allowVcMigration | boolean | true | Indicates if connections established based on the given service profile can be migrated to a different A-side port. |
| data.customFields | |||
| label | string | ASN | Label under which a custom parameter is presented on the Equnix Fabric portal or exposed through an API. |
| description | string | Excluded ASNs: 0, 13884, 36351, 64512, 64513, 65100, 65201–65234, 65402–65433, 65500, and 4201065000–4201065999. | Custom parameter description. |
| required | boolean | true | Indicates if a given custom field is mandatory. |
| dataType | string | INTEGER |
Custom field data type. INTEGER - Integer. STRING - String. |
| captureInEmail | boolean | false | Capture the input value and include it in the email notification. |
| data.marketingInfo | |||
| promotion | boolean | true | Authorization to promote the given service profile on Equinix website and other products. |
| processSteps | array[object] | - | A data structure describing the steps necessary to establish connection to the given service provider. |
| data.marketingInfo.processSteps | |||
| title | string | Create Equinix Fabric Connection | Step title. |
| subTitle | string | on the Equinix Fabric | Step's subtitle. |
| description | string | Some very creative and descriptive description. | Details of the actions which must be taken to complete the given step. |
| data.ports | |||
| type | string | COLO | Port type. |
| uuid | string | c791f8cb-5c8f-c8f0-8ce0-306a5c00a4ee | Equinix-assigned port identifier. |
| location | object | - | Attributes associated with the specified asset location. |
| sellerRegion | string | ap-southeast-2 | Seller region where the port is located. |
| data.ports.location | |||
| href | string | https://api.equinix.com/fabric/v4/metros/SV | An absolute URL that returns complete specification for the given entity. |
| metroCode | string | SV | Metropolitan area identifier. |
| data.metros | |||
| code | string | SV | Metropolitan area identifier. |
| name | string | Silicon Valley | Metropolitan area name. |
| ibxs | array[string] | ["SV5","SV1"] | List of IBX data centers within the given metro where subscribers can access services provided by the given service profile. |
| displayName | string | Silicon Valley | Metropoiltan area name displayed on the service profile in the Equinix Fabric portal. |
| pagination | |||
| offset | integer | 2 | Index of the first item returned in the response. |
| limit | integer | 2 | Maximum number of items returned per page. |
| total | integer | 2309 | Total number of service profiles. |
| next | string | /serviceProfiles?offset=4&limit=2 | Next data page url. |
| previous | string | /serviceProfiles?offset=0&limit=2 | Previous data page url. |
Get Specified Service Profile
| GET /fabric/v4/serviceProfiles/{uuid} | |
|---|---|
| Method | GET |
| URL or Endpoint | /fabric/v4/serviceProfiles/{uuid} |
| Headers | Authorization, ic-version |
| Path Parameters | uuid |
| Query Parameters | viewPoint, style |
| Body Parameters | Not applicable |
This API request retrieves a specified service profile. Service profiles define the services offered by service providers enabling other participants to find and connect to them.
Sample curl request
Copy
curl -X
GET 'https://api.equinix.com/fabric/v4/serviceProfiles/317dcd1c-83ba-4d7c-994a-3e7ddb875026'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'ic-version: v4.2'Header parameters
| Parameter | Mandatory | Data Type | Example Values | Applicable Values | Description |
|---|---|---|---|---|---|
| authorization | yes | string | Bearer qwErtY8zyW1abcdefGHI | - | API request authorization token. |
| ic-version | yes | string | v4.2 | v4.2 | API version specifier. |
Path parameters
| Parameter | Mandatory | Data Type | Example Values | Description |
|---|---|---|---|---|
| uuid | yes | string | 13c0f286-1190-480c-8a45-b3df00cad9cf | Equinix-assigned service profile identifier. |
Query parameters
| Parameter | Mandatory | Data Type | Example Values | Applicable Values | Description |
|---|---|---|---|---|---|
| viewPoint | no | string | aSide | aSide zSide Defalt: aSide |
Returns service profile data set with parameters relevant to a buyer (aSide) or a seller (zSide). |
If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.
Sample response
Copy
{
"state": "ACTIVE",
"account": {
"organizationName": "l3-qa-1-270253"
},
"changeLog": {
"createdBy": "l3qa1user1",
"createdByFullName": "l3qa1user1 l3qa1user1",
"createdByEmail": "l3qa1user1@equinix.com",
"createdDateTime": {},
"updatedBy": "eqx-admin",
"updatedByFullName": "eqx-admin eqx-admin",
"updatedByEmail": "eqx-admin@equinix.com",
"updatedDateTime": {}
},
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/c2ba267e-0168-4254-93a2-32487de4ed7c?viewPoint=aSide",
"type": "L2_PROFILE",
"name": "E2E-SPHL2Name-060422130614789",
"uuid": "c2ba267e-0168-4254-93a2-32487de4ed7c",
"description": "<p>E2E-This is SPH Description With <a href=\"https://qa3fabric.corp.equinix.com/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Hyperlink</a>-060422130617254</p>",
"tags": [
"SaaS",
"IaaS"
],
"visibility": "PUBLIC",
"accessPointTypeConfigs": [
{
"type": "COLO",
"uuid": "d68c95c1-f289-4b52-8aee-7f4e2660e070",
"supportedBandwidths": [
50,
200,
500,
1000
],
"allowRemoteConnections": true,
"allowCustomBandwidth": false,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {
"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"apiConfig": {
"apiAvailable": false,
"integrationId": "",
"bandwidthFromApi": false
},
"connectionLabel": "Connection",
"authenticationKey": {
"required": false
}
}
],
"marketingInfo": {
"promotion": true
},
"metros": [
{
"code": "DA",
"name": "Dallas",
"ibxs": [
"DA1"
],
"displayName": "Dallas"
}
],
"selfProfile": false
}Response payload body description
| Parameter | Type | Example | Description |
| state | string | ACTIVE |
Service profile lifecycle stage. ACTIVE - Service profile is active and enables establishing connections. DELETED - Service profile has been deleted. PENDING APPROVAL - Service profile awaiting administrator approval. REJECTED - Service profile has been rejected by the administrator. |
| account | object | - | Customer account information. |
| changeLog | object | - | A permanent record of asset creation, modification, or deletion. |
| href | string | https://api.equinix.com/fabric/v4/serviceProfiles/ 57186196-505d-4075-80f5-60e819e30310 | An absolute URL that returns complete specification for the given entity. |
| type | string | L2_PROFILE |
Service profile type. 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 | string | E2E-SPHL2Name-040122133102496 | Service profile name. |
| uuid | string | d48daade-4c18-446d-9c4d-92f6e2f93f55 | Equinix-assigned service profile identifier. |
| description | string | E2E-This is SPH Description [...] | Service description. |
| notifications | object | - |
Notification preferences and a list of recipients. Applicable for viewPoint query parameter set to zSide. |
| tags | array[string] | SaaS | Labels identifying the type of the services advertised by given service profile. |
| visibility | string | PRIVATE |
Service profile visibility. 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. |
| allowedEmails | array[string] | ["darth@vader.com","han@solo.com"] | Email addresses of users allowed to establish connections based on this service profile. |
| accessPointTypeConfigs | array[object] | - | Available access points types. |
| customFields | array[object] | - | User-defined fields added to a service profile. |
| marketingInfo | object | - | Optional service profile branding, such as the customer's logo. |
| ports | array[object] | - |
Ports associated with the given service profile. Applicable for viewPoint query parameter set to zSide. |
| metros | array[object] | - | Locations where subscribers can access services available through the given service profile. |
| selfProfile | boolean | true |
Indicates if the service profile and the user interacting with the
API belong to the same organization. Applicable for viewPoint query parameter set to aSide. |
| account | |||
| orgId | string | 92214 |
Equinix-assigned organization identifier. Applicable for viewPoint query parameter set to zSide. |
| organizationName | string | testBuyer-270001 | Equinix-assigned organization name. |
| globalOrgId | string | 0016C00000UlveoQAB | Equinix-assigned top-level organization identifier associated with the specified service profile. |
|
globalOrganizationName |
string | Cloud | Equinix-assigned top-level organization name associated with the specified service profile. |
| changeLog | |||
| createdBy | string | testBuyer999 | Identity of the asset creator. |
| createdDateTime | string | 2022-01-04T13:31:31.814Z | Asset creation timestamp. |
| updatedBy | string | eqx-admin999 | Identity of the person who updated the asset. |
| updatedDateTime | string | 2022-01-04T13:31:45.981Z | Asset update request timestamp. |
| createdByEmail | string | testBuyer999@equinix.com | Email address of the asset creator. |
| updatedByEmail | string | eqx-admin999@equinix.com | Email address of the person who updated the asset. |
| createdByFullName | string | testBuyer999 testBuyer999 | First and last name of the asset creator. |
| updatedByFullName | string | eqx-admin999 eqx-admin999 | First and last name of the person who updated the asset. |
| notifications | |||
| emails | array[string] | ["l3qa1user1@equinix.com"] | List of receipients of a given type of notification. |
| type | string | BANDWIDTH_ALERT |
Notification type. BANDWIDTH_ALERT - Bandwidth alert threshold has been reached. CONNECTION_APPROVAL - Connection request awaiting approval. PROFILE_LIFECYCLE - Service profile lifecycle has changed. |
| accessPointTypeConfigs | |||
| type | string | COLO |
Access point type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. |
| uuid | string | f1d3b691-09cb-4570-8567-137ce1ca6328 | Equinix-assigned access point identifier. |
| supportedBandwidths | array[integer] | [200,500,700,1000] | Allowed connection bandwidths (Mbps). |
| allowRemoteConnections | boolean | true | Authorization to establish connections from remote locations. |
| allowCustomBandwidth | boolean | true | Authorization to set a custom connection bandwidth. |
| bandwidthAlertThreshold | integer | 75 |
Send a bandwidth usage alert when the percentage value of the total
bandwidth of the ports associated with the given service profile has
been consumed by your subscribers. Applicable for viewPoint query parameter set to zSide. |
| allowBandwidthAutoApproval | boolean | false | Parameter indicating if bandwidth change requests are approved automatically. |
| linkProtocolConfig | object | - | Settings and preferences for the link protocol used at the access point. |
| enableAutoGenerateServiceKey | boolean | false | Applicable to Verizon Software Defined Interconnect service profile. |
| connectionRedundancyRequired | boolean | false | Indicates if connecting to the service requires creating a pair of redundant connections. |
| apiConfig | object | - | API configuration settings and preferences. |
| connectionLabel | string | Connection | An alternative term for connection in case it's different in your organization. |
| authenticationKey | object | - | Authentication key configuration. |
| metadata | object | - | Additional connection information. |
| accessPointTypeConfigs.linkProtocolConfig | |||
| encapsulationStrategy | string | CTAGED | Additional tagging information required by the seller profile. |
| reuseVlanSTag | boolean | 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. |
| encapsulation | string | DOT1Q |
Data frames encapsulation standard. UNTAGGED - Untagged encapsulation for EPL connections. DOT1Q - DOT1Q encapsulation standard. QINQ - QINQ encapsulation standard. |
| accessPointTypeConfigs.apiConfig | |||
| apiAvailable | boolean | false | Indicates if it's possible to establish connections based on the given service profile using the Equinix Fabric API. |
| integrationId | string | AWS-DirectConnect-01 | A unique identifier issued during onboarding and used to integrate the customer's service profile with the Equinix Fabric API. |
| equinixManagedPort | boolean | false |
Setting indicating that the port is managed by Equinix. Applicable for viewPoint query parameter set to zSide. |
| equinixManagedVlan | boolean | false |
Setting indicating that the VLAN is managed by Equinix. Applicable for viewPoint query parameter set to zSide. |
| allowOverSubscription | boolean | false |
Allow services sales to exceed the available network bandwidth. Applicable for viewPoint query parameter set to zSide. |
| overSubscriptionLimit | integer | 1 |
Port bandwidth multiplier that determines the total bandwidth that
can be allocated to users creating connections to your services. For example, a 10 Gbps port combined with an overSubscriptionLimit parameter value of 10 allows your subscribers to create connections with a total bandwidth of 100 Gbps. Applicable for viewPoint query parameter set to zSide. |
| bandwidthFromApi | boolean | false | Indicates if the connection bandwidth can be obtained directly from the cloud service provider. |
| accessPointTypeConfigs.authenticationKey | |||
| required | boolean | true | Requirement to configure an authentication key. |
| label | string | Cloud Account ID | Name of the parameter that must be provided to authorize the connection. |
| accessPointTypeConfigs.metadata | |||
| allowVcMigration | boolean | true | Indicates if connections established based on the given service profile can be migrated to a different A-side port. |
| customFields | |||
| label | string | ASN | Label under which a custom parameter is presented on the Equnix Fabric portal or exposed through an API. |
| description | string | Excluded ASNs: 0, 13884, 36351, 64512, 64513, 65100, 65201–65234, 65402–65433, 65500, and 4201065000–4201065999. | Custom parameter description. |
| required | boolean | true | Indicates if a given custom field is mandatory. |
| dataType | string | INTEGER |
Custom field data type. INTEGER - Integer. STRING - String. |
| captureInEmail | boolean | false | Capture the input value and include it in the email notification. |
| marketingInfo | |||
| promotion | boolean | true | Authorization to promote the given service profile on Equinix website and other products. |
| processSteps | array[object] | - | A data structure describing the steps necessary to establish connection to the given service provider. |
| marketingInfo.processSteps | |||
| title | string | CreateEquinixFabricConnection | Step title. |
| subTitle | string | ontheEquinixFabric | Step's subtitle. |
| description | string | Some very creative and descriptive description. | Details of the actions which must be taken to complete the given step. |
| ports | |||
| type | string | COLO | Port type. |
| uuid | string | c791f8cb-5c8f-c8f0-8ce0-306a5c00a4ee | Equinix-assigned port identifier. |
| location | object | - | Attributes associated with the specified asset location. |
| sellerRegion | string | ap-southeast-2 | Seller region where the port is located. |
| ports.location | |||
| href | string | https://api.equinix.com/fabric/v4/metros/SV | An absolute URL that returns complete specification for the given entity. |
| metroCode | string | SV | Metropolitan area identifier. |
| metros | |||
| code | string | SV | Metropolitan area identifier. |
| name | string | Silicon Valley | Metropolitan area name. |
| ibxs | array[string] | ["SV5","SV1"] | List of IBX data centers within the given metro where subscribers can access services provided by the given service profile. |
| displayName | string | Silicon Valley | Metropoiltan area name displayed on the service profile in the Equinix Fabric portal. |
Retrieve Service Profiles
| POST /fabric/v4/serviceProfiles/search | |
|---|---|
| Method | POST |
| URL or Endpoint | /fabric/v4/serviceProfiles/search |
| Headers | authorization, content-type, ic-version |
| Path Parameters | Not applicable |
| Query Parameters | Not applicable |
| Body Parameters | filter, pagination, sort |
This API request retrieves service profiles that match provided search criteria.
For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.
Sample curl request
Copy
curl -X POST 'http: //api.equinix.com/fabric/v4/serviceProfiles/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'ic-version: v4.2'
-d '{
"filter": {
"and": [
{
"property": "/name",
"operator": "=",
"values": [
"InterGalacticStorage"
]
},
{
"property": "/type",
"operator": "=",
"values": [
"L2_PROFILE"
]
}
]
},
"pagination": {
"offset": 0,
"limit": 20
},
"sort": [
{
"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}'Header parameters
| Parameter | Mandatory | Data Type | Example Values | Applicable Values | Description |
|---|---|---|---|---|---|
| authorization | yes | string | Bearer qwErtY8zyW1abcdefGHI | - | API request authorization token. |
| ic-version | yes | string | v4.2 | v4.2 | API version specifier. |
Body parameters
| Parameter | Mandatory | Data Type | Example | Applicable Values | Description |
| filter | no | object | - | - | Array of objects defining search conditions. |
| pagination | no | object | - | - | Search results pagination settings. |
| sort | no | object | - | - | Search results sorting settings. |
| filter | |||||
| and | yes | array[object] | - | - | Logical operator. |
| property | yes | string | /metroCode | /name
/uuid /state /metros/code /visibility /type |
Search field parameter. Note that the property value determines the list of applicable operators and values. |
| operator | yes | string | = | = ~* |
Search field parameter operator. ~* - Case-insensitive like. |
| values | yes | array[string] | ["SV"] |
- |
Search field parameter value. |
| /name | no |
"property": "/name", "operator": "=", "values": [ "Service Profile" ] |
Service profile name. | ||
| operator | yes | string | = | = ~* |
Search field parameter operator. |
| values | yes | array[string] | ["HanSolo Inc."] | - | - |
| /uuid | no |
"property": "/uuid", "operator": "=", "values": [ "3a58dd05-f46d-4b1d-a154-2e85c396ea62" ] |
Equinix-assigned service profile identifier. | ||
| operator | yes | string | = | = | Search field parameter operator. |
| values | yes | array[string] |
["3a58dd05-f46d-4b1d-a154-2e85c396ea62"] |
- | - |
| /state | no |
"property": "/state", "operator": "=", "values": [ "ACTIVE" ] |
Asstet lifecycle status. | ||
| operator | yes | string | = | = ~* |
Search field parameter operator. |
| values | yes | array[string] | ["ACTIVE"] |
ACTIVE DELETED
PENDING_APPROVAL |
- |
| /metros/code | no |
{ "property": "/metros/code", "operator": "=", "values": [ "SV" ] } |
Metropolitan area identifier. | ||
| operator | yes | string | = | = ~* |
Search field parameter operator. |
| values | yes | array[string] | ["SV"] |
Use the Get All Metros API request to retrieve the list of metros. |
- |
| /visibility | no |
"property": "/visibility", "operator": "=", "values": [ "PUBLIC" ] |
Service profile visibility on Platform Equinix. | ||
| operator | yes | string | = | = ~* |
Search field parameter operator. |
| values | yes | array[string] | ["PUBLIC"] |
PRIVATE |
PRIVATE - Establishing connectins based on a private service profile
requires service provider's authorization. PUBLIC - Public service profiles are listed on the Equinix Fabric portal allowing anyone to establish connections to advertised services. |
| /type | no |
"property": "/type", "operator": "=", "values": [ "L2_PROFILE" ] |
Service profile type. |
||
| operator | yes | string | IN | = ~* |
Search field parameter operator. |
| values | yes | array[string] | ["L2_PROFILE"] | L2_PROFILE L3_PROFILE |
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 3 of the OSI networking model. |
| pagination | |||||
| offset | no | integer | 0 | Minimum: 0 Default: 0 |
Index of the first item returned in the response. |
| limit | no | integer | 20 | Minimum: 1 Default: 20 |
Maximum number of items returned per page. |
| sort | |||||
| direction | no | string | DESC | ASC DESC |
Search results sorting direction. |
| property | no | string | /changeLog/updatedDateTime |
/name /uuid /state /metros/code /visibility /type Default:/changeLog/updatedDateTime |
Search results sorting parameter. |
Sample response
Copy
{
"data": [
{
"state": "ACTIVE",
"account": {
"organizationName": "pmSuveer-270163",
"globalOrgId": "0016u000003JZ4xAAG"
},
"changeLog": {
"createdBy": "pmSuveer",
"createdByFullName": "pmSuveer pmSuveer",
"createdByEmail": "pmSuveer@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,
"integrationId": "",
"bandwidthFromApi": false
},
"connectionLabel": "Connection",
"authenticationKey": {
"required": false
}
}
],
"marketingInfo": {
"promotion": true
},
"metros": [
{
"code": "SG",
"name": "Singapore",
"ibxs": [
"SG1"
],
"displayName": "Singapore"
},
{
"code": "SY",
"name": "Sydney",
"ibxs": [
"SY4"
],
"displayName": "Sydney"
}
],
"selfProfile": false
},
{
"state": "ACTIVE",
"account": {
"organizationName": "testBuyer-270001",
"globalOrgId": "0016u000003JZ4sAAG"
},
"changeLog": {
"createdBy": "testBuyer",
"createdByFullName": "testBuyer testBuyer",
"createdByEmail": "testBuyer@equinix.com",
"createdDateTime": "2022-04-05T14:03:09.762Z",
"updatedBy": "eqx-admin",
"updatedByFullName": "eqx-admin eqx-admin",
"updatedByEmail": "eqx-admin@equinix.com",
"updatedDateTime": "2022-04-05T14:03:19.326Z"
},
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/bff14ddf-0681-4e01-841b-2e0900ce0117?viewPoint=aSide",
"type": "L2_PROFILE",
"name": "E2E-SPHL2Name-050422140237776",
"uuid": "bff14ddf-0681-4e01-841b-2e0900ce0117",
"description": "<p>E2E-This is SPH...</p>",
"tags": [
"SaaS",
"IaaS"
],
"visibility": "PUBLIC",
"accessPointTypeConfigs": [
{
"type": "COLO",
"uuid": "573b83c9-8c75-4eb0-8d13-95bca877970f",
"supportedBandwidths": [
200,
500,
700,
1000
],
"allowRemoteConnections": true,
"allowCustomBandwidth": true,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {
"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"apiConfig": {
"apiAvailable": false,
"integrationId": "",
"bandwidthFromApi": false
},
"connectionLabel": "Connection",
"authenticationKey": {
"required": false
}
},
{
"type": "COLO",
"uuid": "573b83c9-8c75-4eb0-8d13-95bca877970f",
"supportedBandwidths": [
200,
500,
700,
1000
],
"allowRemoteConnections": true,
"allowCustomBandwidth": true,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {
"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"apiConfig": {
"apiAvailable": false,
"integrationId": "",
"bandwidthFromApi": false
},
"connectionLabel": "Connection",
"authenticationKey": {
"required": false
}
}
],
"marketingInfo": {
"promotion": true
},
"metros": [
{
"code": "DA",
"name": "Dallas",
"ibxs": [
"DA1"
],
"displayName": "Dallas"
}
],
"selfProfile": true
}
],
"pagination": {
"offset": 0,
"limit": 2,
"total": 51
}
}Response payload body description
| Parameter | Type | Example | Description |
| data | object | - | Data array containing data model entities. |
| pagination | object | - | An absolute URL that returns the specified connection. |
| data | |||
| state | string | ACTIVE |
Service profile lifecycle stage. ACTIVE - Service profile is active and enables establishing connections. DELETED - Service profile has been deleted. PENDING APPROVAL - Service profile awaiting administrator approval. REJECTED - Service profile has been rejected by the administrator. |
| account | object | - | Customer account information. |
| changeLog | object | - | A permanent record of asset creation, modification, or deletion. |
| href | string | https://api.equinix.com/fabric/v4/serviceProfiles/ 57186196-505d-4075-80f5-60e819e30310 | An absolute URL that returns complete specification for the given entity. |
| type | string | L2_PROFILE |
Service profile type. 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 | string | E2E-SPHL2Name-040122133102496 | Service profile name. |
| uuid | string | d48daade-4c18-446d-9c4d-92f6e2f93f55 | Equinix-assigned service profile identifier. |
| description | string | E2E-This is SPH Description [...] | Service description. |
| notifications | object | - |
Notification preferences and a list of recipients. Applicable for viewPoint query parameter set to zSide. |
| tags | array[string] | SaaS | Labels identifying the type of the services advertised by given service profile. |
| visibility | string | PRIVATE |
Service profile visibility. 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. |
| allowedEmails | array[string] | ["darth@vader.com","han@solo.com"] | Email addresses of users allowed to establish connections based on this service profile. |
| accessPointTypeConfigs | array[object] | - | Available access points types. |
| customFields | array[object] | - | User-defined fields added to a service profile. |
| marketingInfo | object | - | Optional service profile branding, such as the customer's logo. |
| ports | array[object] | - |
Ports associated with the given service profile. Applicable for viewPoint query parameter set to zSide. |
| metros | array[object] | - | Locations where subscribers can access services available through the given service profile. |
| selfProfile | boolean | true | Indicates if the service profile and the user interacting with the API belong to the same organization. |
| data.account | |||
| orgId | string | 92214 |
Equinix-assigned organization identifier. Applicable for viewPoint query parameter set to zSide. |
| organizationName | string | testBuyer-270001 | Equinix-assigned organization name. |
| globalOrgId | string | 0016C00000UlveoQAB | Equinix-assigned top-level organization identifier associated with the specified service profile. |
|
globalOrganizationName |
string | Cloud | Equinix-assigned top-level organization name associated with the specified service profile. |
| data.changeLog | |||
| createdBy | string | testBuyer999 | Identity of the asset creator. |
| createdDateTime | string | 2022-01-04T13:31:31.814Z | Asset creation timestamp. |
| updatedBy | string | eqx-admin999 | Identity of the person who updated the asset. |
| updatedDateTime | string | 2022-01-04T13:31:45.981Z | Asset update request timestamp. |
| createdByEmail | string | testBuyer999@equinix.com | Email address of the asset creator. |
| updatedByEmail | string | eqx-admin999@equinix.com | Email address of the person who updated the asset. |
| createdByFullName | string | testBuyer999 testBuyer999 | First and last name of the asset creator. |
| updatedByFullName | string | eqx-admin999 eqx-admin999 | First and last name of the person who updated the asset. |
| data.notifications | |||
| emails | array[string] | ["l3qa1user1@equinix.com"] | List of receipients of a given type of notification. |
| type | string | BANDWIDTH_ALERT |
Notification type. BANDWIDTH_ALERT - Bandwidth alert threshold has been reached. CONNECTION_APPROVAL - Connection request awaiting approval. PROFILE_LIFECYCLE - Service profile lifecycle has changed. |
| data.accessPointTypeConfigs | |||
| type | string | COLO |
Access point type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. |
| uuid | string | f1d3b691-09cb-4570-8567-137ce1ca6328 | Equinix-assigned access point identifier. |
| supportedBandwidths | array[integer] | [200,500,700,1000] | Allowed connection bandwidths (Mbps). |
| allowRemoteConnections | boolean | true | Authorization to establish connections from remote locations. |
| allowCustomBandwidth | boolean | true | Authorization to set a custom connection bandwidth. |
| bandwidthAlertThreshold | integer | 75 |
Send a bandwidth usage alert when the percentage value of the total
bandwidth of the ports associated with the given service profile has
been consumed by your subscribers. Applicable for viewPoint query parameter set to zSide. |
| allowBandwidthAutoApproval | boolean | false | Parameter indicating if bandwidth change requests are approved automatically. |
| linkProtocolConfig | object | - | Settings and preferences for the link protocol used at the access point. |
| enableAutoGenerateServiceKey | boolean | false | Applicable to Verizon Software Defined Interconnect service profile. |
| connectionRedundancyRequired | boolean | false | Indicates if connecting to the service requires creating a pair of redundant connections. |
| apiConfig | object | - | API configuration settings and preferences. |
| connectionLabel | string | Connection | An alternative term for connection in case it's different in your organization. |
| authenticationKey | object | - | Authentication key configuration. |
| metadata | object | - | Additional connection information. |
| data.accessPointTypeConfigs.linkProtocolConfig | |||
| encapsulationStrategy | string | CTAGED | Additional tagging information required by the seller profile. |
| reuseVlanSTag | boolean | 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. |
| encapsulation | string | DOT1Q |
Data frames encapsulation standard. UNTAGGED - Untagged encapsulation for EPL connections. DOT1Q - DOT1Q encapsulation standard. QINQ - QINQ encapsulation standard. |
| data.accessPointTypeConfigs.apiConfig | |||
| apiAvailable | boolean | false | Indicates if it's possible to establish connections based on the given service profile using the Equinix Fabric API. |
| integrationId | string | AWS-DirectConnect-01 | A unique identifier issued during onboarding and used to integrate the customer's service profile with the Equinix Fabric API. |
| equinixManagedPort | boolean | false |
Setting indicating that the port is managed by Equinix. Applicable for viewPoint query parameter set to zSide. |
| equinixManagedVlan | boolean | false |
Setting indicating that the VLAN is managed by Equinix. Applicable for viewPoint query parameter set to zSide. |
| allowOverSubscription | boolean | false |
Allow services sales to exceed the available network bandwidth. Applicable for viewPoint query parameter set to zSide. |
| overSubscriptionLimit | integer | 1 |
Port bandwidth multiplier that determines the total bandwidth that
can be allocated to users creating connections to your services. For example, a 10 Gbps port combined with an overSubscriptionLimit parameter value of 10 allows your subscribers to create connections with a total bandwidth of 100 Gbps. Applicable for viewPoint query parameter set to zSide. |
| bandwidthFromApi | boolean | false | Indicates if the connection bandwidth can be obtained directly from the cloud service provider. |
| data.accessPointTypeConfigs.authenticationKey | |||
| required | boolean | true | Requirement to configure an authentication key. |
| label | string | Cloud Account ID | Name of the parameter that must be provided to authorize the connection. |
| data.accessPointTypeConfigs.metadata | |||
| allowVcMigration | boolean | true | Indicates if connections established based on the given service profile can be migrated to a different A-side port. |
| data.customFields | |||
| label | string | ASN | Label under which a custom parameter is presented on the Equnix Fabric portal or exposed through an API. |
| description | string | Excluded ASNs: 0, 13884, 36351, 64512, 64513, 65100, 65201–65234, 65402–65433, 65500, and 4201065000–4201065999. | Custom parameter description. |
| required | boolean | true | Indicates if a given custom field is mandatory. |
| dataType | string | INTEGER |
Custom field data type. INTEGER - Integer. STRING - String. |
| captureInEmail | boolean | false | Capture the input value and include it in the email notification. |
| data.marketingInfo | |||
| promotion | boolean | true | Authorization to promote the given service profile on Equinix website and other products. |
| processSteps | array[object] | - | A data structure describing the steps necessary to establish connection to the given service provider. |
| data.marketingInfo.processSteps | |||
| title | string | Create Equinix Fabric Connection | Step title. |
| subTitle | string | on the Equinix Fabric | Step's subtitle. |
| description | string | Some very creative and descriptive description. | Details of the actions which must be taken to complete the given step. |
| data.ports | |||
| type | string | COLO | Port type. |
| uuid | string | c791f8cb-5c8f-c8f0-8ce0-306a5c00a4ee | Equinix-assigned port identifier. |
| location | object | - | Attributes associated with the specified asset location. |
| sellerRegion | string | ap-southeast-2 | Seller region where the port is located. |
| data.ports.location | |||
| href | string | https://api.equinix.com/fabric/v4/metros/SV | An absolute URL that returns complete specification for the given entity. |
| metroCode | string | SV | Metropolitan area identifier. |
| data.metros | |||
| code | string | SV | Metropolitan area identifier. |
| name | string | Silicon Valley | Metropolitan area name. |
| ibxs | array[string] | ["SV5","SV1"] | List of IBX data centers within the given metro where subscribers can access services provided by the given service profile. |
| displayName | string | Silicon Valley | Metropoiltan area name displayed on the service profile in the Equinix Fabric portal. |
| pagination | |||
| offset | integer | 2 | Index of the first item returned in the response. |
| limit | integer | 2 | Maximum number of items returned per page. |
| total | integer | 2309 | Total number of service profiles. |
Update Service Profile
| PATCH /fabric/v4/serviceProfiles/{uuid} | |
|---|---|
| Method | PATCH |
| URL or Endpoint | /fabric/v4/serviceProfiles/{uuid} |
| Headers | authorization, content-type, ic-version |
| Path Parameters | uuid |
| Query Parameters | Not applicable |
| Body Parameters | op, path, value |
This API modifies a service profile.
Sample curl request
Copy
curl -X
PATCH 'https: //api.equinix.com/fabric/v4/serviceProfiles/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'ic-version: v4.2'
-d '[
{
"op": "replace",
"path": "/name",
"value": "Service Profile 2"
}
]'Header parameters
| Parameter | Mandatory | Data Type | Example Values | Applicable Values | Description |
|---|---|---|---|---|---|
| authorization | yes | string | Bearer qwErtY8zyW1abcdefGHI | - | API request authorization token. |
| content-type | yes | string | application/json | application/json | Specifies the resource media type. |
| ic-version | yes | string | v4.2 | v4.2 | API version specifier. |
Path parameters
| Parameter | Mandatory | Type | Example Values | Applicable Values | Description |
|---|---|---|---|---|---|
| uuid | yes | string | 3a58dd05-f46d-4b1d-a154-2e85c396ea62 | - | Equinix-assigned service profile identifier. |
Body parameters
| Parameter | Mandatory | Type | Example Values | Applicable Values | Description |
| op | yes | string | replace | replace | Update reqest type. |
| path | yes | string | /name | /name
/visibility /description /tags /allowedEmails /customFields |
Parameter path. |
| value | yes | string | Service Profile 2 | - | Parameter value. |
| /name | |||||
| value | yes | string | Service Profile 2 |
Maximum: 50 characters Allowed characters: alpha-numeric, hyphens ('-'), underscores ('_') and white spaces (' '). |
Service profile name. |
| /visibility | |||||
| value | yes | string | PRIVATE | PRIVATE PUBLIC |
Service profile accessibility. 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. |
| /description | |||||
| value | yes | string | Service profile description. | Maximum: 375 characters. | Service description. |
| /tags | |||||
| value | yes | array[string] | ["IaaS","SaaS"] | - | Labels identifying the type of the services advertised by given service profile. |
| /allowedEmails | |||||
| value | yes | array[string] | ["john@equinix.com","jane@equinix.com"] | - | Email addresses of users allowed to establish connections based on this service profile. Applicable to PRIVATE visibility service profiles. |
| /customFields | |||||
| value | yes | array[object] |
[ { "label": "Global", "description": "Optional ", "required": false, "dataType": "STRING", "captureInEmail": false }, { "label": "ASN", "description": "Number. Mandatory field.", "required": true, "dataType": "NUMBER", "captureInEmail": false } ] |
User-defined fields added to a service profile. | |
If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.
Sample response
Copy
{
"state": "ACTIVE",
"account": {
"orgId": 91997,
"globalOrgId": "0016u000003JZ4sAAG"
},
"changeLog": {
"createdBy": "fusiontestbuyer",
"createdByFullName": "fusiontestBuyer fusiontestBuyer",
"createdByEmail": "fusiontestBuyer@equinix.com",
"createdDateTime": "2022-04-12T12:34:38.381Z",
"updatedBy": "fusiontestbuyer",
"updatedByFullName": "fusiontestBuyer fusiontestBuyer",
"updatedByEmail": "fusiontestBuyer@equinix.com",
"updatedDateTime": "2022-04-13T09:23:10.214Z"
},
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"type": "L2_PROFILE",
"name": "Service Profile 2",
"uuid": "50cee78c-29b8-4596-901d-edbdbc0b8aff",
"description": "Sample_description",
"visibility": "PRIVATE",
"allowedEmails": [
"test@equinix.com",
"testagain@equinix.com"
],
"accessPointTypeConfigs": [
{
"type": "COLO",
"uuid": "39ec4e87-47a6-4200-a32d-7fc41da6754a",
"supportedBandwidths": [
50,
200,
500,
1000
],
"allowRemoteConnections": true,
"allowCustomBandwidth": false,
"bandwidthAlertThreshold": 80,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {
"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "QINQ"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"apiConfig": {
"apiAvailable": false,
"equinixManagedPort": false,
"equinixManagedVlan": false,
"allowOverSubscription": false,
"overSubscriptionLimit": 1,
"bandwidthFromApi": false
},
"connectionLabel": "Connection",
"authenticationKey": {
"required": false
}
}
],
"marketingInfo": {
"promotion": true
},
"ports": [
{
"type": "XF_PORT",
"uuid": "cecd1039-eadd-add3-31e0-387a5c00aeb9",
"location": {
"href": "https://api.equinix.com/fabric/v4/metros/DC",
"metroCode": "DC"
}
}
],
"metros": [
{
"code": "DC",
"ibxs": [
"DC6"
]
}
]
}Response payload body description
| Parameter | Type | Example | Description |
| state | string | ACTIVE | Service profile lifecycle stage. ACTIVE - Service profile is active and enables establishing connections. DELETED - Service profile has been deleted. PENDING APPROVAL - Service profile awaiting administrator approval. REJECTED - Service profile has been rejected by the administrator. |
| account | object | - | Customer account information. |
| changeLog | object | - | A permanent record of asset creation, modification, or deletion. |
| href | string | https://api.equinix.com/fabric/v4/serviceProfiles/ 57186196-505d-4075-80f5-60e819e30310 | An absolute URL that returns complete specification for the given entity. |
| type | string | L2_PROFILE | Service profile type. 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 | string | E2E-SPHL2Name-040122133102496 | Service profile name. |
| uuid | string | d48daade-4c18-446d-9c4d-92f6e2f93f55 | Equinix-assigned service profile identifier. |
| description | string | E2E-This is SPH Description [...] | Service description. |
| notifications | object | - | Notification preferences and a list of recipients. Applicable for viewPoint query parameter set to zSide. |
| tags | array[string] | SaaS | Labels identifying the type of the services advertised by given service profile. |
| visibility | string | PRIVATE | Service profile visibility. 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. |
| allowedEmails | array[string] | ["darth@vader.com","han@solo.com"] | Email addresses of users allowed to establish connections based on this service profile. |
| accessPointTypeConfigs | array[object] | - | Available access points types. |
| customFields | array[object] | - | User-defined fields added to a service profile. |
| marketingInfo | object | - | Optional service profile branding, such as the customer's logo. |
| ports | array[object] | - | Ports associated with the given service profile. Applicable for viewPoint query parameter set to zSide. |
| metros | array[object] | - | Locations where subscribers can access services available through the given service profile. |
| account | |||
| orgId | string | 92214 | Equinix-assigned organization identifier. Applicable for viewPoint query parameter set to zSide. |
| organizationName | string | testBuyer-270001 | Equinix-assigned organization name. |
| globalOrgId | string | 0016C00000UlveoQAB | Equinix-assigned top-level organization identifier associated with the specified service profile. |
|
globalOrganizationName |
string | Cloud | Equinix-assigned top-level organization name associated with the specified service profile. |
| changeLog | |||
| createdBy | string | testBuyer999 | Identity of the asset creator. |
| createdDateTime | string | 2022-01-04T13:31:31.814Z | Asset creation timestamp. |
| updatedBy | string | eqx-admin999 | Identity of the person who updated the asset. |
| updatedDateTime | string | 2022-01-04T13:31:45.981Z | Asset update request timestamp. |
| createdByEmail | string | testBuyer999@equinix.com | Email address of the asset creator. |
| updatedByEmail | string | eqx-admin999@equinix.com | Email address of the person who updated the asset. |
| createdByFullName | string | testBuyer999 testBuyer999 | First and last name of the asset creator. |
| updatedByFullName | string | eqx-admin999 eqx-admin999 | First and last name of the person who updated the asset. |
| notifications | |||
| emails | array[string] | ["l3qa1user1@equinix.com"] | List of receipients of a given type of notification. |
| type | string | BANDWIDTH_ALERT | Notification type. BANDWIDTH_ALERT - Bandwidth alert threshold has been reached. CONNECTION_APPROVAL - Connection request awaiting approval. PROFILE_LIFECYCLE - Service profile lifecycle has changed. |
| accessPointTypeConfigs | |||
| type | string | COLO | Access point type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. |
| uuid | string | f1d3b691-09cb-4570-8567-137ce1ca6328 | Equinix-assigned access point identifier. |
| supportedBandwidths | array[integer] | [200,500,700,1000] | Allowed connection bandwidths (Mbps). |
| allowRemoteConnections | boolean | true | Authorization to establish connections from remote locations. |
| allowCustomBandwidth | boolean | true | Authorization to set a custom connection bandwidth. |
| bandwidthAlertThreshold | integer | 75 | Send a bandwidth usage alert when the percentage value of the total bandwidth of the ports associated
with the given service profile has been consumed by your subscribers. Applicable for viewPoint query parameter set to zSide. |
| allowBandwidthAutoApproval | boolean | false | Parameter indicating if bandwidth change requests are approved automatically. |
| linkProtocolConfig | object | - | Settings and preferences for the link protocol used at the access point. |
| enableAutoGenerateServiceKey | boolean | false | Applicable to Verizon Software Defined Interconnect service profile. |
| connectionRedundancyRequired | boolean | false | Indicates if connecting to the service requires creating a pair of redundant connections. |
| apiConfig | object | - | API configuration settings and preferences. |
| connectionLabel | string | Connection | An alternative term for connection in case it's different in your organization. |
| authenticationKey | object | - | Authentication key configuration. |
| metadata | object | - | Additional connection information. |
| accessPointTypeConfigs.linkProtocolConfig | |||
| encapsulationStrategy | string | CTAGED | Additional tagging information required by the seller profile. |
| reuseVlanSTag | boolean | 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. |
| encapsulation | string | DOT1Q | Data frames encapsulation standard. UNTAGGED - Untagged encapsulation for EPL connections. DOT1Q - DOT1Q encapsulation standard. QINQ - QINQ encapsulation standard. |
| accessPointTypeConfigs.apiConfig | |||
| apiAvailable | boolean | false | Indicates if it's possible to establish connections based on the given service profile using the Equinix Fabric API. |
| integrationId | string | AWS-DirectConnect-01 | A unique identifier issued during onboarding and used to integrate the customer's service profile with the Equinix Fabric API. |
| equinixManagedPort | boolean | false | Setting indicating that the port is managed by Equinix. Applicable for viewPoint query parameter set to zSide. |
| equinixManagedVlan | boolean | false | Setting indicating that the VLAN is managed by Equinix. Applicable for viewPoint query parameter set to zSide. |
| allowOverSubscription | boolean | false | Allow services sales to exceed the available network bandwidth. Applicable for viewPoint query parameter set to zSide. |
| overSubscriptionLimit | integer | 1 | Port bandwidth multiplier that determines the total bandwidth that can be allocated to users creating
connections to your services. For example, a 10 Gbps port combined with an overSubscriptionLimit parameter value of 10 allows your subscribers to create connections with a total bandwidth of 100 Gbps. Applicable for viewPoint query parameter set to zSide. |
| bandwidthFromApi | boolean | false | Indicates if the connection bandwidth can be obtained directly from the cloud service provider. |
| accessPointTypeConfigs.authenticationKey | |||
| required | boolean | true | Requirement to configure an authentication key. |
| label | string | Cloud Account ID | Name of the parameter that must be provided to authorize the connection. |
| accessPointTypeConfigs.metadata | |||
| allowVcMigration | boolean | true | Indicates if connections established based on the given service profile can be migrated to a different A-side port. |
| customFields | |||
| label | string | ASN | Label under which a custom parameter is presented on the Equnix Fabric portal or exposed through an API. |
| description | string | Excluded ASNs: 0, 13884, 36351, 64512, 64513, 65100, 65201–65234, 65402–65433, 65500, and 4201065000–4201065999. | Custom parameter description. |
| required | boolean | true | Indicates if a given custom field is mandatory. |
| dataType | string | INTEGER | Custom field data type. INTEGER - Integer. STRING - String. |
| captureInEmail | boolean | false | Capture the input value and include it in the email notification. |
| marketingInfo | |||
| promotion | boolean | true | Authorization to promote the given service profile on Equinix website and other products. |
| processSteps | array[object] | - | A data structure describing the steps necessary to establish connection to the given service provider. |
| marketingInfo.processSteps | |||
| title | string | Create Equinix Fabric Connection | Step title. |
| subTitle | string | on the Equinix Fabric | Step's subtitle. |
| description | string | Some very creative and descriptive description. | Details of the actions which must be taken to complete the given step. |
| ports | |||
| type | string | COLO | Port type. |
| uuid | string | c791f8cb-5c8f-c8f0-8ce0-306a5c00a4ee | Equinix-assigned port identifier. |
| location | object | - | Attributes associated with the specified asset location. |
| sellerRegion | string | ap-southeast-2 | Seller region where the port is located. |
| ports.location | |||
| href | string | https://api.equinix.com/fabric/v4/metros/SV | An absolute URL that returns complete specification for the given entity. |
| metroCode | string | SV | Metropolitan area identifier. |
| metros | |||
| code | string | SV | Metropolitan area identifier. |
| name | string | Silicon Valley | Metropolitan area name. |
| ibxs | array[string] | ["SV5","SV1"] | List of IBX data centers within the given metro where subscribers can access services provided by the given service profile. |
| displayName | string | Silicon Valley | Metropoiltan area name displayed on the service profile in the Equinix Fabric portal. |
Replace Service Profile
| PUT /fabric/v4/serviceProfiles/{uuid} | |
|---|---|
| Method | PUT |
| URL or Endpoint | /fabric/v4/serviceProfiles/{uuid} |
| Headers | authorization, content-type, ic-version, if-match |
| Path Parameters | uuid |
| Query Parameters | Not applicable |
| Body Parameters | type, name, description, notifications, visibility, allowedEmails, tags, accessPointTypeConfigs, customFields, marketingInfo, ports |
This API request replaces a service profile definition.
Sample curl request
Copy
curl -X
PUT 'https://api.equinix.com/fabric/v4/serviceProfiles/50cee78c-29b8-4596-901d-edbdbc0b8aff'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'content-type: application/json'
-H 'ic-version: v4.2'
-H 'if-match: 1'
-d '{
"name": "Service Profile 2",
"description": "Sample_description",
"type": "L2_PROFILE",
"notifications": [
{
"emails": [
"someone@sample.com"
],
"type": "BANDWIDTH_ALERT"
}
],
"visibility": "PUBLIC",
"allowedEmails": [
"test@equinix.com",
"testagain@equinix.com"
],
"ports": [
{
"uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
"type": "XF_PORT",
"location": {
"metroCode": "SY"
}
}
],
"marketingInfo": {
"promotion": true
},
"accessPointTypeConfigs": [
{
"type": "COLO",
"connectionRedundancyRequired": false,
"allowBandwidthAutoApproval": false,
"allowRemoteConnections": false,
"connectionLabel": "true1",
"enableAutoGenerateServiceKey": false,
"bandwidthAlertThreshold": 10,
"allowCustomBandwidth": true,
"apiConfig": {
"apiAvailable": false,
"equinixManagedVlan": true,
"bandwidthFromApi": false,
"integrationId": null,
"equinixManagedPort": true
},
"authenticationKey": {
"required": false,
"label": "Service Key",
"description": "XYZ"
},
"supportedBandwidths": [
100,
500
]
}
]
}' Header parameters
| Parameter | Mandatory | Data Type | Example Values | Applicable Values | Description |
|---|---|---|---|---|---|
| authorization | yes | string | Bearer qwErtY8zyW1abcdefGHI | - | API request authorization token. |
| content-type | yes | string | application/json | application/json | Specifies the resource media type. |
| ic-version | yes | string | v4.2 | v4.2 | API version specifier. |
| if-match | yes | string | 1 | - | Entity tag (ETag) value for the given resource. |
Path parameters
| Parameter | Mandatory | Data Type | Example Values | Description |
|---|---|---|---|---|
| uuid | yes | string | 13c0f286-1190-480c-8a45-b3df00cad9cf | Equinix-assigned service profile identifier. |
Body parameters
| Parameter | Type | Mandatory | Example | Applicable values | Description |
| type | string | yes | L2_PROFILE | L2_PROFILE L3_PROFILE |
Service profile type. 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 | string | yes | A-to-Z |
Maximum: 50 characters Allowed characters: alpha-numeric, hyphens ('-'), underscores ('_') and white spaces (' '). |
Service profile name. |
| description | string | yes | A-to-Z services for your daily cloud needs. Han Solo approved. | Maximum: 375 characters | Service description. |
| notifications | object | no | - | - | Notification preferences and a list of recipients. |
| visibility | string | yes | PUBLIC | PRIVATE PUBLIC |
Service profile visibility. 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. |
| allowedEmails | array[string] | no | ["darth@vader.com","han@solo.com"] | - | Email addresses of users allowed to establish connections based on this service profile. Applicable to PRIVATE visibility service profiles. |
| tags | array[string] | no | SaaS | - | Labels identifying the type of the services advertised by given service profile. |
| accessPointTypeConfigs | array[object] | yes | - | - | Available access points types. |
| customFields | array[object] | no | - | - | User-defined fields added to a service profile. |
| marketingInfo | object | no | - | - | Optional service profile branding, such as the customer's logo. |
| ports | array[object] | no | - | - | Ports associated with the given service profile. |
| notifications | |||||
| emails | array[string] | no | ["l3qa1user1@equinix.com"] | - | List of receipients of a given type of notification. |
| type | string | no | BANDWIDTH_ALERT |
BANDWIDTH_ALERT CONNECTION_APPROVAL PROFILE_LIFECYCLE |
Notification type. BANDWIDTH_ALERT - Bandwidth alert threshold has been reached. CONNECTION_APPROVAL - Connection request awaiting approval. PROFILE_LIFECYCLE - Service profile lifecycle has changed. |
| accessPointTypeConfigs | |||||
| type | string | no | COLO | COLO VD |
Connection endpoint type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. |
| supportedBandwidths | array[integer] | no | [200,500,700,1000] | - | Allowed connection bandwidths (Mbps). |
| allowRemoteConnections | boolean | no | true | true false |
Authorization to establish connections from remote locations. |
| allowCustomBandwidth | boolean | no | true | true false |
Authorization to set a custom connection bandwidth. |
| bandwidthAlertThreshold | integer | no | 75 | Maximum: 100 | Send a bandwidth usage alert when the percentage value of the total bandwidth of the ports associated with the given service profile has been consumed by your subscribers. |
| allowBandwidthAutoApproval | boolean | no | false | true false |
Parameter indicating if bandwidth change requests are approved automatically. |
| linkProtocolConfig | object | no | - | - | Settings and preferences for the link protocol used at the access point. |
| connectionRedundancyRequired | boolean | no | false | - | Requirement to configure a redundant connection. |
| connectionLabel | string | no | Connection | - | An alternative term for connection in case it's different in your organization. |
| authenticationKey | object | no | - | - | Authentication key configuration. |
| apiConfig | object | - | - | API configuration settings and preferences. | |
| accessPointTypes.apiConfig | |||||
| apiAvailable | boolean | false | Authorization to establish connections with this service profile using API. | ||
| equinixManagedPort | boolean | false | Setting indicating that the port is managed by Equinix. | ||
| equinixManagedVlan | boolean | false | Setting indicating that the VLAN is managed by Equinix. | ||
| allowOverSubscription | boolean | false | Allow services sales to exceed the available network bandwidth. | ||
| overSubscriptionLimit | integer | no | 1 |
Minimum: 1 Maximum: 20 |
Port bandwidth multiplier that determines the total bandwidth that
can be allocated to users creating connections to your services. For example, a 10 Gbps port combined with an overSubscriptionLimit parameter value of 10 allows your subscribers to create connections with a total bandwidth of 100 Gbps. |
| bandwidthFromApi | boolean | false | Indicates if the connection bandwidth can be obtained directly from the cloud service provider. | ||
| accessPointTypeConfigs.linkProtocolConfig | |||||
| encapsulationStrategy | string | no | CTAGED | CTAGED NAMED BOTH |
Additional tagging information required by the seller profile. |
| reuseVlanSTag | boolean | no | 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. |
| encapsulation | string | no | DOT1Q | UNTAGGED DOT1Q QINQ |
Data frames encapsulation standard. UNTAGGED - Untagged encapsulation for EPL connections. DOT1Q - DOT1Q encapsulation standard. QINQ - QINQ encapsulation standard. |
| accessPointTypeConfigs.authenticationKey | |||||
| required | boolean | no | true | true false |
Requirement to configure an authentication key. |
| label | string | no | Cloud Account ID | - | Name of the parameter that must be provided to authorize the connection. |
| customFields | |||||
| label | string | yes | ASN | - | Label under which a custom parameter is presented on the Equnix Fabric portal or exposed through an API. |
| description | string | yes | Excluded ASNs: 0, 13884, 36351, 64512, 64513, 65100, 65201–65234, 65402–65433, 65500, and 4201065000–4201065999. | - | Custom parameter description. |
| required | boolean | no | true | true false |
Indicates if a given custom field is mandatory. |
| dataType | string | yes | INTEGER | INTEGER STRING |
Custom field data type. INTEGER - Integer. STRING - String. |
| captureInEmail | boolean | no | false | true false |
Capture the input value and include it in the email notification. |
| marketingInfo | |||||
| promotion | boolean | no | true | true false |
Authorization to promote the given service profile on Equinix website and other products. |
| processSteps | array[object] | no | - | - | A data structure describing the steps necessary to establish connection to the given service provider. |
| marketingInfo.processSteps | |||||
| title | string | no | CreateEquinixFabricConnection | - | Step title. |
| subTitle | string | no | ontheEquinixFabric | - | Step's subtitle. |
| description | string | no | Some very creative and descriptive description. | - | Details of the actions which must be taken to complete the given step. |
| ports | |||||
| type | string | yes | COLO | COLO VD |
Port type. |
| uuid | string | yes | cecd1039-eadd-add3-31e0-387a5c00aeb9 |
Use the Get All Ports API request to retrieve the list of procured ports.< |
Equinix-assigned port identifier. |
If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.
Sample response
Copy
{
"state": "ACTIVE",
"account": {
"orgId": 91785,
"organizationName": "testSeller-270010",
"globalOrgId": "0016u000003JZ4tAAG"
},
"changeLog": {
"createdBy": "fusiontestseller",
"createdByFullName": "fusiontestSeller fusiontestSeller",
"createdByEmail": "fusiontestSeller@equinix.com",
"createdDateTime": {},
"updatedDateTime": {}
},
"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"
]
}
],
"visibility": "PUBLIC",
"allowedEmails": [
"test@equinix.com",
"testagain@equinix.com"
],
"accessPointTypeConfigs": [
{
"type": "COLO",
"uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
"supportedBandwidths": [
100,
500
],
"allowRemoteConnections": false,
"allowCustomBandwidth": true,
"bandwidthAlertThreshold": 10,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {
"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"apiConfig": {
"apiAvailable": false,
"equinixManagedPort": true,
"equinixManagedVlan": true,
"allowOverSubscription": false,
"overSubscriptionLimit": 1,
"bandwidthFromApi": false
},
"connectionLabel": "true1",
"authenticationKey": {
"required": false,
"label": "Service Key"
}
}
],
"marketingInfo": {
"promotion": true
},
"ports": [
{
"type": "XF_PORT",
"uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
"location": {
"href": "https://api.equinix.com/fabric/v4/metros/SY",
"metroCode": "SY"
}
}
],
"metros": [
{
"code": "SY",
"name": "Sydney",
"ibxs": [
"SY4"
],
"displayName": "Sydney"
}
]
}Response payload body description
Response payload includes configuration parameters defined in the request body. The following table contains descriptions of additional information included in the response payload. For descriptions of the remaining fields, refer to the Body parameters section.
| Parameter | Type | Example | Description |
| state | string | ACTIVE |
Service profile lifecycle stage. ACTIVE - Service profile is active and enables establishing connections. DELETED - Service profile has been deleted. PENDING APPROVAL - Service profile awaiting administrator approval. REJECTED - Service profile has been rejected by the administrator. |
| account | object | - | Customer account information. |
| changeLog | object | - | A permanent record of asset creation, modification, or deletion. |
| href | string | https://api.equinix.com/fabric/v4/serviceProfiles/ 57186196-505d-4075-80f5-60e819e30310 | An absolute URL that returns complete specification for the given entity. |
| uuid | string | d48daade-4c18-446d-9c4d-92f6e2f93f55 | Equinix-assigned service profile identifier. |
| accessPointTypeConfigs | array[object] | - | Available access points types. |
| ports | array[object] | - | Ports associated with the given service profile. |
| metros | array[object] | - | Locations where subscribers can access services available through the given service profile. |
| account | |||
| orgId | string | 92214 | Equinix-assigned organization identifier. |
| organizationName | string | testBuyer-270001 | Equinix-assigned organization name. |
| globalOrgId | string | 0016C00000UlveoQAB | Equinix-assigned top-level organization identifier associated with the specified service profile. |
|
globalOrganizationName |
string | Cloud | Equinix-assigned top-level organization name associated with the specified service profile. |
| changeLog | |||
| createdDateTime | string | 2022-01-04T13:31:31.814Z | Asset creation timestamp. |
| accessPointTypeConfigs | |||
| uuid | string | f20c49cd-b022-4aeb-b3e4-49db4389aff3 | Equinix-assigned access point identifier. |
| ports | |||
| location | object | - | Attributes associated with the specified asset location. |
| ports.location | |||
| href | string | https://api.equinix.com/fabric/v4/metros/SY | An absolute URL that returns complete specification for the given entity. |
| metroCode | string | SY | Metropolitan area identifier. |
| metros | |||
| code | string | SV | Metropolitan area identifier. |
| name | string | Silicon Valley | Metropolitan area name. |
| ibxs | array[string] | ["SV5","SV1"] | List of IBX data centers within the given metro where subscribers can access services provided by the given service profile. |
| displayName | string | Silicon Valley | Metropoiltan area name displayed on the service profile in the Equinix Fabric portal. |
Delete Service Profile
| DELETE /fabric/v4/serviceProfiles/{uuid} | |
|---|---|
| Method | DELETE |
| URL or Endpoint | /fabric/v4/serviceProfiles/{uuid} |
| Headers | authorization, ic-version |
| Path Parameters | uuid |
| Query Parameters | Not applicable |
| Body Parameters | Not applicable |
This API request deletes a specified service profile.
Deleting a service profile doesn't deprovision already established connections.
Sample curl request
Copy
curl -X DELETE 'http://api.equinix.com/fabric/v4/serviceProfiles/13c0f286-1190-480c-8a45-b3df00cad9cf'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'ic-version: v4.2'Header parameters
| Parameter | Mandatory | Data Type | Example Values | Applicable Values | Description |
|---|---|---|---|---|---|
| authorization | yes | string | Bearer qwErtY8zyW1abcdefGHI | - | API request authorization token. |
| ic-version | yes | string | v4.2 | v4.2 | API version specifier. |
Path parameters
| Parameter | Mandatory | Data Type | Example | Applicable Values | Description |
| uuid | yes | string | 13c0f286-1190-480c-8a45-b3df00cad9cf |
Use the Retrieve Service Profiles API request to identify the service profile you want to delete. |
Equinix-assigned service profile identifier. |
Sample response
Copy
{
"state": "DELETED",
"account": {
"orgId": 91785,
"organizationName": "testSeller-270010",
"globalOrgId": "0016u000003JZ4tAAG"
},
"changeLog": {
"createdBy": "fusiontestseller",
"createdByFullName": "fusiontestSeller fusiontestSeller",
"createdByEmail": "fusiontestSeller@equinix.com",
"createdDateTime": {},
"updatedBy": "fusiontestseller",
"updatedByFullName": "fusiontestSeller fusiontestSeller",
"updatedByEmail": "fusiontestSeller@equinix.com",
"updatedDateTime": {}
},
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
"type": "L2_PROFILE",
"name": "Service Profile 2",
"uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
"description": "Sample_description",
"notifications": [
{
"type": "BANDWIDTH_ALERT",
"emails": [
"someone@sample.com"
]
},
{
"type": "CONNECTION_APPROVAL",
"emails": [
"someone@sample.com"
]
},
{
"type": "PROFILE_LIFECYCLE",
"emails": [
"someone@sample.com"
]
}
],
"tags": [
"sample_tag"
],
"visibility": "PUBLIC",
"allowedEmails": [
"test@equinix.com",
"testagain@equinix.com"
],
"accessPointTypeConfigs": [
{
"type": "COLO",
"uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
"supportedBandwidths": [
100,
500
],
"allowRemoteConnections": false,
"allowCustomBandwidth": true,
"bandwidthAlertThreshold": 10,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {
"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"apiConfig": {
"apiAvailable": false,
"equinixManagedPort": true,
"equinixManagedVlan": true,
"allowOverSubscription": false,
"overSubscriptionLimit": 1,
"bandwidthFromApi": false
},
"connectionLabel": "true1",
"authenticationKey": {
"required": false,
"label": "Service Key"
}
}
],
"marketingInfo": {
"promotion": true
},
"ports": [
{
"type": "XF_PORT",
"uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
"location": {
"href": "https://api.equinix.com/fabric/v4/metros/SY",
"metroCode": "SY"
}
}
],
"metros": [
{
"code": "SY",
"name": "Sydney",
"ibxs": [
"SY4"
],
"displayName": "Sydney"
}
]
}Response payload body description
| Parameter | Type | Example | Description |
| state | string | ACTIVE |
Service profile lifecycle stage. ACTIVE - Service profile is active and enables establishing connections. DELETED - Service profile has been deleted. PENDING APPROVAL - Service profile awaiting administrator approval. REJECTED - Service profile has been rejected by the administrator. |
| account | object | - | Customer account information. |
| changeLog | object | - | A permanent record of asset creation, modification, or deletion. |
| href | string | https://api.equinix.com/fabric/v4/serviceProfiles/ 57186196-505d-4075-80f5-60e819e30310 | An absolute URL that returns complete specification for the given entity. |
| type | string | L2_PROFILE |
Service profile type. 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 | string | E2E-SPHL2Name-040122133102496 | Service profile name. |
| uuid | string | d48daade-4c18-446d-9c4d-92f6e2f93f55 | Equinix-assigned service profile identifier. |
| description | string | E2E-This is SPH Description [...] | Service description. |
| notifications | object | - |
Notification preferences and a list of recipients. |
| tags | array[string] | SaaS | Labels identifying the type of the services advertised by given service profile. |
| visibility | string | PRIVATE |
Service profile visibility. 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. |
| allowedEmails | array[string] | ["darth@vader.com","han@solo.com"] | Email addresses of users allowed to establish connections based on this service profile. |
| accessPointTypeConfigs | array[object] | - | Available access points types. |
| customFields | array[object] | - | User-defined fields added to a service profile. |
| marketingInfo | object | - | Optional service profile branding, such as the customer's logo. |
| ports | array[object] | - |
Ports associated with the given service profile. |
| metros | array[object] | - | Locations where subscribers can access services available through the given service profile. |
| selfProfile | boolean | true | Indicates if the service profile and the user interacting with the API belong to the same organization. |
| account | |||
| orgId | string | 92214 |
Equinix-assigned organization identifier. |
| organizationName | string | testBuyer-270001 | Equinix-assigned organization name. |
| globalOrgId | string | 0016C00000UlveoQAB | Equinix-assigned top-level organization identifier associated with the specified service profile. |
|
globalOrganizationName |
string | Cloud | Equinix-assigned top-level organization name associated with the specified service profile. |
| changeLog | |||
| createdBy | string | testBuyer999 | Identity of the asset creator. |
| createdDateTime | string | 2022-01-04T13:31:31.814Z | Asset creation timestamp. |
| updatedBy | string | eqx-admin999 | Identity of the person who updated the asset. |
| updatedDateTime | string | 2022-01-04T13:31:45.981Z | Asset update request timestamp. |
| createdByEmail | string | testBuyer999@equinix.com | Email address of the asset creator. |
| updatedByEmail | string | eqx-admin999@equinix.com | Email address of the person who updated the asset. |
| createdByFullName | string | testBuyer999 testBuyer999 | First and last name of the asset creator. |
| updatedByFullName | string | eqx-admin999 eqx-admin999 | First and last name of the person who updated the asset. |
| notifications | |||
| emails | array[string] | ["l3qa1user1@equinix.com"] | List of receipients of a given type of notification. |
| type | string | BANDWIDTH_ALERT |
Notification type. BANDWIDTH_ALERT - Bandwidth alert threshold has been reached. CONNECTION_APPROVAL - Connection request awaiting approval. PROFILE_LIFECYCLE - Service profile lifecycle has changed. |
| accessPointTypeConfigs | |||
| type | string | COLO |
Access point type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. |
| uuid | string | f1d3b691-09cb-4570-8567-137ce1ca6328 | Equinix-assigned access point identifier. |
| supportedBandwidths | array[integer] | [200,500,700,1000] | Allowed connection bandwidths (Mbps). |
| allowRemoteConnections | boolean | true | Authorization to establish connections from remote locations. |
| allowCustomBandwidth | boolean | true | Authorization to set a custom connection bandwidth. |
| bandwidthAlertThreshold | integer | 75 | Send a bandwidth usage alert when the percentage value of the total bandwidth of the ports associated with the given service profile has been consumed by your subscribers. |
| allowBandwidthAutoApproval | boolean | false | Parameter indicating if bandwidth change requests are approved automatically. |
| linkProtocolConfig | object | - | Settings and preferences for the link protocol used at the access point. |
| enableAutoGenerateServiceKey | boolean | false | Applicable to Verizon Software Defined Interconnect service profile. |
| connectionRedundancyRequired | boolean | false | Indicates if connecting to the service requires creating a pair of redundant connections. |
| apiConfig | object | - | API configuration settings and preferences. |
| connectionLabel | string | Connection | An alternative term for connection in case it's different in your organization. |
| authenticationKey | object | - | Authentication key configuration. |
| metadata | object | - | Additional connection information. |
| accessPointTypeConfigs.linkProtocolConfig | |||
| encapsulationStrategy | string | CTAGED | Additional tagging information required by the seller profile. |
| reuseVlanSTag | boolean | 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. |
| encapsulation | string | DOT1Q |
Data frames encapsulation standard. UNTAGGED - Untagged encapsulation for EPL connections. DOT1Q - DOT1Q encapsulation standard. QINQ - QINQ encapsulation standard. |
| accessPointTypeConfigs.apiConfig | |||
| apiAvailable | boolean | false | Indicates if it's possible to establish connections based on the given service profile using the Equinix Fabric API. |
| integrationId | string | AWS-DirectConnect-01 | A unique identifier issued during onboarding and used to integrate the customer's service profile with the Equinix Fabric API. |
| equinixManagedPort | boolean | false | Setting indicating that the port is managed by Equinix. |
| equinixManagedVlan | boolean | false | Setting indicating that the VLAN is managed by Equinix. |
| allowOverSubscription | boolean | false | Allow services sales to exceed the available network bandwidth. |
| overSubscriptionLimit | integer | 1 |
Port bandwidth multiplier that determines the total bandwidth that
can be allocated to users creating connections to your services. For example, a 10 Gbps port combined with an overSubscriptionLimit parameter value of 10 allows your subscribers to create connections with a total bandwidth of 100 Gbps. Applicable for viewPoint query parameter set to zSide. |
| bandwidthFromApi | boolean | false | Indicates if the connection bandwidth can be obtained directly from the cloud service provider. |
| accessPointTypeConfigs.authenticationKey | |||
| required | boolean | true | Requirement to configure an authentication key. |
| label | string | Cloud Account ID | Name of the parameter that must be provided to authorize the connection. |
| accessPointTypeConfigs.metadata | |||
| allowVcMigration | boolean | true | Indicates if connections established based on the given service profile can be migrated to a different A-side port. |
| customFields | |||
| label | string | ASN | Label under which a custom parameter is presented on the Equnix Fabric portal or exposed through an API. |
| description | string | Excluded ASNs: 0, 13884, 36351, 64512, 64513, 65100, 65201–65234, 65402–65433, 65500, and 4201065000–4201065999. | Custom parameter description. |
| required | boolean | true | Indicates if a given custom field is mandatory. |
| dataType | string | INTEGER |
Custom field data type. INTEGER - Integer. STRING - String. |
| captureInEmail | boolean | false | Capture the input value and include it in the email notification. |
| marketingInfo | |||
| promotion | boolean | true | Authorization to promote the given service profile on Equinix website and other products. |
| processSteps | array[object] | - | A data structure describing the steps necessary to establish connection to the given service provider. |
| marketingInfo.processSteps | |||
| title | string | Create Equinix Fabric Connection | Step title. |
| subTitle | string | on the Equinix Fabric | Step's subtitle. |
| description | string | Some very creative and descriptive description. | Details of the actions which must be taken to complete the given step. |
| ports | |||
| type | string | COLO | Port type. |
| uuid | string | c791f8cb-5c8f-c8f0-8ce0-306a5c00a4ee | Equinix-assigned port identifier. |
| location | object | - | Attributes associated with the specified asset location. |
| sellerRegion | string | ap-southeast-2 | Seller region where the port is located. |
| ports.location | |||
| href | string | https://api.equinix.com/fabric/v4/metros/SV | An absolute URL that returns complete specification for the given entity. |
| metroCode | string | SV | Metropolitan area identifier. |
| metros | |||
| code | string | SV | Metropolitan area identifier. |
| name | string | Silicon Valley | Metropolitan area name. |
| ibxs | array[string] | ["SV5","SV1"] | List of IBX data centers within the given metro where subscribers can access services provided by the given service profile. |
| displayName | string | Silicon Valley | Metropoiltan area name displayed on the service profile in the Equinix Fabric portal. |
