System Service (2.6.0)

Download OpenAPI specification:Download

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

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

Feature Setting

Get feature setting list.

Responses

200

400

Incorrect feature specified.

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error.

get/system/feature

http://gosystem-service:80/v1/system/feature

Response samples

200
400
401
500
default

Content type

application/json

Copy

Expand all Collapse all


{"keyval": 
[
{"key": "InflightTransactionAutoRecovery",
"value": "enable"
}
]
}

Update feature setting.

Request Body schema: application/json

Update feature settings.

keyval

required

Array of objects (FeatureParameter)

Responses

200

400

Incorrect values specified for feature setting.

401

Authorization information is missing or invalid.

409

Feature settings already exist and cannot be updated.

500

Unexpected error.

default

Unexpected error.

put/system/feature

http://gosystem-service:80/v1/system/feature

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"keyval": 
[
{"key": "InflightTransactionAutoRecovery",
"value": "enable"
}
]
}

Response samples

400
401
409
500
default

Content type

application/json

Copy

Expand all Collapse all


{"message": "Error",
"code": 101
}

System Setting

Get system setting.

Responses

200

400

Incorrect values specified for system setting.

401

Authorization information is missing or invalid.

404

A system with the specified name was not found.

409

A system settings already exist and cannot be updated.

500

Unexpected error.

default

Unexpected error

get/system/settings

http://gosystem-service:80/v1/system/settings

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"value": "5",
"key": "Max Backup File Limit"
},
{"value": "0 0 * *",
"key": "Backup Schedule"
},
{"value": "5",
"key": "Max Supportsave File Limit"
},
{"value": "10.10.10.10",
"key": "Remote Server Ip"
},
{"value": "scp",
"key": "Remote Transfer Protocol"
},
{"value": "username",
"key": "Remote Server Username"
},
{"value": "password",
"key": "Remote Server Password"
},
{"value": "/root/test",
"key": "Remote Server Directory"
},
{"value": "Enabled",
"key": "Periodic Device Config Backup"
}
]

Update system setting.

Request Body schema: application/json

Update system settings.

keyval

required

Array of objects (SystemParameter)

Responses

200

400

Incorrect values specified for system setting.

401

Authorization information is missing or invalid.

404

A system with the specified name was not found.

409

A system setting already exists and cannot be updated.

500

Unexpected error.

default

Unexpected error.

put/system/settings

http://gosystem-service:80/v1/system/settings

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"keyval": 
[
{"value": "5",
"key": "MaxBackupFiles"
},
{"value": "0 0 * *",
"key": "BackupSchedule"
},
{"value": "5",
"key": "MaxSsFiles"
},
{"value": "10.10.10.10",
"key": "RemoteServerIP"
},
{"value": "scp",
"key": "RemoteTransferProtocol"
},
{"value": "username",
"key": "RemoteServerUsername"
},
{"value": "password",
"key": "RemoteServerPassword"
},
{"value": "/root/test",
"key": "RemoteServerDirectory"
},
{"value": "Enabled",
"key": "PeriodicDeviceConfigBackup"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"message": "Error",
"code": 101
}

Reset system setting.

Request Body schema: application/json

Reset system settings.

Array

string

Responses

200

400

Incorrect values specified for system setting reset.

401

Authorization information is missing or invalid.

404

A system with the specified name was not found.

409

A system settings already exist and cannot be updated.

500

Unexpected error.

default

Unexpected error

put/system/settings/reset

http://gosystem-service:80/v1/system/settings/reset

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


["BackupSchedule",
"MaxBackupFiles",
"MaxSsFiles",
"RemoteServerSettings",
"PeriodicDeviceConfigBackup"
]

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"message": "Error",
"code": 101
}

Troubleshooting

Get execution detail.

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

query Parameters

required

string

Detailed output of the given execution ID.

Responses

200

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error.

get/system/execution

http://gosystem-service:80/v1/system/execution

Response samples

200
401
500
default

Content type

application/json

Copy

Expand all Collapse all


{"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.

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

200

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error.

get/system/executions

http://gosystem-service:80/v1/system/executions

Response samples

200
401
500
default

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"start_time": "2000-01-23T04:56:07.000Z",
"end_time": "2000-01-23T04:56:07.000Z",
"id": "id",
"URL": "/v1/inventory/switches",
"status": "Completed"
},
{"start_time": "2000-01-22T04:56:07.000Z",
"end_time": "2000-01-22T04:56:07.000Z",
"id": "id",
"URL": "/v1/inventory/switches",
"status": "Failed"
}
]
}

Delete executions.

Delete all requests that were executed earlier than the specific number of days.

query Parameters

days_older_by

required

integer

Default: 30

Delete all requests that were executed earlier than the specific number of days.

Responses

200

202

Accepted

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error.

delete/system/executions

http://gosystem-service:80/v1/system/executions

Response samples

401
500
default

Content type

application/json

Copy

Expand all Collapse all


{"message": "Error",
"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

202

Accepted

401

Authorization information is missing or invalid.

404

Not available.

500

Unexpected error.

default

Unexpected error.

delete/system/clean

http://gosystem-service:80/v1/system/clean

Response samples

202
401
404
500
default

Content type

application/json

Copy

Expand all Collapse all


{"message": "successfully deleted the archive"
}