Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Equinix Service Profiles API

Service Profiles

Equinix Service Profiles API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Service Profiles. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 5 paths, and defines 53 schemas. It is described by OpenAPI 3.0.1, at version 1.2.

Requests are made against a single base URL, https://api.equinix.com.

9 operations 5 paths 53 schemas 1 DELETE3 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.2
Base URL
https://api.equinix.com
Terms of Service
Resource Areas
1

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Service Profiles 9

Service Profiles

GET
/fabric/v4/serviceProfiles
Get all Profiles
getServiceProfiles 3 params → 200400401403500
POST
/fabric/v4/serviceProfiles
Create Profile
createServiceProfile body → 201400401403500
POST
/fabric/v4/serviceProfiles/search
Profile Search
searchServiceProfiles 1 param body → 200400401500
GET
/fabric/v4/serviceProfiles/{serviceProfileId}
Get Profile
getServiceProfileByUuid 2 params → 200400401403500
PUT
/fabric/v4/serviceProfiles/{serviceProfileId}
Replace Profile
putServiceProfileByUuid 2 params body → 202400401403404500
DELETE
/fabric/v4/serviceProfiles/{serviceProfileId}
Delete Profile
deleteServiceProfileByUuid 1 param → 200400401403404500
PATCH
/fabric/v4/serviceProfiles/{serviceProfileId}
Update Profile
updateServiceProfileByUuid 1 param body → 200400401403404500
POST
/fabric/v4/serviceProfiles/{serviceProfileId}/actions
Profile Actions
createServiceProfileAction 1 param body → 201400401403404500
GET
/fabric/v4/serviceProfiles/{serviceProfileId}/metros
Get Profile Metros
getServiceProfileMetrosByUuid 3 params → 200400401403500

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are ServiceProfileMetadata (19 properties), SimplifiedServiceProfile (17 properties), ServiceProfileAccessPointTypeCOLO (16 properties), SimplifiedAccount (12 properties). Each schema is shown below with its type and property counts.

Bandwidths
array
ServiceProfileRequest
object
Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information…
1 property 3 required
ServiceProfileSortCriteria
object
2 properties
ServiceProfileTypeEnum
string
Service profile type
ProcessStep
object
Definition of customized step while making connection
3 properties
AddOperation
object
Add Sub-Resource to the existing model
3 properties 3 required
ApiConfig
object
Configuration for API based Integration for Service Profile
7 properties
ServiceProfileActionResponse
object
Service Profile Action Response
5 properties
ServiceProfileAccessPointTypeVD
object
VirtualDevice Access Point Type
5 properties 1 required
ServiceProfileLinkProtocolConfig
object
Configuration for dot1q to qinq translation support
5 properties
PaginationRequest
object
Pagination request information
2 properties
ServiceProfileId
string
Service Profile UUID
ServiceMetro
object
7 properties
ServiceProfileSimpleExpression
object
3 properties
ServiceProfileMetadata
object
Metadata. Response attribute. Ignored on request payload.
19 properties
ServiceProfileSortDirection
string
Sorting direction
ServiceProfileVisibilityEnum
string
ServiceProfileChange
object
Current state of latest service profile change
7 properties 2 required
Changelog
object
Change log
12 properties
ServiceProfileAccessPointVD
object
Virtual Device Point
4 properties 2 required
ServiceProfiles
object
Service Profiles
2 properties
ServiceMetros
object
Service Profile Metros
2 properties
ReplaceOperation
object
Replace attribute value or sub-resource in the existing model
3 properties 3 required
ServiceProfileSortBy
string
Possible field names to use on sorting
Tags
array
JsonPatchOperation
object
Service Profile Access Points
ServiceProfileAccessPointTypeEnum
string
Access point type
SimplifiedNotification
object
4 properties 2 required
SimplifiedLocation
object
5 properties
JsonPatch_1
array
Bandwidth
integer
speed in Mbps
Pagination
object
Pagination response information
5 properties 2 required
ServiceProfileStateEnum
string
Equinix assigned state.
ServiceProfileAndFilter
object
1 property
ServiceProfileAccessPointCOLO
object
Colo Access Point
6 properties 2 required
ServiceProfileAccessPointType
object
Access Point Type
ServiceProfileActionRequest
object
Service Profile Action Request
2 properties 1 required
ServiceProfileFilter
object
CustomField
object
Define Custom Attributes
6 properties 3 required
Path
string
A JSON Pointer path.
PriceError_additionalInfo
object
2 properties
ServiceProfile
object
Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information…
5 properties
SimplifiedServiceProfile
object
Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information…
17 properties
MarketingInfo
object
3 properties
ServiceProfileAccessPointTypeCOLO
object
Colo Access Point Type
16 properties 1 required
ErrorList
array
List of Error Message
ServiceProfileSearchRequest
object
Search requests containing criteria
3 properties
SimplifiedAccount
object
12 properties
RemoveOperation
object
Remove sub-resource from an existing model
2 properties 2 required
Project
object
1 property 1 required
OpEnum
string
the operation to be performed
Error
object
Error Response with details
6 properties 2 required
AuthenticationKey
object
Authentication Key Support and Customization
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-service-profiles-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
Equinix Agents API
Equinix Authentication API
Equinix availability API
Equinix Batches API
Equinix BGP API
Equinix Capacity API
Equinix Cloud Events API
Equinix Cloud Routers API
Equinix Company Profiles API
Equinix Connections API
Equinix Console Log Details API