CMDB CI API
The CMDB CI API manages Configuration Items (CIs) in Deepser, such as devices, software, and contracts. This section describes the endpoints, role-based permissions, and available fields.
Administrators, Operators, and Key Users can create, retrieve, update, and delete CIs. End Users cannot access this resource via the API.
Endpoints
http://deepserhost/api/rest/cmdb/ci/[id]
http://deepserhost/api/rest/cmdb/cis
Roles
| Administrator | Operator | Key User | User | |
|---|---|---|---|---|
| Actions Allowed | RETRIEVE CREATE UPDATE DELETE | RETRIEVE CREATE UPDATE DELETE | RETRIEVE CREATE UPDATE DELETE |
Fields
The following table lists all fields of the CI entity:
| Field | Description |
|---|---|
| name | The name of the CI, typically a brief description. |
| type_id | The CI type. This value is critical for organizing the CMDB. |
| class_id | The class the CI belongs to. |
| subtype_id | The CI subtype. Along with type_id, this is important for CMDB organization. |
| category1 | Category (1st level). Can be linked to the Service module category to associate Service Operations with CIs. |
| category2 | Category (2nd level). Can be linked to the Service module category to associate Service Operations with CIs. |
| category3 | Category (3rd level). Can be linked to the Service module category to associate Service Operations with CIs. |
| description | Detailed description of the CI. |
| status | The CI lifecycle status. |
| priority_id | Priority from the Operator perspective. |
| urgency_id | Urgency from the requester perspective. |
| business_impact_id | Business impact from the organization perspective. Measures the severity if the CI is unavailable, including affected people, financial losses, or dependent systems. |
| serial_number | The serial number of the CI. |
| notes | Free-text notes field. |
| front_image | The main image of the CI. |
| back_image | The back image of the CI (e.g., rear view of a rack showing connections and cables). |
| assigned_company_id | The company responsible for the CI, typically a service provider. This field affects visibility: users with company-restricted visibility can see CIs where their company appears in either Assigned Company or Owner Company. |
| assigned_group_id | The user group responsible for the CI. Used to restrict access to specific groups of Operators or Key Users. |
| assigned_username | The individual user responsible for the CI. Used to restrict access to a specific Operator or Key User. |
| owner_company_id | The company that owns the CI, typically the customer organization. Like assigned_company_id, this field affects company-based visibility restrictions. |
| owner_group_id | The user group that owns the CI. Can restrict which CIs end users see when creating Service Operations. |
| owner_username | The individual user who owns the CI. Can restrict which CIs a specific end user sees when creating Service Operations. |
| version | The CI version number. Deepser maintains a full version history with change details, author, and timestamps. |
| created_at | Creation date of the record. |
| updated_at | Date of the last update. |
| updated_by | The user who last updated the CI. |