Precision Time

Get Time Service

GET /fabric/v4/timeServices/{serviceId}
Method GET
URL or Endpoint /fabric/v4/timeServices/{serviceId}
Headers Authorization
Path Parameters serviceId
Query Parameters Not applicable
Body Parameters Not applicable

Returns precision time service details.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.


Sample curl request

Copy 
curl -X
GET 'https://api.equinix.com/fabric/v4/timeServices/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
uuid string
REQUIRED
 Equinix-assigned service Id.

Sample response

Copy 
{
    "href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
    "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
    "name": "EPT-Single-Service",
    "type": "NTP",
    "state": "PROVISIONING",
    "connections": [
        {
        "href": "https://api.equinix.com/fabric/v4/connections/a8ba52de-faae-43b5-b0b1-6904d37ee011",
        "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
        }
    ],
    "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.240",
        "defaultGateway": "192.168.0.1"
    },
    "account": {
        "accountNumber": 123456
    }
}

Response payload body description

Parameter
Description
href string
 An absolute URL that has the location of the EPT service.
Example:https://api.equinix.com/fabric/v4/timeServices/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid string
 Equinix-assigned time service identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
name string
 Time service name.
Example: EPT-Single-Service
type string
 Type of time service.
Example:
  • NTP.
  • PTP
state string
 State of the time service.
Example: PROVISIONED. PROVISIONING, PROVISIONING_FAILED, CONFIGURING, CANCELLED, DEPROVISIONING_FAILED, PENDING_CONFIGURATION, DEPROVISIONED, CONFIGURING_FAILED, DEPROVISIONING
connections array
 An array of connection objects.
href string
 An absolute URL that has the location of the connection.
Example:https://api.equinix.com/fabric/v4/connections/4a58dd05-f46d-4b1d-a154-2e85c396ea54
uuid string
 Unique identifier of the connection.
Example: 06dbb0e3-e55d-4090-8aff-fc5654abaad0
package object
 Package details.
href string
 An absolute URL that has the location of the package.
Example:https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD
code string
 Cloud router package code.
Example: NTP_STANDARD
ipv4 object
 EPT service network information.
primary string
 Primary ipv4.
Example: 192.168.0.2
secondary string
 Secondary ipv4.
Example: 192.168.0.3
networkMask string
 Network mask.
Example: 255.255.255.240
defaultGateway string
 Default gateway.
Example: 192.168.0.1
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Delete Time Service

DELETE /fabric/v4/timeServices/{serviceId}
Method DELETE
URL or Endpoint /fabric/v4/timeServices/{serviceId}
Headers Authorization
Path Parameters serviceId
Query Parameters Not applicable
Body Parameters Not applicable

Deletes precision time service by its unique identifier.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.


Sample curl request

Copy 
curl -X
DELETE 'https://api.equinix.com/fabric/v4/timeServices/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
uuid string
REQUIRED
 Equinix-assigned service Id.

Sample response

Copy 
{
    "href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
    "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
    "name": "EPT-Single-Service",
    "type": "NTP",
    "state": "PROVISIONING",
    "connections": [
        {
        "href": "https://api.equinix.com/fabric/v4/connections/a8ba52de-faae-43b5-b0b1-6904d37ee011",
        "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
        }
    ],
    "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.240",
        "defaultGateway": "192.168.0.1"
    },
    "account": {
        "accountNumber": 123456
    }
}

Refer to the response of Get Time Service for the field descriptions.


If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Patch Time Service

PATCH /fabric/v4/timeServices/{serviceId}
Method PATCH
URL or Endpoint /fabric/v4/timeServices/{serviceId}
Headers Authorization
Path Parameters serviceId
Query Parameters Not applicable
Body Parameters op, path, value

Updates time service parameters by ihe unique identifier of the service.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.


Sample curl request

Copy 
curl -X
PATCH 'https: //api.equinix.com/fabric/v4/timeServices/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/name",
        "value": "EPT-Single-Service"
    }
]'

Path parameters

Parameter
Description
uuid string
REQUIRED		 Equinix-assigned service identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Body parameters

Parameter
Description
op string
REQUIRED
 Request type.
Applicable values:
  • replace
  • add
  • remove
path string
REQUIRED
 The field you wish to replace.
Applicable values:
  • /name
  • /ipv4
  • /advanceConfiguration/ntp
  • /advanceConfiguration/ptp
  • /package
value string
REQUIRED
 New field value.

Sample response

Copy 
{
    "href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
    "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
    "name": "EPT-Single-Service",
    "type": "NTP",
    "state": "PROVISIONING",
    "connections": [
        {
        "href": "https://api.equinix.com/fabric/v4/connections/a8ba52de-faae-43b5-b0b1-6904d37ee011",
        "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
        }
    ],
    "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.240",
        "defaultGateway": "192.168.0.1"
    },
    "account": {
        "accountNumber": 123456
    }
}

Refer to the response of Get Time Service for the field descriptions.


If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Create Time Service

POST /fabric/v4/timeServices
Method POST
URL or Endpoint /fabric/v4/timeServices
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters type, name, connections, package, ipv4, advanceConfiguration

