API docs by Redocly

Temp Header Plugin API (0.1)

Download OpenAPI specification:

Get the Temp Header record

Note Though a list, this list should only ever contain one item

Authorizations:
auth

Responses

Response samples

Content type
application/json
{
  • "lock_version": 0,
  • "show_header": false,
  • "notice_date": "2025-09-01",
  • "maintenance_start": "2025-09-10 06:00:00UTC",
  • "maintenance_end": "2025-09-10 08:00:00UTC",
  • "maintenance_message": "A maintenance message",
  • "created_by": "admin",
  • "last_modified_by": "admin",
  • "create_time": "2025-04-03T16:44:34Z",
  • "system_mtime": "2025-04-03T16:44:34Z",
  • "user_mtime": "2025-04-03T16:44:34Z",
  • "jsonmodel_type": "string",
  • "uri": "/plugins/temp_headers"
}

Update the Temp Header record

Authorizations:
auth
Request Body schema: application/json
required
lock_version
integer <int64>
show_header
boolean
notice_date
string <date>
maintenance_start
string <date-time>
maintenance_end
string <date-time>
maintenance_message
string
created_by
string
last_modified_by
string
create_time
string <date-time>
system_mtime
string <date-time>
user_mtime
string <date-time>
jsonmodel_type
string
uri
string <uri>

Responses

Request samples

Content type
application/json
{
  • "lock_version": 0,
  • "show_header": false,
  • "notice_date": "2025-09-01",
  • "maintenance_start": "2025-09-10 06:00:00UTC",
  • "maintenance_end": "2025-09-10 08:00:00UTC",
  • "maintenance_message": "A maintenance message",
  • "created_by": "admin",
  • "last_modified_by": "admin",
  • "create_time": "2025-04-03T16:44:34Z",
  • "system_mtime": "2025-04-03T16:44:34Z",
  • "user_mtime": "2025-04-03T16:44:34Z",
  • "jsonmodel_type": "string",
  • "uri": "/plugins/temp_headers"
}

Response samples

Content type
application/json
{
  • "status": "Updated",
  • "id": 1,
  • "lock_version": 0,
  • "stale": true,
  • "uri": "/plugins/temp_headers/1",
  • "warnings": [ ]
}