Create Multiple Range Object - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Multiple Range Object","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":"**Create a range object. _Check the response section for applicable examples (if any)._**","operationId":"createMultipleRangeObject","parameters":[{"description":"Boolean indicating whether this is a bulk operation.","in":"query","name":"bulk","required":false,"schema":{"type":"boolean"}},{"description":"UUID of the ticket for tracking the configuration changes.","in":"header","name":"ticket-id","required":false,"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/object/ranges ( POST to create a range object )":{"value":{"description":"Test Description","name":"TestRange2","type":"Range","value":"10.4.30.40-10.4.30.50"}},"Example 2 : POST /fmc_config/v1/domain/domainUUID/object/ranges?bulk=true ( POST to create a range object )":{"value":[{"description":"Range obj 1","name":"Range1","type":"Range","value":"10.4.30.40-10.4.30.50"},{"description":"Range obj2","name":"Range2","type":"Range","value":"1.2.3.4-1.2.3.10"}]},"Example 3 : POST /fmc_config/v1/domain/domainUUID/object/ranges?bulk=true ( Bulk POST to create a range objects with overrides )":{"value":[{"description":" ","id":"range_obj_uuid","name":"range_obj","overridable":true,"overrides":{"parent":{"id":"range_obj_uuid","type":"Range"},"target":{"id":"domain_uuid","name":"Global \\ EUROPE","type":"Domain"}},"type":"Range","value":"10.10.10.1-10.10.10.10"},{"description":" ","id":"range_obj_uuid","name":"range_obj","overridable":true,"overrides":{"parent":{"id":"range_obj_uuid","type":"Range"},"target":{"id":"device_uuid","name":"FTDv_R1","type":"Device"}},"type":"Range","value":"20.20.20.1-20.20.20.10"}]},"Example 4 : POST /fmc_config/v1/domain/domainUUID/object/ranges ( POST request to create override on a range object. )":{"value":{"description":" ","id":"range2_uuid","name":"range2","overridable":true,"overrides":{"parent":{"id":"range2_uuid","type":"Host"},"target":{"id":"target_uuid","name":"10.10.16.29","type":"Device"}},"type":"Range","value":"1.1.1.1-1.1.1.10"}}},"schema":{"type":"object","description":"A model representing Range Network object definition.","properties":{"description":{"description":"User provided description.","type":"string"},"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Contains the full URL to the current object and its parent (if any)","type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"metadata":{"description":"Object representing metadata properties of response object.","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 chosen 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 query parameter to GET override details for a specific object on a specific target (device or domain).","type":"string"},"overrides":{"description":"This is populated only if this object is an override and contains the parent (global) object id and whether this is an override on 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":"The unique type of this object.","type":"string"},"value":{"description":"Actual value of range.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/RangeObject"}}},"description":"Input representation of address range.","required":true},"responses":{"201":{"content":{"application/json":{"examples":{"Example 1 : POST /fmc_config/v1/domain/domainUUID/object/ranges ( POST to create a range object )":{"value":{"id":"Range-obj-UUID-1","links":{"parent":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses","self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/ranges/Range-obj-UUID-1"},"metadata":{"domain":{"id":"domainUUID","name":"Global \\ TestDomain"},"ipType":"V_4","lastUser":{"name":"testuser"},"parentType":"NetworkAddress"},"name":"TestRange2","overridable":false,"type":"Range","value":"10.4.30.40-10.4.30.50"}},"Example 2 : POST /fmc_config/v1/domain/domainUUID/object/ranges?bulk=true ( POST to create a range object )":{"value":{"items":[{"description":"Range obj 1","id":"range1Uuid","links":{"parent":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUuid/object/networkaddresses","self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUuid/object/ranges/range1Uuid"},"metadata":{"domain":{"id":"domainUuid","name":"Global"},"ipType":"V_4","lastUser":{"name":"pvs"},"parentType":"NetworkAddress","timestamp":0},"name":"Range1","overridable":false,"type":"Range","value":"10.4.30.40-10.4.30.50"},{"description":"Range obj2","id":"range2Uuid","links":{"parent":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUuid/object/networkaddresses","self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUuid/object/ranges/range2Uuid"},"metadata":{"domain":{"id":"domainUuid","name":"Global"},"ipType":"V_4","lastUser":{"name":"pvs"},"parentType":"NetworkAddress","timestamp":0},"name":"Range2","overridable":false,"type":"Range","value":"1.2.3.4-1.2.3.10"}],"links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUuid/object/ranges?bulk=true"}}},"Example 3 : POST /fmc_config/v1/domain/domainUUID/object/ranges?bulk=true ( Bulk POST to create a range objects with overrides )":{"value":{"items":[{"id":"range_obj_uuid","links":{"parent":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUuid/object/networkaddresses","self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUuid/object/ranges/range_obj_uuid"},"metadata":{"domain":{"id":"domain_uuid","name":"Global \\ EUROPE"},"ipType":"V_4","lastUser":{"name":"pvs"},"parentType":"NetworkAddress","timestamp":0},"name":"range_obj","overridable":true,"overrides":{"parent":{"id":"range_obj_uuid","type":"Range"},"target":{"id":"domain_uuid","name":"Global \\ EUROPE","type":"Domain"}},"type":"Range","value":"10.10.10.1-10.10.10.10"},{"id":"range_obj_uuid","links":{"parent":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUuid/object/networkaddresses","self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUuid/object/ranges/range_obj_uuid"},"metadata":{"domain":{"id":"domain_uuid","name":"Global \\ ASIA"},"ipType":"V_4","lastUser":{"name":"pvs"},"parentType":"NetworkAddress","timestamp":0},"name":"range_obj","overridable":true,"overrides":{"parent":{"id":"range_obj_uuid","type":"Range"},"target":{"id":"device_uuid","name":"FTDv_R1","type":"Device"}},"type":"Range","value":"20.20.20.1-20.20.20.10"}],"links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUuid/object/ranges?bulk=true"}}},"Example 4 : POST /fmc_config/v1/domain/domainUUID/object/ranges ( POST request to create override on a range object. )":{"value":{"id":"range2_uuid","links":{"parent":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUuid/object/networkaddresses","self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUuid/object/ranges/range2_uuid?overrideTargetId=target_uuid"},"metadata":{"domain":{"id":"domainUuid","name":"Global"},"ipType":"V_4","lastUser":{"name":"admin"},"parentType":"NetworkAddress","timestamp":0},"name":"range2","overridable":true,"overrides":{"parent":{"id":"range2_uuid","type":"Range"},"target":{"id":"target_uuid","name":"10.10.16.29","type":"Device"}},"type":"Range","value":"1.1.1.1-1.1.1.10"}}},"schema":{"type":"object","description":"A model representing Range Network object definition.","properties":{"description":{"description":"User provided description.","type":"string"},"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Contains the full URL to the current object and its parent (if any)","type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"metadata":{"description":"Object representing metadata properties of response object.","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 chosen 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 query parameter to GET override details for a specific object on a specific target (device or domain).","type":"string"},"overrides":{"description":"This is populated only if this object is an override and contains the parent (global) object id and whether this is an override on 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":"The unique type of this object.","type":"string"},"value":{"description":"Actual value of range.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/RangeObject"}}},"description":"Created"},"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":["Object"],"__originalOperationId":"createMultipleRangeObject","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/ranges"}}