Skip to main content
Loading...

API docs by

Create Service Profile

Request

Create Service Profile creates Equinix Fabric™ Service Profile

Security
BearerAuth
Bodyapplication/jsonrequired
typestring(ServiceProfileTypeEnum)required

Service profile type

Enum:"L2_PROFILE""L3_PROFILE""IA_PROFILE""IX_PROFILE""IC_PROFILE""LMAAS_PROFILE"
Example:"L2_PROFILE"
namestring, <= 50 charactersrequired

Customer-assigned service profile name

Example:"Sample Service Profile"
uuidstring, (uuid)

Equinix-assigned service profile identifier

descriptionstringrequired

User-provided service description should be of maximum length 375

Example:"offering connectivity to my-network"
notificationsArray of objects(SimplifiedNotification)

Recipients of notifications on service profile change

tagsArray of strings(Tags)
visibilitystring(ServiceProfileVisibilityEnum)
Enum:"PRIVATE""PUBLIC"
allowedEmailsArray of strings, (email)
accessPointTypeConfigsArray of objects, non-empty(ServiceProfileAccessPointType)
customFieldsArray of objects(CustomField)
marketingInfoobject(MarketingInfo)
portsArray of objects(ServiceProfileAccessPointCOLO)
virtualDevicesArray of objects(ServiceProfileAccessPointVD)
metrosArray of objects(ServiceMetro)

Derived response attribute.

environmentsArray of objects(ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. Beta

projectIdstring
lastMileConfigobject(ServiceProfileLastMileConfig)

Last-mile provider catalogs and offerings available for this service profile.

Example:
[
  {
    "apiIntegration": { … },
    "contactInfo": [ … ],
    "productCatalogs": [ … ]
  }
]
projectobject(Project)
Payload
{
  "name": "Service Profile 1",
  "description": "Sample_description",
  "type": "L2_PROFILE",
  "notifications": [
    { … }
  ],
  "visibility": "PUBLIC",
  "allowedEmails": [
    "test@equinix.com",
    "testagain@equinix.com"
  ],
  "ports": [
    { … }
  ],
  "marketingInfo": {
    "promotion": true
  },
  "accessPointTypeConfigs": [
    { … }
  ]
}

Responses

Successful Create operation

Headers
ETagstring

response header - identifier for a specific version of a resource.

Bodyapplication/json; charset=UTF-8
hrefstring, (uri)read-only

Service Profile URI response attribute

typestring(ServiceProfileTypeEnum)

Service profile type

Enum:"L2_PROFILE""L3_PROFILE""IA_PROFILE""IX_PROFILE""IC_PROFILE""LMAAS_PROFILE"
Example:"L2_PROFILE"
namestring, <= 50 characters

Customer-assigned service profile name

Example:"Sample Service Profile"
uuidstring, (uuid)

Equinix-assigned service profile identifier

descriptionstring

User-provided service description should be of maximum length 375

Example:"offering connectivity to my-network"
notificationsArray of objects(SimplifiedNotification)

Recipients of notifications on service profile change

tagsArray of strings(Tags)
visibilitystring(ServiceProfileVisibilityEnum)
Enum:"PRIVATE""PUBLIC"
allowedEmailsArray of strings, (email)
accessPointTypeConfigsArray of objects, non-empty(ServiceProfileAccessPointType)
customFieldsArray of objects(CustomField)
marketingInfoobject(MarketingInfo)
portsArray of objects(ServiceProfileAccessPointCOLO)
virtualDevicesArray of objects(ServiceProfileAccessPointVD)
metrosArray of objects(ServiceMetro)

Derived response attribute.

environmentsArray of objects(ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. Beta

selfProfilebooleanread-only

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectIdstring
lastMileConfigobject(ServiceProfileLastMileConfig)

Last-mile provider catalogs and offerings available for this service profile.

Example:
[
  {
    "apiIntegration": { … },
    "contactInfo": [ … ],
    "productCatalogs": [ … ]
  }
]
statestring(ServiceProfileStateEnum)

Equinix assigned state.

Enum:"ACTIVE""PENDING_APPROVAL""DELETED""REJECTED"
Example:"ACTIVE"
accountobject(SimplifiedAccount)

Seller Account for Service Profile.

projectobject(Project)
changeobject(ServiceProfileChange)

Current state of latest service profile change

changeLogobject(Changelog)

Seller Account for Service Profile.

Response
{
  "state": "PENDING_APPROVAL",
  "account": {
    "orgId": 91785,
    "globalOrgId": "0016u000003JZ4tAAG"
  },
  "changeLog": {
    "createdDateTime": "2022-04-12T19:06:57.940Z"
  },
  "href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
  "type": "L2_PROFILE",
  "name": "Service Profile 1",
  "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
  "description": "Sample_description",
  "notifications": [
    { … },
    { … },
    { … }
  ],
  "visibility": "PUBLIC",
  "allowedEmails": [
    "test@equinix.com",
    "testagain@equinix.com"
  ],
  "accessPointTypeConfigs": [
    { … }
  ],
  "marketingInfo": {
    "promotion": true
  },
  "ports": [
    { … }
  ],
  "metros": [
    { … }
  ]
}
Was this page helpful?