ExtremeCloud IQ Controller :: Application Manager API (1.61.1)

Download OpenAPI specification:Download

Extreme Networks Support: support@extremenetworks.com URL: https://www.extremenetworks.com License: Apache 2.0

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 IQ Controller 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

Flow type: password

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

path Parameters

name

required

string

Name of application template that needs to be started.

Responses

Response samples

200

Content type

application/json

{"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-08-24T14:15:22Z",
"Warnings": ["The following volume(s) are still in use by other applications and were not removed: defender"
]
}

Stop an application

Stops an application with the specified template name.

Authorizations:

Authorization

path Parameters

name

required

string

Name of application template that needs to be stopped.

Responses

Response samples

200

Content type

application/json

{"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-08-24T14:15:22Z",
"Warnings": ["The following volume(s) are still in use by other applications and were not removed: defender"
]
}

getLog

Return an application’s log

Authorizations:

Authorization

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

Uninstall an application

Uninstalls an application with the specified template name.

Authorizations:

Authorization

path Parameters

name

required

string

Name of application template that needs to be uninstalled.

Responses

Response samples

200

Content type

application/json

{"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-08-24T14:15:22Z",
"Warnings": ["The following volume(s) are still in use by other applications and were not removed: defender"
]
}

Upgrade an application

Upgrades an application from registry.

Authorizations:

Authorization

path Parameters

name

required

string

Name of application template that needs to be upgraded.

query Parameters

version

required

string

Version of the application.

Responses

Response samples

200

Content type

application/json

{"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-08-24T14:15:22Z",
"Warnings": ["The following volume(s) are still in use by other applications and were not removed: defender"
]
}

Install an application from registry

Installs an application from the registry.

Authorizations:

Authorization

query Parameters

name required	string Name of application template that needs to be installed.
version required	string Version of the application that needs to be installed.

Responses

Response samples

200

Content type

application/json

{"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-08-24T14:15:22Z",
"Warnings": ["The following volume(s) are still in use by other applications and were not removed: defender"
]
}

Install an application from file

Installs an application from file.

Authorizations:

Authorization

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

Response samples

200

Content type

application/json

{"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-08-24T14:15:22Z",
"Warnings": ["The following volume(s) are still in use by other applications and were not removed: defender"
]
}

Upgrade an application from file

Upgrades an application from file.

Authorizations:

Authorization

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

Response samples

200

Content type

application/json

{"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-08-24T14:15:22Z",
"Warnings": ["The following volume(s) are still in use by other applications and were not removed: defender"
]
}

Retrieve resource usage statistics

Returns an application’s resource usage statistics.

Authorizations:

Authorization

path Parameters

name

required

string

Name of the application template to be accessed

Responses

Response samples

200

Content type

application/json

{"MemoryUsage": 0,
"CpuUsage": 0
}

containers

Create and manage containers.

listContainers

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

Authorizations:

Authorization

query Parameters

imageNameOrId	string Name or ID of container image
containerName	string Name of container
volumeName	string Name of container volume

Responses

Response samples

200

Content type

application/json

[{"Names": ["string"
],
"Status": "string",
"State": "string",
"Command": "string",
"Id": "string",
"Created": 0,
"Image": "string",
"Labels": {"empty": true,
"property1": "string",
"property2": "string"
},
"SizeRootFs": 0,
"Mounts": [{"Type": "string",
"Name": "string",
"Source": "string",
"Destination": "string",
"Driver": "string",
"Mode": "string",
"RW": true,
"Propagation": "string"
}
],
"SizeRw": 0,
"NetworkSettings": {"IPAddress": "string",
"IPPrefixLen": 0,
"Gateway": "string",
"Bridge": "string",
"PortMapping": {"empty": true,
"property1": {"property1": "string",
"property2": "string"
},
"property2": {"property1": "string",
"property2": "string"
}
},
"Ports": {"empty": true,
"property1": [{"HostIp": "string",
"HostPort": "string"
}
],
"property2": [{"HostIp": "string",
"HostPort": "string"
}
]
},
"MacAddress": "string",
"Networks": {"empty": true,
"property1": {"Aliases": ["string"
],
"NetworkID": "string",
"EndpointID": "string",
"Gateway": "string",
"IPAddress": "string",
"IPPrefixLen": 0,
"IPv6Gateway": "string",
"GlobalIPv6Address": "string",
"GlobalIPv6PrefixLen": 0,
"MacAddress": "string"
},
"property2": {"Aliases": ["string"
],
"NetworkID": "string",
"EndpointID": "string",
"Gateway": "string",
"IPAddress": "string",
"IPPrefixLen": 0,
"IPv6Gateway": "string",
"GlobalIPv6Address": "string",
"GlobalIPv6PrefixLen": 0,
"MacAddress": "string"
}
},
"EndpointID": "string",
"SandboxID": "string",
"SandboxKey": "string",
"HairpinMode": true,
"LinkLocalIPv6Address": "string",
"LinkLocalIPv6PrefixLen": 0,
"GlobalIPv6Address": "string",
"GlobalIPv6PrefixLen": 0,
"IPv6Gateway": "string"
},
"Ports": [{"PrivatePort": 0,
"PublicPort": 0,
"Type": "string",
"IP": "string"
}
],
"ImageID": "string"
}
]

inspectContainer

Returns low-level information about a container based on name or ID.

Authorizations:

Authorization

path Parameters

idOrName

required

string

ID or name of the container to use

Responses

Response samples

200

Content type

application/json

