POST Create a CI

This API is used to create a new CI.

URL: http://{{server-url}}/api/v1/cmdb/ci

CI Field Table

Field Name	Field Type	Detail Specification
ciId	String	Unique identifier of the CI. This is system-generated and view-only.
ciTypeName(required)	String	Hierarchical CI type name using “$” delimiter. Example: ci$Hardware$laptops. This defines the classification of the CI.
name(required)	String	Name of the Configuration Item.
type(required)	String	The value should be "CI". Indicates that the object being created is a CI.
impactName	String	Indicates the level of impact this CI has on business operations.
statusName	String	Current lifecycle status of the CI (e.g., Active, Inactive, Retired).
vendorName	String	Name of the vendor or supplier of the CI.
productName	String	Product name or model associated with the CI.
departmentName	String	Department that owns or is responsible for the CI.
usedByEmail	Email	Email address of the user currently using the CI.
managedByEmail	Email	Email address of the person responsible for managing the CI.
managedByGroupName	String	Name of the group responsible for managing the CI.
ciGroupName	String	Logical grouping name to categorize the CI (e.g., Networking Devices, Endpoints).
locationName	String	Physical or logical location of the CI.
tags	Set of String	Labels or tags associated with the CI for easy search and categorization.
assignmentDate	String (In above mentioned date format)	The date when the CI was assigned or deployed.
businessServiceName	String	Business service to which the CI contributes or is linked.
customField	Key-Value Pair	Custom fields and values for additional CI-specific information.
description	String	Detailed description or notes about the CI.
ciPropertyList	List of Key-Value Pair	List of properties grouped under CI-specific configurations.
ipAddress	String	IP address assigned to the CI (typically for hardware assets).
hostName	String	Hostname of the device if applicable (typically for hardware).
macAddress	String	MAC address of the hardware device.

Asset property Group Field Table

Hardware Property Group Table

Field Name	Field Type	Detail Specification
type (required)	String	Fixed value "CI" to indicate that the object is a Configu
serialNumber	String	Unique serial number assigned by the manufacturer to identify the CI.
warrentyExpirationDate	String	Date when the warranty for the CI expires. Useful for lifecycle and support planning.
auditDate	String (In above mentioned date format)	The most recent or next scheduled audit date for verifying the CI's existence and compliance.
propertyCustomField	Key-Value Pair	Custom property fields specific to CI properties. Allows additional flexibility in defining CI attributes.

Computer Property Group Table

Field Name	Field Type	Detail Specification
type (required)	String	Fixed value "Computer Property" to identify the property group type.
osName	String	Name of the operating system installed on the computer (e.g., Windows 11, Ubuntu).
osVersion	String	Version number of the operating system.
servicePackName	String	Name of the installed service pack or OS patch level.
osLicenceKey	String	License or activation key for the installed operating system.
osManufacturerName	String	Name of the vendor or manufacturer of the operating system (e.g., Microsoft, Red Hat).
osArchitecture	String	OS architecture format. Valid values: bit_64, bit_32, or all.
bootupState	String	Describes the current bootup state or condition of the system.
memorySize	Number	Total installed physical memory (RAM) in GB.
diskSize	Number	Total available disk space on the system in GB.
domainName	String	Name of the domain the computer is joined to (if applicable).
cpuSpeed	Number	Speed of the system's CPU in GHz.
cpuCoreCount	Number	Total number of physical CPU cores in the system.
partOfDomain	Boolean	Indicates whether the system is part of a domain (true or false).
numberOfLogicalProcessors	Number	Number of logical processors or threads available.
numberOfProcessors	Number	Total number of processor units (sockets) installed.
pcSystemType	String	Describes the system type (e.g., Laptop, Desktop, Server).
activationStatus	String	Indicates the current OS activation status (e.g., Activated, Not Activated).
displayVersion	String	User-friendly version label of the OS (e.g., 22H2 for Windows).
buildNo	String	Operating system build number (e.g., 22621).
lastLoggedInUser	String	Name of the last user who logged into the system.
propertyCustomField	Key-Value Pair	Custom fields for additional computer-specific properties not covered above.

SNMP Property Group Table

Field Name	Field Type	Detail Specification
type (required)	String
systemOID	String	Type should be SNMP Property.
systemUpTime	Number	systemUpTime Should be in minutes
firmware	String
firmwareVersion	String
port	Number
contactName	String
manufacturerName	String
propertyCustomField	Key-Value Pair

Storage Property Group Table

Field Name	Field Type	Detail Specification
type (required)	String	Type should be Storage Property.
driveType	String
diskSpace	Number	Disk Space should be in GB.
freeSpace	Number	Free Space should be in GB.
freeSpaceCheckedOn	String (In above mentioned date format)
propertyCustomField	Key-Value Pair

UPS Property Table

Field Name	Field Type	Detail Specification
type (required)	String	Type should be UPS Property.
modelName	String
batteryVoltage	String
batteryCurrent	String
batteryCapacity	String
capacity	String
voltage	String
power	String
propertyCustomField	Key-Value Pair

