System Service (3.1.0)

Download OpenAPI specification:Download

This spec defines the API provided by the application to validate authorization for the system.

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Feature Setting

Get feature setting list.

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "keyval": [
    ]
}

Update feature setting.

Authorizations:
Request Body schema: application/json

Update feature settings.

required
Array of objects (FeatureParameter)

Responses

Request samples

Content type
application/json
{
  • "keyval": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error",
  • "code": 101
}

System Setting

Get system setting.

Authorizations:
query Parameters
decrypt
boolean
Default: false

Decrypt password and display in plain text

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Update system setting.

Authorizations:
Request Body schema: application/json

Update system settings.

required
Array of objects (SystemParameter)

Responses

Request samples

Content type
application/json
{
  • "keyval": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error",
  • "code": 101
}

Reset system setting.

Authorizations:
Request Body schema: application/json

Reset system settings.

Array ()
string

Responses

Request samples

Content type
application/json
[
  • "BackupSchedule",
  • "MaxBackupFiles",
  • "MaxSsFiles",
  • "RemoteServerSettings",
  • "PeriodicDeviceConfigBackup"
]

Response samples

Content type
application/json
{
  • "message": "Error",
  • "code": 101
}

Troubleshooting

Get execution detail.

Get the detailed output of a request previously executed, based on a given request ID.

Authorizations:
query Parameters
id
required
string

Detailed output of the given execution ID.

Responses

Response samples

Content type
application/json
{
  • "start_time": "2000-01-23T04:56:07.000Z",
  • "end_time": "2000-01-23T04:56:07.000Z",
  • "id": "id",
  • "logs": "logs",
  • "URL": "/v1/inventory/switches",
  • "status": "Failed, Succeeded"
}

Get execution list.

Get the list of all the requests previously executed.