Get Device License - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Device License","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Get the device license associated with the specified ID.**","operationId":"getDeviceLicense","parameters":[{"description":"Unique identifier associated with the device license.","in":"path","name":"objectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /api/fmc_platform/v1/license/devicelicenses/deviceId ( API for GET a device license. )":{"value":{"id":"01184a7e-af2e-11e9-a663-9eb033590246","licenseTypes":["ESSENTIALS","IPS","MALWARE_DEFENSE","URL"],"performanceTier":"FTDv50","type":"DeviceLicense"}}},"schema":{"description":"API's to trigger retrieving and updating the Smart License operations on devices.","properties":{"description":{"description":"More information about the Device License.","type":"string"},"id":{"type":"string"},"items":{"items":{"properties":{"description":{"type":"string"},"id":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/IDeviceLicense","type":"object"},"type":"array"},"licenseTypes":{"items":{"enum":["ESSENTIALS","EXPORT_CONTROL","MALWARE_DEFENSE","MALWARE_DEFENSE_HA","SECURE_CLIENT_PREMIER","SECURE_CLIENT_PREMIER_HA","SECURE_CLIENT_PREMIER_ADVANTAGE","SECURE_CLIENT_PREMIER_ADVANTAGE_HA","URL","URL_HA","IPS","IPS_HA","SECURE_CLIENT_VPNOnly","SECURE_CLIENT_VPNOnly_HA","CARRIER","CARRIER_HA"],"type":"string"},"type":"array"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"type":"string"},"performanceTier":{"enum":["FTDv","FTDv5","FTDv10","FTDv20","FTDv30","FTDv50","FTDv100"],"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/IDeviceLicense"},"type":"array"},"licenseTypes":{"items":{"enum":["ESSENTIALS","EXPORT_CONTROL","MALWARE_DEFENSE","MALWARE_DEFENSE_HA","SECURE_CLIENT_PREMIER","SECURE_CLIENT_PREMIER_HA","SECURE_CLIENT_PREMIER_ADVANTAGE","SECURE_CLIENT_PREMIER_ADVANTAGE_HA","URL","URL_HA","IPS","IPS_HA","SECURE_CLIENT_VPNOnly","SECURE_CLIENT_VPNOnly_HA","CARRIER","CARRIER_HA"],"type":"string"},"type":"array"},"links":{"description":"Object representing this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"description":"Name of the Device License.","type":"string"},"performanceTier":{"enum":["FTDv","FTDv5","FTDv10","FTDv20","FTDv30","FTDv50","FTDv100"],"type":"string"},"type":{"description":"DeviceLicense","type":"string"},"version":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/DeviceLicense"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["License"],"__originalOperationId":"getDeviceLicense","method":"get","path":"/v1/cdfmc/api/fmc_platform/v1/license/devicelicenses/{objectId}"}}