{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/ba77f57b-02d1-3e26-99d6-40948a543c9c","info":{"title":"Crosswork AppManager API","description":"AppManager provides API methods for managing Crosswork applications that run on top of Kubernetes. This includes install-activate, deactivate, update, and uninstall for these applications. It also provides APIs to manage the internal package repository from which application installs are carried out.","version":"3.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/APP/app-overview.md"}},"openapi":"3.0.0","servers":[{"url":"/crosswork/platform/v2"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer token for API authentication."}}},"spec":{"type":"object","properties":{"product_id":{"type":"string","title":"Smart licensing server product id"},"software_id_tag":{"type":"string","title":"software id tag of product as registered\nin smart licensing server / CSSM"},"display_name":{"type":"string","description":"Should be filled with string to be displayed on UI\nWill be defaulted to PID if not given."},"entitlements":{"type":"array","items":{"type":"object","properties":{"entitlement_tag":{"type":"string","title":"unique tag of the entitlement as derived from CSSM"},"version":{"type":"string","title":"version of above entitlement"},"name":{"type":"string","title":"name of the entitlement"},"is_reset_after_first_registration":{"type":"boolean","title":"flag to be set true,if it is resettable after first registration"},"is_lab":{"type":"boolean","description":"set to true if it is a lab entitlement tag.\nUser will be able to use the extended trial period if it is available."}},"example":{"entitlement_tag":"ENT1234","version":"1.0","name":"Entitlement Name","is_reset_after_first_registration":true,"is_lab":false},"$$ref":"#/components/schemas/app_managerSmartLicensingEntitlement"},"title":"List of entitlements that would be used by product"},"capp_licensing_type":{"type":"string","enum":["UNKNOWN_TYPE","ESSENTIALS","ADVANCED"],"default":"UNKNOWN_TYPE","title":"type of the crosswork application","example":"ESSENTIALS","$$ref":"#/components/schemas/app_managerCappLicensingType"},"parent_software_id":{"type":"string","title":"if solution licensing is available, then link it here"},"is_lab_supported":{"type":"boolean","title":"set if lab mode is supported"},"auto_onboard":{"type":"boolean","title":"set if onboard / deboard is expected to happen as part of installation / uninstallation"}},"title":"app_managerSmartLicensingData","example":{"product_id":"PID1234","software_id_tag":"TAG1234","display_name":"Sample Product","entitlements":[],"capp_licensing_type":"ESSENTIALS","parent_software_id":"SWID1234","is_lab_supported":true,"auto_onboard":false},"$$ref":"#/components/schemas/app_managerSmartLicensingData"}}