Skip to main content

Retrieve the current status of an automatic update feature

Contributors
PDFs

GET /support/auto-update

Introduced In: 9.10

Retrieves the current status of the automatic update feature and the End User License Agreement (EULA).

Parameters

Name Type In Required Description

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

enabled

boolean

Flag indicating feature state.

eula

eula
Example response 
{
  "_links": {
    "self": {
      "self": {
        "href": "/api/resourcelink"
      }
    }
  },
  "enabled": 1,
  "eula": {
    "accepted": 1,
    "accepted_ip_address": "192.168.1.125",
    "accepted_timestamp": "2020-12-01 08:12:23 -0500",
    "user_id_accepted": "admin"
  }
}

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

self

Name Type Description

self

href

_links

Name Type Description

self

self

eula

Name Type Description

accepted

boolean

Flag indicating the End User License Agreement (EULA) acceptance. When the feature is enabled, it is assumed that the EULA is accepted.

accepted_ip_address

string

IP Address from where the EULA was accepted.

accepted_timestamp

string

Date and time when the EULA was accepted.

user_id_accepted

string

User ID that provided the EULA acceptance.

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.