Namirasoft API Link V1
Namira Software Corporation API Link Version 1 (1.5.0)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-api-link-v1
Commands
Health
Liveness
Returns the application liveness status
ns-api-link health liveness
Readiness
Returns the application readiness status
ns-api-link health readiness
Metrics
Get
Returns the application metrics
ns-api-link metrics get
Category
List
Returns the category list
ns-api-link category list {filters} {page} {size} {sorts}
ListLinks
Returns the link list of a category
ns-api-link category listlinks {id} {filters} {page} {size} {sorts}
Get
Returns a category by an id
ns-api-link category get {id}
Domain
Search
Returns the domain list
ns-api-link domain search {query} {top}
List
Returns the domain list
ns-api-link domain list {filters} {page} {size} {sorts}
ListLinks
Returns the link list of a domain
ns-api-link domain listlinks {id} {filters} {page} {size} {sorts}
Get
Returns a domain by an id
ns-api-link domain get {id}
Filter
List
Returns the filter list
ns-api-link filter list {filters} {page} {size} {sorts}
ListLinks
Returns the link list by scope and name
ns-api-link filter listlinks {scope} {name} {filters} {page} {size} {sorts}
ListFilterLinks
Returns the filter list by scope and name
ns-api-link filter listfilterlinks {scope} {name} {filters} {page} {size} {sorts}
Get
Returns a filter by an id
ns-api-link filter get {id}
Link
Search
Returns the link list
ns-api-link link search {query} {top}
List
Returns the link list
ns-api-link link list {filters} {page} {size} {sorts}
Get
Returns a link by an id
ns-api-link link get {id}
Schemas
Category
{ "name": "Category", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
LinkFull
{ "name": "LinkFull", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "category_id": { "type": "Integer", "required": true }, "domain_id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "url": { "type": "String", "required": true, "max": 255 }, "logo": { "type": "String", "required": true, "max": 255 }, "public": { "type": "Boolean", "required": true }, "private": { "type": "Boolean", "required": true }, "importance": { "type": "Integer", "required": true }, "description": { "type": "String", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "category": { "name": "Category", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } }, "domain": { "name": "Domain", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "url": { "type": "String", "required": true, "max": 255 }, "logo": { "type": "String", "required": false, "max": 255 }, "published_at": { "type": "DateTime", "required": false }, "description": { "type": "String", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } }}
Domain
{ "name": "Domain", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "url": { "type": "String", "required": true, "max": 255 }, "logo": { "type": "String", "required": false, "max": 255 }, "published_at": { "type": "DateTime", "required": false }, "description": { "type": "String", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Filter
{ "name": "Filter", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "scope": { "type": "String", "required": true, "max": 255 }, "name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
FilterLinkFull
{ "name": "FilterLinkFull", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "parent_id": { "type": "Integer", "required": false }, "filter_id": { "type": "Integer", "required": true }, "link_id": { "type": "Integer", "required": false }, "name": { "type": "String", "required": false, "max": 255 }, "logo": { "type": "String", "required": false, "max": 255 }, "order": { "type": "Integer", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "filter": { "name": "Filter", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "scope": { "type": "String", "required": true, "max": 255 }, "name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } }, "link": { "name": "LinkFull", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "category_id": { "type": "Integer", "required": true }, "domain_id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "url": { "type": "String", "required": true, "max": 255 }, "logo": { "type": "String", "required": true, "max": 255 }, "public": { "type": "Boolean", "required": true }, "private": { "type": "Boolean", "required": true }, "importance": { "type": "Integer", "required": true }, "description": { "type": "String", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "category": { "name": "Category", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } }, "domain": { "name": "Domain", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "url": { "type": "String", "required": true, "max": 255 }, "logo": { "type": "String", "required": false, "max": 255 }, "published_at": { "type": "DateTime", "required": false }, "description": { "type": "String", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } } } }}
Enums
Namira Software Corporation
©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.