Namirasoft Log API V1

Namira Software Corporation Log API Version 1 (1.4.18)

Install


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

npm i -g namirasoft-log-api-v1

Copied!

Commands


Healthz

Get

Returns the application health status

ns-log healthz get

Copied!

Value

List

Returns the value list of a given table and column

ns-log value list {table} {column} {search} {field_id} {limit}

Copied!

LogGroupCategory

List

Returns the log group category list

ns-log loggroupcategory list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a log group category by id.

ns-log loggroupcategory get {id}

Copied!

Create

Creates a new log group category for an entity

ns-log loggroupcategory create {entity_id}

Copied!

--category_id (String)

Delete

Deletes a log group category by an id.

ns-log loggroupcategory delete {entity_id} {id}

Copied!

LogGroupField

List

Returns the log group field list

ns-log loggroupfield list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a log group field by id.

ns-log loggroupfield get {id}

Copied!

Create

Creates a new log group field for an entity

ns-log loggroupfield create {entity_id}

Copied!

--field_id (String)

--value (String)

Update

Updates a log group field by an id for an entity

ns-log loggroupfield update {entity_id} {id}

Copied!

--field_id (String)

--value (String)

Delete

Deletes a log group field by an id.

ns-log loggroupfield delete {entity_id} {id}

Copied!

LogGroupTag

List

Returns the log group tag list

ns-log loggrouptag list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a log group tag by id.

ns-log loggrouptag get {id}

Copied!

Create

Creates a new log group tag for an entity

ns-log loggrouptag create {entity_id}

Copied!

--name (String)

--value (String)

Update

Updates a log group tag by an id for an entity

ns-log loggrouptag update {entity_id} {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a log group tag by an id.

ns-log loggrouptag delete {entity_id} {id}

Copied!

LogGroup

List

Returns the log group list

ns-log loggroup list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a log group by an id

ns-log loggroup get {id}

Copied!

Create

Creates a new log group

ns-log loggroup create

Copied!

--workspace_id (String)

--name (String)

--retention_unit (Enum)

--retention_value (Integer)

--log_group_category (Array)

--log_group_field (Array)

--log_group_tag (Array)

Update

Updates a log group by an id

ns-log loggroup update {id}

Copied!

--workspace_id (String)

--name (String)

--retention_unit (Enum)

--retention_value (Integer)

--log_group_category (Array)

--log_group_field (Array)

--log_group_tag (Array)

Delete

Deletes a log group by an id

ns-log loggroup delete {id}

Copied!

Log

List

Returns the log list

ns-log log list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a log by an id

ns-log log get {id}

Copied!

Create

Creates a new log

ns-log log create

Copied!

--log_group_id (String)

--product_id (String)

--workspace_id (String)

--level (String)

--message (String)

Schemas


LogGroupCategory

{
  "name": "LogGroupCategory",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityCategoryInput

{
  "name": "EntityCategoryInput",
  "type": "Object",
  "required": true,
  "fields": {
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    }
  }
}

LogGroupField

{
  "name": "LogGroupField",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "value": {
      "type": "String",
      "required": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityFieldInput

{
  "name": "EntityFieldInput",
  "type": "Object",
  "required": true,
  "fields": {
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "value": {
      "type": "String",
      "required": false
    }
  }
}

LogGroupTag

{
  "name": "LogGroupTag",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "value": {
      "type": "String",
      "required": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityTagInput

{
  "name": "EntityTagInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "value": {
      "type": "String",
      "required": false
    }
  }
}

LogGroup

{
  "name": "LogGroup",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "workspace_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "retention_unit": {
      "name": "LogGroupRetentionUnit",
      "type": "Enum",
      "required": true,
      "valids": [
        "Day",
        "Week",
        "Month",
        "Year"
      ]
    },
    "retention_value": {
      "type": "Integer",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

LogGroupFull

{
  "name": "LogGroupFull",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "workspace_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "retention_unit": {
      "name": "LogGroupRetentionUnit",
      "type": "Enum",
      "required": true,
      "valids": [
        "Day",
        "Week",
        "Month",
        "Year"
      ]
    },
    "retention_value": {
      "type": "Integer",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    },
    "log_group_category": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityCategoryInput",
          "type": "Object",
          "required": false,
          "fields": {
            "category_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            }
          }
        }
      ]
    },
    "log_group_field": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityFieldInput",
          "type": "Object",
          "required": false,
          "fields": {
            "field_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            },
            "value": {
              "type": "String",
              "required": false
            }
          }
        }
      ]
    },
    "log_group_tag": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityTagInput",
          "type": "Object",
          "required": false,
          "fields": {
            "name": {
              "type": "String",
              "required": true,
              "max": 255
            },
            "value": {
              "type": "String",
              "required": false
            }
          }
        }
      ]
    }
  }
}

LogGroupInput

{
  "name": "LogGroupInput",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "retention_unit": {
      "name": "LogGroupRetentionUnit",
      "type": "Enum",
      "required": true,
      "valids": [
        "Day",
        "Week",
        "Month",
        "Year"
      ]
    },
    "retention_value": {
      "type": "Integer",
      "required": true
    },
    "log_group_category": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityCategoryInput",
          "type": "Object",
          "required": false,
          "fields": {
            "category_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            }
          }
        }
      ]
    },
    "log_group_field": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityFieldInput",
          "type": "Object",
          "required": false,
          "fields": {
            "field_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            },
            "value": {
              "type": "String",
              "required": false
            }
          }
        }
      ]
    },
    "log_group_tag": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityTagInput",
          "type": "Object",
          "required": false,
          "fields": {
            "name": {
              "type": "String",
              "required": true,
              "max": 255
            },
            "value": {
              "type": "String",
              "required": false
            }
          }
        }
      ]
    }
  }
}

Log

{
  "name": "Log",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true
    },
    "log_group_id": {
      "type": "String",
      "required": true
    },
    "product_id": {
      "type": "String",
      "required": false
    },
    "workspace_id": {
      "type": "String",
      "required": false
    },
    "level": {
      "type": "String",
      "required": true
    },
    "message": {
      "type": "String",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

LogCreate

{
  "name": "LogCreate",
  "type": "Object",
  "required": true,
  "fields": {
    "log_group_id": {
      "type": "String",
      "required": true
    },
    "product_id": {
      "type": "String",
      "required": false
    },
    "workspace_id": {
      "type": "String",
      "required": false
    },
    "level": {
      "type": "String",
      "required": true
    },
    "message": {
      "type": "String",
      "required": true
    }
  }
}

Enums

LogGroupRetentionUnit

Day

Week

Month

Year

Namira Software Corporation

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