Skip to main content
REST API reference

Retrieve NTP symmetric authentication key details

PDFs

GET /cluster/ntp/keys/{id}

Introduced In: 9.7

Retrieves the details of a specific NTP symmetric authentication key by numeric identifier or index (ID).

  • cluster time-service ntp key show

Learn more

Parameters

Name Type In Required Description

id

integer

path

True

Key identifier

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

digest_type

string

The type of cryptographic hash used to create and verify the NTP's message authentication code appended to each NTP packet header.

id

integer

NTP symmetric authentication key identifier or index number (ID). This ID is included in the NTP cryptographic hash encoded header.

value

string

A hexadecimal digit string that represents the cryptographic key that is shared with the remote NTP server. The current expected length is 40 characters.

Use the cryptographic key and key ID to create a unique hash value used to authenticate the rest of the NTP data.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "digest_type": "sha1",
  "id": 10,
  "value": "da39a3ee5e6b4b0d3255bfef95601890afd80709"
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.