Create FTD Template Physical Interface - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create FTD Template Physical Interface","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":"**Add physical interfaces to the device template. _Check the response section for applicable examples (if any)._**","operationId":"createFTDTemplatePhysicalInterface","parameters":[{"description":"UUID of the ticket for tracking the configuration changes.","in":"header","name":"ticket-id","required":false,"schema":{"type":"string"}},{"description":"The container id under which this specific resource is contained.","in":"path","name":"containerUUID","required":true,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"requestBody":{"content":{"application/json":{"examples":{"Example 1 : POST /fmc_config/v1/domain/domainUUID/templates/devicetemplates/containerUUID/templateinterfaces ( POST method for Template physical interface for a given container UUID )":{"value":{"port":4,"slot":1}},"Example 6 : POST /fmc_config/v1/domain/domainUUID/templates/devicetemplates/containerUUID/templateinterfaces ( FAILURE: Port is not provided in the payload )":{"value":{"slot":1}},"Example 7 : POST /fmc_config/v1/domain/domainUUID/templates/devicetemplates/containerUUID/templateinterfaces ( FAILURE: Slot is not provided in the payload )":{"value":{"port":4}},"Example 8 : POST /fmc_config/v1/domain/domainUUID/templates/devicetemplates/containerUUID/templateinterfaces ( FAILURE: An empty payload is provided )":{"value":{}}},"schema":{"type":"object","properties":{"description":{"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"},"metadata":{"type":"object","properties":{"domain":{"type":"object","description":"The details about the domain.","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":{"type":"object","description":"This object defines details about the user.","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"},"physicalInterface":{"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"},"readOnly":{"type":"object","description":"Defines the read only conditions if the referenced resource is read only.","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"},"state":{"type":"string"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/FTDTemplateInterfaceMetadata"},"name":{"type":"string"},"port":{"format":"int32","type":"integer"},"slot":{"format":"int32","type":"integer"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/FTDTemplatePhysicalInterface"}}},"description":"The input representation of template physical interface model.","required":true},"responses":{"201":{"content":{"application/json":{"examples":{"Example 1 : POST /fmc_config/v1/domain/domainUUID/templates/devicetemplates/containerUUID/templateinterfaces ( POST method for Template physical interface for a given container UUID )":{"value":{"id":"0050568A-3B37-0ed3-0000-103079215165","links":{"self":"https://u32c01p10-vrouter.cisco.com:30525/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/templates/devicetemplates/b6ec89a2-1017-11ee-a1ae-dceab7cdbae5/templateinterfaces/0050568A-3B37-0ed3-0000-103079215165"},"metadata":{"physicalInterface":{"id":"0050568A-3B37-0ed3-0000-103079215165","links":{"self":"https://u32c01p10-vrouter.cisco.com:30525/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/devicerecords/b6ec89a2-1017-11ee-a1ae-dceab7cdbae5/physicalinterfaces/0050568A-3B37-0ed3-0000-103079215165"},"type":"PhysicalInterface"},"state":"COMMITTED","timestamp":1687861274283},"name":"Ethernet1/4","port":4,"slot":1,"type":"TemplateInterface"}}},"schema":{"type":"object","properties":{"description":{"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"},"metadata":{"type":"object","properties":{"domain":{"type":"object","description":"The details about the domain.","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":{"type":"object","description":"This object defines details about the user.","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"},"physicalInterface":{"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"},"readOnly":{"type":"object","description":"Defines the read only conditions if the referenced resource is read only.","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"},"state":{"type":"string"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/FTDTemplateInterfaceMetadata"},"name":{"type":"string"},"port":{"format":"int32","type":"integer"},"slot":{"format":"int32","type":"integer"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/FTDTemplatePhysicalInterface"}}},"description":"Created"},"422":{"content":{"application/json":{"examples":{"Example 6 : POST /fmc_config/v1/domain/domainUUID/templates/devicetemplates/containerUUID/templateinterfaces ( FAILURE: Port is not provided in the payload )":{"value":{"error":{"category":"FRAMEWORK","messages":[{"description":"Port cannot be empty. Port should be in the range of 1 to 16."}],"severity":"ERROR"}}},"Example 7 : POST /fmc_config/v1/domain/domainUUID/templates/devicetemplates/containerUUID/templateinterfaces ( FAILURE: Slot is not provided in the payload )":{"value":{"error":{"category":"FRAMEWORK","messages":[{"description":"Slot cannot be empty. Slot should be either 1 or 2."}],"severity":"ERROR"}}},"Example 8 : POST /fmc_config/v1/domain/domainUUID/templates/devicetemplates/containerUUID/templateinterfaces ( FAILURE: An empty payload is provided )":{"value":{"error":{"category":"FRAMEWORK","messages":[{"description":"Both slot and port are empty. Slot and plot cannot be null."}],"severity":"ERROR"}}}},"schema":{"type":"object","properties":{"description":{"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"},"metadata":{"type":"object","properties":{"domain":{"type":"object","description":"The details about the domain.","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":{"type":"object","description":"This object defines details about the user.","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"},"physicalInterface":{"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"},"readOnly":{"type":"object","description":"Defines the read only conditions if the referenced resource is read only.","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"},"state":{"type":"string"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/FTDTemplateInterfaceMetadata"},"name":{"type":"string"},"port":{"format":"int32","type":"integer"},"slot":{"format":"int32","type":"integer"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/FTDTemplatePhysicalInterface"}}},"description":"Unprocessable Entity"},"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":["Templates"],"__originalOperationId":"createFTDTemplatePhysicalInterface","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/templates/devicetemplates/{containerUUID}/templateinterfaces"}}