Jump to Content
About us
Home
Resources
Recipes
API References
v2
v2020.11.09
About us
Get access to our API and register here!
API References
Get access to our API and register here!
v2
Home
Resources
Recipes
API References
Create a Token
Search
JUMP TO
Inventory API
System
List all Systems
get
Create a System
post
Retrieve a System
get
Update a System
patch
Delete a System
delete
Appliance
List Gateway's Appliances
get
Retrieve an Appliance
get
Update an Appliance
patch
Delete an Appliance
delete
EV Configuration
Retrieve an EV configuration
get
Create an EV Configuration
post
Update an EV configuration
patch
Delete an EV configuration
delete
EV Profile
List available EV profiles
get
Create a new EV profile
post
Retrieve an EV profile
get
Update an EV profile
patch
Delete an EV profile
delete
Gateway
List all Gateways
get
Retrieve a Gateway
get
Update a Gateway
patch
Delete a Gateway
delete
Create a System's Gateway
post
Scan
List Gateway's Scans
get
Job
List Gateway's Jobs
get
Create a job with a given type
post
Get a Job
get
Cancel a particular job
delete
TariffV2
Retrieve the tariff v2 of a system
get
Set the tariff v2 of a system
post
Update the tariff v2 of a system
patch
Retrieve the tariff end prices of a system
get
Set tariff end prices of a system
post
TimeOfUse
Get time of use optimization decisions of a system.
get
Get time of use optimization settings of a system.
get
Set time of use optimization settings for a system.
put
Update time of use optimization settings for a system.
patch
Get the Time-of-Use forecasts for the grid connection point.
get
Get the last updated timestamp for the Time-of-Use forecasts for the grid connection point.
get
Get the historical status of the Time-of-Use service.
get
Get the last known status of the Time-of-Use service.
get
Evaluate whether the system is ready for enabling Time-of-Use.
get
Get the historical KPIs of the Time-of-Use service.
get
Tag
Replace and create all tags for a specific system
put
Update or create tags for a system
patch
List Tags for a Specific System
get
Create or update a tag for a system
put
Delete a tag for a system
delete
Measurements API
System
Retrieve System's Live Measurement.
get
Historical Measurements for Systems
get
Appliance
List Appliance's Raw Measurements
get
List Appliance's Combined Measurements
get
List Appliance's Energy Management Measurements
get
Cluster
Retrieve Cluster's Live Measurement.
get
User API
User
Retrieve the authenticated User
get
Update the authenticated User
patch
Retrieve the authenticated user's login history
get
List Policy Documents attached to the authenticated User
get
Star
List all starred Systems
get
Star a System
put
Unstar a System
delete
List all starred Accounts
get
Star an Account
put
Unstar an Account
delete
Notification
List Notifications
get
Retrieve a Notification
get
Update a Notification
patch
Token
List all Tokens
get
Create a Token
post
Retrieve a Token
get
Update a Token
patch
Delete a Token
delete
Users
Retrieve a User by ID
get
Customer API
Customer
List all Customers
get
Get Customer
get
Edit a single customer
patch
Delete Customer
delete
List Customer's users
get
Account API
Scan Configuration
Retrieve Scan Configuration
get
Create a Scan Configuration
post
Update a Scan Configuration
patch
Delete a Scan Configuration
delete
Account
Retrieve the authenticated Account
get
Update the authenticated Account
patch
List all Accounts
get
Create an Account
post
Retrieve an Account
get
Update an Account
patch
Delete an Account
delete
List all nested Accounts
get
Get account tree
get
List all parent accounts
get
Get bidding zone
get
Set bidding zone
put
Market Prices
Retrieve energy market prices for the authenticated account
get
Token
List API tokens
get
Create an organizational API token
post
Get an organizational API token
get
Partially update an organizational API token
patch
Delete organizational API token
delete
Rotate an existing organizational API token
post
System
List Account's Systems
get
Assign a System to an Account
post
Unassign a System from an Account
delete
Group
List all Groups
get
Create a Group
post
Retrieve a Group
get
Delete a Group
delete
Get Policy Documents in a Group
get
User
Retrieve a User by ID.
get
Delete User
delete
Notification
List all Notifications
get
Retrieve a Notification
get
List all Rules
get
Create a Rule
post
Retrieve a Rule
get
Update a Rule
put
Delete a Rule
delete
Import Power Limit API
Import Power Limit
Retrieve gateway's current import power limit.
get
Set gateway's import power limit.
put
Delete gateway's import power limit.
delete
Webhook Event Receiver API
Webhook Receiver
Webhook Receiver
post
Powered by
Create a Token
post
https://api.gridx.de/user/tokens
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!