Creates a time service.


Sample curl request - create an NTP Standard Service

Copy 
curl -X
POST 'https://api.equinix.com/fabric/v4/timeServices'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "name": "EPT-Single-Service",
    "type": "NTP",
    "connections": [
    {
        "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
    }
    ],
    "package": {
    "code": "NTP_STANDARD"
    },
    "ipv4": {
    "primary": "192.168.0.2",
    "secondary": "192.168.0.3",
    "networkMask": "255.255.255.240",
    "defaultGateway": "192.168.0.1"
    }
}
'

Sample curl request - create a PTP Standard Service

Copy 
curl -X
POST 'https://api.equinix.com/fabric/v4/timeServices'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "name": "EPT-Single-Service",
    "type": "PTP",
    "connections": [
    {
        "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
    }
    ],
    "package": {
    "code": "PTP_STANDARD"
    },
    "ipv4": {
    "primary": "192.168.0.2",
    "secondary": "192.168.0.3",
    "networkMask": "255.255.255.240",
    "defaultGateway": "192.168.0.1"
    }
}
'

Sample curl request - create a PTP service with advanced configuration

>
Copy
curl -X
POST 'https://api.equinix.com/fabric/v4/timeServices'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "name": "EPT-Single-Service",
    "type": "PTP",
    "connections": [
    {
        "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
    }
    ],
    "package": {
    "code": "PTP_STANDARD"
    },
    "ipv4": {
    "primary": "192.168.0.2",
    "secondary": "192.168.0.3",
    "networkMask": "255.255.255.240",
    "defaultGateway": "192.168.0.1"
    },
    "advanceConfiguration": {
    "ptp": {
        "tailScale": true,
        "domain": 10,
        "priority1": 5,
        "priority2": 7,
        "logAnnounceInterval": 0,
        "logSyncInterval": 0,
        "logDelayReqInterval": 0
    }
}
}'

Body parameters

Parameter
Description
type string
REQUIRED
 Type of service.
Applicable values:
  • PTP
  • NTP
name string
REQUIRED
 Name of time service.
Applicable values:
  • Maximum: 24 characters
  • Allowed characters: alpha-numeric, hyphens ('-') and underscores ('_')
Example: EPT-Single-Service
connections array
REQUIRED
 An array of objects with unique identifiers of connections.
uuid string
REQUIRED
 Unique identifier of connection.
Example: 06dbb0e3-e55d-4090-8aff-fc5654abaad
package object
REQUIRED
 An object that has the package code.
code string
REQUIRED
 Package code.
Applicable values:
  • NTP_STANDARD
  • NTP_ENTERPRISE
  • PTP_STANDARD
  • PTP_ENTERPRISE
ipv4 object
REQUIRED
 An object that has Network IP Configurations for Timing Master Servers.
primary string
REQUIRED
 IPv4 address for the Primary Timing Master Server.
Example: 192.168.0.2
secondary string
REQUIRED
 IPv4 address for the Secondary Timing Master Server.
Example: 192.168.0.3
networkMask string
REQUIRED
 IPv4 address that defines the range of consecutive subnets in the network.
Example: 255.255.255.240
defaultGateway string
REQUIRED
 IPv4 address that establishes the Routing Interface where traffic is directed. It serves as the next hop in the Network.
Example: 192.168.0.1
advanceConfiguration object
OPTIONAL
 An object that has advanced configuration options.
ptp object
OPTIONAL
 An object that has advanced PTP configuration.
tailScale boolean
OPTIONAL
 Time scale value. ARB denotes Arbitrary, and PTP denotes Precision Time Protocol.
domain integer
OPTIONAL
 Represents the domain number associated with the PTP profile. This is used to differentiate multiple PTP networks within a single physical network.
priority1 integer
OPTIONAL
 Specifies the priority level 1 for the clock. The value helps in determining the best clock in the PTP network. Lower values are considered higher priority.
priority2 integer
OPTIONAL
 Specifies the priority level 2 for the clock. It acts as a tie-breaker if multiple clocks have the same priority 1 value. Lower values are considered higher priority.
logAnnounceInterval integer
OPTIONAL
 Represents the log2 interval between consecutive PTP announce messages. For example, a value of 0 implies an interval of 2^0 = 1 second.
logSyncInterval integer
OPTIONAL
 Represents the log2 interval between consecutive PTP synchronization messages. A value of 0 implies an interval of 2^0 = 1 second.
logDelayReqInterval integer
OPTIONAL
 Represents the log2 interval between consecutive PTP delay request messages. A value of 0 implies an interval of 2^0 = 1 second.

Sample response

Copy 
{
    "href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
    "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
    "name": "EPT-Single-Service",
    "type": "NTP",
    "state": "PROVISIONING",
    "connections": [
        {
        "href": "https://api.equinix.com/fabric/v4/connections/a8ba52de-faae-43b5-b0b1-6904d37ee011",
        "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
        }
    ],
    "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.240",
        "defaultGateway": "192.168.0.1"
    },
    "account": {
        "accountNumber": 123456
    }
}

Refer to the response of Get Time Service for the field descriptions.


If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.