Get System Maintenance Messages - Cognigy Documentation

GET

v2.0

system

message

Get System Maintenance Messages

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/system/message \
  --header 'X-API-Key: <api-key>'

{
  "message": "Next great Update will be released next Monday.",
  "until": 1694518620,
  "showOnLogin": true
}

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

The maintenance message

message

string

Example:

"Next great Update will be released next Monday."

until

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

Get System Maintenance Messages

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/system/message \
  --header 'X-API-Key: <api-key>'

{
  "message": "Next great Update will be released next Monday.",
  "until": 1694518620,
  "showOnLogin": true
}