AnkraDocs
Console

API reference · Account and billing

Outbound email

2 operations of the Ankra Cloud API: Abuse handling: whether the account's servers may send on port 25 (new accounts start blocked) and the request that lifts it, the DNS blocklist listings of the platform's public addresses, and the abuse reports staff work. Metadata only: nothing here reads a packet's contents.

Whether the account's servers may send email on port 25#

GET/v1/outbound-email
Operation
get_outbound_email
Credentials
API token, Portal session
Requires
Permission read

blocked means TCP from the account's servers to port 25 of the internet is dropped at the node, over IPv4 and IPv6; submission on 465 and 587 and port 25 on private networks stay open. Accounts start blocked. Carries the account's newest unblock request.

Responses

200The policy and the newest request.application/json · OutboundEmail

200 response fields
FieldTypeDescription
staterequiredstringblocked drops TCP from the servers to port 25 of the internet at the node; unblocked lets it through.One of blocked, unblocked
latest_requestrequiredOutboundEmailUnblockRequest | nullThe account's newest unblock request; null when it never asked.
idrequiredstring
staterequiredstringpending waits for staff, approved unblocked the account, declined carries the staff's reason.One of pending, approved, declined
reasonrequiredstring
staff_reasonrequiredstring | nullWhat staff said when they decided; a decline always carries one.
requested_by_emailrequiredstring
created_atrequiredstring (date-time)
updated_atrequiredstring (date-time)
decided_atrequiredstring (date-time) | null
  • 401Not signed in, or the credential is invalid or expired.
  • 403The role lacks the permission, the token is read-only (a read-only token also gets reason: read_only_token_cannot_read_credentials on every credential read), the CSRF header is missing, a support session may not do this, or the route needs a verified email address and the caller's is not (reason: email_unverified).
  • 429Rate limited. On a customer operation the credential (the API token, or the signed-in user for a session) is over its requests per minute and the X-RateLimit-* headers say when the window ends; on a sign-in route the client network is over its attempts or the email is locked out.
  • defaultAny other error, usually 500.

Example

bash
curl 'https://cloud.ankra.app/v1/outbound-email' \
  -H "Authorization: Bearer $ANKRA_CLOUD_TOKEN"

Ask Ankra to let the account's servers send email on port 25#

POST/v1/outbound-email/unblock-requests
Operation
create_outbound_email_unblock_request
Credentials
API token, Portal session
Requires
Permission operate

Records what the servers send and to whom, for Ankra's staff to decide; approving unblocks every server of the account at once. An account has one pending request at a time, and an account that is already unblocked has nothing to ask for: both answer 409. Recorded in the account's audit log (outbound_smtp.unblock_request.create).

Request bodyapplication/json · CreateOutboundEmailUnblockRequest

Request body fields
FieldTypeDescription
reasonrequiredstringWhat the servers send and to whom: staff read it to decide.

Responses

201The recorded request.application/json · OutboundEmailUnblockRequestEnvelope

201 response fields
FieldTypeDescription
requestrequiredOutboundEmailUnblockRequest
idrequiredstring
staterequiredstringpending waits for staff, approved unblocked the account, declined carries the staff's reason.One of pending, approved, declined
reasonrequiredstring
staff_reasonrequiredstring | nullWhat staff said when they decided; a decline always carries one.
requested_by_emailrequiredstring
created_atrequiredstring (date-time)
updated_atrequiredstring (date-time)
decided_atrequiredstring (date-time) | null
  • 400The request is invalid; detail says why.
  • 401Not signed in, or the credential is invalid or expired.
  • 403The role lacks the permission, the token is read-only (a read-only token also gets reason: read_only_token_cannot_read_credentials on every credential read), the CSRF header is missing, a support session may not do this, or the route needs a verified email address and the caller's is not (reason: email_unverified).
  • 409The resource's state does not allow this now.
  • 422The reason is shorter than 20 characters, longer than 1000 or not text.
  • 429Rate limited. On a customer operation the credential (the API token, or the signed-in user for a session) is over its requests per minute and the X-RateLimit-* headers say when the window ends; on a sign-in route the client network is over its attempts or the email is locked out.
  • defaultAny other error, usually 500.

Example

bash
curl -X POST 'https://cloud.ankra.app/v1/outbound-email/unblock-requests' \
  -H "Authorization: Bearer $ANKRA_CLOUD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "reason": "string"
}'