ExtremeCloud Appliance :: Platform Manager API (1.14.1)

Download OpenAPI specification:Download

Introduction

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.

Authentication and Authorization

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 Appliance authorization server issues tokens called bearer tokens that you use for authorization when making subsequent REST API calls.

bearerAuth

Security scheme type: HTTP
HTTP Authorization Scheme bearer

BackupManager

Get names of all backup files stored on the controller

Authorizations:

Responses

200
default

Error message

get /v1/configuration/backupfilelist

ExtremeCloud Appliance REST API server

https://www.example.com:5825/platformmanager/v1/configuration/backupfilelist

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "backupfile":
    [
    ]
}

Get current schedule for periodic backups

Authorizations:

Responses

200
default

Error message

get /v1/configuration/backupschedule

ExtremeCloud Appliance REST API server

https://www.example.com:5825/platformmanager/v1/configuration/backupschedule

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "frequency": "weekly",
  • "backupWhat": "configuration",
  • "backupDestination": "flash",
  • "transferMethod": "scp",
  • "remoteFile":
    {
    },
  • "dailyOptions":
    {
    },
  • "weeklyOptions":
    {
    },
  • "monthlyOptions":
    {
    },
  • "startTime": "12-20"
}

Update backup schedule on the controller

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 till another schedule is installed.

Authorizations:
Request Body schema: application/json

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 (local, 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 a ':' as the separator between hours and minutes.

Responses

200
default

Error message

put /v1/configuration/backupschedule

ExtremeCloud Appliance REST API server

https://www.example.com:5825/platformmanager/v1/configuration/backupschedule

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "frequency": "weekly",
  • "backupWhat": "configuration",
  • "backupDestination": "flash",
  • "transferMethod": "scp",
  • "remoteFile":
    {
    },
  • "dailyOptions":
    {
    },
  • "weeklyOptions":
    {
    },
  • "monthlyOptions":
    {
    },
  • "startTime": "12-20"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "frequency": "weekly",
  • "backupWhat": "configuration",
  • "backupDestination": "flash",
  • "transferMethod": "scp",
  • "remoteFile":
    {
    },
  • "dailyOptions":
    {
    },
  • "weeklyOptions":
    {
    },
  • "monthlyOptions":
    {
    },
  • "startTime": "12-20"
}

Create a new backup schedule on the controller

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 till another schedule is installed.

Authorizations:
Request Body schema: application/json

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 (local, 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 a ':' as the separator between hours and minutes.

Responses

200
default

Error message

post /v1/configuration/backupschedule

ExtremeCloud Appliance REST API server

https://www.example.com:5825/platformmanager/v1/configuration/backupschedule

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "frequency": "weekly",
  • "backupWhat": "configuration",
  • "backupDestination": "flash",
  • "transferMethod": "scp",
  • "remoteFile":
    {
    },
  • "dailyOptions":
    {
    },
  • "weeklyOptions":
    {
    },
  • "monthlyOptions":
    {
    },
  • "startTime": "12-20"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "frequency": "weekly",
  • "backupWhat": "configuration",
  • "backupDestination": "flash",
  • "transferMethod": "scp",
  • "remoteFile":
    {
    },
  • "dailyOptions":
    {
    },
  • "weeklyOptions":
    {
    },
  • "monthlyOptions":
    {
    },
  • "startTime": "12-20"
}

Create a new configuration backup file

Authorizations:
Request Body schema: application/json

The identifier backup represents backup operations(what to backup & destination)

backupWhat
string (BackupTypes)
Enum: "all" "configuration"
backupDestination
string (LocalDestination)
Enum: "local" "flash"

Responses

200
default

Error message

put /v1/configuration/createbackup

ExtremeCloud Appliance REST API server

https://www.example.com:5825/platformmanager/v1/configuration/createbackup

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "backupWhat": "configuration",
  • "backupDestination": "local"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "result": "CLI Export start: Wed Aug 22 16:46:00 2018, CLI Export end: Wed Aug 22 16:46:01 2018, SUCCESS: Backup/Export complete: EAE.22082018.164600"
}

Upload a configuration backup file

Authorizations:
Request Body schema: multipart/form-data
fileInputStream
string <binary>

Input stream

fileMetaData
string <binary>

Input file meta data (see Usage) Usage: curl -k -i -X POST -H 'Authorization: Bearer 6359d9d3c431157983d13b4edbca6026' -H "Content-Type: multipart/form-data" -F "file=@V2110-smoke.01032018.121518.zip" https://192.168.3.62:5825/platformmanager/v1/configuration/fileupload

body
string <binary>

Responses

200
default

Error message

post /v1/configuration/fileupload