{"Name": "string",
"Path": "string",
"State": {"Status": "string",
"Running": true,
"Paused": true,
"Restarting": true,
"Pid": 0,
"ExitCode": 0,
"StartedAt": "2019-08-24T14:15:22Z",
"FinishedAt": "2019-08-24T14:15:22Z",
"Error": "string",
"OOMKilled": true,
"Health": {"Status": "string",
"FailingStreak": 0,
"Log": [{"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"ExitCode": 0,
"Output": "string"
}
]
}
},
"Args": ["string"
],
"Id": "string",
"Node": {"ID": "string",
"IP": "string",
"Addr": "string",
"Name": "string"
},
"Created": "2019-08-24T14:15:22Z",
"Image": "string",
"Config": {"Hostname": "string",
"Domainname": "string",
"User": "string",
"AttachStdin": true,
"AttachStdout": true,
"AttachStderr": true,
"PortSpecs": ["string"
],
"ExposedPorts": ["string"
],
"Tty": true,
"OpenStdin": true,
"StdinOnce": true,
"Env": ["string"
],
"Cmd": ["string"
],
"Image": "string",
"Volumes": ["string"
],
"WorkingDir": "string",
"Entrypoint": ["string"
],
"NetworkDisabled": true,
"OnBuild": ["string"
],
"Labels": {"empty": true,
"property1": "string",
"property2": "string"
},
"MacAddress": "string",
"HostConfig": {"Binds": ["string"
],
"BlkioWeight": 0,
"BlkioWeightDevice": [{"Path": "string",
"Weight": 0
}
],
"BlkioDeviceReadBps": [{"Path": "string",
"Rate": 0
}
],
"BlkioDeviceWriteBps": [{"Path": "string",
"Rate": 0
}
],
"BlkioDeviceReadIOps": [{"Path": "string",
"Rate": 0
}
],
"BlkioDeviceWriteIOps": [{"Path": "string",
"Rate": 0
}
],
"ContainerIDFile": "string",
"LxcConf": [{"Key": "string",
"Value": "string"
}
],
"Privileged": true,
"PortBindings": {"empty": true,
"property1": [{"HostIp": "string",
"HostPort": "string"
}
],
"property2": [{"HostIp": "string",
"HostPort": "string"
}
]
},
"Links": ["string"
],
"PublishAllPorts": true,
"Dns": ["string"
],
"DnsOptions": ["string"
],
"DnsSearch": ["string"
],
"ExtraHosts": ["string"
],
"VolumesFrom": ["string"
],
"CapAdd": ["string"
],
"CapDrop": ["string"
],
"NetworkMode": "string",
"SecurityOpt": ["string"
],
"Devices": [{"PathOnHost": "string",
"PathInContainer": "string",
"CgroupPermissions": "string"
}
],
"Memory": 0,
"MemorySwap": 0,
"MemorySwappiness": 0,
"MemoryReservation": 0,
"NanoCpus": 0,
"CpuPeriod": 0,
"CpuShares": 0,
"CpusetCpus": "string",
"CpusetMems": "string",
"CpuQuota": 0,
"CgroupParent": "string",
"RestartPolicy": {"available": "always",
"implicit": "unless-stopped"
},
"LogConfig": {"Type": "string",
"Config": {"empty": true,
"property1": "string",
"property2": "string"
}
},
"IpcMode": "string",
"Ulimits": [{"Name": "string",
"Soft": 0,
"Hard": 0
}
],
"PidMode": "string",
"ShmSize": 0,
"OomKillDisable": true,
"OomScoreAdj": 0,
"AutoRemove": true,
"PidsLimit": 0,
"Tmpfs": {"empty": true,
"property1": "string",
"property2": "string"
},
"ReadonlyRootfs": true,
"Runtime": "string",
"StorageOpt": {"empty": true,
"property1": "string",
"property2": "string"
}
},
"StopSignal": "string",
"Healthcheck": {"Test": ["string"
],
"Interval": 0,
"Timeout": 0,
"Retries": 0,
"StartPeriod": 0
},
"NetworkingConfig": {"EndpointsConfig": {"empty": true,
"property1": {"Aliases": ["string"
],
"Links": ["string"
],
"IPPrefixLen": 0,
"MacAddress": "string",
"IPAddress": "string",
"IPv6Gateway": "string",
"Gateway": "string",
"IPAMConfig": {"IPv4Address": "string",
"IPv6Address": "string",
"LinkLocalIPs": ["string"
]
},
"GlobalIPv6Address": "string",
"GlobalIPv6PrefixLen": 0
},
"property2": {"Aliases": ["string"
],
"Links": ["string"
],
"IPPrefixLen": 0,
"MacAddress": "string",
"IPAddress": "string",
"IPv6Gateway": "string",
"Gateway": "string",
"IPAMConfig": {"IPv4Address": "string",
"IPv6Address": "string",
"LinkLocalIPs": ["string"
]
},
"GlobalIPv6Address": "string",
"GlobalIPv6PrefixLen": 0
}
}
}
},
"Mounts": [{"Type": "string",
"Name": "string",
"Source": "string",
"Destination": "string",
"Driver": "string",
"Mode": "string",
"RW": true,
"Propagation": "string"
}
],
"NetworkSettings": {"IPAddress": "string",
"IPPrefixLen": 0,
"Gateway": "string",
"Bridge": "string",
"PortMapping": {"empty": true,
"property1": {"property1": "string",
"property2": "string"
},
"property2": {"property1": "string",
"property2": "string"
}
},
"Ports": {"empty": true,
"property1": [{"HostIp": "string",
"HostPort": "string"
}
],
"property2": [{"HostIp": "string",
"HostPort": "string"
}
]
},
"MacAddress": "string",
"Networks": {"empty": true,
"property1": {"Aliases": ["string"
],
"NetworkID": "string",
"EndpointID": "string",
"Gateway": "string",
"IPAddress": "string",
"IPPrefixLen": 0,
"IPv6Gateway": "string",
"GlobalIPv6Address": "string",
"GlobalIPv6PrefixLen": 0,
"MacAddress": "string"
},
"property2": {"Aliases": ["string"
],
"NetworkID": "string",
"EndpointID": "string",
"Gateway": "string",
"IPAddress": "string",
"IPPrefixLen": 0,
"IPv6Gateway": "string",
"GlobalIPv6Address": "string",
"GlobalIPv6PrefixLen": 0,
"MacAddress": "string"
}
},
"EndpointID": "string",
"SandboxID": "string",
"SandboxKey": "string",
"HairpinMode": true,
"LinkLocalIPv6Address": "string",
"LinkLocalIPv6PrefixLen": 0,
"GlobalIPv6Address": "string",
"GlobalIPv6PrefixLen": 0,
"IPv6Gateway": "string"
},
"Driver": "string",
"ProcessLabel": "string",
"ResolvConfPath": "string",
"HostsPath": "string",
"AppArmorProfile": "string",
"ExecIDs": ["string"
],
"HostnamePath": "string",
"MountLabel": "string",
"RestartCount": 0,
"LogPath": "string",
"VolumesRW": {"empty": true,
"property1": true,
"property2": true
},
"ExecDriver": "string",
"Volumes": {"empty": true,
"property1": "string",
"property2": "string"
},
"HostConfig": {"Binds": ["string"
],
"BlkioWeight": 0,
"BlkioWeightDevice": [{"Path": "string",
"Weight": 0
}
],
"BlkioDeviceReadBps": [{"Path": "string",
"Rate": 0
}
],
"BlkioDeviceWriteBps": [{"Path": "string",
"Rate": 0
}
],
"BlkioDeviceReadIOps": [{"Path": "string",
"Rate": 0
}
],
"BlkioDeviceWriteIOps": [{"Path": "string",
"Rate": 0
}
],
"ContainerIDFile": "string",
"LxcConf": [{"Key": "string",
"Value": "string"
}
],
"Privileged": true,
"PortBindings": {"empty": true,
"property1": [{"HostIp": "string",
"HostPort": "string"
}
],
"property2": [{"HostIp": "string",
"HostPort": "string"
}
]
},
"Links": ["string"
],
"PublishAllPorts": true,
"Dns": ["string"
],
"DnsOptions": ["string"
],
"DnsSearch": ["string"
],
"ExtraHosts": ["string"
],
"VolumesFrom": ["string"
],
"CapAdd": ["string"
],
"CapDrop": ["string"
],
"NetworkMode": "string",
"SecurityOpt": ["string"
],
"Devices": [{"PathOnHost": "string",
"PathInContainer": "string",
"CgroupPermissions": "string"
}
],
"Memory": 0,
"MemorySwap": 0,
"MemorySwappiness": 0,
"MemoryReservation": 0,
"NanoCpus": 0,
"CpuPeriod": 0,
"CpuShares": 0,
"CpusetCpus": "string",
"CpusetMems": "string",
"CpuQuota": 0,
"CgroupParent": "string",
"RestartPolicy": {"available": "always",
"implicit": "unless-stopped"
},
"LogConfig": {"Type": "string",
"Config": {"empty": true,
"property1": "string",
"property2": "string"
}
},
"IpcMode": "string",
"Ulimits": [{"Name": "string",
"Soft": 0,
"Hard": 0
}
],
"PidMode": "string",
"ShmSize": 0,
"OomKillDisable": true,
"OomScoreAdj": 0,
"AutoRemove": true,
"PidsLimit": 0,
"Tmpfs": {"empty": true,
"property1": "string",
"property2": "string"
},
"ReadonlyRootfs": true,
"Runtime": "string",
"StorageOpt": {"empty": true,
"property1": "string",
"property2": "string"
}
}
}

