Skip to main content
Loading...

API docs by

Get Service Profile

Request

Get service profile by UUID. View Point parameter if set to zSide will give seller's view of the profile otherwise buyer's view

Security
BearerAuth
Path
serviceProfileIdstring, (uuid)required

Service Profile UUID

Query
viewPointstring

flips view between buyer and seller representation

Default:"aSide"
Enum:"aSide""zSide"
Payload
// No request payload

Responses

Successful 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": "ACTIVE",
  "account": {
    "organizationName": "testSeller-270010"
  },
  "changeLog": {
    "createdBy": "fusiontestseller",
    "createdByFullName": "fusiontestSeller fusiontestSeller",
    "createdByEmail": "fusiontestSeller@equinix.com",
    "createdDateTime": "2022-04-12T19:06:57.940Z",
    "updatedBy": "fusiontestseller",
    "updatedByFullName": "fusiontestSeller fusiontestSeller",
    "updatedByEmail": "fusiontestSeller@equinix.com",
    "updatedDateTime": "2022-04-12T19:11:04.017Z"
  },
  "href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f?viewPoint=aSide",
  "type": "L2_PROFILE",
  "name": "Service Profile 2",
  "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
  "description": "Sample_description",
  "visibility": "PUBLIC",
  "allowedEmails": [
    "test@equinix.com",
    "testagain@equinix.com"
  ],
  "accessPointTypeConfigs": [
    { … }
  ],
  "marketingInfo": {
    "promotion": true
  },
  "metros": [
    { … }
  ],
  "selfProfile": true
}
Was this page helpful?