Paused Domains API

Table of Contents
Overview
Attributes
Get a list of pauses that are currently in effect
Unpause a domain that is currently paused

Overview

Pausing Domains is GreenArrow’s mechanism for pausing deliveries from an RFC5321.MailFrom domain or an RFC5322.From domain.

Attributes

The following attributes are defined for paused domains:

paused_domain
hash

id
integer

The internal primary key of this pause.

domain
string

The RFC5321.MailFrom or RFC5322.From domain that this pause affects.

recipient_domain
string

The recipient domain that this pause effects.

pause_type
string

May be: rfc5321_mailfrom_domain or rfc5322_from_domain

pause_message
string

The message that is used for deferrals due to this pause.

This defaults to either Deliveries to this recipient domain from this RFC5321.MailFrom domain are paused. or Deliveries to this recipient domain from this RFC5322.From domain are paused..

pause_began_at
timestamp

The time this pause was triggered.

pause_ends_at
timestamp

The time at which this pause will end.

detected_on_throttle
hash

If an explicit throttle was used for the delivery that triggered the pause (i.e. it was not on a domain caught by the “Default Throttling Rule”), this hash is populated with that throttle’s details.

id
integer

The primary key of the throttle.

ip_address
hash

id integer	The primary key of the throttle’s IP address.
name string	The name of the throttle’s IP address.

domains
array

The list of domains specified on the throttle.

Get a list of pauses that are currently in effect

GET /ga/api/v3/eng/paused_domains

Parameters

The following parameters are valid for the above endpoint.

recipient_domain string / optional	Filter the results to just domains that are paused for messages to the specified recipient domain (case-insensitive).
message_domain string / optional	Filter the results to just the specified message domain (case-insensitive). This can be either an RFC5321.MailFrom or RFC5322.From domain.
throttle_domain string / optional	Filter the results to just domains that were detected on a throttle that includes the specified domain (case-insensitive).
pause_type string / optional	Filter the results to just domains that are paused based on either the RFC5321.MailFrom or RFC5322.From domain. Must be one of the following: `rfc5321_mailfrom_domain` or `rfc5322_from_domain`

Examples:

GET /ga/api/v3/eng/paused_domains?recipient_domain=example.com
GET /ga/api/v3/eng/paused_domains?recipient_domain=example.com&message_domain=sender.com
GET /ga/api/v3/eng/paused_domains?throttle_domain=example.com

Response

paused_domains
array

An array of paused domain objects as defined above.

pagination
hash

page integer	The page number of this result set. Page numbers start at 0.
per_page integer	The number of records returned on each page.
num_pages integer	The total number of pages in the result set.
num_records integer	The total number of records that are in the result set.
next_page_token string	A unique identifier that can be used to retrieve the next result set. `null` is returned if this is the last page.

Example

GET /ga/api/v3/eng/paused_domains

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "paused_domains": [
      {
        "id": 1,
        "domain": "example1.com",
        "recipient_domain": "recipient1.com",
        "detected_on_throttle": null,
        "pause_message": null,
        "pause_reason": null,
        "pause_type": "rfc5321_mailfrom_domain",
        "pause_began_at": "2024-05-31T13:32:12Z",
        "pause_ends_at": "2024-05-31T14:32:12Z"
      },
      {
        "id": 2,
        "domain": "example2.com",
        "recipient_domain": "recipient2.com",
        "detected_on_throttle": null,
        "pause_message": null,
        "pause_reason": null,
        "pause_type": "rfc5321_mailfrom_domain",
        "pause_began_at": "2024-05-31T13:32:13Z",
        "pause_ends_at": "2024-05-31T14:32:13Z"
      },
      {
        "id": 3,
        "domain": "example3.com",
        "recipient_domain": "recipient3.com",
        "detected_on_throttle": {
          "id": 1,
          "ip_address": {
            "id": 2,
            "name": "ipaddr-1"
          },
          "domains": [
            "abc.net"
          ]
        },
        "pause_message": null,
        "pause_reason": null,
        "pause_type": "rfc5321_mailfrom_domain",
        "pause_began_at": "2024-05-31T13:32:14Z",
        "pause_ends_at": "2024-05-31T14:32:14Z"
      }
    ],
    "pagination": {
      "page": 0,
      "per_page": 100,
      "num_pages": 1,
      "num_records": 3,
      "next_page_token": null
    }
  },
  "error_code": null,
  "error_messages": null
}

Unpause a domain that is currently paused

DELETE /ga/api/v3/eng/paused_domains/{id}

Delete the specified pause, causing its domain to resume normal sending.

Example

DELETE /ga/api/v3/eng/paused_domains/9

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
  },
  "error_code": null,
  "error_messages": null
}