ExtremeCloud Appliance :: Application Manager API (1.14.1)

Download OpenAPI specification:Download

Introduction

The Application Manager API provides a programmatic interface to install and manage applications, create and manage containers, storage, images, and templates, and access system information and features. 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 Application 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.

Authorization

Get access to data while protecting your account credentials. Obtain the bearer token with a POST request to the management/v1/oauth2/token endpoint using OAuth2 password grant type.

Security scheme type: OAuth2
password OAuth Flow
Token URL: /management/v1/oauth2/token
Scopes:
  • read -

    Grant read-only access to all data

  • FullAdmin -

    Grant read-write access to all data

apps

Install and manage applications.

Start an application

Starts an application with the specified template name.

Authorizations:
Authorization (FullAdmin)
path Parameters
name
required
string

Name of application template that needs to be started.

Responses

200

Application started successfully

304

Application is already running

401

Unauthorized

404

Application with the specified template name cannot be found

415

Unsupported media type

500

Server error

post /apps/{name}/start

ExtremeCloud Appliance REST API Server

https://www.example.com:5825/orchestration/v1/apps/{name}/start

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "AppName": "defender",
  • "AppTitle": "Extreme Defender for IoT",
  • "AppDescription": "Next generation security for medical and other connected devices",
  • "AppIcon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAOxAAADsQBlSsOGwAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAsZSURBVHic7Zp5kBxVHcc/v349m12CG3KAIgEDBALEiEpKRKmEQ8iBEqrksAxRAUkCCh7cN6JccqgoRXaxgqAhCJaKAbJgIRsEEkIloYAQICHGFKJlUkQTNrs73e/9/GO6e3p6Z2Z3Zg/+MN+qV9PXe/2+n/71e7/Xu7BLu7RL/8+SD7oDfVFbc/MoHTbsMM/z9jGeNwJjENVtIrK5q7Fx3cwNG7bX23YFACrTaP1lNw3fauesrnob74/+OHLkJCMyx/e8mZ7vT/Q8D88YPBHE8/BEQAQRsSLyisKfnHOLpm7cuL6W+5QFMJPWgx36Jki70DVrKRfWTbhWPbr77lPE968zvn+cMQZjDIl5z0uKRCAEQCIbqk5VH8PaHxy1YcPqvtyvLIDptH4FdHG0u8ZgT32c8zcOgL+Keri5eVSDc3cZ3/+q8X0xxmB8H68ChAoA0EKxDlr8xsZLJq9atbPafb3yh3VcaudTFrNmBgvOGAij5fS73XabnHNujef7s43vi/F94uLHJZcj5/vkcrnCdpniF39Nzpjz6e5+6cVDDjm42r3LAhDYJ3OoWZHF02l5YCZ3f2TAnAOPNDV9zoNnPGP2M8YkT9z4fvE3gmByOfwUBD+Xw29oSLYzEDC+f5hpaHhuxaRJR9QEQGFEmcMCzHH4b8xgwWUzuKu5HsOncWfTNFquAZWo0Sme7+8ev+/p4qcjIBUJSUSUiYDkfPHaPXOe17Zq4sTxfQYA5Kp4GKHILcqwzTNouX0mCybHZqrpRO7edzoLrt7B8LcEbkg64PvF9zt+37Mwyr0OacOZJx9DSF4lY8bg+0tWjB/f46H5FfprejNUAMFFilw0ndZ3oGU5yBrgn6AdhUtkT9AJIJ8FnUwZ4OmRPQZhyoHwfXxj8HwfkxoQRYrsVRXnHOoc1vMgDOMTAIe44cNvAr7dKwCFHTVmSGOB00BP69FSyW9PmYz5stEQmU890eQ6EUGiO8QAnLWItcUpLpodfOfOe3HSpEVHvvrq8qoAPNhWucsDrwSASPlo8LzCk08PjHEExFGgilPFWYsTwYqggInMewU4nrH2emBayms56ZYhcQ4lJiS13QNE/FtmLMhlBr8e+UMp3BNXTpz4yaoAHN7fhgwAFM2LJB3NQvE8r/i6pEFkB750spRtp5A6IzCnKgBF3h4qAMQdi0AQd7JQXheRbi8DIgshlzafzRZThWI5qSqAYbh1gK3DznMK14I8WnPNdEeT3nmXi8jKuOMxpHSkmCgKSsaDqA1JtV2yDxNWHnjgvlABwBLm7QRer9HBE23MnfIk837YxtxTgJ/UVj8j1ec/vmLFEoVny56mMOqrc1hr4zUAqhpPe8W5JzqWHtitMROgciKEwku19FdwvwVJ7uHwFtVSv9DPYudF5Iqog+2JgbhEc72zljAMCYOAMAwLM4BzhdnAuRIo2YLq+KoAQNpr6743Lr1nsPvXY1wBp/rY4atX/xVge2fnC6qaTxtzzmHDMDEfBEECwVpbBBH/RnU1BcWpjqgKIIf9Sy32Fb10BvceB4W0V5Gf9qWecy77dB2q18TnJ69atdM5typ+4s5arLWE6acfmQ/DEJuFEEVLtrio/YoAHuO8fwBra2AwXHGzAAz+ofRcUVZUSWirLv7M2rUvl5x3rt1GAGxk3EbGgyAgyOd7gEhHg43GiSQaChC6qwIoSP5QAwCAYQAObeprhZLQVg1QvS57TeDcMhuGyVNPh3+YAhFv2zgSohJHg02/FqpvQy8AFK0JgEBD1Gi11WTP+xSfSuvnN2x4GyC9cpPt25+31gaxobThIGM+HQnx62DLRIOqru8VwJPMWw28VYOXDgCFqp+h0rJF8x3S1fWj+LjzvOufP/TQjwFMXLv2fRuGq20qvMMgIEhFQQIiNRYk18YQYhDObVm2adNbvQIAEOTeMocdZZZ4CpsBDKZSKt0juXJhiHOO0Lk7j92y5V8AT48du4+1dr6nekxSMQyX9Rj00sbT40B2UIwjwVpcYf+J6wseKn4PSMm/H4IbicI7srpYMJcr9hhBjlT4sMLWkGAhwOOcu24aLVcJHAvyH4FXQZ7zCDZZzJvp+6pzXdbaTU0id6RA3mCtbUJkKnA/QGhtu+fcpfES2PMKz05ELlGRv2NtkXBktrBpiyUIChDy+WSQ7dOyfxotDwkkH0UVd+STnLeyL3Wzmk7Lo8DJbcz10olTrKVjxkwwudxrxhjf+P7GYzZtOhDguQkTPpQz5j3P8/xkcaO67NOvvHJMPf2I1YcIAA+vVXERAFkZmz+F+/YI6BQAR7hzKRd2F2upnMQ9e8R7HTR1tnNWl0KrwMmV7mWdu5kw9AEUDvjzAQfsd8LGjZuPfvPNHc+PH/+yZ8zkKOdXVb28dsul6hOApXzzmRm0rlc4CNzPAWbQenEX+dvir2eKuQD4RVzneO4eZcltjfebyG8+gQVfaGZk2/ts2xwfvw8aG6CJESNosvYT1tpTIvMYVcTaKcBvoPAaiHOTPc8Dkd8fvX79CoAXxo5t0qame1FtcFHO76wtrBOijyRqLYG1K7+4devtNQMohGrrbaA/A9l7Oi3tik4tuQJGp/eH0TDapcZJhf0Msm4H25YrvBcfz8F3EbnZdHRgfT/JCpMvOYVxoACgu/tZ8f2LRcR6kGSLed+/gCCYTTHNTabWpFi7U4Lg6qyzPgKAf6O/2hOuAH5cAVIJgBDGlJliDHB0duBR1WTQKjHvHMaYBLTr7HxWGxutiCw84d131wE8M27cHmEQXBbXTWeVyScy51Sdmztrx44eU3qv02CsVcwLgFsrnRe0BIDBja50bTmpasn8nUp6DloyevQ+ACds2/Zfm8+/GHR1JZ/V852dl4ZBMCqbDKUXSEEQfH/W9u1lV6d9BgCwBRYCm8oayABQvJoAxIozt/Rc3t3VNSU+H+bz58x87713ANrGjNk7n89fmM0Kg1SeEAbBpV/u6Ki4MKsJwCrmBYpWiALJANC6AEBhfZBOemwYJq/Bl3bseCPe7urqujYMguHZtUAqCq46tbPztmr3qgkAQDOjFgLlvhmOyjQ8qsw1NSkBkc9PzZ57uLFx/3wQnJ1eC6S38/n8VWfk8zf1do+aATzC6XlBv1fmVCYCGFNr25Wkqocsho+mjwX5/E1hEDQkTzuVCgdheNVs53o1D3UAAFjK/CXA45nDzUfQkqwCs9NifxXC0fH2r+Fwde70kvV9/KkLrpwDfTIPdQIAEPgO0J0+NBo3Mt7RzJjQXwlMTW3fSvm+X3km3FxLu3UDWMq8t0HvTB/L4adM1z8IVtBUgEUwhdSftlKq2Tz0AwCAY7cbJVoCQyH5SZ0eWaZKf3TYg4VV5y1lztVlHvoJ4Cm+1qHo2STfBmx65B+wQTCSWLgDOKrkIFxSr3noJwCANuY/LXB3obFC8nMiDwwHGvvbdlYCszOHrpwNt5e9uI/qNwAAHy4D3oqTH0fnQL//5VR32Kc1IACWMG+n4H09/t+iXI3rgDo0IOZhgAAALOXcFRotWxXpdxZYRQNmHgYQAMBTzHsDQAZ+AIw1oOZhgAHEqncl2IsG3DwMEgBwayjNEvurQTEPgwSgjfnLQb5BtX8P67sGzTwMWgRAG3Mf0hoWJRU0qOZhEAEAPMncawQerLP6oJuHQQYAop00nAMs7/XSUg2JeRh0ANDOWV1CbpbAa32sMmTmYQgAACzl7C2QOw54tZdLrxhK8zBEAKAAQcgdT2UIV5xZfqk7qBoyAFAVwgdi/gPTidyzV7z9AOxV7dpd2qVd2qXB1P8A6w2UPhwecNMAAAAASUVORK5CYII=",
  • "ProxyAppUrl": true,
  • "AppFileNameFormat": "defender_[0-9]{2}\\.[0-9]{2}\\.[0-9]{2}",
  • "AppRegistry": "Docker Hub",
  • "Type": "BUILT_IN",
  • "AppVersion": "1.0.0",
  • "LatestVersion": "2.0.0",
  • "AppState": "NOT_INSTALLED",
  • "StartedAt": "2019-10-08T16:03:32Z",
  • "Warnings":
    [
    ]
}

