Create Device Import - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Device Import","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":"**Package and export device configuration of specified Firewall Threat Defenses. _Check the response section for applicable examples (if any)._**","operationId":"createDeviceImport","parameters":[{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"requestBody":{"content":{"multipart/form-data":{"examples":{"Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import device configuration by uploading sfo file )":{"value":{"deviceList":["00e5091a-ca4e-11eb-872b-edfdb3a31887","7de01414-02b7-4693-acf1-8f30a92f2c1f","ec48d989-fed8-4004-99a0-7e6d2a2319d5","02531776-670d-46e7-8e0f-045070a27d59"],"payloadFile":".sfo format device configuration file"}},"Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import device configuration from remote storage using AWS pre-signed url )":{"value":{"deviceList":["00e5091a-ca4e-11eb-872b-edfdb3a31887","7de01414-02b7-4693-acf1-8f30a92f2c1f","ec48d989-fed8-4004-99a0-7e6d2a2319d5","02531776-670d-46e7-8e0f-045070a27d59"],"importOptions":{"options":{"checksum":"0c1b9614e4172e2135d6a06851c0fc5d64689564fc9f5c0543049eb2505c1528","form":{"AWSAccessKeyId":"AKIASSHKUIQN35C746L","bucket":"sample"},"headers":{"X-Amz-Algorithm":"AWS4-HMAC-SHA256","X-Amz-Date":"20210519T191457Z","X-Amz-Expires":"604800","X-Amz-Signature":"08e13665182fa198912dda24a18318958287c38d9d589898982f186cffe2e83fd66f","X-Amz-SignedHeaders":"host"}},"url":"https://sampleBucket.s3.amazonaws.com/prefix/object"},"payloadFile":".sfo format device configuration file"}},"Example 3 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import device configuration from azure storage )":{"value":{"deviceList":["00e5091a-ca4e-11eb-872b-edfdb3a31887","7de01414-02b7-4693-acf1-8f30a92f2c1f","ec48d989-fed8-4004-99a0-7e6d2a2319d5","02531776-670d-46e7-8e0f-045070a27d59"],"importOptions":{"options":{"checksum":"0c1b9614e4172e2135d6a06851c0fc5d64689564fc9f5c0543049eb2505c1528"},"url":"https://myaccount.blob.core.windows.net/sfo/DeviceExport.sfo?sv=2021-02-12&st=2021-02-09&se=2021-02-10&sr=c&sp=r&si=YWJjZGVmZw%3d%3d&sig=dD80ihBh5jfNpymO5Hg1IdiJIEvHcJpCMiCMnN%2fRnbI%3d"}}},"Example 4 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import S2S Only configuration by uploading sfo file )":{"value":{"deviceList":["00e5091a-ca4e-11eb-872b-edfdb3a31887","7de01414-02b7-4693-acf1-8f30a92f2c1f","ec48d989-fed8-4004-99a0-7e6d2a2319d5","02531776-670d-46e7-8e0f-045070a27d59"],"payloadFile":".sfo format device configuration file"}}},"schema":{"properties":{"deviceList":{"description":"Specify list of devices to be imported.","type":"string"},"deviceMappingOptions":{"description":"","type":"string"},"importOptions":{"description":"Optional device configuration import options.","type":"string"},"payloadFile":{"description":"File containing the device configurations in \u003ccode\u003e.sfo\u003c/code\u003e format.","format":"binary","type":"string"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"examples":{"Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import device configuration by uploading sfo file )":{"value":{"deviceList":["00e5091a-ca4e-11eb-872b-edfdb3a31887","7de01414-02b7-4693-acf1-8f30a92f2c1f","ec48d989-fed8-4004-99a0-7e6d2a2319d5","02531776-670d-46e7-8e0f-045070a27d59"],"importOptions":{"options":{"checksum":"ed8c8ea4c7733107753c000d58ab790903a96ea5756aa08b608429b029301377"}},"metadata":{"task":{"description":"Device configuration import task queued","id":"93b2c18a-cb69-11eb-a8f1-27e3d065c679","links":{"self ":"/fmc_config/v1/domain/DomainUUID/job/taskstatuses/93b2c18a-cb69-11eb-a8f1-27e3d065c679"},"status":"200","taskType":"DEVICE_IMPORT"}}}},"Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import device configuration from remote storage using AWS pre-signed url )":{"value":{"deviceList":["00e5091a-ca4e-11eb-872b-edfdb3a31887","7de01414-02b7-4693-acf1-8f30a92f2c1f","ec48d989-fed8-4004-99a0-7e6d2a2319d5","02531776-670d-46e7-8e0f-045070a27d59"],"importOptions":{"options":{"checksum":"0c1b9614e4172e2135d6a06851c0fc5d64689564fc9f5c0543049eb2505c1528","form":{"AWSAccessKeyId":"AKIASSHKUIQN35C746L","bucket":"sample"},"headers":{"X-Amz-Algorithm":"AWS4-HMAC-SHA256","X-Amz-Date":"20210519T191457Z","X-Amz-Expires":"604800","X-Amz-Signature":"08e13665182fa198912dda24a18318958287c38d9d589898982f186cffe2e83fd66f","X-Amz-SignedHeaders":"host"}},"url":"https://sampleBucket.s3.amazonaws.com/prefix/object"},"metadata":{"task":{"description":"Device configuration import task queued","id":"93b2c18a-cb69-11eb-a8f1-27e3d065c679","links":{"self ":"/fmc_config/v1/domain/DomainUUID/job/taskstatuses/93b2c18a-cb69-11eb-a8f1-27e3d065c679"},"status":"200","taskType":"DEVICE_IMPORT"}}}},"Example 3 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import device configuration from azure storage )":{"value":{"deviceList":["00e5091a-ca4e-11eb-872b-edfdb3a31887","7de01414-02b7-4693-acf1-8f30a92f2c1f","ec48d989-fed8-4004-99a0-7e6d2a2319d5","02531776-670d-46e7-8e0f-045070a27d59"],"importOptions":{"options":{"checksum":"0c1b9614e4172e2135d6a06851c0fc5d64689564fc9f5c0543049eb2505c1528"},"url":"https://myaccount.blob.core.windows.net/sfo/DeviceExport.sfo?sv=2021-02-12&st=2021-02-09&se=2021-02-10&sr=c&sp=r&si=YWJjZGVmZw%3d%3d&sig=dD80ihBh5jfNpymO5Hg1IdiJIEvHcJpCMiCMnN%2fRnbI%3d"},"metadata":{"task":{"description":"Device configuration import task queued","id":"93b2c18a-cb69-11eb-a8f1-27e3d065c679","links":{"self ":"/fmc_config/v1/domain/DomainUUID/job/taskstatuses/93b2c18a-cb69-11eb-a8f1-27e3d065c679"},"status":"200","taskType":"DEVICE_IMPORT"}}}},"Example 4 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import S2S Only configuration by uploading sfo file )":{"value":{"deviceList":["00e5091a-ca4e-11eb-872b-edfdb3a31887","7de01414-02b7-4693-acf1-8f30a92f2c1f","ec48d989-fed8-4004-99a0-7e6d2a2319d5","02531776-670d-46e7-8e0f-045070a27d59"],"importOptions":{"includeDeviceCertificates":"false","includeS2sVpnPoliciesOnly":"true","includeSharedPolicies":"false","includeVpnPolicies":"false"},"metadata":{"task":{"description":"Device configuration import task queued","id":"93b2c18a-cb69-11eb-a8f1-27e3d065c679","links":{"self ":"/fmc_config/v1/domain/DomainUUID/job/taskstatuses/93b2c18a-cb69-11eb-a8f1-27e3d065c679"},"status":"200","taskType":"DEVICE_IMPORT"}}}}},"schema":{"type":"object","description":"An object that represents the details for device configuration import.","properties":{"description":{"type":"string"},"deviceList":{"description":"UUIDs of devices to be verified with metadata before import.","items":{"type":"string"},"type":"array"},"deviceMappingOptions":{"type":"object","properties":{"interfaceMapping":{"items":{"type":"object","properties":{"sourceInterface":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","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"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"targetInterface":{"type":"object","properties":{"id":{"type":"string"},"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"},"name":{"type":"string"},"overrideableInterfaceAttributes":{"type":"object","properties":{"autoNeg":{"type":"boolean"},"duplex":{"enum":["AUTO","FULL","HALF"],"type":"string"},"fecMode":{"enum":["AUTO","CL108RS","CL74FC","CL91RS","DISABLE"],"type":"string"},"speed":{"enum":["AUTO","TEN_MBPS","HUNDRED_MBPS","ONE_GBPS","TEN_GBPS","TWENTY_FIVE_GBPS","FORTY_GBPS","HUNDRED_GBPS","TWO_HUNDRED_GBPS","FOUR_HUNDRED_GBPS","DETECT_SFP"],"type":"string"}},"$$ref":"#/components/schemas/IOverrideableInterfaceAttributes"},"selectedInterfaces":{"items":{"type":"object","properties":{"id":{"type":"string"},"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"},"name":{"type":"string"},"overrideableInterfaceAttributes":{"type":"object","properties":{"autoNeg":{"type":"boolean"},"duplex":{"enum":["AUTO","FULL","HALF"],"type":"string"},"fecMode":{"enum":["AUTO","CL108RS","CL74FC","CL91RS","DISABLE"],"type":"string"},"speed":{"enum":["AUTO","TEN_MBPS","HUNDRED_MBPS","ONE_GBPS","TEN_GBPS","TWENTY_FIVE_GBPS","FORTY_GBPS","HUNDRED_GBPS","TWO_HUNDRED_GBPS","FOUR_HUNDRED_GBPS","DETECT_SFP"],"type":"string"}},"$$ref":"#/components/schemas/IOverrideableInterfaceAttributes"},"type":{"type":"string"}},"$$ref":"#/components/schemas/SelectedInterface"},"type":"array"},"type":{"type":"string"}},"$$ref":"#/components/schemas/ITargetInterface"}},"$$ref":"#/components/schemas/IDeviceConfigInterfaceMapping"},"type":"array"},"sourceDevice":{"type":"string"},"targetDevice":{"type":"string"}},"$$ref":"#/components/schemas/IDeviceMappingOptions"},"files":{"description":"Specifies device configuration file in `.sfo` format.","items":{"type":"object","properties":{"attrib":{"type":"string"},"id":{"type":"string"},"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"},"name":{"type":"string"},"path":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IFileWrapper"},"type":"array"},"filesMap":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLFilesMap"},"id":{"type":"string"},"importOptions":{"description":"Import options.","type":"object","properties":{"changeDeviceBeforeImport":{"type":"boolean"},"conflictOption":{"enum":["NEW","LATEST","RENAME_IMPORTED","REPLACE_EXISTING","KEEP_EXISTING","REUSE_EXISTING"],"type":"string"},"includeDeviceCertificates":{"type":"boolean"},"includeS2sVpnPoliciesOnly":{"type":"boolean"},"includeSharedPolicies":{"type":"boolean"},"includeVpnPolicies":{"type":"boolean"},"options":{"type":"object","properties":{"checksum":{"type":"string"},"form":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLForm"},"headers":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLHeaders"}},"$$ref":"#/components/schemas/IDeviceImportExportRequestOptions"},"url":{"type":"string"}},"$$ref":"#/components/schemas/IDeviceImportExportOptions"},"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"},"metadata":{"type":"object","description":"Defines read only details about the object - whether it is system defined, last user who modified the object etc.","properties":{"domain":{"description":"Defines the domains this instance belongs to (if applicable).","type":"object","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","type":"object","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"},"name":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"isLocked":{"type":"boolean"},"lastUser":{"description":"The last user who modified this instance.","type":"object","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","type":"object","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"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance","type":"object","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"description":"The last updated timestamp.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Metadata"},"name":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/DeviceImport"}}},"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":["Devices"],"__originalOperationId":"createDeviceImport","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/operational/imports"}}