appid
|
Yes
|
No
|
The unique ID for the app which is used to identify the app in the Cisco ACI App Center and in the APIC.
|
The ID is a string and can be up to 32 alpha numeric characters only.
|
version
|
Yes
|
Yes
|
Version of the application specifying a major M version and a minor m version.
|
The version is a string M.m and M and m are positive integers. The values of M and m are in the range 0 to 9999.
|
iconfile
|
Yes
|
Yes
|
The path to the icon file in the UIAssets folder. The icon file contains the thumbnail for the app. The thumbnail is used
to uniquely identify the app in the Cisco ACI App Center.
|
The path to the icon file is a string and the file name can be up to 256 characters. The supported file formats are jpeg or
png.
|
name
|
Yes
|
No
|
The name of the application.
|
The name is a string and can be up to 256 characters.
|
shortdescr
|
Yes
|
Yes
|
The description of the app. This information is displayed when the app is listed in the Cisco ACI App Center.
|
The short description is a string and can be up to 1024 characters.
|
vendor
|
Yes
|
No
|
The name of the company.
|
The name is a string and can be up to 256 alpha numeric characters only.
|
vendordomain
|
Yes
|
No
|
The domain ID of the company.
|
The ID is a string and can be up to 32 alpha numeric characters only.
|
apicversion
|
Yes
|
Yes
|
The minimum APIC software version required for the app’s functionality.
|
Must be unique and greater than last approved application.
The format is major.minor(mp), where
|
signature
|
No
|
Yes
|
The signature required for the application files. The signature is issued by Cisco ACI App Center after an app is approved and is allowed to be distributed.
Note
|
Only apps with the signature are supported by Cisco. Apps without the signature are not supported.
|
|
None
|
price
|
No
|
Yes
|
Total cost to download the app. The default is $0.
|
The format for the value is float.
|
contact
|
No
|
Yes
|
The contact information for the app.
|
The format is JSON dictionary.
|
contact-phone
|
No
|
Yes
|
The contact phone number of the company.
|
The phone number is a string.
|
contact-email
|
No
|
Yes
|
The contact email of the company.
|
The email is a string.
|
contact-url
|
No
|
Yes
|
The contact URL of the company.
|
The URL is a string.
|
permissions
|
Yes
|
Yes
|
The permissions required by the app to access the various managed objects and utilities in the MIT. See Cisco ACI AAA RBAC Rules and Privileges for more information about user roles, privileges, and security domains.
Note
|
It is recommended to assign the minimum set of permissions that is required for the app's functionality.
|
|
The format is JSON array.
|
permissionslevel
|
Yes
|
No
|
The permission level required for the application. The permission level defines if the user has read or write access to the
app.
|
The permission level is a string and can be either read or write.
|
api
Note
|
The metadata is only applicable for a stateful app.
|
|
Yes
|
Yes
|
The API supported by the application. Each entry in the API list contains the API URL and the corresponding description. The
API is used to query the backend.
Note
|
In the API, only POST and GET operations are supported.
|
|
The format is JSON dictionary. The key and value are strings.
|
author
|
Yes
|
Yes
|
The name of the app developer.
|
The author is a string and can be up to 256 characters.
|
insertionURL
|
No
|
Yes
|
The insertion URL of the app in the APIC UI. The URL informs the APIC on where to insert the app in the APIC UI. By default,
the user will be able to run the app from the Installed Apps tab. See Integrating the App's UI in the APIC UI.
|
The insertion URL is a string.
|
category
|
Yes
|
Yes
|
The categories of the app used by Cisco ACI App Center to filter the apps.
The allowed categories allowed are:
|
The format is JSON array.
|