Stop an application

Stops an application with the specified template name.

Authorizations:
Authorization (FullAdmin)
path Parameters
name
required
string

Name of application template that needs to be stopped.

Responses

200

Application stopped successfully

304

Application is already stopped

401

Unauthorized

404

Application with the specified template name cannot be found

415

Unsupported media type

500

Server error

post /apps/{name}/stop

ExtremeCloud Appliance REST API Server

https://www.example.com:5825/orchestration/v1/apps/{name}/stop

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "AppName": "defender",
  • "AppTitle": "Extreme Defender for IoT",
  • "AppDescription": "Next generation security for medical and other connected devices",
  • "AppIcon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAOxAAADsQBlSsOGwAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAsZSURBVHic7Zp5kBxVHcc/v349m12CG3KAIgEDBALEiEpKRKmEQ8iBEqrksAxRAUkCCh7cN6JccqgoRXaxgqAhCJaKAbJgIRsEEkIloYAQICHGFKJlUkQTNrs73e/9/GO6e3p6Z2Z3Zg/+MN+qV9PXe/2+n/71e7/Xu7BLu7RL/8+SD7oDfVFbc/MoHTbsMM/z9jGeNwJjENVtIrK5q7Fx3cwNG7bX23YFACrTaP1lNw3fauesrnob74/+OHLkJCMyx/e8mZ7vT/Q8D88YPBHE8/BEQAQRsSLyisKfnHOLpm7cuL6W+5QFMJPWgx36Jki70DVrKRfWTbhWPbr77lPE968zvn+cMQZjDIl5z0uKRCAEQCIbqk5VH8PaHxy1YcPqvtyvLIDptH4FdHG0u8ZgT32c8zcOgL+Keri5eVSDc3cZ3/+q8X0xxmB8H68ChAoA0EKxDlr8xsZLJq9atbPafb3yh3VcaudTFrNmBgvOGAij5fS73XabnHNujef7s43vi/F94uLHJZcj5/vkcrnCdpniF39Nzpjz6e5+6cVDDjm42r3LAhDYJ3OoWZHF02l5YCZ3f2TAnAOPNDV9zoNnPGP2M8YkT9z4fvE3gmByOfwUBD+Xw29oSLYzEDC+f5hpaHhuxaRJR9QEQGFEmcMCzHH4b8xgwWUzuKu5HsOncWfTNFquAZWo0Sme7+8ev+/p4qcjIBUJSUSUiYDkfPHaPXOe17Zq4sTxfQYA5Kp4GKHILcqwzTNouX0mCybHZqrpRO7edzoLrt7B8LcEbkg64PvF9zt+37Mwyr0OacOZJx9DSF4lY8bg+0tWjB/f46H5FfprejNUAMFFilw0ndZ3oGU5yBrgn6AdhUtkT9AJIJ8FnUwZ4OmRPQZhyoHwfXxj8HwfkxoQRYrsVRXnHOoc1vMgDOMTAIe44cNvAr7dKwCFHTVmSGOB00BP69FSyW9PmYz5stEQmU890eQ6EUGiO8QAnLWItcUpLpodfOfOe3HSpEVHvvrq8qoAPNhWucsDrwSASPlo8LzCk08PjHEExFGgilPFWYsTwYqggInMewU4nrH2emBayms56ZYhcQ4lJiS13QNE/FtmLMhlBr8e+UMp3BNXTpz4yaoAHN7fhgwAFM2LJB3NQvE8r/i6pEFkB750spRtp5A6IzCnKgBF3h4qAMQdi0AQd7JQXheRbi8DIgshlzafzRZThWI5qSqAYbh1gK3DznMK14I8WnPNdEeT3nmXi8jKuOMxpHSkmCgKSsaDqA1JtV2yDxNWHnjgvlABwBLm7QRer9HBE23MnfIk837YxtxTgJ/UVj8j1ec/vmLFEoVny56mMOqrc1hr4zUAqhpPe8W5JzqWHtitMROgciKEwku19FdwvwVJ7uHwFtVSv9DPYudF5Iqog+2JgbhEc72zljAMCYOAMAwLM4BzhdnAuRIo2YLq+KoAQNpr6743Lr1nsPvXY1wBp/rY4atX/xVge2fnC6qaTxtzzmHDMDEfBEECwVpbBBH/RnU1BcWpjqgKIIf9Sy32Fb10BvceB4W0V5Gf9qWecy77dB2q18TnJ69atdM5typ+4s5arLWE6acfmQ/DEJuFEEVLtrio/YoAHuO8fwBra2AwXHGzAAz+ofRcUVZUSWirLv7M2rUvl5x3rt1GAGxk3EbGgyAgyOd7gEhHg43GiSQaChC6qwIoSP5QAwCAYQAObeprhZLQVg1QvS57TeDcMhuGyVNPh3+YAhFv2zgSohJHg02/FqpvQy8AFK0JgEBD1Gi11WTP+xSfSuvnN2x4GyC9cpPt25+31gaxobThIGM+HQnx62DLRIOqru8VwJPMWw28VYOXDgCFqp+h0rJF8x3S1fWj+LjzvOufP/TQjwFMXLv2fRuGq20qvMMgIEhFQQIiNRYk18YQYhDObVm2adNbvQIAEOTeMocdZZZ4CpsBDKZSKt0juXJhiHOO0Lk7j92y5V8AT48du4+1dr6nekxSMQyX9Rj00sbT40B2UIwjwVpcYf+J6wseKn4PSMm/H4IbicI7srpYMJcr9hhBjlT4sMLWkGAhwOOcu24aLVcJHAvyH4FXQZ7zCDZZzJvp+6pzXdbaTU0id6RA3mCtbUJkKnA/QGhtu+fcpfES2PMKz05ELlGRv2NtkXBktrBpiyUIChDy+WSQ7dOyfxotDwkkH0UVd+STnLeyL3Wzmk7Lo8DJbcz10olTrKVjxkwwudxrxhjf+P7GYzZtOhDguQkTPpQz5j3P8/xkcaO67NOvvHJMPf2I1YcIAA+vVXERAFkZmz+F+/YI6BQAR7hzKRd2F2upnMQ9e8R7HTR1tnNWl0KrwMmV7mWdu5kw9AEUDvjzAQfsd8LGjZuPfvPNHc+PH/+yZ8zkKOdXVb28dsul6hOApXzzmRm0rlc4CNzPAWbQenEX+dvir2eKuQD4RVzneO4eZcltjfebyG8+gQVfaGZk2/ts2xwfvw8aG6CJESNosvYT1tpTIvMYVcTaKcBvoPAaiHOTPc8Dkd8fvX79CoAXxo5t0qame1FtcFHO76wtrBOijyRqLYG1K7+4devtNQMohGrrbaA/A9l7Oi3tik4tuQJGp/eH0TDapcZJhf0Msm4H25YrvBcfz8F3EbnZdHRgfT/JCpMvOYVxoACgu/tZ8f2LRcR6kGSLed+/gCCYTTHNTabWpFi7U4Lg6qyzPgKAf6O/2hOuAH5cAVIJgBDGlJliDHB0duBR1WTQKjHvHMaYBLTr7HxWGxutiCw84d131wE8M27cHmEQXBbXTWeVyScy51Sdmztrx44eU3qv02CsVcwLgFsrnRe0BIDBja50bTmpasn8nUp6DloyevQ+ACds2/Zfm8+/GHR1JZ/V852dl4ZBMCqbDKUXSEEQfH/W9u1lV6d9BgCwBRYCm8oayABQvJoAxIozt/Rc3t3VNSU+H+bz58x87713ANrGjNk7n89fmM0Kg1SeEAbBpV/u6Ki4MKsJwCrmBYpWiALJANC6AEBhfZBOemwYJq/Bl3bseCPe7urqujYMguHZtUAqCq46tbPztmr3qgkAQDOjFgLlvhmOyjQ8qsw1NSkBkc9PzZ57uLFx/3wQnJ1eC6S38/n8VWfk8zf1do+aATzC6XlBv1fmVCYCGFNr25Wkqocsho+mjwX5/E1hEDQkTzuVCgdheNVs53o1D3UAAFjK/CXA45nDzUfQkqwCs9NifxXC0fH2r+Fwde70kvV9/KkLrpwDfTIPdQIAEPgO0J0+NBo3Mt7RzJjQXwlMTW3fSvm+X3km3FxLu3UDWMq8t0HvTB/L4adM1z8IVtBUgEUwhdSftlKq2Tz0AwCAY7cbJVoCQyH5SZ0eWaZKf3TYg4VV5y1lztVlHvoJ4Cm+1qHo2STfBmx65B+wQTCSWLgDOKrkIFxSr3noJwCANuY/LXB3obFC8nMiDwwHGvvbdlYCszOHrpwNt5e9uI/qNwAAHy4D3oqTH0fnQL//5VR32Kc1IACWMG+n4H09/t+iXI3rgDo0IOZhgAAALOXcFRotWxXpdxZYRQNmHgYQAMBTzHsDQAZ+AIw1oOZhgAHEqncl2IsG3DwMEgBwayjNEvurQTEPgwSgjfnLQb5BtX8P67sGzTwMWgRAG3Mf0hoWJRU0qOZhEAEAPMncawQerLP6oJuHQQYAop00nAMs7/XSUg2JeRh0ANDOWV1CbpbAa32sMmTmYQgAACzl7C2QOw54tZdLrxhK8zBEAKAAQcgdT2UIV5xZfqk7qBoyAFAVwgdi/gPTidyzV7z9AOxV7dpd2qVd2qXB1P8A6w2UPhwecNMAAAAASUVORK5CYII=",
  • "ProxyAppUrl": true,
  • "AppFileNameFormat": "defender_[0-9]{2}\\.[0-9]{2}\\.[0-9]{2}",
  • "AppRegistry": "Docker Hub",
  • "Type": "BUILT_IN",
  • "AppVersion": "1.0.0",
  • "LatestVersion": "2.0.0",
  • "AppState": "NOT_INSTALLED",
  • "StartedAt": "2019-10-08T16:03:32Z",
  • "Warnings":
    [
    ]
}

