System Service (3.1.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.

Authentication

bearerAuth

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

Feature Setting

Get feature setting list.

Authorizations:

bearerAuth

Responses

Response samples

200
400
401
500
default

Content type

application/json

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

Update feature setting.

Authorizations:

bearerAuth

Request Body schema: application/json

Update feature settings.

required

Array of objects (FeatureParameter)

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
401
409
500
default

Content type

application/json

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

System Setting

Get system setting.

Authorizations:

bearerAuth

query Parameters

decrypt

boolean

Default: false

Decrypt password and display in plain text

Responses

Response samples

Content type

application/json

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

Authorizations:

bearerAuth

Request Body schema: application/json

Update system settings.

required

Array of objects (SystemParameter)

Responses

Request samples

Payload

Content type

application/json

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

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

Reset system setting.

Authorizations:

bearerAuth

Request Body schema: application/json

Reset system settings.

Array ()

string

Responses

Request samples

Payload

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:

bearerAuth

query Parameters

id

required

string

Detailed output of the given execution ID.

Responses

Response samples

200
401
500
default

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.

Authorizations:

bearerAuth

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

200
401
500
default

Content type

application/json

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

Authorizations:

bearerAuth

query Parameters

days_older_by

required

integer

Default: 30

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

Responses

Response samples

401
500
default

Content type

application/json

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

Clean

Clean up archives.

Clean up backup and supportsave archives.

Authorizations:

bearerAuth

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

202
401
404
500
default

Content type

application/json

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