Get Smart License - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Smart 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 list of all Smart Licenses and associated information.**","operationId":"getSmartLicense","parameters":[{"name":"offset","description":"Index of first item to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/offset"},{"name":"limit","description":"Number of items to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/limit"},{"name":"expanded","description":"If set to true, the GET response displays a list of objects with additional attributes.","in":"query","required":false,"schema":{"type":"boolean"},"$$ref":"#/components/parameters/expanded"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /api/fmc_platform/v1/license/smartlicenses ( API for the smart license registration status )":{"value":{"items":[{"metadata":{"authStatus":"AUTHORIZED|AUTHORIZED_RESERVED|OUT_OF_COMPLIANCE|AUTHORIZATION_EXPIRED|NOT_AUTHORIZED","evalExpiresInDays":0,"evalUsed":true,"exportControl":true,"lastRenewedTime":"2021-10-25T15:10:26UTC","lastSynchronizedTime":"2021-10-25T15:10:38UTC","virtualAccount":"FMC_ENG_BLR"},"regStatus":"REGISTERED|UNREGISTERED|RESERVATION_IN_PROGRESS|EVALUATION","type":"SmartLicense"}],"links":{"self":"https:/localhost:8585/api/fmc_platform/v1/license/smartlicenses?offset=0&limit=25"},"paging":{"count":1,"limit":25,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"API's to trigger Smart License related operations like evaluation, registration, de-registration and Smart License operations on devices.","properties":{"description":{"description":"More information about the Smart License.","type":"string"},"force":{"description":"true | false, if true, Overwrite FMC instance in Smart Software Manager if instance already exists. default is false","type":"string"},"id":{"type":"string"},"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":{"description":"Object representing metadata attributes for the Smart License.","type":"object","properties":{"authStatus":{"enum":["AUTHORIZED","AUTHORIZED_RESERVED","OUT_OF_COMPLIANCE","AUTHORIZATION_EXPIRED","NOT_AUTHORIZED","EVALUATION"],"type":"string"},"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"},"evalExpiresInDays":{"format":"int32","type":"integer"},"evalUsed":{"type":"boolean"},"exportControl":{"type":"boolean"},"isLocked":{"type":"boolean"},"lastRenewedTime":{"type":"string"},"lastSynchronizedTime":{"type":"string"},"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"},"virtualAccount":{"type":"string"}},"$$ref":"#/components/schemas/ISmartLicenseMetaData"},"name":{"description":"Name of the Smart License.","type":"string"},"regStatus":{"description":"REGISTERED|UNREGISTERED|RESERVATION_IN_PROGRESS|EVALUATION","enum":["REGISTERED","UNREGISTERED","RESERVATION_IN_PROGRESS","EVALUATION"],"type":"string"},"registrationType":{"description":"EVALUATION|REGISTERED|DEREGISTERED","enum":["EVALUATION","REGISTER","DEREGISTER"],"type":"string"},"token":{"description":"X2M3YmJlY...","type":"string"},"type":{"description":"SmartLicense","type":"string"}},"$$ref":"#/components/schemas/SmartLicense"},"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"},"paging":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PagingContainer"}},"$$ref":"#/components/schemas/SmartLicenseListContainer"}}},"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":"getSmartLicense","method":"get","path":"/v1/cdfmc/api/fmc_platform/v1/license/smartlicenses"}}