You are viewing an old version of this content. View the current version.
Compare with Current
View Version History
Version 1
Next »
Overview
Check the list of available endpoints and methods to manage the output configuration of your relays:
Endpoints and methods | Description |
|---|
GET /relays{name}/output see below | Get the output configuration of a specific relay. |
PUT /relays{name}/output see below | Edit the output configuration of a specific relay. |
Endpoints and methods
GET /relays/{name}/output
Get the output configuration of a specific relay.
Request
Path parameters
Add the following path parameters as part of the endpoint:
Parameter | Type | Description |
|---|
name required
| string
| Enter the name of the relay that contains the output configuration you want to retrieve. |
Find below a request example:
https://api.us.devo.com/maduro/relays/myRelay/output
Response
Code | Description | Message |
|---|
200 | Successful response. Relay output configuration retrieved. |
{
"memoryBufferSize": 134217728,
"diskBufferSize": 134217728,
"socketTimeout": 0,
"socketBufferSize": 204800,
"socketKeepAlive": true,
"compression": "none"
}
|
400 | Bad request. The specific error will be shown in the message. |
{
"error": {
"code": 12,
"message": "Invalid signature validation"
}
}
|
403 | Forbidden request. | |
404 | Relay not found. |
{
"code": 1100,
"cid": "0fedf299de8d",
"msg": "Relay 'test' not found",
"context": {
"name": "test"
}
}
|
405 | Method not allowed. |
{
"code": 405,
"cid": "f9f67dba12c6",
"msg": "HTTP 405 Method Not Allowed (path: relays)",
"context": null
}
|
PUT /relays/{name}/output
Edit the output configuration of a specific relay.
Request
Path parameters
Add the following path parameters as part of the endpoint:
Parameter | Type | Description |
|---|
name required
| string
| Enter the name of the relay that contains the output configuration you want to update. |
Request body
The request JSON body must include an object with the following key-value pairs:
Parameter | Type | Description |
|---|
memoryBufferSize required
| number
| Memory buffer size in bytes. The minimum value is 128 MB, and the maximum value is 1024 TB. The default value is 128 MB. |
diskBufferSize required
| number
| Disk buffer size in bytes. The minimum value is 128 MB, and the maximum value is 1024 TB. The default value is 128 MB. |
socketTimeout required
| integer
| Socket timeout in seconds. The minimum and default value is 0. |
socketBufferSize required
| integer
| Socket buffer size in bytes. The minimum value is 128 kB, and the maximum value is 4096 kB. The default is 200 kB. |
socketKeepAlive required
| boolean
| Set this option to true if you want to receive a signal to check that the output socket is operating properly. |
compression required
| string
| Choose the required compression type between gzip and none. The default value is none. |
Find below a request example:
https://api.us.devo.com/maduro/relays/myRelay/output
{
"memoryBufferSize": 134217728,
"diskBufferSize": 134217728,
"socketTimeout": 0,
"socketBufferSize": 204800,
"socketKeepAlive": true,
"compression": "none"
}
Response
Code | Description | Message |
|---|
200 | Successful response. Relay output configuration updated. |
{
"memoryBufferSize": 134217728,
"diskBufferSize": 134217728,
"socketTimeout": 0,
"socketBufferSize": 204800,
"socketKeepAlive": true,
"compression": "none"
}
|
400 | Bad request. The specific error will be shown in the message. |
{
"code": 1202,
"cid": "3c8d4019a9c5",
"msg": "Memory buffer size can't be bigger than disk buffer size",
"context": {
"memoryBufferSize": 1.35266304E8,
"diskBufferSize": 1.34217728E8
}
}
|
403 | Forbidden request. | |
404 | Relay not found. |
{
"code": 1100,
"cid": "0fedf299de8d",
"msg": "Relay 'test' not found",
"context": {
"name": "test"
}
}
|
405 | Method not allowed. |
{
"code": 405,
"cid": "f9f67dba12c6",
"msg": "HTTP 405 Method Not Allowed (path: relays)",
"context": null
}
|
