---
title: "Create object"
method: POST
path: "/objects"
tags: ["Objects"]
---

# Create object

`POST /objects`

Request to create new object

## Request body

- ObjectCreationAndModification
  - `objectType` integer — Possible options: * SUBNET: 1 * NODE: 2 * INTERFACE: 3 * NETWORK: 4 * CONTAINER: 5 * ZONE: 6 * SERVICEROOT: 7 * TEMPLATE: 8 * TEMPLATEGROUP: 9 * TEMPLATEROOT: 10 * NETWORKSERVICE: 11 * VPNCONNECTOR: 12 * CONDITION: 13 * CLUSTER: 14 * OBJECT_BUSINESSSERVICE_PROTOTYPE: 15 * NETWORKMAPROOT: 19 * NETWORKMAPGROUP: 20 * NETWORKMAP: 21 * DASHBOARDROOT: 22 * DASHBOARD: 23 * BUSINESSSERVICEROOT: 27 * BUSINESSSERVICE: 28 * NODELINK: 29 * SLMCHECK: 30 * MOBILEDEVICE: 31 * RACK: 32 * ACCESSPOINT: 33 * CHASSIS: 35 * DASHBOARDGROUP: 36 * SENSOR: 37
  - `name` string — Object name
  - `parentId` integer — Parent object id this object to be created under
  - `comments` string — Object comment
  - `creationFlags` integer — Bit flags for object creation. Possible options: * DISABLE ICMP: 0x0001 * DISABLE NXCP: 0x0002 * DISABLE SNMP: 0x0004 * CREATE UNMANAGED: 0x0008 * ENTER MAINTENANCE: 0x0010 * AS ZONE PROXY: 0x0020 * DISABLE ETHERNET IP: 0x0040 * SNMP SETTINGS LOCKED: 0x0080 * EXTERNAL GATEWAY: 0x0100
  - `primaryName` string — Node primary name (IP address or dns name)
  - `agentPort` integer — Node agent port
  - `snmpPort` integer — Node SNMP port
  - `etherNetIpPort` integer — Node ethernetIP port
  - `sshPort` integer — Node ssh port
  - `ipAddress` string — Network service IP address
  - `agentProxyId` integer — Node agent proxy id
  - `snmpProxyId` integer — Node SNMP proxy id
  - `etherNetIpProxyId` integer — Node ethernetIP proxy id
  - `icmpProxyId` integer — Node ICMP proxy id
  - `sshProxyId` integer — Node ssh proxy id
  - `mapType` integer — Network map type
  - `seedObjectIds` integer[] — Network map seed objects
  - `zoneUIN` integer — Subnet/Node/Zone zone UIN
  - `serviceType` integer — Network service types: * CUSTOM - 0 * SSH - 1 * POP3 - 2 * SMTP - 3 * FTP - 4 * HTTP - 5 * HTTPS - 6 * TELNET - 7
  - `ipPort` integer — Network Service IP port
  - `request` string — Network service IP request
  - `response` string — Network service IP response
  - `linkedNodeId` integer — Linked object for Node Link object
  - `template` boolean — If service check object is template
  - `macAddress` string — Sensor mac address
  - `ifIndex` integer — Interface index
  - `ifType` integer — Interface type
  - `module` integer — Interface module number
  - `port` integer — Interface port
  - `physicalPort` boolean — IF interface has physical port
  - `createStatusDci` boolean — IF status DCI should be created for network service
  - `deviceId` string — Mobile device ID
  - `height` integer — Rack height
  - `controllerId` integer — Chassis controller node id
  - `sshLogin` string — Node ssh login
  - `sshPassword` string — Node password
  - `deviceClass` integer — Sensor device class
  - `vendor` string — Sensor vendor
  - `commProtocol` integer — Sensor communication protocol
  - `xmlConfig` string — Sensor XML config
  - `xmlRegConfig` string — Sensor XML registration config
  - `serialNumber` string — Sensor serial number
  - `deviceAddress` string — Sensor device address
  - `metaType` string — Sensor meta type
  - `description` string — Sensor description
  - `sensorProxy` integer — Sensor proxy node id
  - `instanceDiscoveryMethod` integer — Business service instance discovery method Possible values: * IDM_AGENT_LIST - 1 * IDM_AGENT_TABLE - 2 * IDM_SCRIPT - 5
  - `alias` string
  - `nameOnMap` string
  - `acl` AccessListElement[] — inheritAccessRights should be provided in the same request
    - `userId` integer
    - `accessRights` integer — Bit flag field. Available options: * OBJECT ACCESS READ: 0x00000001 * OBJECT ACCESS MODIFY: 0x00000002 * OBJECT ACCESS CREATE: 0x00000004 * OBJECT ACCESS DELETE: 0x00000008 * OBJECT ACCESS READ ALARMS: 0x00000010 * OBJECT ACCESS ACL: 0x00000020 * OBJECT ACCESS UPDATE ALARMS: 0x00000040 * OBJECT ACCESS SEND EVENTS: 0x00000080 * OBJECT ACCESS CONTROL: 0x00000100 * OBJECT ACCESS TERM ALARMS: 0x00000200 * OBJECT ACCESS PUSH DATA: 0x00000400 * OBJECT ACCESS CREATE ISSUE: 0x00000800 * OBJECT ACCESS DOWNLOAD: 0x00001000 * OBJECT ACCESS UPLOAD: 0x00002000 * OBJECT ACCESS MANAGE FILES: 0x00004000 * OBJECT ACCESS MAINTENANCE: 0x00008000 * OBJECT ACCESS READ AGENT: 0x00010000 * OBJECT ACCESS READ SNMP: 0x00020000 * OBJECT ACCESS SCREENSHOT: 0x00040000
  - `inheritAccessRights` boolean — acl should be provided in the same request
  - `customAttributes` CustomAttribute
    - `value` string
    - `flags` integer — Available options: * INHERITABLE: 1
  - `autoBindFilter` string
  - `version` integer
  - `agentSecret` string
  - `agentProxy` integer
  - `snmpVersion` string — Node SNMP version: * V1 * V2C * V3 * DEFAULT
  - `snmpAuthMethod` integer — snmpAuthName, snmpAuthPassword, snmpPrivPassword, snmpPrivMethod should be provided in the same request
  - `snmpPrivMethod` integer — snmpAuthName, snmpAuthPassword, snmpPrivPassword, snmpAuthMethod should be provided in the same request
  - `snmpAuthName` string — snmpAuthPassword, snmpPrivPassword, snmpAuthMethod, snmpPrivMethod should be provided in the same request
  - `snmpAuthPassword` string — snmpAuthName, snmpPrivPassword, snmpAuthMethod, snmpPrivMethod should be provided in the same request
  - `snmpPrivPassword` string — snmpAuthName, snmpAuthPassword, snmpAuthMethod, snmpPrivMethod should be provided in the same request
  - `snmpProxy` integer
  - `icmpProxy` integer
  - `trustedNodes` integer[]
  - `geolocation` Geolocation
    - `type` integer — Available options: * UNSET: 0 * MANUAL: 1 * GPS: 2 * NETWORK: 3
    - `latitude` number
    - `longitude` number
    - `accuracy` integer — Location accuracy in meters
    - `timestamp` integer — UNIX timestamp
  - `mapBackground` string — UUID. mapBackgroundLocation, mapBackgroundLocation, mapBackgroundZoom, mapBackgroundColor should be provided in the same request.
  - `mapBackgroundLocation` Geolocation
    - `type` integer — Available options: * UNSET: 0 * MANUAL: 1 * GPS: 2 * NETWORK: 3
    - `latitude` number
    - `longitude` number
    - `accuracy` integer — Location accuracy in meters
    - `timestamp` integer — UNIX timestamp
  - `mapBackgroundZoom` integer — mapBackground, mapBackgroundLocation, mapBackgroundLocation, mapBackgroundColor should be provided in the same request.
  - `mapBackgroundColor` integer — mapBackground, mapBackgroundLocation, mapBackgroundLocation, mapBackgroundZoom should be provided in the same request.
  - `mapImage` string — UUID
  - `columnCount` integer
  - `script` string
  - `activationEvent` integer
  - `deactivationEvent` integer
  - `sourceObject` integer
  - `activeStatus` integer
  - `inactiveStatus` integer
  - `drillDownObjectId` integer
  - `pollerNode` integer
  - `requiredPolls` integer
  - `ipProtocol` integer
  - `objectFlags` integer — Object flags specific for each object. Possible values can be found in NXSL documentation under each object. (Example: `Node flags https://www.netxms.org/documentation/nxsl-latest/#_constants_6`) objectFlagsMask should be provided in the same request.
  - `objectFlagsMask` integer — Bitmask that defines which bits in objectFlags will have effect. objectFlags should be provided in the same request.
  - `ifXTablePolicy` integer
  - `reportDefinition` string
  - `networkList` string[] — IP address list
  - `statusCalculationMethod` integer
  - `statusPropagationMethod` integer
  - `fixedPropagatedStatus` string — Object status: * NORMAL * WARNING * MINOR * MAJOR * CRITICAL * UNKNOWN * UNMANAGED * DISABLED * TESTING
  - `statusShift` integer
  - `statusTransformation` unknown[] — ObjectStatus[] Object status mapping list. Possible values: * NORMAL * WARNING * MINOR * MAJOR * CRITICAL * UNKNOWN * UNMANAGED * DISABLED * TESTING
    - unknown
  - `statusSingleThreshold` integer
  - `statusThresholds` integer[]
  - `expectedState` integer
  - `linkColor` integer
  - `connectionRouting` integer
  - `discoveryRadius` integer
  - `filter` string
  - `peerGatewayId` integer
  - `localNetworks` string[] — VPN networks IP address. remoteNetworks should be provided in the same request.
  - `remoteNetworks` string[] — VPN networks IP address. localNetworks should be provided in the same request.
  - `postalAddress` PostalAddress
    - `country` string
    - `city` string
    - `streetAddress` string
    - `postcode` string
  - `agentCacheMode` string — Possible values: * DEFAULT * ON * OFF
  - `agentCompressionMode` string — Possible values: * DEFAULT * ENABLED * DISABLED
  - `mapObjectDisplayMode` string — Possible values: * ICON * SMALL_LABEL * LARGE_LABEL * STATUS * FLOOR_PLAN
  - `physicalContainerObjectId` integer
  - `rackImageFront` string — UUID. rackImageRear, rackPosition, rackHeight, rackOrientation should be provided in the same request.
  - `rackImageRear` string — UUID. rackImageFront, rackPosition, rackHeight, rackOrientation should be provided in the same request.
  - `rackPosition` integer — rackImageFront, rackImageRear, rackHeight, rackOrientation should be provided in the same request.
  - `rackHeight` integer — rackImageFront, rackImageRear, rackPosition, rackOrientation should be provided in the same request.
  - `rackOrientation` string — Possible values: * FILL * FRONT * REAR rackImageFront, rackImageRear, rackPosition, rackHeight should be provided in the same request.
  - `dashboards` integer[]
  - `rackNumberingTopBottom` boolean
  - `chassisId` integer
  - `sshProxy` integer
  - `sshKeyId` integer
  - `zoneProxies` integer[]
  - `urls` string[] — Object Urls
  - `snmpPorts` string[]
  - `responsibleUsers` integer[]
  - `icmpStatCollectionMode` string — Possible values: * DEFAULT * ON * OFF
  - `icmpTargets` string[] — ICMP ping targets IP addresses
  - `chassisPlacement` string
  - `etherNetIPPort` integer
  - `etherNetIPProxy` integer
  - `certificateMappingMethod` string — Possible values: * SUBJECT * PUBLIC_KEY * COMMON_NAME * TEMPLATE_ID certificateMappingData should be provided in the same request.
  - `certificateMappingData` string — certificateMappingMethod should be provided in the same request.
  - `categoryId` integer
  - `geoLocationControlMode` unknown
  - `geoAreas` integer[]
  - `instanceDiscoveryData` string — Business service instance discovery data
  - `instanceDiscoveryFilter` string — Business service instance discovery data filtering script
  - `autoBindFilter2` integer — Second binding script used for DCI binding. Currently used in business service
  - `autoBindFlags` integer — Auto bind bit flags First script is currently used for object bind/unbind, second for dci bind/unbind. Possible values: * First script for auto bind is enabled - 0x0001 * First script for auto unbind is enabled - 0x0002 * Second script for auto bind is enabled - 0x0004 * Second script for auto unbind is enabled - 0x0008
  - `objectStatusThreshold` integer — Business service default threshold for auto created object checks Possible values: * Default - 0 * Warning - 1 * Minor - 2 * Major - 3 * Critical - 4
  - `dciStatusThreshold` integer — Business service default threshold for auto created DCI checks Possible values: * Default - 0 * Warning - 1 * Minor - 2 * Major - 3 * Critical - 4
  - `sourceNode` integer — Id of source node for business service instance discovery methods

## Response `200`

New object ID.

- object

## Other responses

- `401` — Access denied

## Changes

- **2023-02-28** `910d3ad08e09` — 2 info
  - api operation id `createObject` was added
  - added the non-success response with the status `401`
- **2023-02-23** `1026ff73d141` — 1 breaking, 48 warning
  - added `#/components/schemas/objectCreation, #/components/schemas/objectModification` to the request body `allOf` list
  - removed the request property `agentPort`
  - removed the request property `agentProxyId`
  - removed the request property `commProtocol`
  - …45 more
- **2023-02-23** `9c09a2aad349` — 1 warning, 16 info
  - removed the optional property `id` from the response with the `200` status
  - api operation id `createObject` removed and replaced with ``
  - the request property `name` became optional
  - the request property `objectType` became optional
  - …13 more

[Change history](https://skmtc.dev/netxms/apis/netxms-rest-api/changes/objects/post.md)

---

[API](https://skmtc.dev/netxms/apis/netxms-rest-api.md) · [All operations](https://skmtc.dev/netxms/apis/netxms-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/netxms/netxms-rest-api/revisions/910d3ad08e09/schema)