Skip to main content
Loading...

API docs by

Create Time Service

Request

The API provides capability to create Precision Time service

Security
BearerAuth
Bodyapplication/jsonrequired
typestringrequired

Precision Time Service Type refers to the corresponding Protocol.

Enum:"NTP""PTP"
namestringrequired

Precision Time Service name.

packageobject(precisionTimePackageRequest)required

Precision Time Service Level Request

Example:
{
  "code": "NTP_STANDARD"
}
connectionsArray of objects(fabricConnectionUuid)required
Example:
[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  }
]
ipv4object(ipv4)required

EPT service network information

Example:
{
  "primary": "10.0.0.1",
  "secondary": "10.0.0.2",
  "networkMask": "255.255.255.240",
  "defaultGateway": "10.0.0.3"
}
ntpAdvancedConfigurationArray of objects(ntpAdvanceConfiguration)

NTP Advanced configuration - MD5 Authentication.

ptpAdvancedConfigurationobject(ptpAdvanceConfiguration)

PTP Advanced Configuration.

projectobject(Project)
orderobject(precisionTimeOrder)

Precision Time Order

Payload
{
  "type": "NTP",
  "name": "EPT-NTP-Service",
  "connections": [
    { … }
  ],
  "package": {
    "code": "NTP_STANDARD"
  },
  "ipv4": {
    "primary": "192.168.0.2",
    "secondary": "192.168.0.3",
    "networkMask": "255.255.255.255",
    "defaultGateway": "192.167.0.1"
  }
}

Responses

Successful Accepted operation

Bodyapplication/json
hrefstring, (uri)required

Precision Time Service URI.

typestringrequired

Precision Time Service type refers to the corresponding protocol.

Enum:"NTP""PTP"
namestring

Precision Time Service Name.

uuidstring, (uuid)required

Precision Time Service UUID.

statestringrequired

Precision Time Service Status.

Enum:"CANCELLED""CANCELLING""CONFIGURING""CONFIGURING_FAILED""DRAFT""DEPROVISIONING""DEPROVISIONING_FAILED""DEPROVISIONED""PROVISIONED""PROVISIONING"
operationobject(timeServiceOperation)

time service operational data

packageobject(precisionTimePackagePostResponse)required
Example:
{
  "href": "https://api.equinix.com/fabric/v4/timeServicePackage/NTP_STANDARD",
  "code": "NTP_STANDARD"
}
connectionsArray of objects, [ 1 .. 2 ] items, unique(fabricConnectionResponse)

Fabric Connections associated with Precision Time Service.

ipv4object(ipv4)

EPT service network information

Example:
{
  "primary": "10.0.0.1",
  "secondary": "10.0.0.2",
  "networkMask": "255.255.255.240",
  "defaultGateway": "10.0.0.3"
}
ntpAdvancedConfigurationArray of objects(ntpAdvanceConfiguration)

NTP Advanced configuration - MD5 Authentication.

ptpAdvancedConfigurationobject(ptpAdvanceConfiguration)

PTP Advanced Configuration.

projectobject(Project)
accountobject(SimplifiedAccount)
orderobject(precisionTimeOrder)

Precision Time Order

changeLogobject(Changelog)

Change log

Response
{
  "href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
  "type": "NTP",
  "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
  "name": "EPT-NTP-Service",
  "state": "PROVISIONING",
  "connections": [
    { … }
  ],
  "package": {
    "href": "https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD",
    "code": "NTP_STANDARD"
  },
  "ipv4": {
    "primary": "192.168.0.2",
    "secondary": "192.168.0.3",
    "networkMask": "255.255.255.255",
    "defaultGateway": "192.167.0.1"
  },
  "account": {
    "accountNumber": 123456
  },
  "changeLog": {
    "createdByEmail": "abc@xyz.com",
    "createdDateTime": "2024-08-24T06:50:46Z",
    "updatedByEmail": "abc@xyz.com",
    "updatedDateTime": "2024-08-24T06:51:46Z"
  }
}
Was this page helpful?