Inventory API

System
Appliance
EV Configuration
EV Profile
Gateway
Scan
- List Gateway's Scansget
Job
TariffV2
TimeOfUse
Tag

Measurements API

System
- Retrieve System's Live Measurement.get
- Historical Measurements for Systemsget
Appliance
Cluster
- Retrieve Cluster's Live Measurement.get

User API

User
Star
Notification
Token
Users
- Retrieve a User by IDget

Customer API

Customer

Account API

Scan Configuration
Account
Market Prices
- Retrieve energy market prices for the authenticated accountget
Token
System
Group
User
- Retrieve a User by ID.get
- Delete Userdelete
Notification

Import Power Limit API

Import Power Limit

Webhook Event Receiver API

Webhook Receiver
- Webhook Receiverpost

Inventory API

System
Appliance
EV Configuration
EV Profile
Gateway
Scan
- List Gateway's Scansget
Job
TariffV2
TimeOfUse
Tag

Measurements API

System
- Retrieve System's Live Measurement.get
- Historical Measurements for Systemsget
Appliance
Cluster
- Retrieve Cluster's Live Measurement.get

User API

User
Star
Notification
Token
Users
- Retrieve a User by IDget

Customer API

Customer

Account API

Scan Configuration
Account
Market Prices
- Retrieve energy market prices for the authenticated accountget
Token
System
Group
User
- Retrieve a User by ID.get
- Delete Userdelete
Notification

Import Power Limit API

Import Power Limit

Webhook Event Receiver API

Webhook Receiver
- Webhook Receiverpost

Create or update a tag for a system

put https://api.gridx.de/systems/{systemID}/tags/{tagName}

Creates or updates a tag for a specific system. If the tag doesn't exist, it will be created,
and the status code 201 Created will be returned.
If the tag exists, its value will be updated and the status code 200 OK will be returned
(even if the new value is the same as the previous one).

URL Expired

The URL for this request expired after 30 days.

Path Params

systemID

uuid

required

Unique identifier used to access a system.

tagName

string

required

length ≤ 128

The name of the tag to create or update. Must only contain lowercase letters and hyphens, and must not start or end with a hyphen. Must be 128 characters max.

Body Params

The value to associate with the tag.

value

string

required

length ≤ 128

The value associated with the tag name.
This can be any valid string up to 128 characters.

Responses

Response body

object

name

string

required

length ≤ 128

The unique identifier of the tag within the context of the system.
The tag name must consist only of lowercase letters (a-z), numbers (0-9), and hyphens (-), and must not start or end with a hyphen.
It can be at most 128 characters long.

value

string

required

length ≤ 128

The value associated with the tag name.
This can be any valid string up to 128 characters.

createdAt

date-time

Date when the system tag was created in RFC3339 format.

updatedAt

date-time

Date when the system tag was last updated in RFC3339 format.

Response body

object

name

string

required

length ≤ 128

value

string

required

length ≤ 128

The value associated with the tag name.
This can be any valid string up to 128 characters.

createdAt

date-time

Date when the system tag was created in RFC3339 format.

updatedAt

date-time

Date when the system tag was last updated in RFC3339 format.

Response body

object

message

string

required

Message represents the message reported to the user.

details

array of strings

Details represents detail information for the user to fix this
problem

details

Response body

object

message

string

required

Message represents the message reported to the user.

details

array of strings

Details represents detail information for the user to fix this
problem

details

Response body

object

message

string

required

Message represents the message reported to the user.

details

array of strings

Details represents detail information for the user to fix this
problem

details

Response body

object

message

string

required

Message represents the message reported to the user.

details

array of strings

Details represents detail information for the user to fix this
problem

details

Updated 4 months ago

List Tags for a Specific System

Delete a tag for a system

Language

Credentials

Header


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.gridx.de/systems/systemID/tags/tagName \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/vnd.gridx.v2+json

Updated 4 months ago

List Tags for a Specific System

Delete a tag for a system