getLog

Return an application’s log

Authorizations:
Authorization (FullAdmin)
path Parameters
name
required
string

Name of application template to be accessed

query Parameters
stdout
boolean
Default: true

Return logs from stdout

stderr
boolean
Default: true

Return logs from stderr

since
integer <int32>
Default: 0

Only return logs since this time, as a UNIX timestamp

timestamps
boolean
Default: false

Add timestamps to every log line

tail
string
Default: "all"

Only return this number of log lines from the end of the logs. Specify as an integer or 'all' to output all log lines

Responses

200

Application logs

400

Bad parameter

401

Unauthorized

404

Application with the specified template name cannot be found

415

Unsupported media type

500

Server error

get /apps/{name}/log

ExtremeCloud Appliance REST API Server

https://www.example.com:5825/orchestration/v1/apps/{name}/log

Uninstall an application

Uninstalls an application with the specified template name.

Authorizations:
Authorization (FullAdmin)
path Parameters
name
required
string

Name of application template that needs to be uninstalled.

Responses

200

Application uninstalled successfully

401

Unauthorized

404

Application with the specified template name cannot be found

409

Application is either not installed or is currently running

415

Unsupported media type

500

Server error

delete /apps/{name}

ExtremeCloud Appliance REST API Server

https://www.example.com:5825/orchestration/v1/apps/{name}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "AppName": "defender",
  • "AppTitle": "Extreme Defender for IoT",
  • "AppDescription": "Next generation security for medical and other connected devices",
  • "AppIcon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAOxAAADsQBlSsOGwAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAsZSURBVHic7Zp5kBxVHcc/v349m12CG3KAIgEDBALEiEpKRKmEQ8iBEqrksAxRAUkCCh7cN6JccqgoRXaxgqAhCJaKAbJgIRsEEkIloYAQICHGFKJlUkQTNrs73e/9/GO6e3p6Z2Z3Zg/+MN+qV9PXe/2+n/71e7/Xu7BLu7RL/8+SD7oDfVFbc/MoHTbsMM/z9jGeNwJjENVtIrK5q7Fx3cwNG7bX23YFACrTaP1lNw3fauesrnob74/+OHLkJCMyx/e8mZ7vT/Q8D88YPBHE8/BEQAQRsSLyisKfnHOLpm7cuL6W+5QFMJPWgx36Jki70DVrKRfWTbhWPbr77lPE968zvn+cMQZjDIl5z0uKRCAEQCIbqk5VH8PaHxy1YcPqvtyvLIDptH4FdHG0u8ZgT32c8zcOgL+Keri5eVSDc3cZ3/+q8X0xxmB8H68ChAoA0EKxDlr8xsZLJq9atbPafb3yh3VcaudTFrNmBgvOGAij5fS73XabnHNujef7s43vi/F94uLHJZcj5/vkcrnCdpniF39Nzpjz6e5+6cVDDjm42r3LAhDYJ3OoWZHF02l5YCZ3f2TAnAOPNDV9zoNnPGP2M8YkT9z4fvE3gmByOfwUBD+Xw29oSLYzEDC+f5hpaHhuxaRJR9QEQGFEmcMCzHH4b8xgwWUzuKu5HsOncWfTNFquAZWo0Sme7+8ev+/p4qcjIBUJSUSUiYDkfPHaPXOe17Zq4sTxfQYA5Kp4GKHILcqwzTNouX0mCybHZqrpRO7edzoLrt7B8LcEbkg64PvF9zt+37Mwyr0OacOZJx9DSF4lY8bg+0tWjB/f46H5FfprejNUAMFFilw0ndZ3oGU5yBrgn6AdhUtkT9AJIJ8FnUwZ4OmRPQZhyoHwfXxj8HwfkxoQRYrsVRXnHOoc1vMgDOMTAIe44cNvAr7dKwCFHTVmSGOB00BP69FSyW9PmYz5stEQmU890eQ6EUGiO8QAnLWItcUpLpodfOfOe3HSpEVHvvrq8qoAPNhWucsDrwSASPlo8LzCk08PjHEExFGgilPFWYsTwYqggInMewU4nrH2emBayms56ZYhcQ4lJiS13QNE/FtmLMhlBr8e+UMp3BNXTpz4yaoAHN7fhgwAFM2LJB3NQvE8r/i6pEFkB750spRtp5A6IzCnKgBF3h4qAMQdi0AQd7JQXheRbi8DIgshlzafzRZThWI5qSqAYbh1gK3DznMK14I8WnPNdEeT3nmXi8jKuOMxpHSkmCgKSsaDqA1JtV2yDxNWHnjgvlABwBLm7QRer9HBE23MnfIk837YxtxTgJ/UVj8j1ec/vmLFEoVny56mMOqrc1hr4zUAqhpPe8W5JzqWHtitMROgciKEwku19FdwvwVJ7uHwFtVSv9DPYudF5Iqog+2JgbhEc72zljAMCYOAMAwLM4BzhdnAuRIo2YLq+KoAQNpr6743Lr1nsPvXY1wBp/rY4atX/xVge2fnC6qaTxtzzmHDMDEfBEECwVpbBBH/RnU1BcWpjqgKIIf9Sy32Fb10BvceB4W0V5Gf9qWecy77dB2q18TnJ69atdM5typ+4s5arLWE6acfmQ/DEJuFEEVLtrio/YoAHuO8fwBra2AwXHGzAAz+ofRcUVZUSWirLv7M2rUvl5x3rt1GAGxk3EbGgyAgyOd7gEhHg43GiSQaChC6qwIoSP5QAwCAYQAObeprhZLQVg1QvS57TeDcMhuGyVNPh3+YAhFv2zgSohJHg02/FqpvQy8AFK0JgEBD1Gi11WTP+xSfSuvnN2x4GyC9cpPt25+31gaxobThIGM+HQnx62DLRIOqru8VwJPMWw28VYOXDgCFqp+h0rJF8x3S1fWj+LjzvOufP/TQjwFMXLv2fRuGq20qvMMgIEhFQQIiNRYk18YQYhDObVm2adNbvQIAEOTeMocdZZZ4CpsBDKZSKt0juXJhiHOO0Lk7j92y5V8AT48du4+1dr6nekxSMQyX9Rj00sbT40B2UIwjwVpcYf+J6wseKn4PSMm/H4IbicI7srpYMJcr9hhBjlT4sMLWkGAhwOOcu24aLVcJHAvyH4FXQZ7zCDZZzJvp+6pzXdbaTU0id6RA3mCtbUJkKnA/QGhtu+fcpfES2PMKz05ELlGRv2NtkXBktrBpiyUIChDy+WSQ7dOyfxotDwkkH0UVd+STnLeyL3Wzmk7Lo8DJbcz10olTrKVjxkwwudxrxhjf+P7GYzZtOhDguQkTPpQz5j3P8/xkcaO67NOvvHJMPf2I1YcIAA+vVXERAFkZmz+F+/YI6BQAR7hzKRd2F2upnMQ9e8R7HTR1tnNWl0KrwMmV7mWdu5kw9AEUDvjzAQfsd8LGjZuPfvPNHc+PH/+yZ8zkKOdXVb28dsul6hOApXzzmRm0rlc4CNzPAWbQenEX+dvir2eKuQD4RVzneO4eZcltjfebyG8+gQVfaGZk2/ts2xwfvw8aG6CJESNosvYT1tpTIvMYVcTaKcBvoPAaiHOTPc8Dkd8fvX79CoAXxo5t0qame1FtcFHO76wtrBOijyRqLYG1K7+4devtNQMohGrrbaA/A9l7Oi3tik4tuQJGp/eH0TDapcZJhf0Msm4H25YrvBcfz8F3EbnZdHRgfT/JCpMvOYVxoACgu/tZ8f2LRcR6kGSLed+/gCCYTTHNTabWpFi7U4Lg6qyzPgKAf6O/2hOuAH5cAVIJgBDGlJliDHB0duBR1WTQKjHvHMaYBLTr7HxWGxutiCw84d131wE8M27cHmEQXBbXTWeVyScy51Sdmztrx44eU3qv02CsVcwLgFsrnRe0BIDBja50bTmpasn8nUp6DloyevQ+ACds2/Zfm8+/GHR1JZ/V852dl4ZBMCqbDKUXSEEQfH/W9u1lV6d9BgCwBRYCm8oayABQvJoAxIozt/Rc3t3VNSU+H+bz58x87713ANrGjNk7n89fmM0Kg1SeEAbBpV/u6Ki4MKsJwCrmBYpWiALJANC6AEBhfZBOemwYJq/Bl3bseCPe7urqujYMguHZtUAqCq46tbPztmr3qgkAQDOjFgLlvhmOyjQ8qsw1NSkBkc9PzZ57uLFx/3wQnJ1eC6S38/n8VWfk8zf1do+aATzC6XlBv1fmVCYCGFNr25Wkqocsho+mjwX5/E1hEDQkTzuVCgdheNVs53o1D3UAAFjK/CXA45nDzUfQkqwCs9NifxXC0fH2r+Fwde70kvV9/KkLrpwDfTIPdQIAEPgO0J0+NBo3Mt7RzJjQXwlMTW3fSvm+X3km3FxLu3UDWMq8t0HvTB/L4adM1z8IVtBUgEUwhdSftlKq2Tz0AwCAY7cbJVoCQyH5SZ0eWaZKf3TYg4VV5y1lztVlHvoJ4Cm+1qHo2STfBmx65B+wQTCSWLgDOKrkIFxSr3noJwCANuY/LXB3obFC8nMiDwwHGvvbdlYCszOHrpwNt5e9uI/qNwAAHy4D3oqTH0fnQL//5VR32Kc1IACWMG+n4H09/t+iXI3rgDo0IOZhgAAALOXcFRotWxXpdxZYRQNmHgYQAMBTzHsDQAZ+AIw1oOZhgAHEqncl2IsG3DwMEgBwayjNEvurQTEPgwSgjfnLQb5BtX8P67sGzTwMWgRAG3Mf0hoWJRU0qOZhEAEAPMncawQerLP6oJuHQQYAop00nAMs7/XSUg2JeRh0ANDOWV1CbpbAa32sMmTmYQgAACzl7C2QOw54tZdLrxhK8zBEAKAAQcgdT2UIV5xZfqk7qBoyAFAVwgdi/gPTidyzV7z9AOxV7dpd2qVd2qXB1P8A6w2UPhwecNMAAAAASUVORK5CYII=",
  • "ProxyAppUrl": true,
  • "AppFileNameFormat": "defender_[0-9]{2}\\.[0-9]{2}\\.[0-9]{2}",
  • "AppRegistry": "Docker Hub",
  • "Type": "BUILT_IN",
  • "AppVersion": "1.0.0",
  • "LatestVersion": "2.0.0",
  • "AppState": "NOT_INSTALLED",
  • "StartedAt": "2019-10-08T16:03:32Z",
  • "Warnings":
    [
    ]
}