restartContainer

Restarts a container based on ID or name.

Authorizations:

Authorization

path Parameters

idOrName

required

string

ID or name of the container to be restarted

Responses

removeContainer

Removes a container based on name or ID.

Authorizations:

Authorization

path Parameters

nameOrId

required

string

ID or name of the container to be removed

query Parameters

force	boolean Default: false Kill the container that is currently running.
removeVolumes	boolean Default: false Remove volumes associated with the container.

Responses

renameContainer

Rename a container based on name or ID.

Authorizations:

Authorization

path Parameters

nameOrId

Creates a container

Authorizations:

Authorization

query Parameters

name	string Assigns the specified name to the container. Must match /?[a-zA-Z0-9_-]+

Request Body schema: application/json

Definition of the container to be created

	object An object mapping ports to an empty object in the form: {"/<tcp\|udp>": {}}
Image	string The name of the image to use when creating the container
	object (HostConfigDefinition) Container configuration that depends on the host we are running on
Cmd	Array of strings Command to run specified as a string or an array of strings
Env	Array of strings A list of environment variables to set inside the container in the form

Responses

Request samples

Payload

Content type

application/json

{"ExposedPorts": {"property1": { },
"property2": { }
},
"Image": "string",
"HostConfig": {"Binds": ["defender-vol:/backup"
],
"PortBindings": {"8080/tcp": [{"HostIp": "127.0.0.1",
"HostPort": "8080"
}
],
"32541/tcp": [{"HostIp": "127.0.0.1",
"HostPort": "32541"
}
]
},
"RestartPolicy": {"Name": "always",
"MaximumRetryCount": 0
},
"Dns": ["8.8.8.8"
],
"DnsOptions": ["string"
],
"DnsSearch": ["string"
],
"ExtraHosts": ["xca.localhost:10.0.0.1"
],
"StorageOpt": {"size": "120G"
},
"Devices": [{"PathOnHost": "string",
"PathInContainer": "string",
"CgroupPermissions": "string"
}
],
"LogConfig": {"LogType": "json-file",
"Config": {"property1": "string",
"property2": "string"
}
},
"CpuLimit": 0,
"MemoryLimit": 0
},
"Cmd": ["/bin/sh",
"-c",
"echo Hello world",
"..."
],
"Env": ["VAR=value",
"..."
]
}

