Adder RED PSU REST API User Manual
Have a look at the manual Adder RED PSU REST API User Manual online for free. It’s possible to download the document as PDF or print. UserManuals.tech offer 78 ADDER manuals and user’s guides for free. Share the user manual or guide on Facebook, Twitter or Google+.
![Page 6
204Successful Operation (No Content).
401Unauthorised. Invalid or no credentials provided.
/outputs
GET /outputs
Outputs
Summary
Get all Outputs
Responses
CodeDescriptionSchema
200
OK.⇄
▼ {
data:▼ [
▼ {
id:string
type:string
attributes:▼ {
outputNumber:▼ number
The output number
corresponding to the
physical output on the
unit.
current:▼ number (float)
Output current (amps).
status:▼ string
Current Output status.
Enum:
Array [3]
0: "on"
1: "off"
2: "fault"►](http://img.usermanuals.tech/thumb/176/2255/w64_adder-red-psu-rest-api-1478554741_d-5.png "Page 6
204Successful Operation (No Content).
401Unauthorised. Invalid or no credentials provided.
/outputs
GET /outputs
Outputs
Summary
Get all Outputs
Responses
CodeDescriptionSchema
200
OK.⇄
▼ {
data:▼ [
▼ {
id:string
type:string
attributes:▼ {
outputNumber:▼ number
The output number
corresponding to the
physical output on the
unit.
current:▼ number (float)
Output current (amps).
status:▼ string
Current Output status.
Enum:
Array [3]
0: \"on\"
1: \"off\"
2: \"fault\"►")
![Page 7
name:▼ string maxLength:20
Human readable label
corresponding to the
output port.
}
}
]
}
401
Unauthorised. Invalid or no
credentials provided.
/outputs/{id}
GET /outputs/{id}
Outputs
Summary
Get a single Output.
Parameters
NameLocated inDescriptionRequiredSchema
idpathID of OutputYes⇄number
Responses
CodeDescriptionSchema
▼ {
data:▼ {
id:string
type:string
attributes:▼ {
outputNumber:▼ number](http://img.usermanuals.tech/thumb/176/2255/w64_adder-red-psu-rest-api-1478554741_d-6.png "Page 7
name:▼ string maxLength:20
Human readable label
corresponding to the
output port.
}
}
]
}
401
Unauthorised. Invalid or no
credentials provided.
/outputs/{id}
GET /outputs/{id}
Outputs
Summary
Get a single Output.
Parameters
NameLocated inDescriptionRequiredSchema
idpathID of OutputYes⇄number
Responses
CodeDescriptionSchema
▼ {
data:▼ {
id:string
type:string
attributes:▼ {
outputNumber:▼ number")
![Page 8
200OK.⇄
The output number
corresponding to the
physical output on the unit.
current:▼ number (float)
Output current (amps).
status:▼ string
Current Output status.
Enum:
Array [3]
0: "on"
1: "off"
2: "fault"
name:▼ string maxLength:20
Human readable label
corresponding to the output
port.
}
}
}
401
Unauthorised. Invalid or no
credentials provided.
404Document not found.
PUT /outputs/{id}
Outputs
Summary
Update an Output.
Parameters
NameLocated
inDescriptionRequiredSchema...](http://img.usermanuals.tech/thumb/176/2255/w64_adder-red-psu-rest-api-1478554741_d-7.png "Page 8
200OK.⇄
The output number
corresponding to the
physical output on the unit.
current:▼ number (float)
Output current (amps).
status:▼ string
Current Output status.
Enum:
Array [3]
0: \"on\"
1: \"off\"
2: \"fault\"
name:▼ string maxLength:20
Human readable label
corresponding to the output
port.
}
}
}
401
Unauthorised. Invalid or no
credentials provided.
404Document not found.
PUT /outputs/{id}
Outputs
Summary
Update an Output.
Parameters
NameLocated
inDescriptionRequiredSchema...")
![Page 9
ID of Output
bodybody
Output object with attributes
to be updated.
Yes⇄
▼ {
data:▼ {
id:string
type:string
attributes:▼ {
status:▼ string
Set the requested
Output status.
Enum:
Array [2]
0: "ON"
1: "OFF"
name:▼ string maxLength:20
Human readable label
corresponding to the
output port.
}
}
}
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....](http://img.usermanuals.tech/thumb/176/2255/w64_adder-red-psu-rest-api-1478554741_d-8.png "Page 9
ID of Output
bodybody
Output object with attributes
to be updated.
Yes⇄
▼ {
data:▼ {
id:string
type:string
attributes:▼ {
status:▼ string
Set the requested
Output status.
Enum:
Array [2]
0: \"ON\"
1: \"OFF\"
name:▼ string maxLength:20
Human readable label
corresponding to the
output port.
}
}
}
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....")
![Page 10
PSUs
Summary
Get all PSUs
Responses
CodeDescriptionSchema
200OK.⇄
▼ {
data:▼ [
▼ {
id:string
type:string
attributes:▼ {
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:▼...](http://img.usermanuals.tech/thumb/176/2255/w64_adder-red-psu-rest-api-1478554741_d-9.png "Page 10
PSUs
Summary
Get all PSUs
Responses
CodeDescriptionSchema
200OK.⇄
▼ {
data:▼ [
▼ {
id:string
type:string
attributes:▼ {
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:▼...")
![Page 11
(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:▼ {](http://img.usermanuals.tech/thumb/176/2255/w64_adder-red-psu-rest-api-1478554741_d-10.png "Page 11
(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:▼ {")
![Page 12
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)...](http://img.usermanuals.tech/thumb/176/2255/w64_adder-red-psu-rest-api-1478554741_d-11.png "Page 12
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)...")
![Page 13
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](http://img.usermanuals.tech/thumb/176/2255/w64_adder-red-psu-rest-api-1478554741_d-12.png "Page 13
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")
(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) Output current (amps). } } } 401 Unauthorised. Invalid or no credentials provided. 404Document not found. /users►
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.
409
Conflict. Type and ID do not match
the server's endpoint.
/users/{id}
GET /users/{id}►
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 /users/{id}
Users
Summary
Delete a User account.
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
attributes:▼ {
username:▼ 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.