Firewall Property Group Table

Field Name	Field Type	Detail Specification
type (required)	String	Type should be Firewall Property.
firmware	String
firmwareVersion	String
port	Number
subnetMask	String
propertyCustomField	Key-Value Pair

Mobile Device Property Group Table

Field Name	Field Type	Detail Specification
type (required)	String	Type should be Mobile Device Property.
os	String
osVersion	String
memory	Number	Memory should be in GB.
IMEINumber	String
propertyCustomField	Key-Value Pair

Rack Property Group Table

Field Name	Field Type	Detail Specification
type (required)	String	Type should be Rack Property.
footPrint	String
powerConsumption	String
rackUnits	Number
rackUnitsInUse	Number
propertyCustomField	Key-Value Pair

Software Property Group Table

Field Name	Field Type	Detail Specification
type (required)	String	Type should be Software Property.
licenseExpiryDate	String (In above mentioned date format)
licenceTypeName	String	License Type Name
softwareCost	Number
lastAuditDate	String (In above mentioned date format)
licenseKeys	Set of String
executableFileNames	Set of String
propertyCustomField	Key-Value Pair

Example (Request & Response)

Body

{
    "type": "CI",
    "ciTypeName": "Base CI$Hardware$Laptops",
    "name": "DELL Laptop",
    "hostName":"jerry",
    "acquitionDate": "15-08-2020 13:34",
    "categoryName": "IT Administration",
    "ciStatusName":"Operational",
    "tags": [
        "tag-2"
    ],
    "customField": {
        "AssetGlobal":"asset",
        "CMDB Global": "value",
        "Hardware": "cmdbhardware"
    },
    "ciPropertyList": [
        {
            "type": "HardwareProperty",
            "serialNumber": "field value",
            "propertyCustomField": {
                "CMDBHWPG": "cmdbpof",
                "HwPgAsset": "assetpd"
            }
        },
        {
            "type": "ComputerProperty",
            "field name": "field value",
            "propertyCustomField": {
                "Custom field name": "value",
                "Custom field name ": "value"
            }
        }
    ]
}

Request

curl --location 'http://172.16.11.157/api/v1/cmdb/ci' \
--header 'Authorization: Apikey MtawICaqt6xRDUER%40cZd7nhRKPW3c0wxKTx7b530chfUr1C2JsTgFjkcJ7eQV3SteuehUbw%3D%3D' \
--header 'Content-Type: application/json' \
--data '{
    "type": "CI",
    "ciTypeName": "Base CI$Hardware$Laptops",
    "name": "DELL Laptop",
    "hostName":"jerry",
    "acquitionDate": "15-08-2020 13:34",
    "categoryName": "IT Administration",
    "ciStatusName":"Operational",
    "tags": [
        "tag-2"
    ],
    "customField": {
        "AssetGlobal":"asset",
        "CMDB Global": "value",
        "Hardware": "cmdbhardware"
    },
    "ciPropertyList": [
        {
            "type": "HardwareProperty",
            "serialNumber": "field value",
            "propertyCustomField": {
                "CMDBHWPG": "cmdbpof",
                "HwPgAsset": "assetpd"
            }
        },
        {
            "type": "ComputerProperty",
            "field name": "field value",
            "propertyCustomField": {
                "Custom field name": "value",
                "Custom field name ": "value"
            }
        }
    ]
}'

Example Response

{
    "type": "CI",
    "id": 7,
    "name": "DELL Laptop",
    "impactName": "Low",
    "statusName": "Operational",
    "origin": "manual",
    "tags": [
        "tag-2"
    ],
    "createdDate": "30/06/2025 04:19 pm",
    "updatedDate": "30/06/2025 04:19 pm",
    "fileAttachments": [],
    "createdByName": "Aman",
    "updatedByName": "Aman",
    "hostName": "jerry",
    "ciTypeName": "Laptops",
    "ciId": "CI-4",
    "ciPropertyList": [
        {
            "id": 7,
            "refName": "CI-4",
            "type": "HardwareProperty",
            "serialNumber": "field value",
            "propertyCustomField": null
        },
        {
            "id": 7,
            "refName": "CI-4",
            "type": "ComputerProperty",
            "osName": null,
            "osVersion": null,
            "servicePackName": null,
            "osLicenceKey": null,
            "osArchitecture": null,
            "bootupState": null,
            "memorySize": 0,
            "diskSize": 0,
            "domainName": null,
            "cpuSpeed": 0,
            "cpuCoreCount": 0,
            "partOfDomain": false,
            "numberOfLogicalProcessors": 0,
            "numberOfProcessors": 0,
            "pcSystemType": null,
            "lastLoggedInUser": null,
            "activationStatus": null,
            "displayVersion": null,
            "buildNo": null,
            "lastRebootTime": "01/01/1970 05:30 am",
            "propertyCustomField": null
        }
    ],
    "concreteModel": "cmdb"
}