Cloud Cost AutoStopping Rules

This contains APIs to create and manage AutoStopping Rules for your cloud resources.

List AutoStopping Rules

Lists all the AutoStopping rules separated by comma-separated strings.

Securityx-api-key

Request

path Parameters

account_id

required

string

Account Identifier for the Entity

query Parameters

accountIdentifier required	string Account Identifier for the Entity
dry_run	boolean Default: false Flag which if enabled lists out only dry run rules.

Responses

200

successful operation

400

Invalid status value

get/gateway/lw/api/accounts/{account_id}/autostopping/rules

Request samples

curl
Java
Go

Response samples

application/json

{"response": [{"id": 0,
"name": "string",
"org_id": "string",
"account_identifier": "string",
"project_id": "string",
"fulfilment": "string",
"kind": "string",
"cloud_account_id": "string",
"idle_time_mins": 0,
"host_name": "string",
"health_check": { },
"custom_domains": ["string"
],
"match_all_subdomains": true,
"disabled": true,
"routing": {"instance": {"filter_text": "string",
"scale_group": {"id": "string",
"name": "string",
"desired": 0,
"min": 0,
"max": 0,
"on_demand": 0,
"spot": 0,
"mixed_instance": true,
"cloud_account_id": "string",
"provider_name": "string",
"target_groups": [{"id": null,
"name": null,
"port": null,
"protocol": null,
"vpc": null
}
],
"region": "string",
"availability_zones": ["string"
],
"status": "string",
"meta": { }
}
},
"ports": [{"protocol": "string",
"target_protocol": "string",
"port": 0,
"target_port": 0,
"server_name": "string",
"action": "string",
"redirect_url": "string",
"routing_rules": [{"path_match": null
}
]
}
],
"lb": "string",
"k8s": {"RuleJson": "string",
"ConnectorID": "string",
"Namespace": "string"
},
"custom_domain_providers": { },
"container_svc": {"cluster": "string",
"service": "string",
"region": "string",
"task_count": 0
},
"database": {"id": "string",
"region": "string"
}
},
"opts": {"preserve_private_ip": true,
"delete_cloud_resources": true,
"always_use_private_ip": true,
"access_details": { },
"hide_progress_page": true
},
"created_at": "string",
"access_point_id": "string",
"metadata": {"cloud_provider_details": {"name": "string",
"type": "string"
},
"target_group_details": { },
"service_errors": [{"error": "string",
"action": "string"
}
],
"kubernetes_connector_id": "string",
"autostopping_proxy_config": {"http": {"proxy": {"id": "string"
},
"ports": [{"protocol": null,
"target_protocol": null,
"port": null,
"target_port": null,
"server_name": null,
"action": null,
"redirect_url": null,
"routing_rules": [ ]
}
]
},
"tcp": {"proxy": {"id": "string"
},
"ports": [{"protocol": null,
"target_protocol": null,
"port": null,
"target_port": null,
"server_name": null,
"action": null,
"redirect_url": null,
"routing_rules": [ ]
}
]
}
}
},
"status": "string"
}
]
}

Create an AutoStopping Rule

Creates a new AutoStopping Rule.

Securityx-api-key

Request

path Parameters

account_id

required

string

Account Identifier for the Entity

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity

Request Body schema: /
required

Service definition of an AutoStopping rule

deps	Array of objects (ServiceDep)
	object (LwService)
apply_now	boolean

Responses

200

successful operation

400

Invalid status value

post/gateway/lw/api/accounts/{account_id}/autostopping/rules

Request samples

curl
Java
Go

Response samples

application/json

