Skip to content
TotalView API

Get Gating Status

GET
/api/v1/gating/status
 
curl --request GET \
  --url https://api.totalview.energy/api/v1/gating/status \
  --header 'Authorization: Bearer <token>'

Return current month’s usage and remaining capacity for a customer.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
customer_id
Any of:
string

Customer ID (admin only)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
GatingStatus

Current usage/gating status for a customer.

object
customer_id
required
Customer Id
string format: uuid
plan_type
required
Plan Type
string
gating_disabled
required
Gating Disabled
boolean
monthly_run_limit
required
Monthly Run Limit
integer
monthly_mw_limit
required
Monthly Mw Limit
number
runs_used
required
Runs Used
integer
runs_remaining
required
Runs Remaining
integer
mw_used
required
Mw Used
number
mw_remaining
required
Mw Remaining
number
monthly_existing_mw_limit
required
Monthly Existing Mw Limit
number
monthly_future_run_limit
required
Monthly Future Run Limit
integer
existing_mw_used
required
Existing Mw Used
number
existing_mw_remaining
required
Existing Mw Remaining
number
future_runs_used
required
Future Runs Used
integer
future_runs_remaining
required
Future Runs Remaining
integer
Example generated
{
  "customer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "plan_type": "example",
  "gating_disabled": true,
  "monthly_run_limit": 1,
  "monthly_mw_limit": 1,
  "runs_used": 1,
  "runs_remaining": 1,
  "mw_used": 1,
  "mw_remaining": 1,
  "monthly_existing_mw_limit": 1,
  "monthly_future_run_limit": 1,
  "existing_mw_used": 1,
  "existing_mw_remaining": 1,
  "future_runs_used": 1,
  "future_runs_remaining": 1
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}