Response samples

201

Content type

application/json

{"Id": "string",
"Warnings": ["string"
]
}

killContainer

Kills a container based on ID or name.

Authorizations:

Authorization

path Parameters

idOrName

required

string

ID or name of the container to be killed

Responses

getContainerStats

Returns a container’s resource usage statistics based on ID or name.

Authorizations:

Authorization

path Parameters

idOrName

required

string

ID or name of the container to be accessed

Responses

Response samples

200

Content type

application/json

{"Name": "string",
"Path": "string",
"State": {"Status": "string",
"Running": true,
"Paused": true,
"Restarting": true,
"Pid": 0,
"ExitCode": 0,
"StartedAt": "2019-08-24T14:15:22Z",
"FinishedAt": "2019-08-24T14:15:22Z",
"Error": "string",
"OOMKilled": true,
"Health": {"Status": "string",
"FailingStreak": 0,
"Log": [{"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"ExitCode": 0,
"Output": "string"
}
]
}
},
"Args": ["string"
],
"Id": "string",
"Node": {"ID": "string",
"IP": "string",
"Addr": "string",
"Name": "string"
},
"Created": "2019-08-24T14:15:22Z",
"Image": "string",
"Config": {"Hostname": "string",
"Domainname": "string",
"User": "string",
"AttachStdin": true,
"AttachStdout": true,
"AttachStderr": true,
"PortSpecs": ["string"
],
"ExposedPorts": ["string"
],
"Tty": true,
"OpenStdin": true,
"StdinOnce": true,
"Env": ["string"
],
"Cmd": ["string"
],
"Image": "string",
"Volumes": ["string"
],
"WorkingDir": "string",
"Entrypoint": ["string"
],
"NetworkDisabled": true,
"OnBuild": ["string"
],
"Labels": {"empty": true,
"property1": "string",
"property2": "string"
},
"MacAddress": "string",
"HostConfig": {"Binds": ["string"
],
"BlkioWeight": 0,
"BlkioWeightDevice": [{"Path": "string",
"Weight": 0
}
],
"BlkioDeviceReadBps": [{"Path": "string",
"Rate": 0
}
],
"BlkioDeviceWriteBps": [{"Path": "string",
"Rate": 0
}
],
"BlkioDeviceReadIOps": [{"Path": "string",
"Rate": 0
}
],
"BlkioDeviceWriteIOps": [{"Path": "string",
"Rate": 0
}
],
"ContainerIDFile": "string",
"LxcConf": [{"Key": "string",
"Value": "string"
}
],
"Privileged": true,
"PortBindings": {"empty": true,
"property1": [{"HostIp": "string",
"HostPort": "string"
}
],
"property2": [{"HostIp": "string",
"HostPort": "string"
}
]
},
"Links": ["string"
],
"PublishAllPorts": true,
"Dns": ["string"
],
"DnsOptions": ["string"
],
"DnsSearch": ["string"
],
"ExtraHosts": ["string"
],
"VolumesFrom": ["string"
],
"CapAdd": ["string"
],
"CapDrop": ["string"
],
"NetworkMode": "string",
"SecurityOpt": ["string"
],
"Devices": [{"PathOnHost": "string",
"PathInContainer": "string",
"CgroupPermissions": "string"
}
],
"Memory": 0,
"MemorySwap": 0,
"MemorySwappiness": 0,
"MemoryReservation": 0,
"NanoCpus": 0,
"CpuPeriod": 0,
"CpuShares": 0,
"CpusetCpus": "string",
"CpusetMems": "string",
"CpuQuota": 0,
"CgroupParent": "string",
"RestartPolicy": {"available": "always",
"implicit": "unless-stopped"
},
"LogConfig": {"Type": "string",
"Config": {"empty": true,
"property1": "string",
"property2": "string"
}
},
"IpcMode": "string",
"Ulimits": [{"Name": "string",
"Soft": 0,
"Hard": 0
}
],
"PidMode": "string",
"ShmSize": 0,
"OomKillDisable": true,
"OomScoreAdj": 0,
"AutoRemove": true,
"PidsLimit": 0,
"Tmpfs": {"empty": true,
"property1": "string",
"property2": "string"
},
"ReadonlyRootfs": true,
"Runtime": "string",
"StorageOpt": {"empty": true,
"property1": "string",
"property2": "string"
}
},
"StopSignal": "string",
"Healthcheck": {"Test": ["string"
],
"Interval": 0,
"Timeout": 0,
"Retries": 0,
"StartPeriod": 0
},
"NetworkingConfig": {"EndpointsConfig": {"empty": true,
"property1": {"Aliases": ["string"
],
"Links": ["string"
],
"IPPrefixLen": 0,
"MacAddress": "string",
"IPAddress": "string",
"IPv6Gateway": "string",
"Gateway": "string",
"IPAMConfig": {"IPv4Address": "string",
"IPv6Address": "string",
"LinkLocalIPs": ["string"
]
},
"GlobalIPv6Address": "string",
"GlobalIPv6PrefixLen": 0
},
"property2": {"Aliases": ["string"
],
"Links": ["string"
],
"IPPrefixLen": 0,
"MacAddress": "string",
"IPAddress": "string",
"IPv6Gateway": "string",
"Gateway": "string",
"IPAMConfig": {"IPv4Address": "string",
"IPv6Address": "string",
"LinkLocalIPs": ["string"
]
},
"GlobalIPv6Address": "string",
"GlobalIPv6PrefixLen": 0
}
}
}
},
"Mounts": [{"Type": "string",
"Name": "string",
"Source": "string",
"Destination": "string",
"Driver": "string",
"Mode": "string",
"RW": true,
"Propagation": "string"
}
],
"NetworkSettings": {"IPAddress": "string",
"IPPrefixLen": 0,
"Gateway": "string",
"Bridge": "string",
"PortMapping": {"empty": true,
"property1": {"property1": "string",
"property2": "string"
},
"property2": {"property1": "string",
"property2": "string"
}
},
"Ports": {"empty": true,
"property1": [{"HostIp": "string",
"HostPort": "string"
}
],
"property2": [{"HostIp": "string",
"HostPort": "string"
}
]
},
"MacAddress": "string",
"Networks": {"empty": true,
"property1": {"Aliases": ["string"
],
"NetworkID": "string",
"EndpointID": "string",
"Gateway": "string",
"IPAddress": "string",
"IPPrefixLen": 0,
"IPv6Gateway": "string",
"GlobalIPv6Address": "string",
"GlobalIPv6PrefixLen": 0,
"MacAddress": "string"
},
"property2": {"Aliases": ["string"
],
"NetworkID": "string",
"EndpointID": "string",
"Gateway": "string",
"IPAddress": "string",
"IPPrefixLen": 0,
"IPv6Gateway": "string",
"GlobalIPv6Address": "string",
"GlobalIPv6PrefixLen": 0,
"MacAddress": "string"
}
},
"EndpointID": "string",
"SandboxID": "string",
"SandboxKey": "string",
"HairpinMode": true,
"LinkLocalIPv6Address": "string",
"LinkLocalIPv6PrefixLen": 0,
"GlobalIPv6Address": "string",
"GlobalIPv6PrefixLen": 0,
"IPv6Gateway": "string"
},
"Driver": "string",
"ProcessLabel": "string",
"ResolvConfPath": "string",
"HostsPath": "string",
"AppArmorProfile": "string",
"ExecIDs": ["string"
],
"HostnamePath": "string",
"MountLabel": "string",
"RestartCount": 0,
"LogPath": "string",
"VolumesRW": {"empty": true,
"property1": true,
"property2": true
},
"ExecDriver": "string",
"Volumes": {"empty": true,
"property1": "string",
"property2": "string"
},
"HostConfig": {"Binds": ["string"
],
"BlkioWeight": 0,
"BlkioWeightDevice": [{"Path": "string",
"Weight": 0
}
],
"BlkioDeviceReadBps": [{"Path": "string",
"Rate": 0
}
],
"BlkioDeviceWriteBps": [{"Path": "string",
"Rate": 0
}
],
"BlkioDeviceReadIOps": [{"Path": "string",
"Rate": 0
}
],
"BlkioDeviceWriteIOps": [{"Path": "string",
"Rate": 0
}
],
"ContainerIDFile": "string",
"LxcConf": [{"Key": "string",
"Value": "string"
}
],
"Privileged": true,
"PortBindings": {"empty": true,
"property1": [{"HostIp": "string",
"HostPort": "string"
}
],
"property2": [{"HostIp": "string",
"HostPort": "string"
}
]
},
"Links": ["string"
],
"PublishAllPorts": true,
"Dns": ["string"
],
"DnsOptions": ["string"
],
"DnsSearch": ["string"
],
"ExtraHosts": ["string"
],
"VolumesFrom": ["string"
],
"CapAdd": ["string"
],
"CapDrop": ["string"
],
"NetworkMode": "string",
"SecurityOpt": ["string"
],
"Devices": [{"PathOnHost": "string",
"PathInContainer": "string",
"CgroupPermissions": "string"
}
],
"Memory": 0,
"MemorySwap": 0,
"MemorySwappiness": 0,
"MemoryReservation": 0,
"NanoCpus": 0,
"CpuPeriod": 0,
"CpuShares": 0,
"CpusetCpus": "string",
"CpusetMems": "string",
"CpuQuota": 0,
"CgroupParent": "string",
"RestartPolicy": {"available": "always",
"implicit": "unless-stopped"
},
"LogConfig": {"Type": "string",
"Config": {"empty": true,
"property1": "string",
"property2": "string"
}
},
"IpcMode": "string",
"Ulimits": [{"Name": "string",
"Soft": 0,
"Hard": 0
}
],
"PidMode": "string",
"ShmSize": 0,
"OomKillDisable": true,
"OomScoreAdj": 0,
"AutoRemove": true,
"PidsLimit": 0,
"Tmpfs": {"empty": true,
"property1": "string",
"property2": "string"
},
"ReadonlyRootfs": true,
"Runtime": "string",
"StorageOpt": {"empty": true,
"property1": "string",
"property2": "string"
}
}
}