Upgrade an application

Upgrades an application from registry.

Authorizations:
Authorization (FullAdmin)
path Parameters
name
required
string

Name of application template that needs to be upgraded.

query Parameters
version
required
string

Version of the application.

Responses

200

Application upgraded successfully

400

Template not found, template does not define a registry, or the application is not present in the registry

401

Unauthorized

409

Application is either not installed or is currently running

415

Unsupported media type

500

Server error

put /apps/{name}/registry

ExtremeCloud Appliance REST API Server

https://www.example.com:5825/orchestration/v1/apps/{name}/registry

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "AppName": "defender",
  • "AppTitle": "Extreme Defender for IoT",
  • "AppDescription": "Next generation security for medical and other connected devices",
  • "AppIcon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAOxAAADsQBlSsOGwAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAsZSURBVHic7Zp5kBxVHcc/v349m12CG3KAIgEDBALEiEpKRKmEQ8iBEqrksAxRAUkCCh7cN6JccqgoRXaxgqAhCJaKAbJgIRsEEkIloYAQICHGFKJlUkQTNrs73e/9/GO6e3p6Z2Z3Zg/+MN+qV9PXe/2+n/71e7/Xu7BLu7RL/8+SD7oDfVFbc/MoHTbsMM/z9jGeNwJjENVtIrK5q7Fx3cwNG7bX23YFACrTaP1lNw3fauesrnob74/+OHLkJCMyx/e8mZ7vT/Q8D88YPBHE8/BEQAQRsSLyisKfnHOLpm7cuL6W+5QFMJPWgx36Jki70DVrKRfWTbhWPbr77lPE968zvn+cMQZjDIl5z0uKRCAEQCIbqk5VH8PaHxy1YcPqvtyvLIDptH4FdHG0u8ZgT32c8zcOgL+Keri5eVSDc3cZ3/+q8X0xxmB8H68ChAoA0EKxDlr8xsZLJq9atbPafb3yh3VcaudTFrNmBgvOGAij5fS73XabnHNujef7s43vi/F94uLHJZcj5/vkcrnCdpniF39Nzpjz6e5+6cVDDjm42r3LAhDYJ3OoWZHF02l5YCZ3f2TAnAOPNDV9zoNnPGP2M8YkT9z4fvE3gmByOfwUBD+Xw29oSLYzEDC+f5hpaHhuxaRJR9QEQGFEmcMCzHH4b8xgwWUzuKu5HsOncWfTNFquAZWo0Sme7+8ev+/p4qcjIBUJSUSUiYDkfPHaPXOe17Zq4sTxfQYA5Kp4GKHILcqwzTNouX0mCybHZqrpRO7edzoLrt7B8LcEbkg64PvF9zt+37Mwyr0OacOZJx9DSF4lY8bg+0tWjB/f46H5FfprejNUAMFFilw0ndZ3oGU5yBrgn6AdhUtkT9AJIJ8FnUwZ4OmRPQZhyoHwfXxj8HwfkxoQRYrsVRXnHOoc1vMgDOMTAIe44cNvAr7dKwCFHTVmSGOB00BP69FSyW9PmYz5stEQmU890eQ6EUGiO8QAnLWItcUpLpodfOfOe3HSpEVHvvrq8qoAPNhWucsDrwSASPlo8LzCk08PjHEExFGgilPFWYsTwYqggInMewU4nrH2emBayms56ZYhcQ4lJiS13QNE/FtmLMhlBr8e+UMp3BNXTpz4yaoAHN7fhgwAFM2LJB3NQvE8r/i6pEFkB750spRtp5A6IzCnKgBF3h4qAMQdi0AQd7JQXheRbi8DIgshlzafzRZThWI5qSqAYbh1gK3DznMK14I8WnPNdEeT3nmXi8jKuOMxpHSkmCgKSsaDqA1JtV2yDxNWHnjgvlABwBLm7QRer9HBE23MnfIk837YxtxTgJ/UVj8j1ec/vmLFEoVny56mMOqrc1hr4zUAqhpPe8W5JzqWHtitMROgciKEwku19FdwvwVJ7uHwFtVSv9DPYudF5Iqog+2JgbhEc72zljAMCYOAMAwLM4BzhdnAuRIo2YLq+KoAQNpr6743Lr1nsPvXY1wBp/rY4atX/xVge2fnC6qaTxtzzmHDMDEfBEECwVpbBBH/RnU1BcWpjqgKIIf9Sy32Fb10BvceB4W0V5Gf9qWecy77dB2q18TnJ69atdM5typ+4s5arLWE6acfmQ/DEJuFEEVLtrio/YoAHuO8fwBra2AwXHGzAAz+ofRcUVZUSWirLv7M2rUvl5x3rt1GAGxk3EbGgyAgyOd7gEhHg43GiSQaChC6qwIoSP5QAwCAYQAObeprhZLQVg1QvS57TeDcMhuGyVNPh3+YAhFv2zgSohJHg02/FqpvQy8AFK0JgEBD1Gi11WTP+xSfSuvnN2x4GyC9cpPt25+31gaxobThIGM+HQnx62DLRIOqru8VwJPMWw28VYOXDgCFqp+h0rJF8x3S1fWj+LjzvOufP/TQjwFMXLv2fRuGq20qvMMgIEhFQQIiNRYk18YQYhDObVm2adNbvQIAEOTeMocdZZZ4CpsBDKZSKt0juXJhiHOO0Lk7j92y5V8AT48du4+1dr6nekxSMQyX9Rj00sbT40B2UIwjwVpcYf+J6wseKn4PSMm/H4IbicI7srpYMJcr9hhBjlT4sMLWkGAhwOOcu24aLVcJHAvyH4FXQZ7zCDZZzJvp+6pzXdbaTU0id6RA3mCtbUJkKnA/QGhtu+fcpfES2PMKz05ELlGRv2NtkXBktrBpiyUIChDy+WSQ7dOyfxotDwkkH0UVd+STnLeyL3Wzmk7Lo8DJbcz10olTrKVjxkwwudxrxhjf+P7GYzZtOhDguQkTPpQz5j3P8/xkcaO67NOvvHJMPf2I1YcIAA+vVXERAFkZmz+F+/YI6BQAR7hzKRd2F2upnMQ9e8R7HTR1tnNWl0KrwMmV7mWdu5kw9AEUDvjzAQfsd8LGjZuPfvPNHc+PH/+yZ8zkKOdXVb28dsul6hOApXzzmRm0rlc4CNzPAWbQenEX+dvir2eKuQD4RVzneO4eZcltjfebyG8+gQVfaGZk2/ts2xwfvw8aG6CJESNosvYT1tpTIvMYVcTaKcBvoPAaiHOTPc8Dkd8fvX79CoAXxo5t0qame1FtcFHO76wtrBOijyRqLYG1K7+4devtNQMohGrrbaA/A9l7Oi3tik4tuQJGp/eH0TDapcZJhf0Msm4H25YrvBcfz8F3EbnZdHRgfT/JCpMvOYVxoACgu/tZ8f2LRcR6kGSLed+/gCCYTTHNTabWpFi7U4Lg6qyzPgKAf6O/2hOuAH5cAVIJgBDGlJliDHB0duBR1WTQKjHvHMaYBLTr7HxWGxutiCw84d131wE8M27cHmEQXBbXTWeVyScy51Sdmztrx44eU3qv02CsVcwLgFsrnRe0BIDBja50bTmpasn8nUp6DloyevQ+ACds2/Zfm8+/GHR1JZ/V852dl4ZBMCqbDKUXSEEQfH/W9u1lV6d9BgCwBRYCm8oayABQvJoAxIozt/Rc3t3VNSU+H+bz58x87713ANrGjNk7n89fmM0Kg1SeEAbBpV/u6Ki4MKsJwCrmBYpWiALJANC6AEBhfZBOemwYJq/Bl3bseCPe7urqujYMguHZtUAqCq46tbPztmr3qgkAQDOjFgLlvhmOyjQ8qsw1NSkBkc9PzZ57uLFx/3wQnJ1eC6S38/n8VWfk8zf1do+aATzC6XlBv1fmVCYCGFNr25Wkqocsho+mjwX5/E1hEDQkTzuVCgdheNVs53o1D3UAAFjK/CXA45nDzUfQkqwCs9NifxXC0fH2r+Fwde70kvV9/KkLrpwDfTIPdQIAEPgO0J0+NBo3Mt7RzJjQXwlMTW3fSvm+X3km3FxLu3UDWMq8t0HvTB/L4adM1z8IVtBUgEUwhdSftlKq2Tz0AwCAY7cbJVoCQyH5SZ0eWaZKf3TYg4VV5y1lztVlHvoJ4Cm+1qHo2STfBmx65B+wQTCSWLgDOKrkIFxSr3noJwCANuY/LXB3obFC8nMiDwwHGvvbdlYCszOHrpwNt5e9uI/qNwAAHy4D3oqTH0fnQL//5VR32Kc1IACWMG+n4H09/t+iXI3rgDo0IOZhgAAALOXcFRotWxXpdxZYRQNmHgYQAMBTzHsDQAZ+AIw1oOZhgAHEqncl2IsG3DwMEgBwayjNEvurQTEPgwSgjfnLQb5BtX8P67sGzTwMWgRAG3Mf0hoWJRU0qOZhEAEAPMncawQerLP6oJuHQQYAop00nAMs7/XSUg2JeRh0ANDOWV1CbpbAa32sMmTmYQgAACzl7C2QOw54tZdLrxhK8zBEAKAAQcgdT2UIV5xZfqk7qBoyAFAVwgdi/gPTidyzV7z9AOxV7dpd2qVd2qXB1P8A6w2UPhwecNMAAAAASUVORK5CYII=",
  • "ProxyAppUrl": true,
  • "AppFileNameFormat": "defender_[0-9]{2}\\.[0-9]{2}\\.[0-9]{2}",
  • "AppRegistry": "Docker Hub",
  • "Type": "BUILT_IN",
  • "AppVersion": "1.0.0",
  • "LatestVersion": "2.0.0",
  • "AppState": "NOT_INSTALLED",
  • "StartedAt": "2019-10-08T16:03:32Z",
  • "Warnings":
    [
    ]
}

