Get FTD Cloud Status - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get FTD Cloud Status","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 cloud connectivity status of FTD managed by cdFMC.**","operationId":"getFTDCloudStatus","parameters":[{"description":"Unique identifier of the cloud managed device.","in":"path","name":"deviceId","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 1 : GET /api/fmc_config/v1/domain/domainUUID/integration/ftdcloudstatus/deviceUUID ( GET by ID FTD Cloud Status )":{"value":{"defaultContextInfo":"{\n \"clientInfo\": {\n \"version\": \"7.4.2.1\",\n \"description\": \"192.168.0.162 FTD-NLN-1 (FMC managed)\",\n \"name\": \"FTD-NLN-1\",\n \"guid\": \"df7d17c0-19bf-11f0-b6b6-bbeb4cb22f58\",\n \"type\": \"Cisco Firepower Threat Defense for VMware\",\n \"ip\": \"192.168.0.162\"\n },\n \"settings\": {\n \"client\": {\n \"administration\": {\n \"headers\": {},\n \"auth\": {\n \"csrfToken\": \"******\"\n },\n \"uri\": \"\",\n \"enabled\": \"false\"\n },\n \"statusCallback\": {\n \"uri\": \"\"\n },\n \"contextCallback\": {\n \"uri\": \"\"\n },\n \"fileUpload\": [\n {\n \"type\": \"tls_fingerprint\",\n \"uri\": \"file:///ngfw/var/log/mercury_telemetry_stats.json.gz\",\n \"refreshInterval\": 86400,\n \"skipIfMissing\": true\n }\n ],\n \"applicationConfig\": null,\n \"events\": {\n \"uri\": \"ipc:///ngfw/var/sf/run/EventHandler_SSEConnector.sock\",\n \"type\": \"ZMQ_PUSH\",\n \"enabled\": \"true\"\n },\n \"proxyReg\": {\n \"uri\": \"\",\n \"type\": \"\"\n }\n },\n \"exchange\": {\n \"registration\": {\n \"refreshInterval\": 180\n },\n \"fqdn\": \"staging-sse.cisco.com\"\n },\n \"dataInput\": {\n \"http\": null\n }\n },\n \"id\": \"default\",\n \"meta\": {\n \"created\": \"2025-06-04T23:38:54Z\",\n \"lastModified\": \"2025-06-04T23:38:54Z\",\n \"deviceId\": \"25b7ddc8-bfad-4a0e-ac4c-173a76bd0880\",\n \"connectorVersion\": \"2.1.16\"\n },\n \"endpoints\": [\n {\n \"type\": \"serviceActivation\",\n \"uri\": \"http://localhost:8989/v1/contexts/default/activations\"\n },\n {\n \"type\": \"status\",\n \"uri\": \"http://localhost:8989/v1/contexts/default/status\"\n },\n {\n \"type\": \"statistics\",\n \"uri\": \"http://localhost:8989/v1/contexts/default/statistics\"\n },\n {\n \"type\": \"workflows\",\n \"uri\": \"http://localhost:8989/v1/contexts/default/workflows\"\n },\n {\n \"type\": \"urn:services:messaging\",\n \"uri\": \"http://localhost:8989/v1/contexts/default/services/messaging\"\n },\n {\n \"type\": \"urn:services:token\",\n \"uri\": \"http://localhost:8989/v1/contexts/default/services/token\"\n },\n {\n \"type\": \"services\",\n \"uri\": \"http://localhost:8989/v1/contexts/default/services/registry\"\n },\n {\n \"type\": \"tenant\",\n \"uri\": \"http://localhost:8989/v1/contexts/default/tenant\"\n },\n {\n \"type\": \"eventsws\",\n \"uri\": \"ws://localhost:8989/v1/contexts/default/services/eventsws\"\n },\n {\n \"type\": \"wsproxy\",\n \"uri\": \"ws://localhost:8989/v1/contexts/default/services/wsproxy\"\n }\n ],\n \"status\": {\n \"client\": [\n {\n \"type\": \"tls_fingerprint\",\n \"status\": \"Success\",\n \"name\": \"\",\n \"description\": \"Skipped file-upload: open /ngfw/var/log/mercury_telemetry_stats.json.gz: no such file or directory\"\n },\n {\n \"type\": \"administration\",\n \"status\": \"Stopped\",\n \"name\": \"\",\n \"description\": \"Administration service module stopped\"\n },\n {\n \"type\": \"Events\",\n \"status\": \"Failed\",\n \"name\": \"\",\n \"description\": \"Events service module failed, err: zmq4: could not dial to \\\"ipc:///ngfw/var/sf/run/EventHandler_SSEConnector.sock\\\" (retry=250ms): dial unix /ngfw/var/sf/run/EventHandler_SSEConnector.sock: connect: connection refused\"\n },\n {\n \"type\": \"urn:services:messaging\",\n \"status\": \"Init\",\n \"name\": \"\",\n \"description\": \"Data exchange service is enabled\"\n },\n {\n \"type\": \"wsproxy\",\n \"status\": \"Success\",\n \"name\": \"\",\n \"description\": \"Websocket Proxy service started\"\n },\n {\n \"type\": \"SSE_notification\",\n \"status\": \"Init\",\n \"name\": \"\",\n \"description\": \"SSE notifications receiving service is pending\"\n }\n ],\n \"exchange\": [\n {\n \"type\": \"registration\",\n \"status\": \"Enrolled\",\n \"name\": \"\",\n \"description\": \"Device has been enrolled.\"\n }\n ],\n \"dataInput\": null\n },\n \"statistics\": {\n \"client\": [\n {\n \"type\": \"urn:services:messaging\",\n \"statistics\": {\n \"failureCount\": 0,\n \"successCount\": 0,\n \"totalRequests\": 0,\n \"lastFailure\": \"\",\n \"lastSuccess\": \"\"\n }\n },\n {\n \"type\": \"wsproxy\",\n \"statistics\": {\n \"ActiveConnections\": 0,\n \"LastConnect\": \"\",\n \"LastDisconnect\": \"\",\n \"TotalBytesUpstream\": 0,\n \"TotalBytesDownstream\": 0\n }\n },\n {\n \"type\": \"administration\",\n \"statistics\": null\n },\n {\n \"type\": \"Events\",\n \"statistics\": {\n \"ZmqStat\": {\n \"LastCloudConnectSuccess\": \"2025-06-04T23:38:56.410473182Z\",\n \"LastCloudConnectFailure\": \"\",\n \"LastCloudDisconnect\": \"\",\n \"TotalEventsReceived\": 0,\n \"TotalEventsSent\": 0\n },\n \"WsStat\": {\n \"ActiveConnections\": 0,\n \"LastClientConnectSuccess\": \"\",\n \"LastClientDisconnect\": \"\",\n \"LastCloudConnectSuccess\": \"\",\n \"LastCloudConnectFailure\": \"\",\n \"LastCloudDisconnect\": \"\",\n \"TotalEventsReceived\": 0,\n \"TotalEventsSent\": 0\n }\n }\n }\n ],\n \"exchange\": [\n {\n \"type\": \"registration\",\n \"statistics\": {\n \"activation\": {\n \"registration\": {\n \"timestamp\": \"2025-06-04T23:38:54.676589415Z\",\n \"timeTaken\": 0.33668382,\n \"timeDuration\": \"336.68382ms\"\n },\n \"enrollment\": {\n \"timestamp\": \"2025-06-04T23:38:54.917028682Z\",\n \"timeTaken\": 0.240418178,\n \"timeDuration\": \"240.418178ms\"\n },\n \"unregistration\": {\n \"timestamp\": \"\",\n \"timeTaken\": 0,\n \"timeDuration\": \"\"\n }\n },\n \"refresh\": {\n \"registration\": {\n \"timestamp\": \"2025-06-04T23:50:55.129149683Z\",\n \"timeTaken\": 0.211287958,\n \"timeDuration\": \"211.287958ms\",\n \"successCount\": 4,\n \"failureCount\": 0\n },\n \"enrollment\": {\n \"timestamp\": \"\",\n \"timeTaken\": 0,\n \"timeDuration\": \"\",\n \"successCount\": 0,\n \"failureCount\": 0\n }\n }\n }\n }\n ]\n }\n}","tenantInfo":"{\"registeredTenantInfo\":{\"companyName\":\"cisco-nln-bulk-ftd-sapi__svhv7h\",\"id\":\"0c4cb4e2-d251-49dc-8bfc-715e94bd4096\",\"spId\":\"CDO\"},\"tenantInfo\":[{\"companyName\":\"cisco-nln-bulk-ftd-sapi__svhv7h\",\"id\":\"0c4cb4e2-d251-49dc-8bfc-715e94bd4096\",\"spId\":\"CDO\"}]}","type":"FTDCloudStatus"}},"Example 2 : GET /api/fmc_config/v1/domain/domainUUID/integration/ftdcloudstatus/deviceUUID ( GET by ID FTD Cloud Status when SSE connector is not running )":{"value":{"error":{"message":"SSE connector is not running","type":"FTDCloudStatus"}}},"Example 4 : GET /api/fmc_config/v1/domain/domainUUID/integration/ftdcloudstatus/deviceUUID ( GET by ID FTD Cloud Status when default context is absent )":{"value":{"error":{"message":"Default context is not present","type":"FTDCloudStatus"}}}},"schema":{"type":"object","description":"An object that represents the details for FTD cloud status.","properties":{"defaultContextInfo":{"description":"The default cloud context information for the device.","type":"string"},"description":{"type":"string"},"error":{"description":"The error information if fetching the cloud status fails.","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"},"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"},"tenantInfo":{"description":"The tenant details to which the device is registered.","type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/FTDCloudStatus"}}},"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":["Integration"],"__originalOperationId":"getFTDCloudStatus","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/integration/ftdcloudstatus/{deviceId}"}}