getContainerLogs

Returns stdout and stderr logs from a container based on ID or name. Note: This endpoint works only for containers with the json-file or journald logging driver.

Authorizations:

Authorization

path Parameters

idOrName

required

string

ID or name of the container to be accessed

query Parameters

stdout	boolean Default: false Return logs from stdout
stderr	boolean Default: false Return logs from stderr
since	integer <int32> Default: 0 Only return logs since this time (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

images

Create and manage application images.

listImages

Returns list of images on the server. This endpoint returns a different, smaller representation of an image compared to when inspecting a single image.

Authorizations:

Authorization

Responses

Response samples

200

Content type

application/json

[{"Size": 0,
"Id": "string",
"Created": "string",
"Labels": {"empty": true,
"property1": "string",
"property2": "string"
},
"VirtualSize": 0,
"RepoDigests": ["string"
],
"ParentId": "string",
"RepoTags": ["string"
]
}
]

force

required

boolean

Default: false

Remove image even if it is being used by a stopped container or has other tags.

Responses

Response samples

200

Content type

application/json

[{ }
]

tagImage

Tags an image based on ID or name, to make it part of a repository.

Authorizations:

Authorization

path Parameters

idOrName

required

string

Name or ID of image to tag

query Parameters

repo required	string The repository to tag in. For example, someuser/someimage
tag required	string Name of the new tag

Responses

importImage

Load a set of images and tags into a repository.

Authorizations:

Authorization

header Parameters

Content-Length

integer <int64>

Request Body schema: multipart/form-data

file	string <binary> A tar archive containing images to be loaded into a repository

Responses

exportImage

Returns a tarball containing all images and metadata for a repository.

Authorizations:

Authorization

path Parameters

idOrName

required

string

Name or ID of repository to be accessed

Responses

Response samples

200

Content type

application/octet-stream

No sample

system

Access system information and features.

getSystemInformation

Returns system information

Authorizations:

Authorization

Responses

Response samples

200

Content type

application/json

{"Name": "string",
"Debug": true,
"ID": "string",
"ClusterStore": "string",
"NCPU": 0,
"CgroupDriver": "string",
"ContainersPaused": 0,
"MemoryLimit": true,
"MemTotal": 0,
"Architecture": "string",
"InitPath": "string",
"HttpProxy": "string",
"InitSha1": "string",
"Driver": "string",
"KernelVersion": "string",
"CpuCfsQuota": true,
"HttpsProxy": "string",
"CpuCfsPeriod": true,
"KernelMemory": true,
"DriverStatus": [["string"
]
],
"ExecutionDriver": "string",
"DockerRootDir": "string",
"IPv4Forwarding": true,
"Labels": ["string"
],
"NoProxy": "string",
"SwapLimit": true,
"Swarm": {"Cluster": {"ID": "string",
"Version": {"Index": 0
},
"CreatedAt": "2019-08-24T14:15:22Z",
"UpdatedAt": "2019-08-24T14:15:22Z",
"Spec": {"Name": "string",
"Labels": {"empty": true,
"property1": "string",
"property2": "string"
},
"Orchestration": {"TaskHistoryRetentionLimit": 0
},
"Raft": {"SnapshotInterval": 0,
"KeepOldSnapshots": 0,
"LogEntriesForSlowFollowers": 0,
"ElectionTick": 0,
"HeartbeatTick": 0
},
"Dispatcher": {"HeartbeatPeriod": 0
},
"CAConfig": {"NodeCertExpiry": 0,
"ExternalCAs": [{"Protocol": "string",
"URL": "string",
"Options": {"empty": true,
"property1": "string",
"property2": "string"
}
}
]
},
"EncryptionConfig": {"AutoLockManagers": true
},
"TaskDefaults": {"LogDriver": {"Name": "string",
"Options": {"empty": true,
"property1": "string",
"property2": "string"
}
}
}
}
},
"ControlAvailable": true,
"Error": "string",
"LocalNodeState": "string",
"NodeAddr": "string",
"NodeID": "string",
"Nodes": 0,
"Managers": 0,
"RemoteManagers": [{"Addr": "string",
"NodeID": "string"
}
]
},
"OperatingSystem": "string",
"OSType": "string",
"NEventsListener": 0,
"NFd": 0,
"ServerVersion": "string",
"NGoroutines": 0,
"SystemStatus": [["string"
]
],
"Plugins": {"Volume": ["string"
],
"Network": ["string"
]
},
"OomKillDisable": true,
"RegistryConfig": {"IndexConfigs": {"empty": true,
"property1": {"Name": "string",
"Mirrors": ["string"
],
"Secure": true,
"Official": true
},
"property2": {"Name": "string",
"Mirrors": ["string"
],
"Secure": true,
"Official": true
}
},
"InsecureRegistryCIDRs": ["string"
]
},
"Containers": 0,
"Images": 0,
"SystemTime": "2019-08-24T14:15:22Z",
"ContainersStopped": 0,
"IndexServerAddress": "string",
"ContainersRunning": 0,
"ExperimentalBuild": true
}

getApplicationTemplates

Returns available application templates.

Authorizations:

Authorization

Responses

Response samples

200

Content type

application/json

[{"AppInfo": {"AppName": "defender",
"AppTitle": "Extreme Defender for IoT",
"AppDescription": "Next gen 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"
},
"AppConfiguration": {"AppVolumes": ["defender-vol1",
"defender-vol2"
],
"ExposedPorts": {"12334/udp": { }
},
"Image": "string",
"Cmd": ["/bin/sh",
"-c",
"echo Hello world",
"..."
],
"Env": ["VAR=value",
"..."
],
"HostConfig": {"Binds": ["defender-vol:/backup"
],
"PortBindings": {"8080/tcp": [{"HostIp": "127.0.0.1",
"HostPort": "8080"
}
],
"32541/tcp": [{"HostIp": "127.0.0.1",
"HostPort": "32541"
}
]
},
"RestartPolicy": {"Name": "always",
"MaximumRetryCount": 0
},
"Dns": ["8.8.8.8"
],
"DnsOptions": ["string"
],
"DnsSearch": ["string"
],
"ExtraHosts": ["xca.localhost:10.0.0.1"
],
"StorageOpt": {"size": "120G"
},
"Devices": [{"PathOnHost": "string",
"PathInContainer": "string",
"CgroupPermissions": "string"
}
],
"LogConfig": {"LogType": "json-file",
"Config": {"property1": "string",
"property2": "string"
}
},
"CpuLimit": 0,
"MemoryLimit": 0
}
}
}
]

templates

Create and manage templates.

list

Returns a summary of all supported templates (for both installed and uninstalled apps).

Authorizations:

Authorization

Responses

Response samples

200

Content type

application/json

[{"type": "BUILT_IN",
"template": {"AppInfo": {"AppName": "defender",
"AppTitle": "Extreme Defender for IoT",
"AppDescription": "Next gen 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"
},
"AppConfiguration": {"AppVolumes": ["defender-vol1",
"defender-vol2"
],
"ExposedPorts": {"12334/udp": { }
},
"Image": "string",
"Cmd": ["/bin/sh",
"-c",
"echo Hello world",
"..."
],
"Env": ["VAR=value",
"..."
],
"HostConfig": {"Binds": ["defender-vol:/backup"
],
"PortBindings": {"8080/tcp": [{"HostIp": "127.0.0.1",
"HostPort": "8080"
}
],
"32541/tcp": [{"HostIp": "127.0.0.1",
"HostPort": "32541"
}
]
},
"RestartPolicy": {"Name": "always",
"MaximumRetryCount": 0
},
"Dns": ["8.8.8.8"
],
"DnsOptions": ["string"
],
"DnsSearch": ["string"
],
"ExtraHosts": ["xca.localhost:10.0.0.1"
],
"StorageOpt": {"size": "120G"
},
"Devices": [{"PathOnHost": "string",
"PathInContainer": "string",
"CgroupPermissions": "string"
}
],
"LogConfig": {"LogType": "json-file",
"Config": {"property1": "string",
"property2": "string"
}
},
"CpuLimit": 0,
"MemoryLimit": 0
}
}
}
}
]

add

Creates a new user-defined application template.

Authorizations:

Authorization

Request Body schema: application/json

User defined application template

required	object (ApplicationInformation) General information for an application
required	object (ApplicationConfiguration) Configuration of an application

Responses

Request samples

Payload

Content type

application/json

{"AppInfo": {"AppName": "defender",
"AppTitle": "Extreme Defender for IoT",
"AppDescription": "Next gen 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"
},
"AppConfiguration": {"AppVolumes": ["defender-vol1",
"defender-vol2"
],
"ExposedPorts": {"12334/udp": { }
},
"Image": "string",
"Cmd": ["/bin/sh",
"-c",
"echo Hello world",
"..."
],
"Env": ["VAR=value",
"..."
],
"HostConfig": {"Binds": ["defender-vol:/backup"
],
"PortBindings": {"8080/tcp": [{"HostIp": "127.0.0.1",
"HostPort": "8080"
}
],
"32541/tcp": [{"HostIp": "127.0.0.1",
"HostPort": "32541"
}
]
},
"RestartPolicy": {"Name": "always",
"MaximumRetryCount": 0
},
"Dns": ["8.8.8.8"
],
"DnsOptions": ["string"
],
"DnsSearch": ["string"
],
"ExtraHosts": ["xca.localhost:10.0.0.1"
],
"StorageOpt": {"size": "120G"
},
"Devices": [{"PathOnHost": "string",
"PathInContainer": "string",
"CgroupPermissions": "string"
}
],
"LogConfig": {"LogType": "json-file",
"Config": {"property1": "string",
"property2": "string"
}
},
"CpuLimit": 0,
"MemoryLimit": 0
}
}
}

getTemplate

Returns a user-defined application template based on name.

Authorizations:

Authorization

path Parameters

name

required

string

Name of application template to be accessed

Responses

Response samples

200

Content type

application/json

{"AppInfo": {"AppName": "defender",
"AppTitle": "Extreme Defender for IoT",
"AppDescription": "Next gen 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"
},
"AppConfiguration": {"AppVolumes": ["defender-vol1",
"defender-vol2"
],
"ExposedPorts": {"12334/udp": { }
},
"Image": "string",
"Cmd": ["/bin/sh",
"-c",
"echo Hello world",
"..."
],
"Env": ["VAR=value",
"..."
],
"HostConfig": {"Binds": ["defender-vol:/backup"
],
"PortBindings": {"8080/tcp": [{"HostIp": "127.0.0.1",
"HostPort": "8080"
}
],
"32541/tcp": [{"HostIp": "127.0.0.1",
"HostPort": "32541"
}
]
},
"RestartPolicy": {"Name": "always",
"MaximumRetryCount": 0
},
"Dns": ["8.8.8.8"
],
"DnsOptions": ["string"
],
"DnsSearch": ["string"
],
"ExtraHosts": ["xca.localhost:10.0.0.1"
],
"StorageOpt": {"size": "120G"
},
"Devices": [{"PathOnHost": "string",
"PathInContainer": "string",
"CgroupPermissions": "string"
}
],
"LogConfig": {"LogType": "json-file",
"Config": {"property1": "string",
"property2": "string"
}
},
"CpuLimit": 0,
"MemoryLimit": 0
}
}
}

update

Updates a user-defined application template based on name.

Authorizations:

Authorization

path Parameters

name

required

string

Name of template to be updated

Request Body schema: application/json

Application template

required	object (ApplicationInformation) General information for an application
required	object (ApplicationConfiguration) Configuration of an application

Responses

Request samples

Payload

Content type

application/json

{"AppInfo": {"AppName": "defender",
"AppTitle": "Extreme Defender for IoT",
"AppDescription": "Next gen 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"
},
"AppConfiguration": {"AppVolumes": ["defender-vol1",
"defender-vol2"
],
"ExposedPorts": {"12334/udp": { }
},
"Image": "string",
"Cmd": ["/bin/sh",
"-c",
"echo Hello world",
"..."
],
"Env": ["VAR=value",
"..."
],
"HostConfig": {"Binds": ["defender-vol:/backup"
],
"PortBindings": {"8080/tcp": [{"HostIp": "127.0.0.1",
"HostPort": "8080"
}
],
"32541/tcp": [{"HostIp": "127.0.0.1",
"HostPort": "32541"
}
]
},
"RestartPolicy": {"Name": "always",
"MaximumRetryCount": 0
},
"Dns": ["8.8.8.8"
],
"DnsOptions": ["string"
],
"DnsSearch": ["string"
],
"ExtraHosts": ["xca.localhost:10.0.0.1"
],
"StorageOpt": {"size": "120G"
},
"Devices": [{"PathOnHost": "string",
"PathInContainer": "string",
"CgroupPermissions": "string"
}
],
"LogConfig": {"LogType": "json-file",
"Config": {"property1": "string",
"property2": "string"
}
},
"CpuLimit": 0,
"MemoryLimit": 0
}
}
}

remove

Removes a user-defined application template based on name.

Authorizations:

Authorization

path Parameters

name

required

string

Name of template to be removed

Responses

getDefaults

Returns default parameters to use when creating a new custom template.

Authorizations:

Authorization

Responses

Response samples

200

Content type

application/json

[{"defaultIcon": "string",
"registry": {"implicit": "Docker Hub",
"available": ["Docker Hub",
"Extreme Hub"
]
},
"logging": {"implicit": "json-file",
"available": "json-file"
},
"cpuLimit": {"implicit": 1,
"max": 2
},
"memoryLimit": {"implicit": 0,
"max": 0
},
"restartPolicy": {"available": "always",
"implicit": "unless-stopped"
}
}
]

getSummary

Retrieve the summary of an application template.

Authorizations:

Authorization

path Parameters

name

required

string

Application template name

Responses

Response samples

200

Content type

application/json

{"AppInfo": {"AppName": "defender",
"AppTitle": "Extreme Defender for IoT",
"AppDescription": "Next gen 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"
},
"AppConfiguration": {"AppVolumes": ["defender-vol1",
"defender-vol2"
],
"ExposedPorts": {"12334/udp": { }
},
"Image": "string",
"Cmd": ["/bin/sh",
"-c",
"echo Hello world",
"..."
],
"Env": ["VAR=value",
"..."
],
"HostConfig": {"Binds": ["defender-vol:/backup"
],
"PortBindings": {"8080/tcp": [{"HostIp": "127.0.0.1",
"HostPort": "8080"
}
],
"32541/tcp": [{"HostIp": "127.0.0.1",
"HostPort": "32541"
}
]
},
"RestartPolicy": {"Name": "always",
"MaximumRetryCount": 0
},
"Dns": ["8.8.8.8"
],
"DnsOptions": ["string"
],
"DnsSearch": ["string"
],
"ExtraHosts": ["xca.localhost:10.0.0.1"
],
"StorageOpt": {"size": "120G"
},
"Devices": [{"PathOnHost": "string",
"PathInContainer": "string",
"CgroupPermissions": "string"
}
],
"LogConfig": {"LogType": "json-file",
"Config": {"property1": "string",
"property2": "string"
}
},
"CpuLimit": 0,
"MemoryLimit": 0
}
}
}

volumes

Create and manage persistent storage that can be attached to containers.

createVolume

Creates a volume with the specified configuration.

Authorizations:

Authorization

Request Body schema: application/json

Volume configuration

name	string
mountPoint	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"mountPoint": "string"
}

