Delete Ospf Interface Policy Model - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Delete Ospf Interface Policy Model","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":"**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**","operationId":"deleteOspfInterfacePolicyModel","parameters":[{"description":"[DEV ERROR: Missing description]","in":"path","name":"objectId","required":true,"schema":{"type":"string"}},{"description":"[DEV ERROR: Missing description]","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"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface/ospfinterfaceuuid ( Success: Test DELETE method for OSPF Interface )":{"value":{"deviceInterface":{"id":"uuid","name":"Interface name","type":"Interface"},"id":"ospfinterfaceuuid","links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface/ospfinterfaceuuid"},"ospfProtocolConfiguration":{"enableBFD":"boolean","filterOutgoingLSA":"boolean","ignoreMtuMismatch":"boolean","ospfAuthentication":{"keyChain":{"authKey":{"id":"uuid","name":"String","overridable":"boolean"},"authType":"keychainauthentication"}},"ospfInterval":{"helloInterval":{"deadInterval":"integer","helloInterval":"integer","neighborDetectionType":"ospfdeadintervalmechanism"},"helloMultiplier":{"helloMultiplier":"integer"}},"packetCost":"short","priority":"short","ptpNonBroadcast":"boolean","retransmitInterval":"short","transmitDelay":"short"},"type":"OspfInterface"}}},"schema":{"type":"object","properties":{"description":{"type":"string"},"deviceInterface":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"ifname":{"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","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"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"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"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/IFTDInterface"},"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","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"},"ospfProtocolConfiguration":{"type":"object","properties":{"enableBFD":{"type":"boolean"},"filterOutgoingLSA":{"type":"boolean"},"ignoreMtuMismatch":{"type":"boolean"},"ospfAuthentication":{"type":"object","properties":{"areaAuth":{"type":"object","properties":{"authType":{"type":"string"},"md5AuthList":{"items":{"type":"object","properties":{"authType":{"type":"string"},"md5Key":{"type":"string"},"md5KeyId":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IOspfMD5Auth"},"type":"array"},"passwdAuth":{"type":"object","properties":{"authKey":{"type":"string"},"authType":{"type":"string"}},"$$ref":"#/components/schemas/IOspfPasswdAuth"}},"$$ref":"#/components/schemas/IOspfAreaAuth"},"keyChain":{"type":"object","properties":{"authKey":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"keys":{"items":{"type":"object","properties":{"acceptLifeTime":{"type":"object","properties":{"endLifeTimeValue":{"type":"string"},"endLifetimeType":{"enum":["INFINITE","DURATION","DATETIME"],"type":"string"},"startLifeTimeValue":{"type":"string"},"timeZone":{"type":"string"}},"$$ref":"#/components/schemas/ILifeTime"},"authAlgorithm":{"type":"string"},"authString":{"type":"object","properties":{"cryptoEncryptionType":{"enum":["PLAINTEXT"],"type":"string"},"cryptoKeyString":{"type":"string"}},"$$ref":"#/components/schemas/IAuthTypeAndString"},"keyId":{"format":"int32","type":"integer"},"sendLifeTime":{"type":"object","properties":{"endLifeTimeValue":{"type":"string"},"endLifetimeType":{"enum":["INFINITE","DURATION","DATETIME"],"type":"string"},"startLifeTimeValue":{"type":"string"},"timeZone":{"type":"string"}},"$$ref":"#/components/schemas/ILifeTime"}},"$$ref":"#/components/schemas/IKeyObject"},"type":"array"},"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","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"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"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"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/IKeyChainObject"},"authType":{"type":"string"}},"$$ref":"#/components/schemas/IOspfKeyChainAuth"},"md5AuthList":{"items":{"type":"object","properties":{"authType":{"type":"string"},"md5Key":{"type":"string"},"md5KeyId":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IOspfMD5Auth"},"type":"array"},"passwdAuth":{"type":"object","properties":{"authKey":{"type":"string"},"authType":{"type":"string"}},"$$ref":"#/components/schemas/IOspfPasswdAuth"}},"$$ref":"#/components/schemas/IOspfAuthentication"},"ospfInterval":{"type":"object","properties":{"helloInterval":{"type":"object","properties":{"deadInterval":{"format":"int32","type":"integer"},"helloInterval":{"format":"int32","type":"integer"},"neighborDetectionType":{"type":"string"}},"$$ref":"#/components/schemas/IOspfDeadIntervalMechanism"},"helloMultiplier":{"type":"object","properties":{"helloMultiplier":{"format":"int32","type":"integer"},"neighborDetectionType":{"type":"string"}},"$$ref":"#/components/schemas/IOspfHelloMultiplierMechanism"}},"$$ref":"#/components/schemas/IOspfInterval"},"packetCost":{"format":"int32","type":"integer"},"priority":{"format":"int32","type":"integer"},"ptpNonBroadcast":{"type":"boolean"},"retransmitInterval":{"format":"int32","type":"integer"},"transmitDelay":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IOspfProtocolConfiguration"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/OspfInterfacePolicyModel"}}},"description":"OK"},"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":"deleteOspfInterfacePolicyModel","method":"delete","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ospfinterface/{objectId}"}}