To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-support-api-v1
Returns the application liveness status
ns-support health liveness
Returns the application readiness status
ns-support health readiness
Returns the application metrics
ns-support metrics get
Returns the value list of a given table and column
ns-support value list {table} {column} {search} {field_id} {limit}
Returns the row count of every entity across all databases, optionally grouped by workspace_id and filtered to specific workspaces
ns-support overview count
--group_by_workspace (Boolean)
--workspace_ids (Array)
Returns the category list
ns-support category list {filters} {page} {size} {sorts} {all_workspaces}
Returns a category by an id
ns-support category get {id}
Returns the ticket list
ns-support ticket list {filters} {page} {size} {sorts} {all_workspaces}
Returns a ticket by an id
ns-support ticket get {id}
Creates a new ticket
ns-support ticket create
--product_id (String)
--category_id (String)
--resource_id (String)
--title (String)
--priority (Enum)
--description (String)
Updates a status to resolved by an id
ns-support ticket resolved {id}
Returns the message list
ns-support message list {filters} {page} {size} {sorts} {all_workspaces}
Returns a message by an id
ns-support message get {id}
Creates a new message
ns-support message create
--ticket_id (String)
--sender_id (String)
--message (String)
--ticket_resolved (Boolean)
{ "name": "OverviewCountInput", "type": "Object", "required": true, "fields": { "group_by_workspace": { "type": "Boolean", "required": false }, "workspace_ids": { "type": "Array", "required": false, "items": [ { "type": "String", "required": true } ] } }}
{ "name": "OverviewCountRow", "type": "Object", "required": true, "fields": { "database": { "type": "String", "required": true }, "table": { "type": "String", "required": true }, "total": { "type": "Integer", "required": true }, "by_workspace": { "type": "Array", "required": false, "items": [ { "name": "OverviewCountByWorkspace", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } } } ] } }}
{ "name": "OverviewCountByWorkspace", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } }}
{ "name": "Category", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
{ "name": "Ticket", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "resource_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "last_sender_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "title": { "type": "String", "required": true, "max": 255 }, "status": { "name": "TicketStatus", "type": "Enum", "required": true, "valids": [ "Open", "InProgress", "Resolved", "Closed" ] }, "priority": { "name": "TicketPriority", "type": "Enum", "required": true, "valids": [ "Low", "Medium", "High", "Urgent" ] }, "assignee": { "name": "TicketAssignee", "type": "Enum", "required": true, "valids": [ "ReadOnly" ] }, "description": { "type": "String", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
{ "name": "TicketInput", "type": "Object", "required": true, "fields": { "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "resource_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "title": { "type": "String", "required": true, "max": 255 }, "priority": { "name": "TicketPriority", "type": "Enum", "required": true, "valids": [ "Low", "Medium", "High", "Urgent" ] }, "description": { "type": "String", "required": true } }}
{ "name": "Message", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "ticket_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "sender_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "message": { "type": "String", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
{ "name": "MessageInput", "type": "Object", "required": true, "fields": { "ticket_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "sender_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "message": { "type": "String", "required": true }, "ticket_resolved": { "type": "Boolean", "required": true } }}
Open
InProgress
Resolved
Closed
Low
Medium
High
Urgent
ReadOnly
©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.