Response samples

201

Content type

application/json

{"Name": "string",
"Status": {"empty": true,
"property1": "string",
"property2": "string"
},
"Labels": {"empty": true,
"property1": "string",
"property2": "string"
},
"Driver": "string",
"Scope": "string",
"Options": {"empty": true,
"property1": "string",
"property2": "string"
},
"DriverOpts": {"empty": true,
"property1": "string",
"property2": "string"
},
"Mountpoint": "string"
}

inspectVolume

Returns information about a volume based on name or ID.

Authorizations:

Authorization

path Parameters

nameOrId

required

string

Name or ID of volume to be accessed

Responses

Response samples

200

Content type

application/json

{"Name": "string",
"Status": {"empty": true,
"property1": "string",
"property2": "string"
},
"Labels": {"empty": true,
"property1": "string",
"property2": "string"
},
"Driver": "string",
"Scope": "string",
"Options": {"empty": true,
"property1": "string",
"property2": "string"
},
"DriverOpts": {"empty": true,
"property1": "string",
"property2": "string"
},
"Mountpoint": "string"
}

removeVolume

Deletes a volume based on name or ID.

Authorizations:

Authorization

path Parameters

nameOrId

required

string

Name or ID of volume to be deleted

Responses

listVolumes

Returns a list of all volumes on the server.

Authorizations:

Authorization

query Parameters

dangling

boolean

Default: false

When set to true, returns all volumes that are not in use by a container. When set to false, only returns volumes that are in use by one or more containers.

Responses

Response samples

200

Content type

application/json

{"Warnings": ["string"
],
"Volumes": [{"Name": "string",
"Driver": "string",
"DriverOpts": {"empty": true,
"property1": "string",
"property2": "string"
},
"Options": {"empty": true,
"property1": "string",
"property2": "string"
},
"Labels": {"empty": true,
"property1": "string",
"property2": "string"
},
"Mountpoint": "string",
"Scope": "string",
"Status": {"empty": true,
"property1": "string",
"property2": "string"
}
}
]
}