Install an application from registry

Installs an application from the registry.

Authorizations:
Authorization (FullAdmin)
query Parameters
name
required
string

Name of application template that needs to be installed.

version
required
string

Version of application that needs to be installed.

Responses

200

Application installed successfully

400

Template not found, template does not define a registry, or application is not present in the registry

401

Unauthorized

409

Application is already installed

415

Unsupported media type

500

Server error

post /apps/registry

ExtremeCloud Appliance REST API Server

https://www.example.com:5825/orchestration/v1/apps/registry

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "AppName": "defender",
  • "AppTitle": "Extreme Defender for IoT",
  • "AppDescription": "Next generation security for medical and other connected devices",
  • "AppIcon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAOxAAADsQBlSsOGwAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAsZSURBVHic7Zp5kBxVHcc/v349m12CG3KAIgEDBALEiEpKRKmEQ8iBEqrksAxRAUkCCh7cN6JccqgoRXaxgqAhCJaKAbJgIRsEEkIloYAQICHGFKJlUkQTNrs73e/9/GO6e3p6Z2Z3Zg/+MN+qV9PXe/2+n/71e7/Xu7BLu7RL/8+SD7oDfVFbc/MoHTbsMM/z9jGeNwJjENVtIrK5q7Fx3cwNG7bX23YFACrTaP1lNw3fauesrnob74/+OHLkJCMyx/e8mZ7vT/Q8D88YPBHE8/BEQAQRsSLyisKfnHOLpm7cuL6W+5QFMJPWgx36Jki70DVrKRfWTbhWPbr77lPE968zvn+cMQZjDIl5z0uKRCAEQCIbqk5VH8PaHxy1YcPqvtyvLIDptH4FdHG0u8ZgT32c8zcOgL+Keri5eVSDc3cZ3/+q8X0xxmB8H68ChAoA0EKxDlr8xsZLJq9atbPafb3yh3VcaudTFrNmBgvOGAij5fS73XabnHNujef7s43vi/F94uLHJZcj5/vkcrnCdpniF39Nzpjz6e5+6cVDDjm42r3LAhDYJ3OoWZHF02l5YCZ3f2TAnAOPNDV9zoNnPGP2M8YkT9z4fvE3gmByOfwUBD+Xw29oSLYzEDC+f5hpaHhuxaRJR9QEQGFEmcMCzHH4b8xgwWUzuKu5HsOncWfTNFquAZWo0Sme7+8ev+/p4qcjIBUJSUSUiYDkfPHaPXOe17Zq4sTxfQYA5Kp4GKHILcqwzTNouX0mCybHZqrpRO7edzoLrt7B8LcEbkg64PvF9zt+37Mwyr0OacOZJx9DSF4lY8bg+0tWjB/f46H5FfprejNUAMFFilw0ndZ3oGU5yBrgn6AdhUtkT9AJIJ8FnUwZ4OmRPQZhyoHwfXxj8HwfkxoQRYrsVRXnHOoc1vMgDOMTAIe44cNvAr7dKwCFHTVmSGOB00BP69FSyW9PmYz5stEQmU890eQ6EUGiO8QAnLWItcUpLpodfOfOe3HSpEVHvvrq8qoAPNhWucsDrwSASPlo8LzCk08PjHEExFGgilPFWYsTwYqggInMewU4nrH2emBayms56ZYhcQ4lJiS13QNE/FtmLMhlBr8e+UMp3BNXTpz4yaoAHN7fhgwAFM2LJB3NQvE8r/i6pEFkB750spRtp5A6IzCnKgBF3h4qAMQdi0AQd7JQXheRbi8DIgshlzafzRZThWI5qSqAYbh1gK3DznMK14I8WnPNdEeT3nmXi8jKuOMxpHSkmCgKSsaDqA1JtV2yDxNWHnjgvlABwBLm7QRer9HBE23MnfIk837YxtxTgJ/UVj8j1ec/vmLFEoVny56mMOqrc1hr4zUAqhpPe8W5JzqWHtitMROgciKEwku19FdwvwVJ7uHwFtVSv9DPYudF5Iqog+2JgbhEc72zljAMCYOAMAwLM4BzhdnAuRIo2YLq+KoAQNpr6743Lr1nsPvXY1wBp/rY4atX/xVge2fnC6qaTxtzzmHDMDEfBEECwVpbBBH/RnU1BcWpjqgKIIf9Sy32Fb10BvceB4W0V5Gf9qWecy77dB2q18TnJ69atdM5typ+4s5arLWE6acfmQ/DEJuFEEVLtrio/YoAHuO8fwBra2AwXHGzAAz+ofRcUVZUSWirLv7M2rUvl5x3rt1GAGxk3EbGgyAgyOd7gEhHg43GiSQaChC6qwIoSP5QAwCAYQAObeprhZLQVg1QvS57TeDcMhuGyVNPh3+YAhFv2zgSohJHg02/FqpvQy8AFK0JgEBD1Gi11WTP+xSfSuvnN2x4GyC9cpPt25+31gaxobThIGM+HQnx62DLRIOqru8VwJPMWw28VYOXDgCFqp+h0rJF8x3S1fWj+LjzvOufP/TQjwFMXLv2fRuGq20qvMMgIEhFQQIiNRYk18YQYhDObVm2adNbvQIAEOTeMocdZZZ4CpsBDKZSKt0juXJhiHOO0Lk7j92y5V8AT48du4+1dr6nekxSMQyX9Rj00sbT40B2UIwjwVpcYf+J6wseKn4PSMm/H4IbicI7srpYMJcr9hhBjlT4sMLWkGAhwOOcu24aLVcJHAvyH4FXQZ7zCDZZzJvp+6pzXdbaTU0id6RA3mCtbUJkKnA/QGhtu+fcpfES2PMKz05ELlGRv2NtkXBktrBpiyUIChDy+WSQ7dOyfxotDwkkH0UVd+STnLeyL3Wzmk7Lo8DJbcz10olTrKVjxkwwudxrxhjf+P7GYzZtOhDguQkTPpQz5j3P8/xkcaO67NOvvHJMPf2I1YcIAA+vVXERAFkZmz+F+/YI6BQAR7hzKRd2F2upnMQ9e8R7HTR1tnNWl0KrwMmV7mWdu5kw9AEUDvjzAQfsd8LGjZuPfvPNHc+PH/+yZ8zkKOdXVb28dsul6hOApXzzmRm0rlc4CNzPAWbQenEX+dvir2eKuQD4RVzneO4eZcltjfebyG8+gQVfaGZk2/ts2xwfvw8aG6CJESNosvYT1tpTIvMYVcTaKcBvoPAaiHOTPc8Dkd8fvX79CoAXxo5t0qame1FtcFHO76wtrBOijyRqLYG1K7+4devtNQMohGrrbaA/A9l7Oi3tik4tuQJGp/eH0TDapcZJhf0Msm4H25YrvBcfz8F3EbnZdHRgfT/JCpMvOYVxoACgu/tZ8f2LRcR6kGSLed+/gCCYTTHNTabWpFi7U4Lg6qyzPgKAf6O/2hOuAH5cAVIJgBDGlJliDHB0duBR1WTQKjHvHMaYBLTr7HxWGxutiCw84d131wE8M27cHmEQXBbXTWeVyScy51Sdmztrx44eU3qv02CsVcwLgFsrnRe0BIDBja50bTmpasn8nUp6DloyevQ+ACds2/Zfm8+/GHR1JZ/V852dl4ZBMCqbDKUXSEEQfH/W9u1lV6d9BgCwBRYCm8oayABQvJoAxIozt/Rc3t3VNSU+H+bz58x87713ANrGjNk7n89fmM0Kg1SeEAbBpV/u6Ki4MKsJwCrmBYpWiALJANC6AEBhfZBOemwYJq/Bl3bseCPe7urqujYMguHZtUAqCq46tbPztmr3qgkAQDOjFgLlvhmOyjQ8qsw1NSkBkc9PzZ57uLFx/3wQnJ1eC6S38/n8VWfk8zf1do+aATzC6XlBv1fmVCYCGFNr25Wkqocsho+mjwX5/E1hEDQkTzuVCgdheNVs53o1D3UAAFjK/CXA45nDzUfQkqwCs9NifxXC0fH2r+Fwde70kvV9/KkLrpwDfTIPdQIAEPgO0J0+NBo3Mt7RzJjQXwlMTW3fSvm+X3km3FxLu3UDWMq8t0HvTB/L4adM1z8IVtBUgEUwhdSftlKq2Tz0AwCAY7cbJVoCQyH5SZ0eWaZKf3TYg4VV5y1lztVlHvoJ4Cm+1qHo2STfBmx65B+wQTCSWLgDOKrkIFxSr3noJwCANuY/LXB3obFC8nMiDwwHGvvbdlYCszOHrpwNt5e9uI/qNwAAHy4D3oqTH0fnQL//5VR32Kc1IACWMG+n4H09/t+iXI3rgDo0IOZhgAAALOXcFRotWxXpdxZYRQNmHgYQAMBTzHsDQAZ+AIw1oOZhgAHEqncl2IsG3DwMEgBwayjNEvurQTEPgwSgjfnLQb5BtX8P67sGzTwMWgRAG3Mf0hoWJRU0qOZhEAEAPMncawQerLP6oJuHQQYAop00nAMs7/XSUg2JeRh0ANDOWV1CbpbAa32sMmTmYQgAACzl7C2QOw54tZdLrxhK8zBEAKAAQcgdT2UIV5xZfqk7qBoyAFAVwgdi/gPTidyzV7z9AOxV7dpd2qVd2qXB1P8A6w2UPhwecNMAAAAASUVORK5CYII=",
  • "ProxyAppUrl": true,
  • "AppFileNameFormat": "defender_[0-9]{2}\\.[0-9]{2}\\.[0-9]{2}",
  • "AppRegistry": "Docker Hub",
  • "Type": "BUILT_IN",
  • "AppVersion": "1.0.0",
  • "LatestVersion": "2.0.0",
  • "AppState": "NOT_INSTALLED",
  • "StartedAt": "2019-10-08T16:03:32Z",
  • "Warnings":
    [
    ]
}

