Namirasoft Bill Watch API V1
Namira Software Corporation Bill Watch API Version 1 (1.4.41)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-bill-watch-api-v1
Commands
Healthz
Get
Returns the application health status
ns-bill-watch healthz get
Value
List
Returns the value list of a given table and column
ns-bill-watch value list {table} {column} {search} {field_id} {limit}
AWSCategory
List
Returns the aws category list
ns-bill-watch awscategory list {filters} {page} {size} {sorts}
Get
Returns a aws category by id.
ns-bill-watch awscategory get {id}
Create
Creates a new aws category for an entity
ns-bill-watch awscategory create {entity_id}
--category_id (String)
Delete
Deletes a aws category by an id.
ns-bill-watch awscategory delete {entity_id} {id}
AWSField
List
Returns the aws field list
ns-bill-watch awsfield list {filters} {page} {size} {sorts}
Get
Returns a aws field by id.
ns-bill-watch awsfield get {id}
Create
Creates a new aws field for an entity
ns-bill-watch awsfield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a aws field by an id for an entity
ns-bill-watch awsfield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a aws field by an id.
ns-bill-watch awsfield delete {entity_id} {id}
AWSTag
List
Returns the aws tag list
ns-bill-watch awstag list {filters} {page} {size} {sorts}
Get
Returns a aws tag by id.
ns-bill-watch awstag get {id}
Create
Creates a new aws tag for an entity
ns-bill-watch awstag create {entity_id}
--name (String)
--value (String)
Update
Updates a aws tag by an id for an entity
ns-bill-watch awstag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a aws tag by an id.
ns-bill-watch awstag delete {entity_id} {id}
AWS
List
Returns the aws list
ns-bill-watch aws list {filters} {page} {size} {sorts}
Get
Returns an aws by an id
ns-bill-watch aws get {id}
Create
Creates a new aws
ns-bill-watch aws create
--workspace_id (String)
--credential_aws_id (String)
--topic_id (String)
--log_group_id (String)
--name (String)
--active (Boolean)
--lookback_periods (Array)
--dimensions (Any)
--metrics (Any)
--description (String)
--rule_ids (Array)
--aws_category (Array)
--aws_field (Array)
--aws_tag (Array)
Update
Updates an aws by an id
ns-bill-watch aws update {id}
--workspace_id (String)
--credential_aws_id (String)
--topic_id (String)
--log_group_id (String)
--name (String)
--active (Boolean)
--lookback_periods (Array)
--dimensions (Any)
--metrics (Any)
--description (String)
--rule_ids (Array)
--aws_category (Array)
--aws_field (Array)
--aws_tag (Array)
Delete
Deletes an aws by an id
ns-bill-watch aws delete {id}
AzureCategory
List
Returns the azure category list
ns-bill-watch azurecategory list {filters} {page} {size} {sorts}
Get
Returns a azure category by id.
ns-bill-watch azurecategory get {id}
Create
Creates a new azure category for an entity
ns-bill-watch azurecategory create {entity_id}
--category_id (String)
Delete
Deletes a azure category by an id.
ns-bill-watch azurecategory delete {entity_id} {id}
AzureField
List
Returns the azure field list
ns-bill-watch azurefield list {filters} {page} {size} {sorts}
Get
Returns a azure field by id.
ns-bill-watch azurefield get {id}
Create
Creates a new azure field for an entity
ns-bill-watch azurefield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a azure field by an id for an entity
ns-bill-watch azurefield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a azure field by an id.
ns-bill-watch azurefield delete {entity_id} {id}
AzureTag
List
Returns the azure tag list
ns-bill-watch azuretag list {filters} {page} {size} {sorts}
Get
Returns a azure tag by id.
ns-bill-watch azuretag get {id}
Create
Creates a new azure tag for an entity
ns-bill-watch azuretag create {entity_id}
--name (String)
--value (String)
Update
Updates a azure tag by an id for an entity
ns-bill-watch azuretag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a azure tag by an id.
ns-bill-watch azuretag delete {entity_id} {id}
Azure
List
Returns the azure list
ns-bill-watch azure list {filters} {page} {size} {sorts}
Get
Returns an azure by an id
ns-bill-watch azure get {id}
Create
Creates a new azure
ns-bill-watch azure create
--workspace_id (String)
--credential_azure_id (String)
--topic_id (String)
--log_group_id (String)
--name (String)
--active (Boolean)
--lookback_periods (Array)
--description (String)
--rule_ids (Array)
--azure_category (Array)
--azure_field (Array)
--azure_tag (Array)
Update
Updates an azure by an id
ns-bill-watch azure update {id}
--workspace_id (String)
--credential_azure_id (String)
--topic_id (String)
--log_group_id (String)
--name (String)
--active (Boolean)
--lookback_periods (Array)
--description (String)
--rule_ids (Array)
--azure_category (Array)
--azure_field (Array)
--azure_tag (Array)
Delete
Deletes an azure by an id
ns-bill-watch azure delete {id}
GCPCategory
List
Returns the gcp category list
ns-bill-watch gcpcategory list {filters} {page} {size} {sorts}
Get
Returns a gcp category by id.
ns-bill-watch gcpcategory get {id}
Create
Creates a new gcp category for an entity
ns-bill-watch gcpcategory create {entity_id}
--category_id (String)
Delete
Deletes a gcp category by an id.
ns-bill-watch gcpcategory delete {entity_id} {id}
GCPField
List
Returns the gcp field list
ns-bill-watch gcpfield list {filters} {page} {size} {sorts}
Get
Returns a gcp field by id.
ns-bill-watch gcpfield get {id}
Create
Creates a new gcp field for an entity
ns-bill-watch gcpfield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a gcp field by an id for an entity
ns-bill-watch gcpfield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a gcp field by an id.
ns-bill-watch gcpfield delete {entity_id} {id}
GCPTag
List
Returns the gcp tag list
ns-bill-watch gcptag list {filters} {page} {size} {sorts}
Get
Returns a gcp tag by id.
ns-bill-watch gcptag get {id}
Create
Creates a new gcp tag for an entity
ns-bill-watch gcptag create {entity_id}
--name (String)
--value (String)
Update
Updates a gcp tag by an id for an entity
ns-bill-watch gcptag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a gcp tag by an id.
ns-bill-watch gcptag delete {entity_id} {id}
GCP
List
Returns the gcp list
ns-bill-watch gcp list {filters} {page} {size} {sorts}
Get
Returns a gcp by an id
ns-bill-watch gcp get {id}
Create
Creates a new gcp
ns-bill-watch gcp create
--workspace_id (String)
--credential_gcp_id (String)
--topic_id (String)
--log_group_id (String)
--name (String)
--active (Boolean)
--lookback_periods (Array)
--description (String)
--rule_ids (Array)
--gcp_category (Array)
--gcp_field (Array)
--gcp_tag (Array)
Update
Updates a gcp by an id
ns-bill-watch gcp update {id}
--workspace_id (String)
--credential_gcp_id (String)
--topic_id (String)
--log_group_id (String)
--name (String)
--active (Boolean)
--lookback_periods (Array)
--description (String)
--rule_ids (Array)
--gcp_category (Array)
--gcp_field (Array)
--gcp_tag (Array)
Delete
Deletes a gcp by an id
ns-bill-watch gcp delete {id}
RuleCategory
List
Returns the rule category list
ns-bill-watch rulecategory list {filters} {page} {size} {sorts}
Get
Returns a rule category by id.
ns-bill-watch rulecategory get {id}
Create
Creates a new rule category for an entity
ns-bill-watch rulecategory create {entity_id}
--category_id (String)
Delete
Deletes a rule category by an id.
ns-bill-watch rulecategory delete {entity_id} {id}
RuleField
List
Returns the rule field list
ns-bill-watch rulefield list {filters} {page} {size} {sorts}
Get
Returns a rule field by id.
ns-bill-watch rulefield get {id}
Create
Creates a new rule field for an entity
ns-bill-watch rulefield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a rule field by an id for an entity
ns-bill-watch rulefield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a rule field by an id.
ns-bill-watch rulefield delete {entity_id} {id}
RuleTag
List
Returns the rule tag list
ns-bill-watch ruletag list {filters} {page} {size} {sorts}
Get
Returns a rule tag by id.
ns-bill-watch ruletag get {id}
Create
Creates a new rule tag for an entity
ns-bill-watch ruletag create {entity_id}
--name (String)
--value (String)
Update
Updates a rule tag by an id for an entity
ns-bill-watch ruletag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a rule tag by an id.
ns-bill-watch ruletag delete {entity_id} {id}
Rule
List
Returns the rule list
ns-bill-watch rule list {filters} {page} {size} {sorts}
Get
Returns a rule by an id
ns-bill-watch rule get {id}
Create
Creates a new rule
ns-bill-watch rule create
--workspace_id (String)
--name (String)
--conditions (Any)
--description (String)
--rule_category (Array)
--rule_field (Array)
--rule_tag (Array)
Update
Updates a rule by an id
ns-bill-watch rule update {id}
--workspace_id (String)
--name (String)
--conditions (Any)
--description (String)
--rule_category (Array)
--rule_field (Array)
--rule_tag (Array)
Delete
Deletes a rule by an id
ns-bill-watch rule delete {id}
Schemas
AWSCategory
{ "name": "AWSCategory", "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 } }}
AWSField
{ "name": "AWSField", "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": "Any", "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": "Any", "required": false } }}
AWSTag
{ "name": "AWSTag", "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 } }}
AWS
{ "name": "AWS", "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 }, "credential_aws_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "log_group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "active": { "type": "Boolean", "required": true }, "lookback_periods": { "type": "Any", "required": true }, "dimensions": { "type": "Any", "required": true }, "metrics": { "type": "Any", "required": true }, "description": { "type": "String", "required": false }, "last_run_status": { "name": "AWSLastRunStatus", "type": "Enum", "required": true, "valids": [ "NotStarted", "Processing", "Scheduled", "Successed", "Failed" ] }, "last_run_at": { "type": "DateTime", "required": false }, "last_run_anomaly_found": { "type": "Boolean", "required": false }, "last_run_message": { "type": "String", "required": false }, "next_run_scheduled_at": { "type": "DateTime", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
AWSFull
{ "name": "AWSFull", "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 }, "credential_aws_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "log_group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "active": { "type": "Boolean", "required": true }, "lookback_periods": { "type": "Array", "required": true, "items": [ { "name": "LookbackPeriod", "type": "Object", "required": true, "fields": { "days": { "type": "Integer", "required": true }, "mon": { "type": "Boolean", "required": true }, "tue": { "type": "Boolean", "required": true }, "wed": { "type": "Boolean", "required": true }, "thu": { "type": "Boolean", "required": true }, "fri": { "type": "Boolean", "required": true }, "sat": { "type": "Boolean", "required": true }, "sun": { "type": "Boolean", "required": true } } } ] }, "dimensions": { "type": "Any", "required": true }, "metrics": { "type": "Any", "required": true }, "description": { "type": "String", "required": false }, "last_run_status": { "name": "AWSLastRunStatus", "type": "Enum", "required": true, "valids": [ "NotStarted", "Processing", "Scheduled", "Successed", "Failed" ] }, "last_run_at": { "type": "DateTime", "required": false }, "last_run_anomaly_found": { "type": "Boolean", "required": false }, "last_run_message": { "type": "String", "required": false }, "next_run_scheduled_at": { "type": "DateTime", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "aws_rule": { "type": "Array", "required": true, "items": [ { "name": "AWSRule", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "aws_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "rule_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } ] }, "aws_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "aws_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": "Any", "required": false } } } ] }, "aws_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 } } } ] } }}
LookbackPeriod
{ "name": "LookbackPeriod", "type": "Object", "required": true, "fields": { "days": { "type": "Integer", "required": true }, "mon": { "type": "Boolean", "required": true }, "tue": { "type": "Boolean", "required": true }, "wed": { "type": "Boolean", "required": true }, "thu": { "type": "Boolean", "required": true }, "fri": { "type": "Boolean", "required": true }, "sat": { "type": "Boolean", "required": true }, "sun": { "type": "Boolean", "required": true } }}
AWSRule
{ "name": "AWSRule", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "aws_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "rule_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
AWSInput
{ "name": "AWSInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "credential_aws_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "log_group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "active": { "type": "Boolean", "required": true }, "lookback_periods": { "type": "Array", "required": true, "items": [ { "name": "LookbackPeriod", "type": "Object", "required": true, "fields": { "days": { "type": "Integer", "required": true }, "mon": { "type": "Boolean", "required": true }, "tue": { "type": "Boolean", "required": true }, "wed": { "type": "Boolean", "required": true }, "thu": { "type": "Boolean", "required": true }, "fri": { "type": "Boolean", "required": true }, "sat": { "type": "Boolean", "required": true }, "sun": { "type": "Boolean", "required": true } } } ] }, "dimensions": { "type": "Any", "required": true }, "metrics": { "type": "Any", "required": true }, "description": { "type": "String", "required": false }, "rule_ids": { "type": "Array", "required": true, "items": [ { "type": "String", "required": true, "min": 20 } ] }, "aws_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "aws_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": "Any", "required": false } } } ] }, "aws_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 } } } ] } }}
AzureCategory
{ "name": "AzureCategory", "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 } }}
AzureField
{ "name": "AzureField", "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": "Any", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
AzureTag
{ "name": "AzureTag", "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 } }}
Azure
{ "name": "Azure", "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 }, "credential_azure_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "log_group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "active": { "type": "Boolean", "required": true }, "lookback_periods": { "type": "Any", "required": true }, "description": { "type": "String", "required": false }, "last_run_status": { "name": "AzureLastRunStatus", "type": "Enum", "required": true, "valids": [ "NotStarted", "Processing", "Scheduled", "Successed", "Failed" ] }, "last_run_at": { "type": "DateTime", "required": false }, "last_run_anomaly_found": { "type": "Boolean", "required": false }, "last_run_message": { "type": "String", "required": false }, "next_run_scheduled_at": { "type": "DateTime", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
AzureFull
{ "name": "AzureFull", "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 }, "credential_azure_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "log_group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "active": { "type": "Boolean", "required": true }, "lookback_periods": { "type": "Array", "required": true, "items": [ { "name": "LookbackPeriod", "type": "Object", "required": true, "fields": { "days": { "type": "Integer", "required": true }, "mon": { "type": "Boolean", "required": true }, "tue": { "type": "Boolean", "required": true }, "wed": { "type": "Boolean", "required": true }, "thu": { "type": "Boolean", "required": true }, "fri": { "type": "Boolean", "required": true }, "sat": { "type": "Boolean", "required": true }, "sun": { "type": "Boolean", "required": true } } } ] }, "description": { "type": "String", "required": false }, "last_run_status": { "name": "AzureLastRunStatus", "type": "Enum", "required": true, "valids": [ "NotStarted", "Processing", "Scheduled", "Successed", "Failed" ] }, "last_run_at": { "type": "DateTime", "required": false }, "last_run_anomaly_found": { "type": "Boolean", "required": false }, "last_run_message": { "type": "String", "required": false }, "next_run_scheduled_at": { "type": "DateTime", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "azure_rule": { "type": "Array", "required": true, "items": [ { "name": "AzureRule", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "azure_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "rule_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } ] }, "azure_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "azure_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": "Any", "required": false } } } ] }, "azure_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 } } } ] } }}
AzureRule
{ "name": "AzureRule", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "azure_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "rule_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
AzureInput
{ "name": "AzureInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "credential_azure_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "log_group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "active": { "type": "Boolean", "required": true }, "lookback_periods": { "type": "Array", "required": true, "items": [ { "name": "LookbackPeriod", "type": "Object", "required": true, "fields": { "days": { "type": "Integer", "required": true }, "mon": { "type": "Boolean", "required": true }, "tue": { "type": "Boolean", "required": true }, "wed": { "type": "Boolean", "required": true }, "thu": { "type": "Boolean", "required": true }, "fri": { "type": "Boolean", "required": true }, "sat": { "type": "Boolean", "required": true }, "sun": { "type": "Boolean", "required": true } } } ] }, "description": { "type": "String", "required": false }, "rule_ids": { "type": "Array", "required": true, "items": [ { "type": "String", "required": true, "min": 20 } ] }, "azure_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "azure_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": "Any", "required": false } } } ] }, "azure_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 } } } ] } }}
GCPCategory
{ "name": "GCPCategory", "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 } }}
GCPField
{ "name": "GCPField", "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": "Any", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GCPTag
{ "name": "GCPTag", "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 } }}
GCP
{ "name": "GCP", "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 }, "credential_gcp_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "log_group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "active": { "type": "Boolean", "required": true }, "lookback_periods": { "type": "Any", "required": true }, "description": { "type": "String", "required": false }, "last_run_status": { "name": "GCPLastRunStatus", "type": "Enum", "required": true, "valids": [ "NotStarted", "Processing", "Scheduled", "Successed", "Failed" ] }, "last_run_at": { "type": "DateTime", "required": false }, "last_run_anomaly_found": { "type": "Boolean", "required": false }, "last_run_message": { "type": "String", "required": false }, "next_run_scheduled_at": { "type": "DateTime", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GCPFull
{ "name": "GCPFull", "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 }, "credential_gcp_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "log_group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "active": { "type": "Boolean", "required": true }, "lookback_periods": { "type": "Array", "required": true, "items": [ { "name": "LookbackPeriod", "type": "Object", "required": true, "fields": { "days": { "type": "Integer", "required": true }, "mon": { "type": "Boolean", "required": true }, "tue": { "type": "Boolean", "required": true }, "wed": { "type": "Boolean", "required": true }, "thu": { "type": "Boolean", "required": true }, "fri": { "type": "Boolean", "required": true }, "sat": { "type": "Boolean", "required": true }, "sun": { "type": "Boolean", "required": true } } } ] }, "description": { "type": "String", "required": false }, "last_run_status": { "name": "GCPLastRunStatus", "type": "Enum", "required": true, "valids": [ "NotStarted", "Processing", "Scheduled", "Successed", "Failed" ] }, "last_run_at": { "type": "DateTime", "required": false }, "last_run_anomaly_found": { "type": "Boolean", "required": false }, "last_run_message": { "type": "String", "required": false }, "next_run_scheduled_at": { "type": "DateTime", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "gcp_rule": { "type": "Array", "required": true, "items": [ { "name": "GCPRule", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "gcp_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "rule_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } ] }, "gcp_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "gcp_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": "Any", "required": false } } } ] }, "gcp_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 } } } ] } }}
GCPRule
{ "name": "GCPRule", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "gcp_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "rule_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GCPInput
{ "name": "GCPInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "credential_gcp_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "log_group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "active": { "type": "Boolean", "required": true }, "lookback_periods": { "type": "Array", "required": true, "items": [ { "name": "LookbackPeriod", "type": "Object", "required": true, "fields": { "days": { "type": "Integer", "required": true }, "mon": { "type": "Boolean", "required": true }, "tue": { "type": "Boolean", "required": true }, "wed": { "type": "Boolean", "required": true }, "thu": { "type": "Boolean", "required": true }, "fri": { "type": "Boolean", "required": true }, "sat": { "type": "Boolean", "required": true }, "sun": { "type": "Boolean", "required": true } } } ] }, "description": { "type": "String", "required": false }, "rule_ids": { "type": "Array", "required": true, "items": [ { "type": "String", "required": true, "min": 20 } ] }, "gcp_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "gcp_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": "Any", "required": false } } } ] }, "gcp_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 } } } ] } }}
RuleCategory
{ "name": "RuleCategory", "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 } }}
RuleField
{ "name": "RuleField", "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": "Any", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
RuleTag
{ "name": "RuleTag", "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 } }}
Rule
{ "name": "Rule", "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 }, "conditions": { "type": "Any", "required": true }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
RuleFull
{ "name": "RuleFull", "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 }, "conditions": { "type": "Any", "required": true }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "rule_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "rule_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": "Any", "required": false } } } ] }, "rule_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 } } } ] } }}
RuleInput
{ "name": "RuleInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "conditions": { "type": "Any", "required": true }, "description": { "type": "String", "required": false }, "rule_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "rule_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": "Any", "required": false } } } ] }, "rule_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 } } } ] } }}
Enums
AWSLastRunStatus
NotStarted
Processing
Scheduled
Successed
Failed
AzureLastRunStatus
NotStarted
Processing
Scheduled
Successed
Failed
GCPLastRunStatus
NotStarted
Processing
Scheduled
Successed
Failed
Namira Software Corporation
©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.