{"type":"api","title":"Update Network Object","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/b36b2683-243e-3edc-8c84-85b5f4140afd","info":{"version":"1.0.1","title":"Cisco Secure Access Network and Service Objects API","description":"Manage the Network and Service Objects in the organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Network Objects","description":"Manage the Network Objects in the organization."},{"name":"Network Object Groups","description":"Manage the Network Object Groups in the organization."},{"name":"Service Objects","description":"Manage the Service Objects in the organization."},{"name":"Service Object Groups","description":"Manage the Service Object Groups in the organization."},{"name":"Unified Objects","description":"List the Objects and Object Groups in the organization."},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/policies/network-and-service-objects-overview.md","uri":"secure-access-api-reference-network-and-service-objects-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"policies/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"Client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"policies.objects.networkObjects:read":"Read the Network Object resources","policies.objects.networkObjectGroups:read":"Read the Network Object Group resources","policies.objects.networkObjects:write":"Write the Network Object resources","policies.objects.networkObjectGroups:write":"Write the Network Object Group resources","policies.objects.serviceObjects:read":"Read the Service Object resources","policies.objects.serviceObjectGroups:read":"Read the Service Object Groups resources","policies.objects.serviceObjects:write":"Write the Service Object resources","policies.objects.serviceObjectGroups:write":"Write the Service Object Group resources"}}}}}},"spec":{"tags":["Network Objects","Secure Access"],"summary":"Update Network Object","description":"Update a Network Object in the organization.","security":[{"oauthFlow":["policies.objects.networkObjects:write"]}],"operationId":"updateNetworkObject","parameters":[{"name":"networkObjectId","in":"path","description":"The ID of the Network Object.","required":true,"schema":{"type":"integer"},"example":123456,"$$ref":"#/components/parameters/networkObjectId"}],"requestBody":{"description":"Create the Network Object with the properties.","content":{"application/json":{"schema":{"type":"object","description":"The properties of the Network Object request body.","required":["name","value"],"properties":{"name":{"type":"string","description":"The name of the Network Object.","example":"Company network"},"description":{"type":"string","description":"The description of the Network Object.","example":"network object description"},"value":{"type":"object","description":"The values of the Network Object for the network, host, range, or fully-qualified domain name (FQDN).","oneOf":[{"type":"object","description":"The properties of the network.","required":["type","addresses"],"properties":{"type":{"type":"string","description":"The network type.","enum":["network","host","range"],"example":"range"},"addresses":{"type":"array","description":"The list of IP addresses or IP address ranges for the network.\nSeparate the range of IPv4 addresses with a hyphen (**-**).","maxItems":1,"minItems":1,"items":{"type":"string","example":"10.10.0.0-10.10.2.0"}}},"example":{"type":"network","addresses":["192.68.1.0/24"]},"$$ref":"#/components/schemas/NetworkValueType"},{"type":"object","description":"The properties of the fully-qualified domain name (FQDN).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of the domain name.","enum":["fqdn"]},"addresses":{"type":"array","description":"The list of domains.","maxItems":1,"minItems":1,"items":{"type":"string","example":"www.cisco.com"},"example":["www.cisco.com"]}},"$$ref":"#/components/schemas/FqdnValueType"}]}},"example":{"name":"test create network object one","value":{"type":"network","addresses":["192.68.1.0/24"]},"description":"test description for network object one."},"$$ref":"#/components/schemas/NetworkObjectRequestSchema"},"example":{"name":"test create network object one","value":{"type":"network","addresses":["192.68.1.0/24"]},"description":"test description for network object one."}}},"$$ref":"#/components/requestBodies/NetworkObject"},"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the Network Object response.","required":["name","value"],"properties":{"id":{"type":"integer","description":"The ID of the Network Object.","example":123456,"$$ref":"#/components/schemas/idNetworkObject"},"name":{"type":"string","description":"The name of the Network Object.","example":"A network object","$$ref":"#/components/schemas/nameNetworkObject"},"description":{"type":"string","description":"The description of the Network Object.","example":"network object description","$$ref":"#/components/schemas/descriptionNetworkObject"},"value":{"type":"object","description":"The value of the Network Object, which is represented by the network properties.","oneOf":[{"type":"object","description":"The properties of the network.","required":["type","addresses"],"properties":{"type":{"type":"string","description":"The network type.","enum":["network","host","range"],"example":"range"},"addresses":{"type":"array","description":"The list of IP addresses or IP address ranges for the network.\nSeparate the range of IPv4 addresses with a hyphen (**-**).","maxItems":1,"minItems":1,"items":{"type":"string","example":"10.10.0.0-10.10.2.0"}}},"example":{"type":"network","addresses":["192.68.1.0/24"]},"$$ref":"#/components/schemas/NetworkValueType"},{"type":"object","description":"The properties of the fully-qualified domain name (FQDN).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of the domain name.","enum":["fqdn"]},"addresses":{"type":"array","description":"The list of domains.","maxItems":1,"minItems":1,"items":{"type":"string","example":"www.cisco.com"},"example":["www.cisco.com"]}},"$$ref":"#/components/schemas/FqdnValueType"}]},"url":{"type":"string","description":"The URL for the Network Object.","example":"http://api.sse.cisco.com/v1/objects/network/1245"},"created_at":{"type":"string","format":"date-time","description":"The date and time when the object was created, specified in the ISO 8601 format.","example":"2021-10-02T20:00:00Z","$$ref":"#/components/schemas/created_at"},"modified_at":{"type":"string","format":"date-time","description":"The date and time when the object was updated, specified in the ISO 8601 format.","example":"2021-11-02T20:00:00Z","$$ref":"#/components/schemas/modified_at"},"modified_by":{"type":"string","description":"The hash of the ID for the user account that modified the object.","example":"12089817","$$ref":"#/components/schemas/modified_by"}},"example":{"id":15884,"name":"demo object","description":"description for demo object","value":{"type":"network","addresses":["192.68.1.0/24"]},"url":"https://api.sse.cisco.com/policies/v2/objects/networkObjects/15884","created_at":"2024-11-13T20:51:14Z","modified_at":"2024-11-13T20:51:14Z","modified_by":"12089817"},"$$ref":"#/components/schemas/NetworkObjectResponseSchema"},"example":{"id":15894,"name":"new name for network object one","description":"new description for network object one.","value":{"type":"network","addresses":["192.68.1.0/24"]},"url":"https://api.sse.cisco.com/policies/v2/objects/networkObjects/15894","created_at":"2024-11-19T22:05:41Z","modified_at":"2024-11-19T22:17:42.449Z","modified_by":"85e0c78b608a4336adb50d7bafdf6032"}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Organization ID must be a numeric value."}},"$$ref":"#/components/schemas/400ErrorObject"}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Authorization token is invalid."}},"$$ref":"#/components/schemas/401ErrorObject"}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Authorized"}},"$$ref":"#/components/schemas/403ErrorObject"}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Found"}},"$$ref":"#/components/schemas/404ErrorObject"}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Internal Server Error"}},"$$ref":"#/components/schemas/500ErrorObject"}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"updateNetworkObject","method":"put","path":"/objects/networkObjects/{networkObjectId}"}}