Custom Properties & Configuration APIs Overview

N-central's Custom Properties APIs enable you to manage and customize property configurations across your organization's hierarchy. These APIs allow you to create, retrieve, and update custom properties for both devices and organization units, providing flexible configuration management capabilities.

API Methods

Organization Unit Custom Properties

Manage custom properties at the organization unit level, allowing you to set and maintain configuration values that apply to entire organizational segments.

Key Operations

• Get Property (GET /api/org-units/{orgUnitId}/custom-properties/{propertyId}): Retrieve specific custom property details
• Update Property (PUT /api/org-units/{orgUnitId}/custom-properties/{propertyId}): Modify existing custom property values
• List Properties (GET /api/org-units/{orgUnitId}/custom-properties): Retrieve all custom properties for an organization unit

Property Types

• TEXT: Standard text values
• HTML_LINK: URL and web resource links
• DATE: Date-based properties
• ENUMERATED: Properties with predefined value sets
• PASSWORD: Secure credential storage

Device Custom Properties

Configure and manage properties specific to individual devices, enabling granular control over device-level configurations.

Key Operations

• Get Property (GET /api/devices/{deviceId}/custom-properties/{propertyId}): Retrieve device-specific property details
• Update Property (PUT /api/devices/{deviceId}/custom-properties/{propertyId}): Modify device property values
• List Properties (GET /api/devices/{deviceId}/custom-properties): Get all custom properties for a device

Default Custom Properties

Manage default property values and propagation rules across your organization hierarchy.

Key Operations

• Get Default Property (GET /api/org-units/{orgUnitId}/org-custom-property-defaults/{propertyId}): Retrieve default property configurations
• Update Default Property (PUT /api/org-units/{orgUnitId}/org-custom-property-defaults): Modify default property settings

Propagation Types

• NO_PROPAGATION: Values apply only to the specified level
• SERVICE_ORGANIZATION_ONLY: Propagate to service organization level
• CUSTOMER_AND_SITE: Propagate to both customer and site levels
• SITE_ONLY: Apply only to site level entities

Key Features

Flexible Property Types

Supports multiple property types (HTML_LINK, TEXT, DATE, ENUMERATED, PASSWORD) with comprehensive validation and type-specific handling. Each type maintains its own data format and validation rules.

Customizable Propagation Control

Offers granular control over how properties propagate through your organization with multiple propagation types:

• Service organization levels
• Customer and site combinations
• Individual level control
• Selective propagation to specific organizational units

Comprehensive Value Management

Manages both default and custom values for properties with:

• Default value specification
• Enumerated value list support for properties requiring specific options
• Support for organization-wide property defaults
• Device-specific property customization

Implementation Example

// Retrieve a device custom property
GET /api/devices/123456/custom-properties/789
Authorization: Bearer <YOUR_TOKEN>

// Response
{
    "propertyId": 789,
    "propertyName": "Location",
    "propertyType": "TEXT",
    "value": "Data Center 1"
}

// Update an organization unit property
PUT /api/org-units/456/custom-properties/789
Authorization: Bearer <YOUR_TOKEN>
Content-Type: application/json

{
    "value": "New Configuration Value"
}