Install an application from file

Installs an application from file.

Authorizations:
Authorization (FullAdmin)
query Parameters
name
required
string

Name of application template that needs to be installed.

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

A tar archive containing images of the application that needs to be installed.

Responses

200

Application installed successfully

400

Template not found or no file was supplied

401

Unauthorized

409

Application is already installed

415

Unsupported media type

500

Server error

post /apps/file

ExtremeCloud Appliance REST API Server

https://www.example.com:5825/orchestration/v1/apps/file

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "AppName": "defender",
  • "AppTitle": "Extreme Defender for IoT",
  • "AppDescription": "Next generation security for medical and other connected devices",
  • "AppIcon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAOxAAADsQBlSsOGwAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAsZSURBVHic7Zp5kBxVHcc/v349m12CG3KAIgEDBALEiEpKRKmEQ8iBEqrksAxRAUkCCh7cN6JccqgoRXaxgqAhCJaKAbJgIRsEEkIloYAQICHGFKJlUkQTNrs73e/9/GO6e3p6Z2Z3Zg/+MN+qV9PXe/2+n/71e7/Xu7BLu7RL/8+SD7oDfVFbc/MoHTbsMM/z9jGeNwJjENVtIrK5q7Fx3cwNG7bX23YFACrTaP1lNw3fauesrnob74/+OHLkJCMyx/e8mZ7vT/Q8D88YPBHE8/BEQAQRsSLyisKfnHOLpm7cuL6W+5QFMJPWgx36Jki70DVrKRfWTbhWPbr77lPE968zvn+cMQZjDIl5z0uKRCAEQCIbqk5VH8PaHxy1YcPqvtyvLIDptH4FdHG0u8ZgT32c8zcOgL+Keri5eVSDc3cZ3/+q8X0xxmB8H68ChAoA0EKxDlr8xsZLJq9atbPafb3yh3VcaudTFrNmBgvOGAij5fS73XabnHNujef7s43vi/F94uLHJZcj5/vkcrnCdpniF39Nzpjz6e5+6cVDDjm42r3LAhDYJ3OoWZHF02l5YCZ3f2TAnAOPNDV9zoNnPGP2M8YkT9z4fvE3gmByOfwUBD+Xw29oSLYzEDC+f5hpaHhuxaRJR9QEQGFEmcMCzHH4b8xgwWUzuKu5HsOncWfTNFquAZWo0Sme7+8ev+/p4qcjIBUJSUSUiYDkfPHaPXOe17Zq4sTxfQYA5Kp4GKHILcqwzTNouX0mCybHZqrpRO7edzoLrt7B8LcEbkg64PvF9zt+37Mwyr0OacOZJx9DSF4lY8bg+0tWjB/f46H5FfprejNUAMFFilw0ndZ3oGU5yBrgn6AdhUtkT9AJIJ8FnUwZ4OmRPQZhyoHwfXxj8HwfkxoQRYrsVRXnHOoc1vMgDOMTAIe44cNvAr7dKwCFHTVmSGOB00BP69FSyW9PmYz5stEQmU890eQ6EUGiO8QAnLWItcUpLpodfOfOe3HSpEVHvvrq8qoAPNhWucsDrwSASPlo8LzCk08PjHEExFGgilPFWYsTwYqggInMewU4nrH2emBayms56ZYhcQ4lJiS13QNE/FtmLMhlBr8e+UMp3BNXTpz4yaoAHN7fhgwAFM2LJB3NQvE8r/i6pEFkB750spRtp5A6IzCnKgBF3h4qAMQdi0AQd7JQXheRbi8DIgshlzafzRZThWI5qSqAYbh1gK3DznMK14I8WnPNdEeT3nmXi8jKuOMxpHSkmCgKSsaDqA1JtV2yDxNWHnjgvlABwBLm7QRer9HBE23MnfIk837YxtxTgJ/UVj8j1ec/vmLFEoVny56mMOqrc1hr4zUAqhpPe8W5JzqWHtitMROgciKEwku19FdwvwVJ7uHwFtVSv9DPYudF5Iqog+2JgbhEc72zljAMCYOAMAwLM4BzhdnAuRIo2YLq+KoAQNpr6743Lr1nsPvXY1wBp/rY4atX/xVge2fnC6qaTxtzzmHDMDEfBEECwVpbBBH/RnU1BcWpjqgKIIf9Sy32Fb10BvceB4W0V5Gf9qWecy77dB2q18TnJ69atdM5typ+4s5arLWE6acfmQ/DEJuFEEVLtrio/YoAHuO8fwBra2AwXHGzAAz+ofRcUVZUSWirLv7M2rUvl5x3rt1GAGxk3EbGgyAgyOd7gEhHg43GiSQaChC6qwIoSP5QAwCAYQAObeprhZLQVg1QvS57TeDcMhuGyVNPh3+YAhFv2zgSohJHg02/FqpvQy8AFK0JgEBD1Gi11WTP+xSfSuvnN2x4GyC9cpPt25+31gaxobThIGM+HQnx62DLRIOqru8VwJPMWw28VYOXDgCFqp+h0rJF8x3S1fWj+LjzvOufP/TQjwFMXLv2fRuGq20qvMMgIEhFQQIiNRYk18YQYhDObVm2adNbvQIAEOTeMocdZZZ4CpsBDKZSKt0juXJhiHOO0Lk7j92y5V8AT48du4+1dr6nekxSMQyX9Rj00sbT40B2UIwjwVpcYf+J6wseKn4PSMm/H4IbicI7srpYMJcr9hhBjlT4sMLWkGAhwOOcu24aLVcJHAvyH4FXQZ7zCDZZzJvp+6pzXdbaTU0id6RA3mCtbUJkKnA/QGhtu+fcpfES2PMKz05ELlGRv2NtkXBktrBpiyUIChDy+WSQ7dOyfxotDwkkH0UVd+STnLeyL3Wzmk7Lo8DJbcz10olTrKVjxkwwudxrxhjf+P7GYzZtOhDguQkTPpQz5j3P8/xkcaO67NOvvHJMPf2I1YcIAA+vVXERAFkZmz+F+/YI6BQAR7hzKRd2F2upnMQ9e8R7HTR1tnNWl0KrwMmV7mWdu5kw9AEUDvjzAQfsd8LGjZuPfvPNHc+PH/+yZ8zkKOdXVb28dsul6hOApXzzmRm0rlc4CNzPAWbQenEX+dvir2eKuQD4RVzneO4eZcltjfebyG8+gQVfaGZk2/ts2xwfvw8aG6CJESNosvYT1tpTIvMYVcTaKcBvoPAaiHOTPc8Dkd8fvX79CoAXxo5t0qame1FtcFHO76wtrBOijyRqLYG1K7+4devtNQMohGrrbaA/A9l7Oi3tik4tuQJGp/eH0TDapcZJhf0Msm4H25YrvBcfz8F3EbnZdHRgfT/JCpMvOYVxoACgu/tZ8f2LRcR6kGSLed+/gCCYTTHNTabWpFi7U4Lg6qyzPgKAf6O/2hOuAH5cAVIJgBDGlJliDHB0duBR1WTQKjHvHMaYBLTr7HxWGxutiCw84d131wE8M27cHmEQXBbXTWeVyScy51Sdmztrx44eU3qv02CsVcwLgFsrnRe0BIDBja50bTmpasn8nUp6DloyevQ+ACds2/Zfm8+/GHR1JZ/V852dl4ZBMCqbDKUXSEEQfH/W9u1lV6d9BgCwBRYCm8oayABQvJoAxIozt/Rc3t3VNSU+H+bz58x87713ANrGjNk7n89fmM0Kg1SeEAbBpV/u6Ki4MKsJwCrmBYpWiALJANC6AEBhfZBOemwYJq/Bl3bseCPe7urqujYMguHZtUAqCq46tbPztmr3qgkAQDOjFgLlvhmOyjQ8qsw1NSkBkc9PzZ57uLFx/3wQnJ1eC6S38/n8VWfk8zf1do+aATzC6XlBv1fmVCYCGFNr25Wkqocsho+mjwX5/E1hEDQkTzuVCgdheNVs53o1D3UAAFjK/CXA45nDzUfQkqwCs9NifxXC0fH2r+Fwde70kvV9/KkLrpwDfTIPdQIAEPgO0J0+NBo3Mt7RzJjQXwlMTW3fSvm+X3km3FxLu3UDWMq8t0HvTB/L4adM1z8IVtBUgEUwhdSftlKq2Tz0AwCAY7cbJVoCQyH5SZ0eWaZKf3TYg4VV5y1lztVlHvoJ4Cm+1qHo2STfBmx65B+wQTCSWLgDOKrkIFxSr3noJwCANuY/LXB3obFC8nMiDwwHGvvbdlYCszOHrpwNt5e9uI/qNwAAHy4D3oqTH0fnQL//5VR32Kc1IACWMG+n4H09/t+iXI3rgDo0IOZhgAAALOXcFRotWxXpdxZYRQNmHgYQAMBTzHsDQAZ+AIw1oOZhgAHEqncl2IsG3DwMEgBwayjNEvurQTEPgwSgjfnLQb5BtX8P67sGzTwMWgRAG3Mf0hoWJRU0qOZhEAEAPMncawQerLP6oJuHQQYAop00nAMs7/XSUg2JeRh0ANDOWV1CbpbAa32sMmTmYQgAACzl7C2QOw54tZdLrxhK8zBEAKAAQcgdT2UIV5xZfqk7qBoyAFAVwgdi/gPTidyzV7z9AOxV7dpd2qVd2qXB1P8A6w2UPhwecNMAAAAASUVORK5CYII=",
  • "ProxyAppUrl": true,
  • "AppFileNameFormat": "defender_[0-9]{2}\\.[0-9]{2}\\.[0-9]{2}",
  • "AppRegistry": "Docker Hub",
  • "Type": "BUILT_IN",
  • "AppVersion": "1.0.0",
  • "LatestVersion": "2.0.0",
  • "AppState": "NOT_INSTALLED",
  • "StartedAt": "2019-10-08T16:03:33Z",
  • "Warnings":
    [
    ]
}

