Skip to content
Request Support
  • There are no suggestions because the search field is empty.

API Methods

This article outlines the different API methods and types of requests that can be created using MxToolbox's API.

API Methods

Methods are the unique types of API requests that can be submitted via the database. The below image shows the different API methods. Click each orange row for more information.

Access your MxToolbox API setup here.

api_methods

Lookup

Run lookups using the same engine as SuperTool.

Monitor

Current status of all subscribed monitors and CRUD operations.

Monitor Tags

Tag management and CRUD operations for tags of given monitor.

Usage

The number of consumed and maximum allowed requests.

Request

[GET] api/v1/Lookup/{Command}/?argument={argument}

Commands

A

AA

BIMI

DMARC

DKIM

api/v1/Lookup/{dkim}:{selector}

DNS

MTA-STS

MX

PTR

SPF

TXT

Response Schema

{
'UID' : '',
'Command' : '',
'CommandArgument' : '',
'TimeRecorded' : new Date(),
'ReportingNameServer' : '',
'TimeToComplete' : '',
'IsEndpoint' : false,
'HasSubscriptions' : false,
'Failed' : [
	{'ID' : 0},
	{'Name' : ''},
	{'Info' : ''},
	{'Url' : ''},
	],
'Warnings' : [
	{'ID' : 0},
	{'Name' : ''},
	{'Info' : ''},
	{'Url' : ''},
	],
'Passed' : [
	{'ID' : 0},
	{'Name' : ''},
	{'Info' : ''},
	{'Url' : ''},
	],
'Timeouts' : [
	{'ID' : 0},
	{'Name' : ''},
	{'Info' : ''},
	{'Url' : ''},
	]
}

To learn more, see our About API article.