Adder RED PSU REST API User Manual

(amps).
outputCurrent:▼ number (float)
Output current
(amps).
}
}
]
}
401
Unauthorised. Invalid or no
credentials provided.
/psus/{id}
GET /psus/{id}
PSUs
Summary
Get a single PSU
Parameters
NameLocated inDescriptionRequiredSchema
idpathID of PSUYes⇄number
Responses
CodeDescriptionSchema
▼ {
data:▼ {
id:string
type:string
attributes:▼ { 

200OK.⇄
psuNumber:▼ number
The PSU number
corresponding to the
physical psu on the
unit.
status:▼ string
Current state of the
PSU.
Enum:
 Array [4]
0: "active"
1: "present"
2: "not present"
3: "invalid"
internalTemperature:▼ number (float)
Internal temperature
(degrees Celsius).
ambientTemperature:▼ number (float)
Ambient temperature
(degrees Celsius).
fanSpeed:▼ number
Fan-speed (rpm).
mainsCurrent:▼ number (float)
Input current (amps).
outputCurrent:▼ number (float)...

GET /users
Users
Summary
Get all Users accounts.
Responses
CodeDescriptionSchema
200OK.⇄
▼ {
data:▼ [
▼ {
id:string
type:string
attributes:▼ {
username:▼ string
maxLength:18
Unique username
}
}
]
}
401
Unauthorised. Invalid or no credentials
provided.
POST /users
Users
Summary
Add a new User account.
Parameters 

NameLocated
inDescriptionRequiredSchema
bodybody
User object with new User
attributes.
Yes⇄
▼ {
data:▼ {
type:string
attributes:▼ {
username:▼ string
maxLength:18
Unique
username
password:▼ string
Password
}
}
}
Responses
CodeDescriptionHeaders
201Resource Created.
NameDescriptionTypeDetails
Location
Location of
the newly
created
resource.
"string"
 Object
description: "Location of the newly creat
ed resource."
type: "string"
401
Unauthorised. Invalid or no
credentials provided....

Users
Summary
Get a single User account.
Parameters
NameLocated inDescriptionRequiredSchema
idpathID of UserYes⇄number
Responses
CodeDescriptionSchema
200OK.⇄
▼ {
data:▼ {
id:string
type:string
attributes:▼ {
username:▼ string
maxLength:18
Unique username
}
}
}
401
Unauthorised. Invalid or no credentials
provided.
404Document not found.
PUT /users/{id}
Users
Summary 

Update a User account.
Parameters
NameLocated
inDescriptionRequiredSchema
idpathID of UserYes⇄number
bodybody
User object with attributes to be
updated.
Yes⇄
▼ {
data:▼ {
id:string
type:string
attributes:▼ {
password:▼ string
Password
}
}
}
Responses
CodeDescription
204Successful Operation (No Content).
401Unauthorised. Invalid or no credentials provided.
404Not Found. Response to a request to modify a resource that does not exist.
409Conflict. Type and ID do not match the server's endpoint.
DELETE...

Parameters
NameLocated inDescriptionRequiredSchema
idpathID of UserYes⇄number
Responses
CodeDescription
204Successful Operation (No Content).
401Unauthorised. Invalid or no credentials provided.
404Not Found. Response to a request to delete a resource that does not exist.
409Conflict. Response to a request to delete admin user.
/users/me
GET /users/me
Users
Summary
Special case to get the user information for authenticated user.
Responses
CodeDescriptionSchema
200OK.⇄
▼ {
data:▼ {
id:string
type:string...

maxLength:18
Unique username
}
}
}
401
Unauthorised. Invalid or no credentials
provided.
404Document not found.
/network
GET /network
Network
Summary
Get network information
Responses
CodeDescriptionSchema
200OK.⇄
▼ {
data:▼ {
id:string
type:string
attributes:▼ {
macAddress:▼ string
Network interface
MAC address
ipAddress:▼ string
IP Address
ipNetmask:▼ string
Netmask IP 

ipGateway:▼ string
Gateway IP
useDhcp:▼ boolean
Use DHCP
}
}
}
401
Unauthorised. Invalid or no credentials
provided.
PUT /network
Network
Summary
Update the network information
Parameters
NameLocated
inDescriptionRequiredSchema
resourcebody
Network object with attributes to be
updated.
Yes⇄
▼ {
data:▼ {
id:string
type:string
attributes:▼ {
ipAddress:▼ string
IP
Address
ipNetmask:▼ string
Netmask
IP
ipGateway:▼ string
Gateway
IP 

useDhcp:▼
boolean
Use
DHCP
}
}
}
Responses
CodeDescription
204Successful Operation (No Content).
401Unauthorised. Invalid or no credentials provided.
409Conflict. Type and ID do not match the server's endpoint.