Inventory API
System
Delete a Systemdelete
Update a Systempatch
Retrieve a Systemget
Create a Systempost
List all Systemsget
Appliance
Delete an Appliancedelete
Update an Appliancepatch
Retrieve an Applianceget
List Gateway's Appliancesget
EV Configuration
Delete an EV configurationdelete
Update an EV configurationpatch
Create an EV Configurationpost
Retrieve an EV configurationget
EV Profile
Delete an EV profiledelete
Update an EV profilepatch
Retrieve an EV profileget
Create a new EV profilepost
List available EV profilesget
Gateway
Create a System's Gatewaypost
Delete a Gatewaydelete
Update a Gatewaypatch
Retrieve a Gatewayget
List all Gatewaysget
Scan
List Gateway's Scansget
Job
Cancel a particular jobdelete
Get a Jobget
Create a job with a given typepost
List Gateway's Jobsget
TariffV2
Set tariff end prices of a systempost
Retrieve the tariff end prices of a systemget
Update the tariff v2 of a systempatch
Set the tariff v2 of a systempost
Retrieve the tariff v2 of a systemget
TimeOfUse
Get the historical KPIs of the Time-of-Use service.get
Evaluate whether the system is ready for enabling Time-of-Use.get
Get the last known status of the Time-of-Use service.get
Get the historical status of the Time-of-Use service.get
Get the last updated timestamp for the Time-of-Use forecasts for the grid connection point.get
Get the Time-of-Use forecasts for the grid connection point.get
Update time of use optimization settings for a system.patch
Set time of use optimization settings for a system.put
Get time of use optimization settings of a system.get
Get time of use optimization decisions of a system.get
Tag
Delete a tag for a systemdelete
Create or update a tag for a systemput
List Tags for a Specific Systemget
Update or create tags for a systempatch
Replace and create all tags for a specific systemput

Measurements API
System
Historical Measurements for Systemsget
Retrieve System's Live Measurement.get
Appliance
List Appliance's Energy Management Measurementsget
List Appliance's Combined Measurementsget
List Appliance's Raw Measurementsget
Cluster
Retrieve Cluster's Live Measurement.get

User API
User
List Policy Documents attached to the authenticated Userget
Retrieve the authenticated user's login historyget
Update the authenticated Userpatch
Retrieve the authenticated Userget
Star
Unstar an Accountdelete
Star an Accountput
List all starred Accountsget
Unstar a Systemdelete
Star a Systemput
List all starred Systemsget
Notification
Update a Notificationpatch
Retrieve a Notificationget
List Notificationsget
Token
Delete a Tokendelete
Update a Tokenpatch
Retrieve a Tokenget
Create a Tokenpost
List all Tokensget
Users
Retrieve a User by IDget

Customer API
Customer
List Customer's usersget
Delete Customerdelete
Edit a single customerpatch
Get Customerget
List all Customersget

Account API
Scan Configuration
Delete a Scan Configurationdelete
Update a Scan Configurationpatch
Create a Scan Configurationpost
Retrieve Scan Configurationget
Account
Set bidding zoneput
Get bidding zoneget
List all parent accountsget
Get account treeget
List all nested Accountsget
Delete an Accountdelete
Update an Accountpatch
Retrieve an Accountget
Create an Accountpost
List all Accountsget
Update the authenticated Accountpatch
Retrieve the authenticated Accountget
Market Prices
Retrieve energy market prices for the authenticated accountget
Token
Rotate an existing organizational API tokenpost
Delete organizational API tokendelete
Partially update an organizational API tokenpatch
Get an organizational API tokenget
Create an organizational API tokenpost
List API tokensget
System
Unassign a System from an Accountdelete
Assign a System to an Accountpost
List Account's Systemsget
Group
Get Policy Documents in a Groupget
Delete a Groupdelete
Retrieve a Groupget
Create a Grouppost
List all Groupsget
User
Delete Userdelete
Retrieve a User by ID.get
Notification
Delete a Ruledelete
Update a Ruleput
Retrieve a Ruleget
Create a Rulepost
List all Rulesget
Retrieve a Notificationget
List all Notificationsget

Import Power Limit API
Import Power Limit
Delete gateway's import power limit.delete
Set gateway's import power limit.put
Retrieve gateway's current import power limit.get

Webhook Event Receiver API
Webhook Receiver
Webhook Receiverpost

