Get Domain - Security Cloud Control Firewall Manager API Documentation - Cisco DevNet

{"type":"api","title":"Get Domain","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/830d1f62208c73e8aeba17d0e26773e8902a279e/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.17.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.uae.security.cisco.com/firewall","description":"UAE"},{"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.dev.secure.cisco/api/rest","description":"Devf9"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"},{"url":"https://manage.secure.cisco/api/rest","description":"ProdF9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Get version information for the specified domain.**","operationId":"getDomain","parameters":[{"description":"Unique identifier of the domain.","in":"path","name":"objectId","required":true,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 3 : GET /api/fmc_platform/v1/info/domain/{domainUUID}/{objectId} ( GET success of Domain )":{"value":{"description":"Description of domains","links":{"self":"https://fmc.cisco.com/api/fmc_platform/v1/info/domain/\u003cdomainUUID\u003e/987e6543-e21b-32d3-b456-543214174111"},"name":"Name of the domain","parentUUID":"Domain parent UUID","tenantUUID":"Domain tenant mapping UUID","type":"Domain","uuid":"UUID of the domain"}}},"schema":{"description":"The details about the domain.","properties":{"description":{"type":"string"},"hostLimit":{"description":"Maximum number of hosts in the domain.","format":"int32","type":"integer"},"id":{"description":"Unique UUID of this domain.","type":"string"},"links":{"description":"Links to the domain resource URLs.","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":{"properties":{"domain":{"$ref":"#/components/schemas/Domain","type":"object"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","description":"This object defines details about the user.","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to 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"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","description":"Defines the read only conditions if the referenced resource is read only.","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"taskStatus":{"properties":{"description":{"type":"string"},"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"},"message":{"type":"string"},"metadata":{"$ref":"#/components/schemas/IMetadata","type":"object"},"name":{"type":"string"},"showDetailedDeviceStatus":{"type":"string"},"status":{"type":"string"},"subTasks":{"items":{"$ref":"#/components/schemas/ISubTask","type":"object"},"type":"array"},"taskType":{"enum":["DEVICE_REGISTRATION","SMART_LICENSE","DEVICE_DEPLOYMENT","DEVICE_ROLLBACK","NGFWHA_OPERATIONS","COPY_CONFIG_REQUEST","HIT_COUNT_REFRESH","ACTION_TYPE_DOMAIN_CHANGES","FTD_CLUSTER_BOOTSTRAP","FTD_CLUSTER_CREATE","FTD_CLUSTER_BREAK","FTD_CLUSTER_ADD_NODES","FTD_CLUSTER_REMOVE_NODES","DEVICE_BACKUP","FTD_CLUSTER_UPDATE_BOOTSTRAP","FTD_CLUSTER_COMMAND","SSP_EPM_OIR","SSP_EPM_BREAKOUT_DEPLOY","DEVICE_EXPORT","DEVICE_IMPORT","POLICY_EXPORT","CHASSIS_REGISTRATION","CHANGE_MANAGER","CONFIGURE_DEVICE_VALIDATE","CONFIGURE_DEVICE","CONFIGURE_MANAGER","CONFIGURE_MANAGER_ADD","CONFIGURE_MANAGER_DELETE","INITIATE_MIGRATION","DISCARD_MIGRATION","SWITCH_TO_ANALYTICS","DELETE_DEVICE","GENERATE_REPORTS","FLEXCONFIG_MIGRATION","DEVICE_UNREGISTRATION","PENDING_CHANGES_REQUEST","DEVICE_TROUBLESHOOT","DEVICE_MODEL_MIGRATION","DEVICE_TEMPLATE_CREATION","CHASSIS_CONVERSION_REQUEST","SNORT_PROFILER","CPU_PROFILER","POLICY_REPORT_GENERATION","DEVICE_TEMPLATE_APPLY","LTP_ONBOARDING","POLICY_CLONE_OPERATION","DEVICE_CERTIFICATE_MANAGEMENT","OOB_CHANGES_REQUEST","UPLOAD_TROUBLESHOOT","FMC_MODEL_MIGRATION","EXTERNAL_AUTHENTICATION","EXECUTE_BULK_COMMANDS","FA_TELEMETRY_DATA_GENERATION"],"type":"string"},"type":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/TaskStatus"},"timestamp":{"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/DomainMetadata"},"name":{"description":"Name of the domain or keywords used to filter from domain names.","type":"string"},"parentUUID":{"description":"UUID of the parent domain.","type":"string"},"tenantUUID":{"description":"UUID of the tenant used for domain mapping.","type":"string"},"type":{"description":"Domain type definition.","type":"string"},"uuid":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/Domain"}}},"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":["System Information"],"__originalOperationId":"getDomain","method":"get","path":"/v1/cdfmc/api/fmc_platform/v1/info/domain/{domainUUID}/{objectId}"}}