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 Precision Time API

Precision Time

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

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

This API exposes 9 operations across 6 paths, and defines 112 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 6 paths 112 schemas 1 DELETE4 GET1 PATCH2 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 6 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Precision Time 9

Precision Time

POST
/fabric/v4/timeServices
Create Time Service
createTimeServices body → 202400401403415500
GET
/fabric/v4/timeServices/{serviceId}
Get Service By ID.
getTimeServicesById 1 param → 200400401403404415500
PUT
/fabric/v4/timeServices/{serviceId}
Configure Service.
fulfillTimeServices 1 param body → 202400401403404415500
DELETE
/fabric/v4/timeServices/{serviceId}
Delete by ID.
deleteTimeServiceById 1 param → 202401403404415500
PATCH
/fabric/v4/timeServices/{serviceId}
Update By ID.
updateTimeServicesById 1 param body → 202400401403404415500
POST
/fabric/v4/timeServices/search
Search Time Services
searchTimeServices body → 200400401403415500
GET
/fabric/v4/timeServices/{serviceId}/connections
Get Connection Links
getTimeServicesConnectionsByServiceId 1 param → 200401403415500
GET
/fabric/v4/timeServicePackages
Get Packages
getTimeServicesPackages → 200415500
GET
/fabric/v4/timeServicePackages/{packageCode}
Get Package By Code
getTimeServicesPackageByCode 1 param → 200415500

Schemas 112

The contract defines 112 schemas that model the data the API accepts and returns. The most detailed are SimplifiedPort (30 properties), ServiceProfileMetadata (19 properties), PhysicalPort (17 properties), SimplifiedServiceProfile (17 properties). Each schema is shown below with its type and property counts.

