Update Element NTP (v2.0)

PUT 
/v2.0/api/tenants/:tenant_id/elements/:element_id/ntp/:ntp_id

Update an existing element NTP.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

element_id stringrequired

ID of the element.

ntp_id stringrequired

The NTP configuration ID.

application/json

Body

description

The description of the Network Time Protocol (NTP) configuration. Max characters = 256.

id string

The ID of the NTP configuration.

name stringrequired

The name of the NTP configuration. Max characters = 128.

ntp_servers NTPServer[]required
The configured NTP servers. A minimum of 1 and a maximum of 10 NTP servers can be configured.
Array [
host stringrequired
The host IP address or domain name.
max_poll int32required
The maximum polling interval. It specifies the polling intervals for NTP messages in seconds as a power of two.The values of Max Poll can be set between 4 and 17.
min_poll int32required
The minimum polling interval. It specifies the polling intervals for NTP messages in seconds as a power of two.The values of Min Poll can be set between 4 and 17.
version int32required
The version of the NTP configuration. NTP versions 2, 3 and 4 are supported.
]
source_interface_ids string[]

The interface used for sending a request to an NTP server. A source interface can include PPPoE or sub-interfaces with IP addresses. Up to 10 source interfaces are supported.

tags string[]

A information field that can be added to identify the NTP configuration.

Responses

200

Successful Operation

application/json

Schema

Schema

description

The description of the Network Time Protocol (NTP) configuration. Max characters = 256.

id string

The ID of the NTP configuration.

name stringrequired

The name of the NTP configuration. Max characters = 128.

ntp_servers NTPServer[]required
The configured NTP servers. A minimum of 1 and a maximum of 10 NTP servers can be configured.
Array [
host stringrequired
The host IP address or domain name.
max_poll int32required
The maximum polling interval. It specifies the polling intervals for NTP messages in seconds as a power of two.The values of Max Poll can be set between 4 and 17.
min_poll int32required
The minimum polling interval. It specifies the polling intervals for NTP messages in seconds as a power of two.The values of Min Poll can be set between 4 and 17.
version int32required
The version of the NTP configuration. NTP versions 2, 3 and 4 are supported.
]
source_interface_ids string[]

The interface used for sending a request to an NTP server. A source interface can include PPPoE or sub-interfaces with IP addresses. Up to 10 source interfaces are supported.

tags string[]

A information field that can be added to identify the NTP configuration.

Example (from schema)

{
  "id": "string",
  "name": "string",
  "ntp_servers": [
    {
      "host": "string",
      "max_poll": 0,
      "min_poll": 0,
      "version": 0
    }
  ],
  "source_interface_ids": [
    "string"
  ],
  "tags": [
    "string"
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "NTP_CONFIG_UNSUPPORTED_SWVERSION"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
      },
      {
        "code": "NTP_CONFIG_INVALID_INTERFACE_IDS"
      },
      {
        "code": "NTP_CONFIG_INVALID_SERVER_LIST"
      }
    ]
  }
}

Loading...