Email

Return list of recipients

get

API Key Scope: recipients / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Responses

200

List of recipient.

application/json

get

/email/recipients

HTTPcURLJavaScriptPython

GET /api/v2/email/recipients HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of recipient.

{
  "count": 1,
  "recipients": [
    {
      "email_id": "text",
      "activation": 1,
      "email_address": "text",
      "severity_low": 1,
      "severity_high": 1
    }
  ]
}

Creates a new recipient.

post

API Key Scope: recipients / create

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Body

application/json

email_idstringOptional

activationintegerOptional

email_addressstringOptional

severity_lowintegerOptional

severity_highintegerOptional

Responses

201

A specific recipient.

application/json

422

The received resource was not correctly formatted.

application/json

post

/email/recipients

HTTPcURLJavaScriptPython

POST /api/v2/email/recipients HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "email_id": "text",
  "activation": 1,
  "email_address": "text",
  "severity_low": 1,
  "severity_high": 1
}

{
  "email_id": "text",
  "activation": 1,
  "email_address": "text",
  "severity_low": 1,
  "severity_high": 1
}

Displays a specific recipient.

get

API Key Scope: recipients / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

email_idstringRequired

Numeric ID of email recipient.

Responses

200

A specific recipient.

application/json

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get

/email/recipients/{email_id}

HTTPcURLJavaScriptPython

GET /api/v2/email/recipients/{email_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

{
  "email_id": "text",
  "activation": 1,
  "email_address": "text",
  "severity_low": 1,
  "severity_high": 1
}

Updates a specific recipient with his relations.

put

API Key Scope: recipients / update

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

email_idstringRequired

Numeric ID of email recipient.

Body

application/json

email_idstringOptional

activationintegerOptional

email_addressstringOptional

severity_lowintegerOptional

severity_highintegerOptional

Responses

200

A specific recipient.

application/json

422

The received resource was not correctly formatted.

application/json

put

/email/recipients/{email_id}

HTTPcURLJavaScriptPython

PUT /api/v2/email/recipients/{email_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "email_id": "text",
  "activation": 1,
  "email_address": "text",
  "severity_low": 1,
  "severity_high": 1
}

{
  "email_id": "text",
  "activation": 1,
  "email_address": "text",
  "severity_low": 1,
  "severity_high": 1
}

Destroys a specific recipient.

delete

API Key Scope: recipients / destroy

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

email_idstringRequired

Numeric ID of email recipient.

Responses

204

Recipient destroyed.

delete

/email/recipients/{email_id}

HTTPcURLJavaScriptPython

DELETE /api/v2/email/recipients/{email_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

204

Recipient destroyed.

No content

Return relay server infos

get

API Key Scope: relay_server / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Responses

200

relay server infos.

application/json

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get

/email/relay_server

HTTPcURLJavaScriptPython

GET /api/v2/email/relay_server HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

{
  "server": "text",
  "sender": "text",
  "user": "text",
  "password": "text"
}

Updates relay server infos.

put

API Key Scope: relay_server / update

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Body

application/json

serverstringOptional

senderstringOptional

userstringOptional

passwordstringOptional

Responses

200

relay server infos.

application/json

422

The received resource was not correctly formatted.

application/json

put

/email/relay_server

HTTPcURLJavaScriptPython

PUT /api/v2/email/relay_server HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "server": "text",
  "sender": "text",
  "user": "text",
  "password": "text"
}

{
  "server": "text",
  "sender": "text",
  "user": "text",
  "password": "text"
}