Onboard FTD device - Security Cloud Control API Documentation

{"type":"api","title":"Onboard FTD device","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/b6174f03868a5c05a075dd7020d71743587e002d/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control API","version":"1.9.0","description":"Use the documentation to explore the endpoints Security Cloud Control has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"openapi":"3.0.1","servers":[{"url":"https://edge.us.cdo.cisco.com/api/rest","description":"US"},{"url":"https://edge.eu.cdo.cisco.com/api/rest","description":"EU"},{"url":"https://edge.apj.cdo.cisco.com/api/rest","description":"APJ"},{"url":"https://edge.aus.cdo.cisco.com/api/rest","description":"AUS"},{"url":"https://edge.in.cdo.cisco.com/api/rest","description":"IN"},{"url":"https://edge.staging.cdo.cisco.com/api/rest","description":"Staging"},{"url":"https://edge.scale.cdo.cisco.com/api/rest","description":"Scale"},{"url":"https://edge.ci.cdo.cisco.com/api/rest","description":"CI"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"description":"This is an asynchronous operation to generate a registration key for a cdFMC managed FTD device in the CDO tenant. This operation returns a link to a transaction object that can be used to monitor the progress of the operation. Onboarding a cdFMC managed FTD device is a two-step process: the first step, handled by this operation, creates an FTD device with a configure manager string that must be pasted into the FTD device's Command-Line Interface. The FTD then uses this information to register itself with the Security Cloud Control tenant.","operationId":"createFtdDevice","requestBody":{"content":{"application/json":{"schema":{"properties":{"deviceType":{"description":"Specify the type of the FTD. The only supported type of FTD is CDFMC_MANAGED_FTD","enum":["CDFMC_MANAGED_FTD"],"type":"string"},"fmcAccessPolicyUid":{"description":"Specify the unique identifier, represented as a UUID, of the FMC access policy to apply to this device.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"labels":{"description":"Labels used to identify/tag Security Cloud Control entities.","properties":{"groupedLabels":{"additionalProperties":{"description":"Groups of labels used to identify/tag Security Cloud Control entities.","example":{"group1":["label-1","label-2"],"group2":["label-1","label-2"]},"items":{"description":"Groups of labels used to identify/tag Security Cloud Control entities.","example":"{\"group1\":[\"label-1\",\"label-2\"],\"group2\":[\"label-1\",\"label-2\"]}","type":"string"},"type":"array","uniqueItems":true},"description":"Groups of labels used to identify/tag Security Cloud Control entities.","example":{"group1":["label-1","label-2"],"group2":["label-1","label-2"]},"type":"object"},"ungroupedLabels":{"description":"Set of free-labels used to identify/tag Security Cloud Control entities.","example":["label-a","label-b","label-c"],"items":{"description":"Set of free-labels used to identify/tag Security Cloud Control entities.","example":"[\"label-a\",\"label-b\",\"label-c\"]","type":"string"},"type":"array","uniqueItems":true}},"type":"object","$$ref":"#/components/schemas/Labels"},"licenses":{"description":"Specify a set of licenses to apply to the device.","enum":["BASE","CARRIER","MALWARE","THREAT","URLFilter"],"example":["BASE","CARRIER"],"items":{"description":"Specify a set of licenses to apply to the device.","enum":["BASE","CARRIER","THREAT","MALWARE","URLFilter","BASE","CARRIER","MALWARE","THREAT","URLFilter"],"example":"[\"BASE\",\"CARRIER\"]","type":"string"},"type":"array","uniqueItems":true},"name":{"description":"Specify a human-readable name for the device.","example":"My FTD","type":"string"},"performanceTier":{"description":"Specify the performance tier of the FTDv (required only if isVirtual is set to true)","enum":["FTDv5","FTDv10","FTDv20","FTDv30","FTDv50","FTDv100","FTDv"],"type":"string"},"virtual":{"description":"Indicate whether the FTD is a virtual or a physical device.","example":true,"type":"boolean"}},"required":["deviceType","fmcAccessPolicyUid","licenses","name"],"type":"object","$$ref":"#/components/schemas/FtdCreateOrUpdateInput"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"properties":{"cdoTransactionStatus":{"description":"The status of the transaction","enum":["PENDING","IN_PROGRESS","DONE","ERROR"],"example":"IN_PROGRESS","type":"string"},"entityUid":{"description":"The unique identifier of the entity that the transaction is triggered on. This can be empty, for a transaction that is not tied to an entity, such as transactions which refresh RA VPN sessions.","example":"f5f660d4-4b81-4374-877d-fbc4bee894e2","format":"uuid","type":"string"},"entityUrl":{"description":"A URL to access the entity that the transaction is triggered on. This can also be empty","example":"https://edge.us.cdo.cisco.com/platform/public-api/v1/inventory/devices/f5f660d4-4b81-4374-877d-fbc4bee894e2","type":"string"},"errorDetails":{"additionalProperties":{"description":"Transaction error details, if any","type":"string"},"description":"Transaction error details, if any","type":"object"},"errorMessage":{"description":"Transaction error message, if any","type":"string"},"lastUpdatedTime":{"description":"The time (UTC; represented using the RFC-3339 standard) at which the transaction status was last updated","example":"2023-12-13T08:15:44Z","format":"date-time","type":"string"},"submissionTime":{"description":"The time (UTC; represented using the RFC-3339 standard) at which the transaction was triggered","example":"2023-12-13T05:15:44Z","format":"date-time","type":"string"},"tenantUid":{"description":"The unique identifier of the tenant that the transaction triggered on.","example":"5131daad-e813-4b8f-8f42-be1e241e2cdb","format":"uuid","type":"string"},"transactionDetails":{"additionalProperties":{"description":"Transaction details, if any","type":"string"},"description":"Transaction details, if any","type":"object"},"transactionPollingUrl":{"description":"The URL to poll to track the progress of the transaction.","example":"https://edge.us.cdo.cisco.com/platform/v1/transactions/7131daad-e813-4b8f-8f42-be1e241e8cdb","type":"string"},"transactionType":{"description":"the type of the transaction","enum":["ONBOARD_ASA","ONBOARD_IOS","ONBOARD_DUO_ADMIN_PANEL","CREATE_FTD","ONBOARD_FTD_ZTP","REGISTER_FTD","DELETE_CDFMC_MANAGED_FTD","RECONNECT_ASA","READ_ASA","EXECUTE_CLI_COMMAND","DEPLOY_ASA_DEVICE_CHANGES","DEPLOY_FTD_DEVICE_CHANGES","INDEX_TENANT","TERMINATE_DEVICE_RA_VPN_SESSIONS","REFRESH_RA_VPN_SESSIONS","TERMINATE_USER_RA_VPN_SESSIONS","UPGRADE_ASA","UPGRADE_FTD","CREATE_SDC","SEND_AI_ASSISTANT_MESSAGE","MSP_CREATE_TENANT","MSP_ADD_USERS_TO_TENANT","MSP_ADD_USER_GROUPS_TO_TENANT","MSP_DELETE_USERS_FROM_TENANT","MSP_DELETE_USER_GROUPS_FROM_TENANT","MSP_ADD_EXISTING_TENANT","MSP_ENABLE_MULTICLOUD_DEFENSE","MSP_PROVISION_CDFMC","CREATE_USERS","EXECUTE_ASA_COMMAND"],"example":"ONBOARD_ASA","type":"string"},"transactionUid":{"description":"The unique identifier of the transaction triggered.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/CdoTransaction"}}},"description":"Security Cloud Control Transaction object that can be used to track the progress of the creation operation."},"400":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A 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":"A human-readable error description in English.","example":"sample error","type":"string"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"Invalid input provided. Check the response for details.","$$ref":"#/components/responses/http400BadRequest"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A human-readable error description in English.","example":"invalid_token","type":"string"},"errorDescription":{"description":"A human-readable error description in English.","example":"Your token is invalid","type":"string"}},"type":"object","$$ref":"#/components/schemas/AuthenticationError"}}},"description":"Request not authorized.","$$ref":"#/components/responses/http401Unauthorised"},"403":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A 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":"A human-readable error description in English.","example":"sample error","type":"string"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, on the error","example":{},"type":"object"},"description":"Additional details, if any, on the error","example":{},"type":"object"},"errorCode":{"description":"A 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":"A human-readable error description in English.","example":"sample error","type":"string"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Onboard FTD device","tags":["Inventory"],"__originalOperationId":"createFtdDevice","method":"post","path":"/v1/inventory/devices/ftds"}}