Onboard FTD device - Security Cloud Control API Documentation

{"type":"api","title":"Onboard FTD device","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/3cbd2b31d746744f0037786d8499488ecf93488c/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control API","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"},"version":"1.5.0"},"tags":[{"name":"Cloud-delivered FMC","x-displayName":"Cloud-delivered FMC"},{"name":"Remote Access Monitoring","x-displayName":"Remote Access Monitoring"},{"name":"Users","x-displayName":"Users"},{"name":"Search","x-displayName":"Search"},{"name":"ASA Access Rules","x-displayName":"ASA Access Rules"},{"name":"Access Groups","x-displayName":"Access Groups"},{"name":"Inventory","x-displayName":"Inventory"},{"name":"Connectors","x-displayName":"Connectors"},{"name":"Command Line Interface","x-displayName":"Command Line Interface"},{"name":"Change Requests","x-displayName":"Change Requests"},{"name":"AI Assistant","x-displayName":"AI Assistant"},{"name":"Tenant Management","x-displayName":"Tenant Management"},{"name":"Meta","x-displayName":"Meta"},{"name":"Changelogs","x-displayName":"Changelogs"},{"name":"Audit Logs","x-displayName":"Audit Logs"},{"name":"swagger-redirect-controller","x-displayName":"swagger-redirect-controller"},{"name":"Object Management","x-displayName":"Object Management"},{"name":"MSP","x-displayName":"MSP"},{"name":"Transactions","x-displayName":"Transactions"}],"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":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"spec":{"tags":["Inventory"],"summary":"Onboard FTD device","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":{"required":["deviceType","fmcAccessPolicyUid","licenses","name"],"type":"object","properties":{"name":{"type":"string","description":"Specify a human-readable name for the device.","example":"My FTD"},"licenses":{"uniqueItems":true,"type":"array","description":"Specify a set of licenses to apply to the device.","example":["BASE","CARRIER"],"items":{"type":"string","description":"Specify a set of licenses to apply to the device.","example":"[\"BASE\",\"CARRIER\"]","enum":["BASE","CARRIER","THREAT","MALWARE","URLFilter","BASE","CARRIER","MALWARE","THREAT","URLFilter"]},"enum":["BASE","CARRIER","MALWARE","THREAT","URLFilter"]},"virtual":{"type":"boolean","description":"Indicate whether the FTD is a virtual or a physical device.","example":true},"fmcAccessPolicyUid":{"type":"string","description":"Specify the unique identifier, represented as a UUID, of the FMC access policy to apply to this device.","format":"uuid","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb"},"performanceTier":{"type":"string","description":"Specify the performance tier of the FTDv (required only if isVirtual is set to true)","enum":["FTDv5","FTDv10","FTDv20","FTDv30","FTDv50","FTDv100","FTDv"]},"labels":{"type":"object","properties":{"groupedLabels":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Groups of labels used to identify/tag Security Cloud Control entities.","example":{"group1":["label-1","label-2"],"group2":["label-1","label-2"]},"items":{"type":"string","description":"Groups of labels used to identify/tag Security Cloud Control entities.","example":"{\"group1\":[\"label-1\",\"label-2\"],\"group2\":[\"label-1\",\"label-2\"]}"}},"description":"Groups of labels used to identify/tag Security Cloud Control entities.","example":{"group1":["label-1","label-2"],"group2":["label-1","label-2"]}},"ungroupedLabels":{"uniqueItems":true,"type":"array","description":"Set of free-labels used to identify/tag Security Cloud Control entities.","example":["label-a","label-b","label-c"],"items":{"type":"string","description":"Set of free-labels used to identify/tag Security Cloud Control entities.","example":"[\"label-a\",\"label-b\",\"label-c\"]"}}},"description":"Labels used to identify/tag Security Cloud Control entities.","$$ref":"#/components/schemas/Labels"},"deviceType":{"type":"string","description":"Specify the type of the FTD. The only supported type of FTD is CDFMC_MANAGED_FTD","enum":["CDFMC_MANAGED_FTD"]}},"$$ref":"#/components/schemas/FtdCreateOrUpdateInput"}}},"required":true},"responses":{"202":{"description":"Security Cloud Control Transaction object that can be used to track the progress of the creation operation.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantUid":{"type":"string","description":"The unique identifier of the tenant that the transaction triggered on.","format":"uuid","example":"5131daad-e813-4b8f-8f42-be1e241e2cdb"},"transactionUid":{"type":"string","description":"The unique identifier of the transaction triggered.","format":"uuid","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb"},"entityUid":{"type":"string","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.","format":"uuid","example":"f5f660d4-4b81-4374-877d-fbc4bee894e2"},"entityUrl":{"type":"string","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"},"transactionPollingUrl":{"type":"string","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"},"submissionTime":{"type":"string","description":"The time (UTC; represented using the RFC-3339 standard) at which the transaction was triggered","format":"date-time","example":"2023-12-13T05:15:44Z"},"lastUpdatedTime":{"type":"string","description":"The time (UTC; represented using the RFC-3339 standard) at which the transaction status was last updated","format":"date-time","example":"2023-12-13T08:15:44Z"},"transactionDetails":{"type":"object","additionalProperties":{"type":"string","description":"Transaction details, if any"},"description":"Transaction details, if any"},"errorMessage":{"type":"string","description":"Transaction error message, if any"},"errorDetails":{"type":"object","additionalProperties":{"type":"string","description":"Transaction error details, if any"},"description":"Transaction error details, if any"},"transactionType":{"type":"string","description":"the type of the transaction","example":"ONBOARD_ASA","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","INDEX_TENANT","TERMINATE_DEVICE_RA_VPN_SESSIONS","REFRESH_RA_VPN_SESSIONS","TERMINATE_USER_RA_VPN_SESSIONS","DEVICE_UPGRADE","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"]},"cdoTransactionStatus":{"type":"string","description":"The status of the transaction","example":"IN_PROGRESS","enum":["PENDING","IN_PROGRESS","DONE","ERROR"]}},"$$ref":"#/components/schemas/CdoTransaction"}}}},"400":{"description":"Invalid input provided. Check the response for details.","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","description":"A unique code that describes the error.","example":"INVALID_INPUT","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST"]},"errorMsg":{"type":"string","description":"A human-readable error description in English.","example":"sample error"},"details":{"type":"object","additionalProperties":{"type":"object","description":"Additional details, if any, on the error","example":{}},"description":"Additional details, if any, on the error","example":{}}},"$$ref":"#/components/schemas/CommonApiError"}}},"$$ref":"#/components/responses/http400BadRequest"},"401":{"description":"Request not authorized.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"A human-readable error description in English.","example":"invalid_token"},"errorDescription":{"type":"string","description":"A human-readable error description in English.","example":"Your token is invalid"}},"$$ref":"#/components/schemas/AuthenticationError"}}},"$$ref":"#/components/responses/http401Unauthorised"},"403":{"description":"User does not have sufficient privileges to perform this operation.","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","description":"A unique code that describes the error.","example":"INVALID_INPUT","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST"]},"errorMsg":{"type":"string","description":"A human-readable error description in English.","example":"sample error"},"details":{"type":"object","additionalProperties":{"type":"object","description":"Additional details, if any, on the error","example":{}},"description":"Additional details, if any, on the error","example":{}}},"$$ref":"#/components/schemas/CommonApiError"}}},"$$ref":"#/components/responses/http403Forbidden"},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","description":"A unique code that describes the error.","example":"INVALID_INPUT","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST"]},"errorMsg":{"type":"string","description":"A human-readable error description in English.","example":"sample error"},"details":{"type":"object","additionalProperties":{"type":"object","description":"Additional details, if any, on the error","example":{}},"description":"Additional details, if any, on the error","example":{}}},"$$ref":"#/components/schemas/CommonApiError"}}}}},"security":[{"bearerAuth":[]}],"__originalOperationId":"createFtdDevice","method":"post","path":"/v1/inventory/devices/ftds"}}