Continuity-Service

REST service to maintain Retarus Email Continuity mailboxes and control failover routing

Find out more about Retarus Email Continuity
Download OpenAPI description
email-continuity-api.json
email-continuity-api.yaml
Languages
Servers
Mock server

https://developers.retarus.com/_mock/seg/email-continuity-api/

Public Endpoint

https://api.retarus.com/email/continuity/v2/

Customer

Bulk request, update or delete user information for all users belonging to the {CUSTOMER} number specified in the path of a request

Operations

Customer Flag

Update or delete flag for all users belonging to the {CUSTOMER} number specified in the path of a request, e.g. activate the Email Continuity failover or access to the web mailbox for all users

Operations

Set flag for all users belonging to the {CUSTOMER} specified in the URL path

Request

Path
CUSTOMERstring(customer)[ 5 .. 7 ] characters[0-9]{5}([A-Z]{2})?required
Example: 44444
FLAGstringrequired
Enum"failover""access"
Query
groupArray of strings or null(failoverGroups)<= 16 items

Restricts the operation to users who are a member of at least one of the given failover groups. If this parameter is absent, the operation will be applied to all users of the customer {CUSTOMER}.

Example: group=group=emea&group=germany
curl -i -X PUT \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/seg/email-continuity-api/44444/{FLAG}?group=group%3Demea%26group%3Dgermany'

Responses

OK

Bodyapplication/json
idstringrequired
timestampstringrequired
affectedUsersinteger>= 0required
Response
application/json
{
  "id": "string",
  "timestamp": "string",
  "affectedUsers": 0
}

Remove flag for all users belonging to the {CUSTOMER} specified in the URL path

Request

Path
CUSTOMERstring(customer)[ 5 .. 7 ] characters[0-9]{5}([A-Z]{2})?required
Example: 44444
FLAGstringrequired
Enum"failover""access"
Query
groupArray of strings or null(failoverGroups)<= 16 items

Restricts the operation to users who are a member of at least one of the given failover groups. If this parameter is absent, the operation will be applied to all users of the customer {CUSTOMER}.

Example: group=group=emea&group=germany
curl -i -X DELETE \
  -u <username>:<password> \
  'https://developers.retarus.com/_mock/seg/email-continuity-api/44444/{FLAG}?group=group%3Demea%26group%3Dgermany'

Responses

OK

Bodyapplication/json
idstringrequired
timestampstringrequired
affectedUsersinteger>= 0required
Response
application/json
{
  "id": "string",
  "timestamp": "string",
  "affectedUsers": 0
}

User

Request, update or delete user information for a single user belonging to the {CUSTOMER} number specified in the path of a request

Operations

User Flag

Update or delete flag for a single user belonging to the {CUSTOMER} number specified in the path of a request, e.g. activate the Email Continuity failover or the access to the web mailbox

Operations

Token

Request a security token required for account activation and password reset

Operations

Password

Update user password using a security token

Operations