Documentation Powered by ReDoc

System Service (2.4.0)

Download OpenAPI specification:Download

Extreme Networks: support@extremenetworks.com URL: http://www.extremenetworks.com License: Apache license

This is the spec that defines the API provided by the application to validate authorization for the passed role

Feature Setting

getFeatureSettingList

Responses

Response samples

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

updateFeatureSetting

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": "Device is already registered in inventory",
  • "code": 101
}

System Setting

getSystemSetting

Responses

Response samples

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

updateSystemSetting

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": "Device is already registered in inventory",
  • "code": 101
}

Trouble Shooting

getExecutionDetail

Get the detailed output of the given execution ID

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"
}

getExecutionList

Get the list of all the previous executions

query Parameters
limit
required
integer
Default: 10

Limit the number of executions that will be sent in the response. Default is 10

status
string
Default: "all"

Filter the executions based on the status(failed/succeeded/all)

Responses

Response samples

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

deleteExecutions

This API will delete the execution older than specific number of days

query Parameters
days_older_by
required
integer
Default: 30

Deletes execution entries older than specified number of days

Responses

Response samples

Content type
application/json
{
  • "message": "Device is already registered in inventory",
  • "code": 101
}

Clean

clean up archives

Clean up backup and supportsave archives

query Parameters
archive_type
required
string
Enum: "backup" "supportsave"

type of archive that has to be deleted

name
required
string

name of archive that has to be deleted

Responses

Response samples

Content type
application/json
{
  • "message": "successfully deleted the archive"
}