{"response": {"id": 0,
"name": "string",
"org_id": "string",
"account_identifier": "string",
"project_id": "string",
"fulfilment": "string",
"kind": "string",
"cloud_account_id": "string",
"idle_time_mins": 0,
"host_name": "string",
"health_check": { },
"custom_domains": ["string"
],
"match_all_subdomains": true,
"disabled": true,
"routing": {"instance": {"filter_text": "string",
"scale_group": {"id": "string",
"name": "string",
"desired": 0,
"min": 0,
"max": 0,
"on_demand": 0,
"spot": 0,
"mixed_instance": true,
"cloud_account_id": "string",
"provider_name": "string",
"target_groups": [{"id": "string",
"name": "string",
"port": 0,
"protocol": "string",
"vpc": "string"
}
],
"region": "string",
"availability_zones": ["string"
],
"status": "string",
"meta": { }
}
},
"ports": [{"protocol": "string",
"target_protocol": "string",
"port": 0,
"target_port": 0,
"server_name": "string",
"action": "string",
"redirect_url": "string",
"routing_rules": [{"path_match": "string"
}
]
}
],
"lb": "string",
"k8s": {"RuleJson": "string",
"ConnectorID": "string",
"Namespace": "string"
},
"custom_domain_providers": { },
"container_svc": {"cluster": "string",
"service": "string",
"region": "string",
"task_count": 0
},
"database": {"id": "string",
"region": "string"
}
},
"opts": {"preserve_private_ip": true,
"delete_cloud_resources": true,
"always_use_private_ip": true,
"access_details": { },
"hide_progress_page": true
},
"created_at": "string",
"access_point_id": "string",
"metadata": {"cloud_provider_details": {"name": "string",
"type": "string"
},
"target_group_details": { },
"service_errors": [{"error": "string",
"action": "string"
}
],
"kubernetes_connector_id": "string",
"autostopping_proxy_config": {"http": {"proxy": {"id": "string"
},
"ports": [{"protocol": "string",
"target_protocol": "string",
"port": 0,
"target_port": 0,
"server_name": "string",
"action": "string",
"redirect_url": "string",
"routing_rules": [null
]
}
]
},
"tcp": {"proxy": {"id": "string"
},
"ports": [{"protocol": "string",
"target_protocol": "string",
"port": 0,
"target_port": 0,
"server_name": "string",
"action": "string",
"redirect_url": "string",
"routing_rules": [null
]
}
]
}
}
},
"status": "string"
}
}

Return AutoStopping Rule details

Returns details of an AutoStopping Rule for the given identifier.

Securityx-api-key

Request

path Parameters

account_id required	string Account Identifier for the Entity
rule_id required	number ID of the AutoStopping Rule for which you need to fetch the details

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity

Responses

200

successful operation

400

Invalid status value

get/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}

Request samples

curl
Java
Go

Response samples

application/json

{"response": {"deps": [{ }
],
"service": {"id": 0,
"name": "string",
"org_id": "string",
"account_identifier": "string",
"project_id": "string",
"fulfilment": "string",
"kind": "string",
"cloud_account_id": "string",
"idle_time_mins": 0,
"host_name": "string",
"health_check": { },
"custom_domains": ["string"
],
"match_all_subdomains": true,
"disabled": true,
"routing": {"instance": {"filter_text": "string",
"scale_group": {"id": "string",
"name": "string",
"desired": 0,
"min": 0,
"max": 0,
"on_demand": 0,
"spot": 0,
"mixed_instance": true,
"cloud_account_id": "string",
"provider_name": "string",
"target_groups": [{"id": null,
"name": null,
"port": null,
"protocol": null,
"vpc": null
}
],
"region": "string",
"availability_zones": ["string"
],
"status": "string",
"meta": { }
}
},
"ports": [{"protocol": "string",
"target_protocol": "string",
"port": 0,
"target_port": 0,
"server_name": "string",
"action": "string",
"redirect_url": "string",
"routing_rules": [{"path_match": null
}
]
}
],
"lb": "string",
"k8s": {"RuleJson": "string",
"ConnectorID": "string",
"Namespace": "string"
},
"custom_domain_providers": { },
"container_svc": {"cluster": "string",
"service": "string",
"region": "string",
"task_count": 0
},
"database": {"id": "string",
"region": "string"
}
},
"opts": {"preserve_private_ip": true,
"delete_cloud_resources": true,
"always_use_private_ip": true,
"access_details": { },
"hide_progress_page": true
},
"created_at": "string",
"access_point_id": "string",
"metadata": {"cloud_provider_details": {"name": "string",
"type": "string"
},
"target_group_details": { },
"service_errors": [{"error": "string",
"action": "string"
}
],
"kubernetes_connector_id": "string",
"autostopping_proxy_config": {"http": {"proxy": {"id": "string"
},
"ports": [{"protocol": null,
"target_protocol": null,
"port": null,
"target_port": null,
"server_name": null,
"action": null,
"redirect_url": null,
"routing_rules": [ ]
}
]
},
"tcp": {"proxy": {"id": "string"
},
"ports": [{"protocol": null,
"target_protocol": null,
"port": null,
"target_port": null,
"server_name": null,
"action": null,
"redirect_url": null,
"routing_rules": [ ]
}
]
}
}
},
"status": "string"
},
"apply_now": true
}
}

Delete an AutoStopping Rule

Deletes an AutoStopping Rule for the given identifier.

Securityx-api-key

Request

path Parameters

rule_id required	number ID of the AutoStopping Rule that you want to delete
account_id required	string Account Identifier for the Entity

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity

Responses

200

successful operation

400

Invalid status value

delete/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}

Request samples

curl
Java
Go

Return health status of an AutoStopping Rule

Returns health status of an AutoStopping Rule for the given identifier.

Securityx-api-key

Request

path Parameters

account_id required	string Account Identifier for the Entity
rule_id required	number ID of the AutoStopping Rule for which you need to fetch the health status

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity

Responses

200

successful operation

400

Invalid status value

get/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/health

Request samples

curl
Java
Go

Response samples

application/json

{"response": { }
}

Return savings details for an AutoStopping Rule

Returns savings details for an AutoStopping rule for the given identifier and the specified time duration.

Securityx-api-key

Request

path Parameters

account_id required	string Account Identifier for the Entity
rule_id required	number ID of the AutoStopping Rule for which you want to fetch savings detail

query Parameters

accountIdentifier required	string Account Identifier for the Entity
from	string Start time for the computation of savings
to	string End time for the computation of savings
group_by	string

Responses

200

successful operation

400

Invalid status value

get/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/savings

Request samples

curl
Java
Go

Response samples

application/json

{ }

List all the resources for an AutoStopping Rule

Lists all the resources for an AutoStopping Rule for the given identifier.

Securityx-api-key

Request

path Parameters

account_id required	string Account Identifier for the Entity
rule_id required	number <int64> ID of the AutoStopping Rule for which you need to list the resources

query Parameters

cloud_account_id required	string Connector ID
region required	string Cloud region where resources belong to
accountIdentifier required	string Account Identifier for the Entity

Responses

200

successful operation

400

Invalid status value

get/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/resources

Request samples

curl
Java
Go

Response samples

application/json

{"response": [{"id": "string",
"name": "string",
"region": "string",
"availability_zone": "string",
"status": "string",
"type": "string",
"launch_time": "string",
"ipv4": ["string"
],
"private_ipv4": ["string"
],
"tags": { },
"resource_type": "string",
"provider_name": "string",
"is_spot": true,
"platform": "string",
"cloud_account_id": 0,
"metadata": { },
"provider_type": "string"
}
]
}

Return diagnostics result of an AutoStopping Rule

Returns the diagnostics result of an AutoStopping rule for the given identifier.

Securityx-api-key

Request

path Parameters

account_id required	string Account Identifier for the Entity
rule_id required	number ID of the AutoStopping rule for which you need to fetch the diagnostics details

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity

Responses

200

successful operation

400

Invalid status value

get/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/diagnostics

Request samples

curl
Java
Go

Response samples

application/json

{"response": [{"message": "string",
"name": "string",
"success": true,
"type": "string"
}
]
}

Warm up an AutoStopping Rule

Warm up resources under an Autostopping rule

Securityx-api-key

Request

path Parameters

account_id required	string Account Identifier for the Entity
rule_id required	number ID of the AutoStopping rule which you want to warm up

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity

Request Body schema: /
required

Warm Up Options

idle_time_mins	integer Default: "5" Specifies time for which resource should be running
source	string Default: "Warm up through API" Specifies source of warm up
forced_trigger	boolean Default: true Specifies warm up as force action to override schedules

Responses

200

successful operation

500

Internal error

post/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/warmup

Request samples

curl
Java
Go

Response samples

application/json

"string"

Cool down an AutoStopping Rule

Cool down resources under an Autostopping rule

Securityx-api-key

Request

path Parameters

account_id required	string Account Identifier for the Entity
rule_id required	number ID of the AutoStopping rule you want to cool down

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity

Request Body schema: /
required

Cool Down Options

propagate	boolean Specifies if we need to propagate cool down to dependant rules
force	boolean Specifies if the cool down is by force

Responses

200

successful operation

500

Internal error

post/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/cooldown

Request samples

curl
Java
Go

Response samples

application/json

"string"

Return metadata of cool down of an AutoStopping Rule

Securityx-api-key

Request

path Parameters

account_id required	string Account Identifier for the Entity
rule_id required	number ID of the AutoStopping rule for which you need to fetch the diagnostics details

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity

Responses

200

successful operation

500

Internal error

get/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/cooldown_meta

Request samples

curl
Java
Go

Response samples

application/json

{"ts": 0,
"success": true,
"response": ["string"
]
}

Return cumulative savings for all the AutoStopping Rules

Returns cumulative savings for all the AutoStopping Rules.

Securityx-api-key

Request

path Parameters

account_id

required

string

Account Identifier for the Entity

query Parameters

accountIdentifier

required

string

Account Identifier for the Entity

