Harness

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 -i -X GET \
  'https://app.harness.io/gateway/lw/api/accounts/{account_id}/autostopping/rules?accountIdentifier=string&dry_run=false' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "response": [
    ]
}

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 -i -X POST \
  'https://app.harness.io/gateway/lw/api/accounts/{account_id}/autostopping/rules?accountIdentifier=string' \
  -H 'Content-Type: */*' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[object Object]'
Response samples
application/json
{
  • "response": {
    }
}

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 -i -X GET \
  'https://app.harness.io/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "response": {
    }
}

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 -i -X DELETE \
  'https://app.harness.io/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

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 -i -X GET \
  'https://app.harness.io/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/health?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
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 -i -X GET \
  'https://app.harness.io/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/savings?accountIdentifier=string&from=string&to=string&group_by=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
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 -i -X GET \
  'https://app.harness.io/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/resources?cloud_account_id=string&region=string&accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "response": [
    ]
}

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 -i -X GET \
  'https://app.harness.io/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/diagnostics?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "response": [
    ]
}

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 -i -X POST \
  'https://app.harness.io/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/warmup?accountIdentifier=string' \
  -H 'Content-Type: */*' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[object Object]'
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 -i -X POST \
  'https://app.harness.io/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/cooldown?accountIdentifier=string' \
  -H 'Content-Type: */*' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[object Object]'
Response samples
application/json
"string"

Return metadata of cool down of an AutoStopping Rule

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 -i -X GET \
  'https://app.harness.io/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/cooldown_meta?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "ts": 0,
  • "success": true,
  • "response": [
    ]
}

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 -i -X GET \
  'https://app.harness.io/gateway/lw/api/accounts/{account_id}/autostopping/rules/savings/cumulative?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "response": {
    }
}

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 -i -X PUT \
  'https://app.harness.io/gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/toggle_state?disable=true&accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "response": [
    ]
}
➔ Next to Cloud Cost AutoStopping Rules V2