Inventory API
System
Delete a Systemdelete
Update a Systempatch
Retrieve a Systemget
Create a Systempost
List all Systemsget
Appliance
Delete an Appliancedelete
Update an Appliancepatch
Retrieve an Applianceget
List Gateway's Appliancesget
EV Configuration
Delete an EV configurationdelete
Update an EV configurationpatch
Create an EV Configurationpost
Retrieve an EV configurationget
EV Profile
Delete an EV profiledelete
Update an EV profilepatch
Retrieve an EV profileget
Create a new EV profilepost
List available EV profilesget
Gateway
Create a System's Gatewaypost
Delete a Gatewaydelete
Update a Gatewaypatch
Retrieve a Gatewayget
List all Gatewaysget
Scan
List Gateway's Scansget
Job
Cancel a particular jobdelete
Get a Jobget
Create a job with a given typepost
List Gateway's Jobsget
TariffV2
Set tariff end prices of a systempost
Retrieve the tariff end prices of a systemget
Update the tariff v2 of a systempatch
Set the tariff v2 of a systempost
Retrieve the tariff v2 of a systemget
TimeOfUse
Get the historical KPIs of the Time-of-Use service.get
Evaluate whether the system is ready for enabling Time-of-Use.get
Get the last known status of the Time-of-Use service.get
Get the historical status of the Time-of-Use service.get
Get the last updated timestamp for the Time-of-Use forecasts for the grid connection point.get
Get the Time-of-Use forecasts for the grid connection point.get
Update time of use optimization settings for a system.patch
Set time of use optimization settings for a system.put
Get time of use optimization settings of a system.get
Get time of use optimization decisions of a system.get
Tag
Delete a tag for a systemdelete
Create or update a tag for a systemput
List Tags for a Specific Systemget
Update or create tags for a systempatch
Replace and create all tags for a specific systemput

Measurements API
System
Historical Measurements for Systemsget
Retrieve System's Live Measurement.get
Appliance
List Appliance's Energy Management Measurementsget
List Appliance's Combined Measurementsget
List Appliance's Raw Measurementsget
Cluster
Retrieve Cluster's Live Measurement.get

User API
User
List Policy Documents attached to the authenticated Userget
Retrieve the authenticated user's login historyget
Update the authenticated Userpatch
Retrieve the authenticated Userget
Star
Unstar an Accountdelete
Star an Accountput
List all starred Accountsget
Unstar a Systemdelete
Star a Systemput
List all starred Systemsget
Notification
Update a Notificationpatch
Retrieve a Notificationget
List Notificationsget
Token
Delete a Tokendelete
Update a Tokenpatch
Retrieve a Tokenget
Create a Tokenpost
List all Tokensget
Users
Retrieve a User by IDget

Customer API
Customer
List Customer's usersget
Delete Customerdelete
Edit a single customerpatch
Get Customerget
List all Customersget

Account API
Scan Configuration
Delete a Scan Configurationdelete
Update a Scan Configurationpatch
Create a Scan Configurationpost
Retrieve Scan Configurationget
Account
Set bidding zoneput
Get bidding zoneget
List all parent accountsget
Get account treeget
List all nested Accountsget
Delete an Accountdelete
Update an Accountpatch
Retrieve an Accountget
Create an Accountpost
List all Accountsget
Update the authenticated Accountpatch
Retrieve the authenticated Accountget
Market Prices
Retrieve energy market prices for the authenticated accountget
Token
Rotate an existing organizational API tokenpost
Delete organizational API tokendelete
Partially update an organizational API tokenpatch
Get an organizational API tokenget
Create an organizational API tokenpost
List API tokensget
System
Unassign a System from an Accountdelete
Assign a System to an Accountpost
List Account's Systemsget
Group
Get Policy Documents in a Groupget
Delete a Groupdelete
Retrieve a Groupget
Create a Grouppost
List all Groupsget
User
Delete Userdelete
Retrieve a User by ID.get
Notification
Delete a Ruledelete
Update a Ruleput
Retrieve a Ruleget
Create a Rulepost
List all Rulesget
Retrieve a Notificationget
List all Notificationsget

Import Power Limit API
Import Power Limit
Delete gateway's import power limit.delete
Set gateway's import power limit.put
Retrieve gateway's current import power limit.get

Webhook Event Receiver API
Webhook Receiver
Webhook Receiverpost

200Tag was successfully updated.

201Tag was successfully created.

400Malformed request.

403Forbidden.

404System not found

500There has been an internal error on our side. We're looking into it.