Adder RED PSU REST API User Manual

							RED PSU REST API
Adder Technology RED PSU REST API. Copyright 2015 Adder Technology. All Rights Reserved.
Version 0.0.5
Paths
/system
GET /system
System
Summary
Get system level information
Responses
CodeDescriptionSchema
200OK.⇄
▼ {
data:▼ {
id:string
type:string
attributes:▼ {
firmwareVersion:▼
Currently running system
firmware version.
name:▼ string maxLength:20
Unit name
description:▼ string maxLength:30
Unit description
location:▼ string maxLength:20
Unit location
requirePassword:▼ boolean
True if a password is 
						

							required to access the
unit.
startupDelay:▼ number
Delay after reset before
outputs start to switch
on (ms).
channelInterval:▼ number
Interval between Outputs
switching on (ms).
}
}
}
401
Unauthorised. Invalid or no
credentials provided.
PUT /system
System
Summary
Update the system information
Parameters
NameLocated
inDescriptionRequiredSchema
▼ {
data:▼ {
id:string
type:string
attributes:▼ {
name:▼ string
maxLength:20
Unit name
description:▼ string
maxLength:30 
						

							resourcebody
System info object with
attributes to be updated.
Yes⇄
Unit
description
location:▼ string
maxLength:20
Unit
location
requirePassword:▼ boolean
True if a
password is
required to
access the
unit.
startupDelay:▼ number
Delay after
reset
before
outputs
start to
switch on
(ms).
channelInterval:▼ number
Interval
between
Outputs
switching
on (ms).
}
}
}
Responses
CodeDescription
204Successful Operation (No Content).
401Unauthorised. Invalid or no credentials provided.
409Conflict. Type and ID do not match the server's endpoint. 
						

							/system/reset
POST /system/reset
System
Summary
Perform a system reset
Parameters
NameLocated inDescriptionRequiredSchema
levelbodyReset levelYes⇄
▼ {
level:string
}
Responses
CodeDescription
204Successful Operation (No Content).
401Unauthorised. Invalid or no credentials provided.
/system/identify
POST /system/identify
System
Summary
Identify the unit by flashing LED's
Description 
						

							Flash the LEDs the required number of times to identify the unit. A negative value will flash them indefinitely. Setting to 0 will
stop the flashing.
Parameters
NameLocated inDescriptionRequiredSchema
repeatbodyNumber of repeats.Yes⇄
▼ {
repeat:number
}
Responses
CodeDescription
204Successful Operation (No Content).
401Unauthorised. Invalid or no credentials provided.
/system/updateFirmware
POST /system/updateFirmware
System
Summary
Update the system firmware
Parameters
NameLocated inDescriptionRequiredSchema
firmwareImageformDataFirmware ImageYes⇄file
Responses
CodeDescription 
						

							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"►  
						

							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 
						

							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
idpathYes⇄number►  
						

							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.
409Conflict. Type and ID do not match the server's endpoint.
/psus
GET /psus►  
						

							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:▼ number
Fan-speed (rpm).
mainsCurrent:▼ number (float)
Input current►