{"type":"api","title":"Send a direct request to a registered device in Security Cloud Control","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.15.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"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":{"description":"Send a direct command to the specified device.","operationId":"executeDeviceCommand","parameters":[{"description":"By default, the API waits up to 70 seconds for a device response. Append the 'async' flag to return immediately without waiting for the response.","in":"query","name":"async","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"deviceUid":{"description":"The unique identifier, represented as a UUID, of the target device for the command. Currently, only FMC devices are supported.","example":"6e3492c6-083a-4ead-9da9-cd2db32a965d","minLength":1,"type":"string"},"request":{"description":"The request that the user wants to execute on the device.","properties":{"commands":{"description":"A list of commands to be executed on the device.","items":{"properties":{"body":{"description":"The body of the command (optional).","example":{},"type":"string"},"link":{"description":"The FMC endpoint to invoke for this command.","example":"/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f","minLength":1,"type":"string"},"method":{"description":"The HTTP method for the command.","example":"GET","minLength":1,"type":"string"}},"required":["link","method"],"type":"object","$$ref":"#/components/schemas/Command"},"minItems":1,"type":"array"}},"required":["commands"],"type":"object","$$ref":"#/components/schemas/FmcRequest"}},"required":["deviceUid","request"],"type":"object","$$ref":"#/components/schemas/DeviceGatewayApiRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"responded":{"value":{"data":{"inResponseTo":{"command":"executeFmcRequests","deviceType":"fmc","deviceUid":"fb8e46fc-30b0-437f-921d-606c53d4b94c","larUid":"b5a71c7b-f309-4102-8fa2-9eec2260a1b7"},"responseBody":"[{\"id\":\"0050568A-5AB4-0ed3-0000-021474986635\",\"name\":\"Marketing\",\"agentId\":\"agent_007\",\"topicName\":\"aws365\",\"description\":\"IPs of marketing department\",\"type\":\"DynamicObject\",\"objectType\":\"IP\",\"links\":{\"self\":\"https://fmc.acme.com/api/fmc_config/v1/domain/e276abe1-e0f2-11e3-8169-6d9ed49b625f/object/dynamicobjects/0050568C-5AB4-0ed3-0000-021474986635\"},\"metadata\":{\"domain\":{\"name\":\"Global\",\"id\":\"e276abec-e0f2-11e3-8169-6d9ed49b625f\",\"type\":\"Domain\"}}}]","responseStatus":"SUCCESS","tenantUid":"936fca6c-000b-4375-b903-46e6a95c7153"},"requestId":"11111111-1111-1111-1111-111111111111","responseOrigin":"secure-connector","status":"responded"}},"timeout":{"value":{"data":"The request timed out due to a hard limit of 70 seconds. You may poll for a belated response using the url provided in the 'data' field","requestId":"11111111-1111-1111-1111-111111111111","responseOrigin":"device-gateway-api","status":"timeout"}}}}},"description":"The request was successfully processed, and the device command was executed."},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"summary":"Send a direct request to a registered device in Security Cloud Control","tags":["Commands"],"__originalOperationId":"executeDeviceCommand","method":"post","path":"/v1/fmc/gateway/command"}}