/
Manage relays using the API
Document toolboxDocument toolbox

Manage relays using the API

Owned by Juan Tomás Alonso Nieto (Deactivated)
Last updated: Dec 20, 2023 by Borja Moro Moreno (Unlicensed)
2 min read
[ 1 Overview ] [ 2 Endpoints and methods ]

Overview

Check the list of available endpoints and methods to manage your relays:

Endpoints and methods

Description

Endpoints and methods

Description

GET /relays see below

Get information about all the relays in your domain.

PUT /relays/{name}/activate see below

Activate a relay in your domain.

PUT /relays/{name}/deactivate see below

Deactivate a relay in your domain.

Endpoints and methods

GET /relays

Get information about all the relays in your domain.

Find below a request example:

https://api-us.devo.com/maduro/relays

Code

Description

Message

Code

Description

Message

200

Successful response. Relay information retrieved.

[ { "name": "PENDING__DO-NOT-DELETE", "creationDate": "2021-08-13T13:21:02Z", "updateDate": "2021-08-13T13:21:02Z", "version": "2.0.1", "status": 1, "localSyslogForwarding": true }, { "name": "INACTIVE__DO-NOT-DELETE", "creationDate": "2021-08-13T14:24:23Z", "updateDate": "2021-08-13T14:28:44Z", "version": "2.0.1", "status": 5, "localSyslogForwarding": true }, { "name": "BAD_VERSION__DO-NOT-DELETE", "creationDate": "2021-08-13T14:33:58Z", "updateDate": "2022-05-12T09:05:37Z", "version": "2.0", "status": 0, "localSyslogForwarding": true }, ]

400

Bad request. The specific error will be shown in the message.

{ "error": { "code": 12, "message": "Invalid signature validation" } }

403

Forbidden request.

405

Method not allowed.

PUT /relays/{name}/activate

Activate a relay in your domain.

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

Parameter

Type

Description

name required

string

Enter the name of the relay you want to activate.

Find below a request example:

Code

Description

Message

Code

Description

Message

204

Successful response. Relay activated.

-

400

Bad request. The specific error will be shown in the message.

403

Forbidden request.

404

Relay not found.

405

Method not allowed.

PUT /relays/{name}/deactivate

Deactivate a relay in your domain.

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

Parameter

Type

Description

name required

string

Enter the name of the relay you want to deactivate.

Find below a request example:

Related content

Working with the Lookups API
Working with the Lookups API
Devo latest
Read with this
Manage relay rules using the API
Manage relay rules using the API
Devo latest
More like this
Manage output configuration using the API
Manage output configuration using the API
Devo latest
More like this
Relay API
Relay API
Devo latest
More like this
Working on the list of relays
Working on the list of relays
Devo latest
More like this
Working on the list of relays
Working on the list of relays
Devo v7.10.0
More like this