TimeServiceSimpleExpression
object
3 properties
NetworkEquinixStatus
string
Network status
Bandwidths
array
ptpAdvanceConfiguration
object
PTP Advanced Configuration.
9 properties
SimplifiedNetworkChange
object
Current state of latest network change
3 properties
AccessPointType
string
Access point type
PortServiceCode
string
type of product
VirtualDevice
object
Virtual Device AccessPoint Information
6 properties
AccessPoint
object
Access point object
17 properties
precisionTimeChangeOperation
object
Fabric Precision Timing change operation data
3 properties 3 required
precisionTimeServicePackagesResponse
object
Precision Packages
2 properties
connectionLink
object
3 properties
PortState
string
Port lifecycle state
Interface
object
Interface Information
5 properties
ProcessStep
object
Definition of customized step while making connection
3 properties
PortPriority
string
Port priority in redundancy group
CloudRouterPostRequestPackage
object
Fabric Cloud Router Package Type
3 properties 1 required
ServiceProfileTypeEnum
string
Service profile type
precisionTimeOrder
object
Precision Time Order
3 properties
PortInterface
object
Port interface
1 property
ApiConfig
object
Configuration for API based Integration for Service Profile
7 properties
PeeringType
string
Access point peering type
LinkProtocolType
string
Type of Link Protocol
ServiceProfileAccessPointTypeVD
object
VirtualDevice Access Point Type
5 properties 1 required
NetworkType
string
Network type
NetworkState
string
Network status
ServiceProfileLinkProtocolConfig
object
Configuration for dot1q to qinq translation support
5 properties
PhysicalPortType
string
Type of Port
ipv4
object
EPT service network information
4 properties 3 required
PaginationRequest
object
Pagination request information
2 properties
ServiceMetro
object
7 properties
NetworkChangeType
string
Type of change
PortType
string
Type of Port
ServiceProfileMetadata
object
Metadata. Response attribute. Ignored on request payload.
19 properties
ServiceProfileVisibilityEnum
string
PortEncapsulation
object
Port encapsulation configuration
2 properties
PortOperation
object
Operational specifications for ports.
6 properties
Changelog
object
Change log
12 properties
PortSettings
object
Port configuration settings
7 properties
ServiceProfileAccessPointVD
object
Virtual Device Point
4 properties 2 required
marketplaceSubscription
object
Equinix Fabric Entity for Marketplace Subscription
3 properties
precisionTimePackageRequest
object
Precision Time Service Level Request
1 property 1 required
PortTether
object
Port physical connection
7 properties
PriceCharge
object
Price Charge
2 properties
PhysicalPort
object
Physical Port specification
17 properties
precisionTimePackagePostResponse
object
2 properties 1 required
virtualConnectionUuid
object
UUID of the Fabric Connection Instance
3 properties 1 required
PortAdditionalInfo
object
Additional information
2 properties
CloudRouter
object
Fabric Cloud Router object
9 properties
ntpAdvanceConfiguration
array
NTP Advanced configuration - MD5 Authentication.
Tags
array
ServiceSearchResponse
object
2 properties
ServiceProfileAccessPointTypeEnum
string
Access point type
SimplifiedNotification
object
4 properties 2 required
md5
object
3 properties
SimplifiedLocation
object
5 properties
PhysicalPortSettings
object
Physical Port configuration settings
2 properties
Bandwidth
integer
speed in Mbps
Link
object
5 properties
Pagination
object
Pagination response information
5 properties 2 required
NetworkScope
string
Network scope
virtualConnectionSide
object
Fabric Connection access point object.
1 property
PortLoa
object
Port Loas
2 properties
PortDevice
object
Port device
3 properties
CloudRouterChangeOperation
object
Fabric Cloud Router change operation data
3 properties 3 required
TimeServicesSearchRequest
object
Search requests containing criteria
3 properties
NetworkOperation
object
Network operational data
1 property
PortOrder
object
6 properties
precisionTimeServiceResponse
object
Precision Time Service Response Schema.
16 properties 5 required
SimplifiedNetwork
object
Network specification
12 properties 1 required
ServiceProfileAccessPointCOLO
object
Colo Access Point
6 properties 2 required
timeServiceOperation
object
time service operational data
1 property
SimplifiedLinkProtocol
object
Connection link protocol Configuration
4 properties
VirtualNetwork
object
Virtual Network Information
2 properties
CloudRouterChange
object
Current state of latest CloudRouter change
7 properties 2 required
ServiceProfileAccessPointType
object
Access Point Type
TimeServiceSortCriteria
object
2 properties
TimeServiceFilter
object
PortOrderSignatureDelegate
object
order delegate details
3 properties
CustomField
object
Define Custom Attributes
6 properties 3 required
PriceError_additionalInfo
object
2 properties
ServiceId
string
Precision Time Service UUID
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
TimeServiceOrFilter
object
1 property
precisionTimePrice
object
Precision Time Price
2 properties
precisionTimeServiceConnectionsResponse
object
EPT service instance's L2 connections
2 properties
MarketingInfo
object
3 properties
precisionTimeServiceRequest
object
Create Precision Time Service Request Schema.
9 properties 5 required
ServiceProfileAccessPointTypeCOLO
object
Colo Access Point Type
16 properties 1 required
ErrorList
array
List of Error Message
MetalInterconnection
object
Metal Interconnection
1 property
TimeServiceSortDirection
string
Sorting direction
TimeServiceSortBy
string
Possible field names to use on sorting
CloudRouterAccessPointState
string
Access point lifecycle state
PortOrderSignature
object
Port signature details
2 properties
PortDeviceRedundancy
object
Device redundancy
2 properties
Order
object
7 properties
SimplifiedAccount
object
12 properties
Project
object
1 property 1 required
PortNotification
object
2 properties 2 required
virtualConnectionTimeServiceResponse
object
Fabric Connection Precision Time Service Response Object
5 properties
PortRedundancy
object
Port redundancy configuration
3 properties
SimplifiedLocationWithoutIBX
object
4 properties 1 required
CloudRouterPostRequestBase
object
Create Cloud Router
9 properties
precisionTimePackageResponse
object
EPT Service Package Information
12 properties 3 required
TimeServiceFilters
object
1 property
PortDemarcationPoint
object
Customer physical Port
8 properties
Error
object
Error Response with details
6 properties 2 required
PortOrderPurchaseOrder
object
purchase order
7 properties
SimplifiedPort
object
Port specification
30 properties
Package
object
Package settings for port
2 properties
AuthenticationKey
object
Authentication Key Support and Customization
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-precision-time-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