Namirasoft NWS Region API V1

Namira Software Corporation NWS Region API Version 1 (1.4.8)

Install


To use this cli, we need to first Install Nodejs, then run the following command.

npm i -g namirasoft-nws-region-api-v1

Copied!

Commands


Healthz

Get

Returns the application health status

ns-nws-region healthz get

Copied!

Metrics

Get

Returns the application metrics

ns-nws-region metrics get

Copied!

Value

List

Returns the value list of a given table and column

ns-nws-region value list {table} {column} {search} {field_id} {limit}

Copied!

Region

List

Returns the region list

ns-nws-region region list {filters} {page} {size} {sorts}

Copied!

Get

Returns a region by an id

ns-nws-region region get {id}

Copied!

_GetFor

Returns a region by an id

ns-nws-region region _getfor {user_id} {id}

Copied!

Schemas


Region

{
  "name": "Region",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "provider": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "country": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "cpu_min": {
      "type": "Integer",
      "required": true
    },
    "memory_min": {
      "type": "Integer",
      "required": true
    },
    "disk_min": {
      "type": "Integer",
      "required": true
    },
    "cpu_max": {
      "type": "Integer",
      "required": true
    },
    "memory_max": {
      "type": "Integer",
      "required": true
    },
    "disk_max": {
      "type": "Integer",
      "required": true
    },
    "description": {
      "type": "String",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

RegionFull

{
  "name": "RegionFull",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "provider": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "country": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "cpu_min": {
      "type": "Integer",
      "required": true
    },
    "memory_min": {
      "type": "Integer",
      "required": true
    },
    "disk_min": {
      "type": "Integer",
      "required": true
    },
    "cpu_max": {
      "type": "Integer",
      "required": true
    },
    "memory_max": {
      "type": "Integer",
      "required": true
    },
    "disk_max": {
      "type": "Integer",
      "required": true
    },
    "description": {
      "type": "String",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    },
    "gitlab_api_url": {
      "type": "String",
      "required": true
    },
    "gitlab_token": {
      "type": "String",
      "required": true
    },
    "cpu_price": {
      "type": "Integer",
      "required": true
    },
    "memory_price": {
      "type": "Integer",
      "required": true
    },
    "disk_price": {
      "type": "Integer",
      "required": true
    }
  }
}

Enums

Namira Software Corporation

©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.