Create FTD Cluster Device Readiness Container - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create FTD Cluster Device Readiness Container","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":"**Check if cluster is ready to become control and if the data devices are compatible with that control. This readiness check is for platforms that support cluster bootstrap from Firewall Management Center. _Check the response section for applicable examples (if any)._**","operationId":"createFTDClusterDeviceReadinessContainer","parameters":[{"description":"Boolean value, if set to \"true\" skips control readiness check and only checks data device compatibility with control.","in":"query","name":"skipControlReadiness","required":false,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"A model representing FTD Cluster Device Readiness Model","properties":{"clusterMode":{"description":"INDIVIDUAL or SPANNED mode","enum":["SPANNED","INDIVIDUAL"],"type":"string"},"controlDevice":{"description":"Control device details","type":"object","properties":{"clusterReadiness":{"type":"object","properties":{"errors":{"items":{"type":"string"},"type":"array"},"status":{"enum":["READY","NOT_READY"],"type":"string"}},"required":["errors","status"],"$$ref":"#/components/schemas/IDeviceClusterReadinessData"},"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IFTDClusterDeviceReadinessEntity"},"dataDevices":{"description":"List of data devices","items":{"type":"object","properties":{"clusterReadiness":{"type":"object","properties":{"errors":{"items":{"type":"string"},"type":"array"},"status":{"enum":["READY","NOT_READY"],"type":"string"}},"required":["errors","status"],"$$ref":"#/components/schemas/IDeviceClusterReadinessData"},"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IFTDClusterDeviceReadinessEntity"},"type":"array"},"description":{"type":"string"},"mtuWarningMsg":{"type":"string"},"name":{"type":"string"},"version":{"type":"string"}},"required":["controlDevice"],"$$ref":"#/components/schemas/FTDClusterDeviceReadinessContainer"}}},"description":"Input representation of device details for control and data devices.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object","description":"A model representing FTD Cluster Device Readiness Model","properties":{"clusterMode":{"description":"INDIVIDUAL or SPANNED mode","enum":["SPANNED","INDIVIDUAL"],"type":"string"},"controlDevice":{"description":"Control device details","type":"object","properties":{"clusterReadiness":{"type":"object","properties":{"errors":{"items":{"type":"string"},"type":"array"},"status":{"enum":["READY","NOT_READY"],"type":"string"}},"required":["errors","status"],"$$ref":"#/components/schemas/IDeviceClusterReadinessData"},"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IFTDClusterDeviceReadinessEntity"},"dataDevices":{"description":"List of data devices","items":{"type":"object","properties":{"clusterReadiness":{"type":"object","properties":{"errors":{"items":{"type":"string"},"type":"array"},"status":{"enum":["READY","NOT_READY"],"type":"string"}},"required":["errors","status"],"$$ref":"#/components/schemas/IDeviceClusterReadinessData"},"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IFTDClusterDeviceReadinessEntity"},"type":"array"},"description":{"type":"string"},"mtuWarningMsg":{"type":"string"},"name":{"type":"string"},"version":{"type":"string"}},"required":["controlDevice"],"$$ref":"#/components/schemas/FTDClusterDeviceReadinessContainer"}}},"description":"Created"},"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":["Device Clusters"],"__originalOperationId":"createFTDClusterDeviceReadinessContainer","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deviceclusters/ftdclusterreadinesscheck"}}