{"type":"api","title":"Update property to component, group or device","meta":{"id":"/apps/pubhub/media/cyber-vision-5-3/e889ca86e22c7a47e33bc1438ffdba51f3384493/262737b2-b3c2-32cd-b07b-fdbdcd23918f","info":{"description":"RESTful API to manage the resources of Cisco Cyber Vision centers.","title":"Cisco Cyber Vision center v3 API.","version":"3.0.0-5.3.0"},"security":[{"token":[]}],"tags":[{"description":"Routes to configure the Active Discovery mode.","name":"ActiveDiscovery"},{"description":"Activities are an aggregation of flows between components.","name":"Activities"},{"description":"In monitor mode, these routes allow to retrieve and review differences between the actual network activity and the baseline description.","name":"BaselineDifferences"},{"description":"A baseline is used for monitor mode. They represent a snapshot of the network.","name":"Baselines"},{"description":"Components are logical nodes of the network.","name":"Components"},{"description":"Routes to manage network organization.","name":"CustomNetwork"},{"description":"Routes to manage custom properties that can be added to components or groups.","name":"CustomProperties"},{"description":"Routes to retrieve statistics and dashboard information. ","name":"Dashboard"},{"description":"Routes to retrieve information about the sensor deployment tokens.","name":"Deployments"},{"description":"A Device is a physical device that host a software that communicates on the network","name":"Devices"},{"description":"Routes to retrieve about external communications.","name":"ExternalCommunication"},{"description":"Flows represent a network interaction between two components.","name":"Flows"},{"description":"Routes to retrieve information about the global credentials.","name":"GlobalCredentials"},{"description":"Routes to get a graphical representation of the components, activities, etc.","name":"Graph"},{"description":"Groups are a logical way to organize components.","name":"Groups"},{"description":"Various routes to get more information about a center.","name":"Misc"},{"description":"Routes to access the application parameters such as security options and allow to manage custom parameters.","name":"Parameters"},{"description":"Routes to retrieve information about pcap files replayed.","name":"PcapReplays"},{"description":"Presets are a way to filter data and prepare visualizations.","name":"Presets"},{"description":"Preset Based Reports","name":"Reports"},{"description":"Routes to access the configuration of the risk scores.","name":"RiskScores"},{"description":"Routes to browse sensor folders.","name":"SensorExplorer"},{"description":"Routes to retrieve information about the enrolled sensors.","name":"Sensors"},{"description":"Routes to retrieve information about the sensor templates.","name":"SensorTemplates"},{"description":"Tags are meaningful labels applied to components and activities to describe network behaviors and device properties.","name":"Tags"},{"description":"Vulnerabilities are known security threats that could allow an attacker to gain unauthorized privileges.","name":"Vulnerabilities"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"swagger":"2.0","basePath":"/api/3.0/","schemes":["https"],"securityDefinitions":{"token":{"description":"API token created in the Cyber Vision administration UI","type":"apiKey","name":"x-token-id","in":"header"}}},"spec":{"description":"Update a property to a component, a group or a device. Devices are volatile objects in Cyber Vision: expect devices to be deleted at any moment and extra properties to be lost.\n","tags":["CustomProperties"],"summary":"Update property to component, group or device.","operationId":"putExtraField","parameters":[{"enum":["components","groups","devices"],"type":"string","description":"the object (components, groups or devices) where to update extra property","name":"object","in":"path","required":true},{"type":"string","description":"the object id (component id or group id)","name":"id","in":"path","required":true},{"type":"string","description":"property id to update","name":"propertyId","in":"path","required":true},{"description":"the property to update","name":"property","in":"body","required":true,"schema":{"type":"object","properties":{"label":{"type":"string","x-go-name":"Label"},"value":{"type":"string","x-go-name":"Value"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/extrafield","$$ref":"#/definitions/UpdateExtraFieldBody"}}],"responses":{"200":{"description":"extra property successfully updated","schema":{"type":"object","properties":{"Msg":{"type":"string"},"Status":{"type":"integer","format":"int64"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/scv/helper","$$ref":"#/definitions/SimpleResponse"},"examples":{"application/json":{"Msg":"ok","Status":200}}},"400":{"description":"bad request"},"401":{"description":"incorrect token"},"404":{"description":"not found"},"412":{"description":"precondition failed. Label should be \u003c= 60 characters and Value \u003c= 180 characters"},"default":{"description":"unexpected error"}},"__originalOperationId":"putExtraField","consumes":["application/json"],"produces":["application/json"],"security":[{"token":[]}],"method":"put","path":"/{object}/{id}/usersProperties/{propertyId}"}}