Download OpenAPI specification:Download
The Platform Manager API provides a programmatic interface to access and manage backup files, flash memory, license information, controller logs, network test data, and platform settings.
It is based on RESTful principles and uses standard HTTP methods for requests and responses. It uses OAuth 2.0 for authentication and authorization. API request and response bodies are formatted in JavaScript Object Notation (JSON).
Note: To submit API calls, your RESTful API consuming program needs to have logged in using credentials granting at least read permissions, and only user accounts with FullAdmin credentials can make configuration changes through the REST API.
The Platform Manager REST API uses the OAuth 2.0 protocol to provide secure authorized access to the API. OAuth is an authorization framework that enables web, mobile, and desktop applications to access protected resources.
To begin, pass your client login credentials in the Authorization header within a POST request to the management/v1/oauth2/token
endpoint.
In exchange for these credentials the ExtremeCloud IQ Controller authorization server issues tokens called bearer tokens that you use for authorization when making subsequent REST API calls.
Error message
ExtremeCloud IQ Controller REST API server
{- "backupfile": [
- "EAE.09072018.112751.zip"
]
}
ExtremeCloud IQ Controller REST API server
{- "frequency": "weekly",
- "backupWhat": "configuration",
- "backupDestination": "flash",
- "transferMethod": "scp",
- "remoteFile": {
- "serverIP": "8.8.8.8",
- "userid": "Admin",
- "password": "abc123",
- "directory": "/",
- "fileName": "example.txt",
- "localDestination": "flash"
}, - "dailyOptions": {
- "weekendIncluded": true
}, - "weeklyOptions": {
- "backupMonday": true,
- "backupTuesday": true,
- "backupWednesday": true,
- "backupThursday": true,
- "backupFriday": true,
- "backupSaturday": true,
- "backupSunday": true
}, - "monthlyOptions": {
- "dayOfMonth": 20
}, - "startTime": "12-20"
}
Replaces the complete backup schedule on the controller with one that is input, provided that all attributes of the new schedule are valid. If the frequency attribute of the new schedule is none, then the rest of the schedule attributes are ignored. If the frequency is set to none, any previously set backup schedule is canceled and no new scheduled backups will occur until another schedule is installed.
New schedule to set
frequency | string (BackupFrequencyType) Enum: "none" "daily" "weekly" "monthly" Represents an enum data type containing the possible frequencies of configuration backups. |
backupWhat | string (BackupTypes) Enum: "all" "configuration" |
backupDestination | string (BackupDestination) Enum: "none" "local" "remote" "flash" A list of backup destination setting options. For example, local or remote. |
transferMethod | string (FileTransferMethod) Enum: "ftp" "scp" "http" |
remoteFile | object (RemoteFile) |
dailyOptions | object (DailyScheduleOptions) |
weeklyOptions | object (WeeklyScheduleOptions) |
monthlyOptions | object (MonthlyScheduleOptions) |
startTime | string The time at which the periodic backup starts each day that it runs. The time is in 24 hour military local time in the form HH-MM. A dash ('-') is used in place of ':' as the separator between hours and minutes. |
Error message
ExtremeCloud IQ Controller REST API server
{- "frequency": "weekly",
- "backupWhat": "configuration",
- "backupDestination": "flash",
- "transferMethod": "scp",
- "remoteFile": {
- "serverIP": "8.8.8.8",
- "userid": "Admin",
- "password": "abc123",
- "directory": "/",
- "fileName": "example.txt",
- "localDestination": "flash"
}, - "dailyOptions": {
- "weekendIncluded": true
}, - "weeklyOptions": {
- "backupMonday": true,
- "backupTuesday": true,
- "backupWednesday": true,
- "backupThursday": true,
- "backupFriday": true,
- "backupSaturday": true,