Responses

200

successful operation

400

Invalid status value

get/gateway/lw/api/accounts/{account_id}/autostopping/rules/savings/cumulative

Request samples

curl
Java
Go

Response samples

application/json

{"response": {"days": ["string"
],
"potential_cost": [0
],
"actual_cost": [0
],
"savings": [0
],
"total_savings": 0,
"total_potential": 0,
"total_cost": 0,
"savings_percent": 0,
"total_active_services": 0
}
}

Disable/Enable an Autostopping Rule

Disables or enables an Autostopping Rule for the given identifier.

Securityx-api-key

Request

path Parameters

account_id required	string Account Identifier for the Entity
rule_id required	string ID of the AutoStopping rule to be enabled/disabled

query Parameters

disable required	boolean
accountIdentifier required	string Account Identifier for the Entity

Responses

200

successful operation

400

Invalid status value

put/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/toggle_state

Request samples

curl
Java
Go

Response samples

application/json

{"response": [{"id": 0,
"name": "string",
"org_id": "string",
"account_identifier": "string",
"project_id": "string",
"fulfilment": "string",
"kind": "string",
"cloud_account_id": "string",
"idle_time_mins": 0,
"host_name": "string",
"health_check": { },
"custom_domains": ["string"
],
"match_all_subdomains": true,
"disabled": true,
"routing": {"instance": {"filter_text": "string",
"scale_group": {"id": "string",
"name": "string",
"desired": 0,
"min": 0,
"max": 0,
"on_demand": 0,
"spot": 0,
"mixed_instance": true,
"cloud_account_id": "string",
"provider_name": "string",
"target_groups": [{"id": null,
"name": null,
"port": null,
"protocol": null,
"vpc": null
}
],
"region": "string",
"availability_zones": ["string"
],
"status": "string",
"meta": { }
}
},
"ports": [{"protocol": "string",
"target_protocol": "string",
"port": 0,
"target_port": 0,
"server_name": "string",
"action": "string",
"redirect_url": "string",
"routing_rules": [{"path_match": null
}
]
}
],
"lb": "string",
"k8s": {"RuleJson": "string",
"ConnectorID": "string",
"Namespace": "string"
},
"custom_domain_providers": { },
"container_svc": {"cluster": "string",
"service": "string",
"region": "string",
"task_count": 0
},
"database": {"id": "string",
"region": "string"
}
},
"opts": {"preserve_private_ip": true,
"delete_cloud_resources": true,
"always_use_private_ip": true,
"access_details": { },
"hide_progress_page": true
},
"created_at": "string",
"access_point_id": "string",
"metadata": {"cloud_provider_details": {"name": "string",
"type": "string"
},
"target_group_details": { },
"service_errors": [{"error": "string",
"action": "string"
}
],
"kubernetes_connector_id": "string",
"autostopping_proxy_config": {"http": {"proxy": {"id": "string"
},
"ports": [{"protocol": null,
"target_protocol": null,
"port": null,
"target_port": null,
"server_name": null,
"action": null,
"redirect_url": null,
"routing_rules": [ ]
}
]
},
"tcp": {"proxy": {"id": "string"
},
"ports": [{"protocol": null,
"target_protocol": null,
"port": null,
"target_port": null,
"server_name": null,
"action": null,
"redirect_url": null,
"routing_rules": [ ]
}
]
}
}
},
"status": "string"
}
]
}

➔ Next to Cloud Cost AutoStopping Rules V2

Cloud Cost AutoStopping Rules

List AutoStopping Rules

path Parameters

query Parameters

Create an AutoStopping Rule

path Parameters

query Parameters

Request Body schema: */*required

Return AutoStopping Rule details

path Parameters

query Parameters

Delete an AutoStopping Rule

path Parameters

query Parameters

Return health status of an AutoStopping Rule

path Parameters

query Parameters

Return savings details for an AutoStopping Rule

path Parameters

query Parameters

List all the resources for an AutoStopping Rule

path Parameters

query Parameters

Return diagnostics result of an AutoStopping Rule

path Parameters

query Parameters

Warm up an AutoStopping Rule

path Parameters

query Parameters

Request Body schema: */*required

Cool down an AutoStopping Rule

path Parameters

query Parameters

Request Body schema: */*required

Return metadata of cool down of an AutoStopping Rule

path Parameters

query Parameters

Return cumulative savings for all the AutoStopping Rules

path Parameters

query Parameters

Disable/Enable an Autostopping Rule

path Parameters

query Parameters

Request Body schema: /
required

Request Body schema: /
required

Request Body schema: /
required