Create RAD Kit Service - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create RAD Kit Service","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":"**Creates the RADKit Service on the FMC. _Check the response section for applicable examples (if any)._**","operationId":"createRADKitService","parameters":[{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"requestBody":{"content":{"application/json":{"examples":{"Example 1 : POST /api/fmc_troubleshoot/v1/domain/{domainUUID}/radkit/services/ ( POST request to start the RADKit Service )":{"value":{"status":"ENABLED","type":"RADKitService"}},"Example 2 : POST /api/fmc_troubleshoot/v1/domain/{domainUUID}/radkit/services/ ( POST request to stop the RADKit Service )":{"value":{"status":"DISABLED","type":"RADKitService"}}},"schema":{"type":"object","description":"Cisco Remote Automation Development Kit Service","properties":{"description":{"type":"string"},"id":{"description":"RADKit Service ID.","type":"string"},"isCloudConnected":{"type":"boolean"},"isEnrolled":{"description":"Boolean value that indicates if the service is enrolled in the RADKit Cisco cloud","type":"boolean"},"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":{"description":"Optional message about the RADKit Service which may include status or other information.","type":"string"},"name":{"type":"string"},"serviceId":{"description":"Service ID string for a cloud enrolled service to be used for connecting from the RADKit client","type":"string"},"status":{"description":"(ENUM) Can be either ENABLED, DISABLED, STARTING or RUNNING.","enum":["ENABLED","DISABLED","STARTING","RUNNING"],"type":"string"},"type":{"description":"RADKitService","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/RADKitService"}}},"description":"The input for RADKit Service.","required":true},"responses":{"202":{"content":{"application/json":{"examples":{"Example 1 : POST /api/fmc_troubleshoot/v1/domain/{domainUUID}/radkit/services/ ( POST request to start the RADKit Service )":{"value":{"id":"1","isCloudConnected":false,"isEnrolled":false,"message":"The RADKit Service was started.","status":"RUNNING","type":"RADKitService"}},"Example 2 : POST /api/fmc_troubleshoot/v1/domain/{domainUUID}/radkit/services/ ( POST request to stop the RADKit Service )":{"value":{"message":"The RADKit Service was stopped.","status":"DISABLED","type":"RADKitService"}}},"schema":{"type":"object","description":"Cisco Remote Automation Development Kit Service","properties":{"description":{"type":"string"},"id":{"description":"RADKit Service ID.","type":"string"},"isCloudConnected":{"type":"boolean"},"isEnrolled":{"description":"Boolean value that indicates if the service is enrolled in the RADKit Cisco cloud","type":"boolean"},"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":{"description":"Optional message about the RADKit Service which may include status or other information.","type":"string"},"name":{"type":"string"},"serviceId":{"description":"Service ID string for a cloud enrolled service to be used for connecting from the RADKit client","type":"string"},"status":{"description":"(ENUM) Can be either ENABLED, DISABLED, STARTING or RUNNING.","enum":["ENABLED","DISABLED","STARTING","RUNNING"],"type":"string"},"type":{"description":"RADKitService","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/RADKitService"}}},"description":"Accepted"},"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":["Troubleshoot"],"__originalOperationId":"createRADKitService","method":"post","path":"/v1/cdfmc/api/fmc_troubleshoot/v1/domain/{domainUUID}/radkit/services"}}