Upgrade an application from file

Upgrades an application from file.

Authorizations:
Authorization (FullAdmin)
path Parameters
name
required
string

Name of application template that needs to be upgraded.

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

A tar archive containing images of the application to be upgraded.

Responses

200

Application upgraded successfully

400

Template not found or no file was supplied

401

Unauthorized

409

Application is either not installed or is currently running

415

Unsupported media type

500

Server error

put /apps/{name}/file

ExtremeCloud Appliance REST API Server

https://www.example.com:5825/orchestration/v1/apps/{name}/file

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "AppName": "defender",
  • "AppTitle": "Extreme Defender for IoT",
  • "AppDescription": "Next generation security for medical and other connected devices",
  • "AppIcon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAOxAAADsQBlSsOGwAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAsZSURBVHic7Zp5kBxVHcc/v349m12CG3KAIgEDBALEiEpKRKmEQ8iBEqrksAxRAUkCCh7cN6JccqgoRXaxgqAhCJaKAbJgIRsEEkIloYAQICHGFKJlUkQTNrs73e/9/GO6e3p6Z2Z3Zg/+MN+qV9PXe/2+n/71e7/Xu7BLu7RL/8+SD7oDfVFbc/MoHTbsMM/z9jGeNwJjENVtIrK5q7Fx3cwNG7bX23YFACrTaP1lNw3fauesrnob74/+OHLkJCMyx/e8mZ7vT/Q8D88YPBHE8/BEQAQRsSLyisKfnHOLpm7cuL6W+5QFMJPWgx36Jki70DVrKRfWTbhWPbr77lPE968zvn+cMQZjDIl5z0uKRCAEQCIbqk5VH8PaHxy1YcPqvtyvLIDptH4FdHG0u8ZgT32c8zcOgL+Keri5eVSDc3cZ3/+q8X0xxmB8H68ChAoA0EKxDlr8xsZLJq9atbPafb3yh3VcaudTFrNmBgvOGAij5fS73XabnHNujef7s43vi/F94uLHJZcj5/vkcrnCdpniF39Nzpjz6e5+6cVDDjm42r3LAhDYJ3OoWZHF02l5YCZ3f2TAnAOPNDV9zoNnPGP2M8YkT9z4fvE3gmByOfwUBD+Xw29oSLYzEDC+f5hpaHhuxaRJR9QEQGFEmcMCzHH4b8xgwWUzuKu5HsOncWfTNFquAZWo0Sme7+8ev+/p4qcjIBUJSUSUiYDkfPHaPXOe17Zq4sTxfQYA5Kp4GKHILcqwzTNouX0mCybHZqrpRO7edzoLrt7B8LcEbkg64PvF9zt+37Mwyr0OacOZJx9DSF4lY8bg+0tWjB/f46H5FfprejNUAMFFilw0ndZ3oGU5yBrgn6AdhUtkT9AJIJ8FnUwZ4OmRPQZhyoHwfXxj8HwfkxoQRYrsVRXnHOoc1vMgDOMTAIe44cNvAr7dKwCFHTVmSGOB00BP69FSyW9PmYz5stEQmU890eQ6EUGiO8QAnLWItcUpLpodfOfOe3HSpEVHvvrq8qoAPNhWucsDrwSASPlo8LzCk08PjHEExFGgilPFWYsTwYqggInMewU4nrH2emBayms56ZYhcQ4lJiS13QNE/FtmLMhlBr8e+UMp3BNXTpz4yaoAHN7fhgwAFM2LJB3NQvE8r/i6pEFkB750spRtp5A6IzCnKgBF3h4qAMQdi0AQd7JQXheRbi8DIgshlzafzRZThWI5qSqAYbh1gK3DznMK14I8WnPNdEeT3nmXi8jKuOMxpHSkmCgKSsaDqA1JtV2yDxNWHnjgvlABwBLm7QRer9HBE23MnfIk837YxtxTgJ/UVj8j1ec/vmLFEoVny56mMOqrc1hr4zUAqhpPe8W5JzqWHtitMROgciKEwku19FdwvwVJ7uHwFtVSv9DPYudF5Iqog+2JgbhEc72zljAMCYOAMAwLM4BzhdnAuRIo2YLq+KoAQNpr6743Lr1nsPvXY1wBp/rY4atX/xVge2fnC6qaTxtzzmHDMDEfBEECwVpbBBH/RnU1BcWpjqgKIIf9Sy32Fb10BvceB4W0V5Gf9qWecy77dB2q18TnJ69atdM5typ+4s5arLWE6acfmQ/DEJuFEEVLtrio/YoAHuO8fwBra2AwXHGzAAz+ofRcUVZUSWirLv7M2rUvl5x3rt1GAGxk3EbGgyAgyOd7gEhHg43GiSQaChC6qwIoSP5QAwCAYQAObeprhZLQVg1QvS57TeDcMhuGyVNPh3+YAhFv2zgSohJHg02/FqpvQy8AFK0JgEBD1Gi11WTP+xSfSuvnN2x4GyC9cpPt25+31gaxobThIGM+HQnx62DLRIOqru8VwJPMWw28VYOXDgCFqp+h0rJF8x3S1fWj+LjzvOufP/TQjwFMXLv2fRuGq20qvMMgIEhFQQIiNRYk18YQYhDObVm2adNbvQIAEOTeMocdZZZ4CpsBDKZSKt0juXJhiHOO0Lk7j92y5V8AT48du4+1dr6nekxSMQyX9Rj00sbT40B2UIwjwVpcYf+J6wseKn4PSMm/H4IbicI7srpYMJcr9hhBjlT4sMLWkGAhwOOcu24aLVcJHAvyH4FXQZ7zCDZZzJvp+6pzXdbaTU0id6RA3mCtbUJkKnA/QGhtu+fcpfES2PMKz05ELlGRv2NtkXBktrBpiyUIChDy+WSQ7dOyfxotDwkkH0UVd+STnLeyL3Wzmk7Lo8DJbcz10olTrKVjxkwwudxrxhjf+P7GYzZtOhDguQkTPpQz5j3P8/xkcaO67NOvvHJMPf2I1YcIAA+vVXERAFkZmz+F+/YI6BQAR7hzKRd2F2upnMQ9e8R7HTR1tnNWl0KrwMmV7mWdu5kw9AEUDvjzAQfsd8LGjZuPfvPNHc+PH/+yZ8zkKOdXVb28dsul6hOApXzzmRm0rlc4CNzPAWbQenEX+dvir2eKuQD4RVzneO4eZcltjfebyG8+gQVfaGZk2/ts2xwfvw8aG6CJESNosvYT1tpTIvMYVcTaKcBvoPAaiHOTPc8Dkd8fvX79CoAXxo5t0qame1FtcFHO76wtrBOijyRqLYG1K7+4devtNQMohGrrbaA/A9l7Oi3tik4tuQJGp/eH0TDapcZJhf0Msm4H25YrvBcfz8F3EbnZdHRgfT/JCpMvOYVxoACgu/tZ8f2LRcR6kGSLed+/gCCYTTHNTabWpFi7U4Lg6qyzPgKAf6O/2hOuAH5cAVIJgBDGlJliDHB0duBR1WTQKjHvHMaYBLTr7HxWGxutiCw84d131wE8M27cHmEQXBbXTWeVyScy51Sdmztrx44eU3qv02CsVcwLgFsrnRe0BIDBja50bTmpasn8nUp6DloyevQ+ACds2/Zfm8+/GHR1JZ/V852dl4ZBMCqbDKUXSEEQfH/W9u1lV6d9BgCwBRYCm8oayABQvJoAxIozt/Rc3t3VNSU+H+bz58x87713ANrGjNk7n89fmM0Kg1SeEAbBpV/u6Ki4MKsJwCrmBYpWiALJANC6AEBhfZBOemwYJq/Bl3bseCPe7urqujYMguHZtUAqCq46tbPztmr3qgkAQDOjFgLlvhmOyjQ8qsw1NSkBkc9PzZ57uLFx/3wQnJ1eC6S38/n8VWfk8zf1do+aATzC6XlBv1fmVCYCGFNr25Wkqocsho+mjwX5/E1hEDQkTzuVCgdheNVs53o1D3UAAFjK/CXA45nDzUfQkqwCs9NifxXC0fH2r+Fwde70kvV9/KkLrpwDfTIPdQIAEPgO0J0+NBo3Mt7RzJjQXwlMTW3fSvm+X3km3FxLu3UDWMq8t0HvTB/L4adM1z8IVtBUgEUwhdSftlKq2Tz0AwCAY7cbJVoCQyH5SZ0eWaZKf3TYg4VV5y1lztVlHvoJ4Cm+1qHo2STfBmx65B+wQTCSWLgDOKrkIFxSr3noJwCANuY/LXB3obFC8nMiDwwHGvvbdlYCszOHrpwNt5e9uI/qNwAAHy4D3oqTH0fnQL//5VR32Kc1IACWMG+n4H09/t+iXI3rgDo0IOZhgAAALOXcFRotWxXpdxZYRQNmHgYQAMBTzHsDQAZ+AIw1oOZhgAHEqncl2IsG3DwMEgBwayjNEvurQTEPgwSgjfnLQb5BtX8P67sGzTwMWgRAG3Mf0hoWJRU0qOZhEAEAPMncawQerLP6oJuHQQYAop00nAMs7/XSUg2JeRh0ANDOWV1CbpbAa32sMmTmYQgAACzl7C2QOw54tZdLrxhK8zBEAKAAQcgdT2UIV5xZfqk7qBoyAFAVwgdi/gPTidyzV7z9AOxV7dpd2qVd2qXB1P8A6w2UPhwecNMAAAAASUVORK5CYII=",
  • "ProxyAppUrl": true,
  • "AppFileNameFormat": "defender_[0-9]{2}\\.[0-9]{2}\\.[0-9]{2}",
  • "AppRegistry": "Docker Hub",
  • "Type": "BUILT_IN",
  • "AppVersion": "1.0.0",
  • "LatestVersion": "2.0.0",
  • "AppState": "NOT_INSTALLED",
  • "StartedAt": "2019-10-08T16:03:33Z",
  • "Warnings":
    [
    ]
}

Retrieve resource usage statistics

Returns an application’s resource usage statistics.

Authorizations:
Authorization (FullAdmin)
path Parameters
name
required
string

Name of application template to be accessed

Responses

200

Resource usage statistics

401

Unauthorized

404

Application with the specified template name cannot be found

415

Unsupported media type

500

Server error

get /apps/{name}/stats

ExtremeCloud Appliance REST API Server

https://www.example.com:5825/orchestration/v1/apps/{name}/stats

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "MemoryUsage": 0,
  • "CpuUsage": 0
}

containers

Create and manage containers.

listContainers

Returns list of all containers. You can filter by container image or volume

Authorizations:
Authorization (FullAdmin)
query Parameters
imageNameOrId
string

Name or ID of container image

containerName
string

Name of container

volumeName
string

Name of container volume

Responses

200

Container list

400

Bad parameter

401

Unauthorized

415

Unsupported media type

500

Server error

get /containers

ExtremeCloud Appliance REST API Server

https://www.example.com:5825/orchestration/v1/containers

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {