Update External Storage - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Update External Storage","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":"**Modify the external event storage configuration associated with the specified ID. _Check the response section for applicable examples (if any)._**","operationId":"updateExternalStorage","parameters":[{"description":"Identifier for the external event storage.","in":"path","name":"objectId","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 : PUT /fmc_config/v1/domain/domainUUID/integration/externalstorage/externalStorageUUID ( PUT to update the ExternalStorage )":{"value":{"crossLaunchEnabled":true,"deviceMap":{"deviceUUID":"logHostUUID"},"doNotStoreConnectionEvents":false,"id":"externalStorageUUID","isLinaLoggingEnabled":false,"logHosts":[{"logHost":"10.20.30.40","logId":"logHostUUID","logPort":8514}],"remoteQueryCert":"Remote Query Cert","remoteQueryHost":"example.com","remoteQueryPort":443,"type":"ExternalStorage","uiHost":"example.com","uiPort":443}},"Example 2 : PUT /fmc_config/v1/domain/domainUUID/integration/externalstorage/externalStorageUUID ( PUT with credentials to update the ExternalStorage and create Remote Query API user )":{"value":{"crossLaunchEnabled":true,"deviceMap":{"deviceUUID":"logHostUUID"},"doNotStoreConnectionEvents":false,"id":"externalStorageUUID","isLinaLoggingEnabled":false,"logHosts":[{"logHost":"10.20.30.40","logId":"logHostUUID","logPort":8514}],"password":"********","remoteQueryCert":"Remote Query Cert","remoteQueryHost":"example.com","remoteQueryPort":443,"type":"ExternalStorage","uiHost":"example.com","uiPort":443,"username":"admin"}}},"schema":{"type":"object","properties":{"crossLaunchEnabled":{"type":"boolean"},"description":{"type":"string"},"deviceMap":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLDeviceMap"},"doNotStoreConnectionEvents":{"type":"boolean"},"enabled":{"type":"boolean"},"id":{"type":"string"},"intValue":{"format":"int32","type":"integer"},"isLinaLoggingEnabled":{"type":"boolean"},"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"},"logHosts":{"items":{"type":"object","properties":{"logHost":{"type":"string"},"logId":{"type":"string"},"logPort":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/ILogHost"},"type":"array"},"longValue":{"format":"int32","type":"integer"},"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"},"network":{"type":"object","description":"A model representing Network object definition.","properties":{"description":{"description":"User provided resource description. ","type":"string"},"id":{"description":"Unique identifier representing response object.","type":"string"},"links":{"description":"Object containing related links.","type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"metadata":{"description":"Object representing metadata properties of NetworkObject.","type":"object","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":{"description":"User assigned resource name.","type":"string"},"overridable":{"description":"Boolean indicating whether object values can be overridden.","type":"boolean"},"overrideTargetId":{"description":"Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain).","type":"string"},"overrides":{"description":"An object override allows you to define an alternate value for an object on a device or domain.","type":"object","properties":{"parent":{"description":"Link to the parent/global resource which is overriden.","type":"object","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"},"target":{"description":"The device or the domain target on which this override is enabled.","type":"object","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"}},"$$ref":"#/components/schemas/IOverride"},"type":{"description":"Type associated with resource: NetworkObject.","type":"string"},"value":{"description":"Actual value of the network.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/NetworkObject"},"password":{"type":"string"},"remoteQueryCert":{"type":"string"},"remoteQueryHost":{"type":"string"},"remoteQueryPort":{"format":"int32","type":"integer"},"template":{"type":"string"},"type":{"type":"string"},"uiHost":{"type":"string"},"uiPort":{"format":"int32","type":"integer"},"username":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/ExternalStorage"}}},"description":"Input representation of external event storage config.","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : PUT /fmc_config/v1/domain/domainUUID/integration/externalstorage/externalStorageUUID ( PUT to update the ExternalStorage )":{"value":{"crossLaunchEnabled":true,"description":"Example","deviceMap":{"deviceUUID":"logHostUUID"},"doNotStoreConnectionEvents":false,"id":"externalStorageUUID","isLinaLoggingEnabled":false,"links":{"self":"/fmc_config/v1/domain/domainUUID/integration/externalstorage/externalStorageUUID"},"logHosts":[{"logHost":"10.20.30.40","logId":"logHostUUID","logPort":8514}],"name":"ExternalStorage externalStorageUUID","remoteQueryCert":"Remote Query Cert","remoteQueryHost":"example.com","remoteQueryPort":443,"type":"ExternalStorage","uiHost":"example.com","uiPort":443}},"Example 2 : PUT /fmc_config/v1/domain/domainUUID/integration/externalstorage/externalStorageUUID ( PUT with credentials to update the ExternalStorage and create Remote Query API user )":{"value":{"crossLaunchEnabled":true,"description":"Example","deviceMap":{"deviceUUID":"logHostUUID"},"doNotStoreConnectionEvents":false,"id":"externalStorageUUID","isLinaLoggingEnabled":false,"links":{"self":"/fmc_config/v1/domain/domainUUID/integration/externalstorage/externalStorageUUID"},"logHosts":[{"logHost":"10.20.30.40","logId":"logHostUUID","logPort":8514}],"name":"ExternalStorage externalStorageUUID","remoteQueryCert":"Remote Query Cert","remoteQueryHost":"example.com","remoteQueryPort":443,"type":"ExternalStorage","uiHost":"example.com","uiPort":443}}},"schema":{"type":"object","properties":{"crossLaunchEnabled":{"type":"boolean"},"description":{"type":"string"},"deviceMap":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLDeviceMap"},"doNotStoreConnectionEvents":{"type":"boolean"},"enabled":{"type":"boolean"},"id":{"type":"string"},"intValue":{"format":"int32","type":"integer"},"isLinaLoggingEnabled":{"type":"boolean"},"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"},"logHosts":{"items":{"type":"object","properties":{"logHost":{"type":"string"},"logId":{"type":"string"},"logPort":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/ILogHost"},"type":"array"},"longValue":{"format":"int32","type":"integer"},"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"},"network":{"type":"object","description":"A model representing Network object definition.","properties":{"description":{"description":"User provided resource description. ","type":"string"},"id":{"description":"Unique identifier representing response object.","type":"string"},"links":{"description":"Object containing related links.","type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"metadata":{"description":"Object representing metadata properties of NetworkObject.","type":"object","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":{"description":"User assigned resource name.","type":"string"},"overridable":{"description":"Boolean indicating whether object values can be overridden.","type":"boolean"},"overrideTargetId":{"description":"Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain).","type":"string"},"overrides":{"description":"An object override allows you to define an alternate value for an object on a device or domain.","type":"object","properties":{"parent":{"description":"Link to the parent/global resource which is overriden.","type":"object","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"},"target":{"description":"The device or the domain target on which this override is enabled.","type":"object","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"}},"$$ref":"#/components/schemas/IOverride"},"type":{"description":"Type associated with resource: NetworkObject.","type":"string"},"value":{"description":"Actual value of the network.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/NetworkObject"},"password":{"type":"string"},"remoteQueryCert":{"type":"string"},"remoteQueryHost":{"type":"string"},"remoteQueryPort":{"format":"int32","type":"integer"},"template":{"type":"string"},"type":{"type":"string"},"uiHost":{"type":"string"},"uiPort":{"format":"int32","type":"integer"},"username":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/ExternalStorage"}}},"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":["Integration"],"__originalOperationId":"updateExternalStorage","method":"put","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/integration/externalstorage/{objectId}"}}