A complete collection of email authentication API documentation for DMARC, SPF, DKIM, MTA-STS, TLS-RPT, and BIMI
\nWelcome to the PowerDMARC API workspace! We have created collections of API documentation for our email authentication platform’s advanced features. This will help you get started on your journey toward a more secure emailing experience.
\nExplore our range of APIs for DMARC, SPF, DKIM, MTA-STS, TLS-RPT, and BIMI implementation, management, and troubleshooting tools.
\nChoose the API collection that you want to work with:
\nBIMI Converter - Select the “Converter” API collection if you want to view API documentation for our BIMI SVG converter tool. The SVG converter API helps you get started with changing your logos into BIMI-compliant SVG images.
\nRecord Generators - Select the “Generators” API collection if you want to view documentation for DMARC record generator API, SPF record generator API, DKIM record generator API, BIMI record generator API, and TLS-RPT record generator API.
\nThis collection will help you get started with your email authentication implementations.
\nRecord Lookup tools - Select the “Lookup tools” API collection if you want to view documentation for our complete range of email authentication lookup tool APIs. The collection explores:
\nA Record Lookup API
\nAAAA Record Lookup API
\nSPF Lookup API
\nBIMI Record Lookup API
\nCNAME Record Lookup API
\nDKIM Record Lookup API
\nDMARC Record Lookup API
\nFCRDNS Record Lookup API
\nMTA-STS TLS-RPT Record Lookup API
\nMX Record Lookup API
\nNS Record Lookup API
\nPTR Record Lookup API
\nSOA Record Lookup API
\nTXT Record Lookup API
\nWHOIS Record Lookup API
\nMSSP APIs - select the MSSP API folder, if you are the MSSP client of the PowerDMARC and want to have access to the main functionality of the role.
\nAll endpoints in this API are relative to the following base URL: https://app.powerdmarc.com
\nNote:
For MSSPs, ensure you are using the correct base URL based on whether the MSSP is whitelabeled or not.
The base URL will be: https://\"mssp-subdomain\".powerdmarc.com
(example: \"mssp-subdomain\" could be \"my_mssp\", resulting in https://my_mssp.powerdmarc.com/)
The base URL will be: https://\"whitelabel-domain\"
(example: \"whitelabel-domain\" could be \"example.com\" resulting in https://example.com/)
Accept - application/json
Content-Type - application/json
Authorization - Bearer token
This API enforces rate limits for usage. The rate limits are as follows:
\nExceeding these limits will result in a 429 Too Many Requests response.
The API endpoint may return the following response codes along with their corresponding error messages:
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"27019739","collectionId":"c59a8893-fb97-408a-83d9-187451d212f9","publishedId":"2s93m1ZPTx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"05BDBB"},"publishDate":"2023-05-19T10:54:00.000Z"},"item":[{"name":"MSSP APIs","item":[{"name":"MSSP End User","item":[{"name":"User Management","item":[{"name":"Create Account Member","id":"8de67976-4eaf-4400-b998-8bf6cca94cbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Name\",\n \"email\": \"test@example.com\",\n \"password\": \"Yourpass1234`\"\n}","options":{"raw":{"language":"json"}}},"url":"","description":"POST /api/v1/mssp/accounts/{accountId}/membersaccountId (required): Provide the account ID to specify the account for which this API call will be executedname (required):
type: string
description: Max length 255 characters.
email (required):
type: string
description: The email field must be a valid email address (RFC-compliant), belong to an existing domain with valid DNS records (MX, A, or AAAA), and not exceed 255 characters.
password (required):
type: string
description: Password should contain minimum 8 characters, at least one uppercase letter, one lowercase letter, one number and one special character without any spaces.
phone (optional):
type: string
description: Provide the phone number with phone code starting with +
user_role : Id of user role
user_access_template : Id of the user access template to be specified for the user_role \"Custom\"
select_all_domains:
type: Boolean
Optional parameter: The default value = true if not specified in the request
Possible values: true, false
description: An optional parameter that sets the accessible domains for the created user. If set to true (default value), all existing domains in the account will be accessible by the created user.
If set to false, the domains accessible by the user will need to be specified in the “selected_domains” parameter described below
selected_domains:
type: Array
required: When select_all_domains is false
description:An array of domain ids that will be accessible by the created user
selected_domain_groups
type: Array
optional parameter:The default value is blank if not specified
description:An array of domain groups ids that will be accessible by the created user
assign_corresponding_domains
type: Boolean
optional parameter: The default is false
description:Corresponds to the “Assign corresponding domains to user” toggle on the “Accessible Domain Groups” section of the User Creation UI
assign_new_domains_to_user:
type: Boolean
optional parameter: The default value is true
description:Allows newly created domains to be assigned to the created user
201 Successfully created.
\n422 Unporcessable entity error response: The possible error messages are as follows:
\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"name\": [\n \"The name has already been taken\",\n \"The name must be a string.\",\n \"The name may not be greater than 255 characters.\",\n \"The name field is required.\"\n ],\n \"email\": [\n \"The email has already been taken\",\n \"The email field is required.\",\n \"The email may not be greater than 255 characters.\",\n \"The email must be a valid email address.\"\n ],\n \"password\": [\n \"The password field is required.\",\n \"Your password should contain minimum 8 characters, at least one uppercase letter, one lowercase letter, one number and one special character.\"\n ],\n \"phone\": [\n \"The phone format is invalid.\"\n ],\n \"page\": [\n \"The page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\",\n \"The per page must be at least 1.\"\n ]\n }\n}\n\nDELETE /api/v1/mssp/accounts/{accountId}/members/{userId}accountId (required): Provide the account ID to specify the account for which this API call will be executeduserId (required): Provide the user ID to specify the user under the account which will be deletedGET /api/v1/mssp/accounts/{accountId}/members/{userId}accountId (required): Provide the account ID to specify the account for which this API call will be executeduserId (required): Provide the user ID to retrieve user details associated with an account.GET /api/v1/mssp/accounts/{accountId}/membersaccountId (required): Provide the account ID to get associated account members.perPage (optional):
type: integer
description: The response data comes in a paginated format, allowing a maximum of 50 items on each page. While the field is optional, it defaults to 15 items per page. You have the option to set this value to anything between 1 and 50, depending on how many items of data you prefer to view per page.
page (optional):
type: integer
description: The page field is intended for pagination. Pass a page number to get the data for the specific page.
{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"page\": [\n \"The page must be an integer.\",\n \"The per page must be at least 1.\"\n ]\n }\n}\n\nGET /api/v1/mssp/domains-group/{accountId}accountId (required):target (optional):description: Pass group name to find occurance.POST /api/v1/mssp/domains-group/{accountId}accountId (required):name (required):
description (optional):
domains_id (required):
type: array
type of items: integer
description: The field accepts valid domains ID.
color (optional) :
description: The field accepts color code in hexadecimal format{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"name\": [\n \"The name has already been taken\",\n \"The name must be at least 3 characters.\",\n \"The action type must be a string.\",\n \"The name field is required.\"\n ],\n \"description\": [\n \"The description may not be greater than 500 characters.\",\n \"The mechanism is invalid.\",\n \"The per page must be at least 1.\"\n ],\n \"domains_id\": [\n \"The domains id may not have more than 1000 items.\",\n \"The domains id must have at least 1 items\",\n \"The domains id must be an array.\",\n \"The domains id field is required.\",\n \"The domains id must contain unique elements.\"\n ],\n \"color\": [\n \"The color format is invalid\"\n ]\n }\n}\n\nDELETE /api/v1/mssp/domains-group/{groupID}/groupID (required):PATCH /api/v1/mssp/domains-group/{groupId}groupId (required):name (optional):description (optional):domains_id (optional):type: arraytype of items: integerdescription: The field accepts valid domains ID.color (optional) :description: The field accepts color code in hexadecimal format{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"name\": [\n \"The name has already been taken\",\n \"The name must be at least 3 characters.\",\n \"The action type must be a string.\",\n \"The name field is required.\"\n ],\n \"description\": [\n \"The description may not be greater than 500 characters.\",\n \"The mechanism is invalid.\",\n \"The per page must be at least 1.\"\n ],\n \"domains_id\": [\n \"The domains id may not have more than 1000 items.\",\n \"The domains id must have at least 1 items\",\n \"The domains id must be an array.\",\n \"The domains id field is required.\"\n ],\n \"color\": [\n \"The color format is invalid\"\n ]\n }\n}\n\nGET /api/v1/mssp/accounts/{accountId}/domainsaccountId (required): Provide the account ID to get associated account domains.perPage (optional):type: integerdescription: The response data comes in a paginated format, allowing a maximum of 50 items on each page. While the field is optional, it defaults to 15 items per page. You have the option to set this value to anything between 1 and 50, depending on how many items of data you prefer to view per page.page (optional):type: integerdescription: The page field is intended for pagination. Pass a page number to get the data for the specific page.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"page\": [\n \"The page must be an integer.\",\n \"The per page must be at least 1.\"\n ]\n }\n}\n\nGET /api/v1/mssp/accounts/{accountId}/domains/{domainId}accountId (required):domainId (required): Provide account associated domains's domainId to get detailsperPage (optional):
type: integer
description: Maximum number of domain records returned per response. The maximum value can be set to 50. The field is optional, and its default value is 15.
422 Unprocessable entity error response: The possible error messages are as follows:
\n{\n \"message\": \"The per page must be an integer.\"\n}\n\ndomainId(required):
type: integer
Description: Unique identifier of the domain whose MTA-STS policy should be retrieved
{\"message\": \"Hosted MTA-STS is not activated for this domain.\"}\n\ndomainId(required):
type: integer
Description: ID of the domain whose policy is being updated
policy(required):
type: string
Description: The MTA-STS policy content, submitted as a single string. Each directive (e.g., mode, mx) must be on its own line.
{\nFormat Errors\n\"message\": \"Invalid line format. Expected 'key: value'.\"\n\"message\": \"Duplicate directive.\"\n\"message\": \"Unrecognized directive.\"\n\"message\": \"At least one valid directive must be provided.\"\nVersion\n\"message\":\"Version value is required.\"\n\"message\": \"Version must be 'STSv1'.\"\nMode\n\"message\":\"Mode value is required.\"\n\"message\":\"Mode must be one of: enforce, testing or none.\"\nMax-Age\n\"message\":\"Max-Age value is required.\"\n\"message\":\"Max-Age must be a positive integer.\"\n\"message\":\"Max-Age cannot exceed 31,557,600 seconds (1 year).\"\nMX\n\"message\":\"MX value is required.\"\n\"message\":\"MX value must be a valid domain name.\"\nGeneral Errors\n\"message\": \"MTA-STS mode cannot be updated because hosted MTA-STS is not activated for this domain.\"\n}\n\ndomainId(required):
type: integer
Description: Unique identifier of the domain whose MTA-STS policy is being reset.
{\n\"message\": \"MTA-STS mode cannot be updated because hosted MTA-STS is not activated for this domain.\"\n}\n\ndomainId(required):
type: integer
Description: Unique identifier of the domain to update the MTA-STS Mode
mode(required):
type: string
Description: The MTA-STS mode to set for the domain. Allowed values: \"none\", \"testing\", \"enforce\".
{\n\"message\": \"MTA-STS mode cannot be updated because hosted MTA-STS is not activated for this domain.\"\n\"message\": \"Invalid 'mode' value provided. Supported values are:'none', 'testing', 'enforce'\"\n}\n\nGET /api/v1/mssp/hosted/spf/{domainID}PATCH /api/v1/mssp/hosted/spf/{domainID}actionType (required if adding or deleting mechanism):
description: The actionType only applies to mechanisms. If you intend to create or delete a mechanism, then this parameter is required.
available_values: 0 or 1, pass 0 to delete the mechanism or 1 to create
mechanismType (required with mechanismValue):
type: stringavailable_values: a,mx,ip4,ip6,include,exists,ptr,redirectmechanismValue required with mechanismType:
type: stringallMechanismsPrefix: (optional)
available_values: + (Pass) ,- (fail), ~ (soft fail) ,? (neutral){\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"actionType\": [\n \"The action type field is required when mechanism type is present.\",\n \"The selected action type is invalid.\",\n \"The action type must be a number.\"\n ],\n \"mechanismValue\": [\n \"The mechanism value field is required when mechanism type is present.\",\n \"The mechanism is invalid.\",\n \"The per page must be at least 1.\"\n ],\n \"mechanismType\": [\n \"The mechanism type field is required when mechanism value is present.\",\n \"The selected mechanism type is invalid.\",\n \"The mechanism type must be a string.\"\n ],\n \"allMechanismPrefix\": [\n \"The selected all mechanism prefix is invalid.\"\n ]\n }\n}\n\nGET /api/v1/mssp/hosted/dmarc/{domainID}domainID (required):POST /api/v1/mssp/hosted/dmarc/{domainID}domainID (required):dmarc_policy (required):available_values: none,reject,quarantinepolicy_percentage (required):type: numericavailable_values: from 0 to 100subdomains_policy:available_values: none,reject,quarantineforensic_options:type: arrayavailable_values_in_array: 0, 1, d, sdescription: Meaning of tags 0 - DKIM and SPF don't pass or align, 1 - DKIM doesn't pass or align, d - DKIM doesn't pass or align, s - SPF doesn't pass or align.dmarc_rua: (required)type: arrayarray_element_type: emaildmarc_ruf:type: arrayarray_element_type: emailspf_alignment:type: stringavailable_values: s, rdescription: Meaning of tags s - Strict, r - Relaxeddkim_alignment:type: stringavailable_values: s, rdescription: Meaning of tags s - Strict, r - Relaxed{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"dmarc_policy\": [\n \"The dmarc policy field is required\",\n \"The selected dmarc policy is invalid.\"\n ],\n \"policy_percentage\": [\n \"The policy percentage field is required\",\n \"The policy percentage must be a number.\",\n \"The policy percentage must be at least 0.\",\n \"The policy percentage may not be greater than 100.\"\n ],\n \"subdomains_policy\": [\n \"The selected subdomains policy is invalid.\"\n ],\n \"forensic_options\": [\n \"The selected forensic_options.Index is invalid\",\n \"The forensic options must be an array.\",\n \"The forensic_options.Index field has a duplicate value.\"\n ],\n \"dmarc_rua\": [\n \"The dmarc rua must be an array.\",\n \"The dmarc_rua.Index must be a valid email address.\",\n \"The dmarc_rua.Index field has a duplicate value.\"\n ],\n \"dmarc_ruf\": [\n \"The dmarc ruf must be an array.\",\n \"The dmarc_ruf.Index must be a valid email address.\",\n \"The dmarc_ruf.Index field has a duplicate value.\"\n ],\n \"spf_alignment\": [\n \"The selected spf alignment is invalid.\"\n ],\n \"dkim_alignment\": [\n \"The selected dkim alignment is invalid.\"\n ]\n }\n}\n\nGET /api/v1/mssp/hosted/bimi/{domainID}domainID (required):POST /api/v1/mssp/hosted/bimi/{domainID}domainID (required):certificate_url:description: The field requires a valid certificate file URL with .pem extension.certificate_file:type: filedescription: The field requires a valid .pem file, the max size of file should not exceed 2 MB.logo_url:description: The field requires a valid SVG logo file URL with .svg extension.logo_file:type: stringdescription: The field requires a valid .svg file encoded to base64.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"certificate_url\": [\n \"The certificate url format is invalid.\",\n \"The selected action type is invalid.\",\n \"The action type must be a number.\"\n ],\n \"certificate_file\": [\n \"The certificate file must be a file.\",\n \"The certificate file is either invalid pem file or not compatible.\",\n \"The certificate file may not be greater than 2 megabyte.\"\n ],\n \"logo_url\": [\n \"The logo url format is invalid.\"\n ],\n \"logo_file\": [\n \"The logo file must be a string.\"\n ]\n }\n}\n\nDelete /api/v1/mssp/hosted/dkim-selector/{selectorID}selectorID (required):POST /api/v1/mssp/hosted/dkim-selector/{domainID}domainID (required):selector(required):description: Name of a selectorrecord_type(required):type: stringavailable_values: txt, cname, public_keyrecord(required):description: If the record_type is name insert generated DKIM Record value (after the \"p=\" tag)comment (optional):type: stringsender_service_id (optional):404 Resource not found
\n422 Unporcessable entity error response: The possible error messages are as follows:
\n {\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"selector\": [\n \"The selector field is required\",\n \"The selector may not be greater than 120 characters.\",\n \"Current field must be without spaces\",\n \"The selector must be a string\"\n ],\n \"record_type\": [\n \"The record type field is required\",\n \"The selected record type is invalid.\"\n ],\n \"record\": [\n \"The record field is required\",\n \"The record may not be greater than 2400 characters.\",\n \"Please enter a valid domain name, without http:// prefix\"\n ],\n \"comment\": [\n \"The comment may not be greater than 500 characters.\",\n \"The comment must be a string.\"\n ],\n \"sender_service_id\": [\n \"The sender service id must be an integer.\",\n \"The selected sender service id is invalid.\"\n ]\n }\n }\n\n423 Something went wrong. It is possible that there is a configuration mismatch in your DNS settings.
\nPATCH /api/v1/mssp/hosted/dkim-selector/{selectorID}selectorID (required):selector(required):description: Name of a selectorrecord_type(required):type: string|enumavailable_values: txt, cname, public_keyrecord(required):description: If the record_type is name insert generated DKIM Record value (after the \"p=\" tag)comment (optional):type: stringsender_service_id (optional):404 Resource not found
\n422 Unporcessable entity error response: The possible error messages are as follows:
\n {\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"selector\": [\n \"The selector field is required\",\n \"The selector may not be greater than 120 characters.\",\n \"Current field must be without spaces\",\n \"The selector must be a string\"\n ],\n \"record_type\": [\n \"The record type field is required\",\n \"The selected record type is invalid.\"\n ],\n \"record\": [\n \"The record field is required\",\n \"The record may not be greater than 2400 characters.\",\n \"Please enter a valid domain name, without http:// prefix\"\n ],\n \"comment\": [\n \"The comment may not be greater than 500 characters.\",\n \"The comment must be a string.\"\n ],\n \"sender_service_id\": [\n \"The sender service id must be an integer.\",\n \"The selected sender service id is invalid.\"\n ]\n }\n }\n\n423 Something went wrong. It is possible that there is a configuration mismatch in your DNS settings.
\nGET /api/v1/mssp/hosted/dkim-selector/{domainID}domainID (required):Get a domain and return the results of the analysis
\nResponses
\n{\n \"data\": {\n \"percent\": 100,\n \"score\": 100,\n \"score_mark\": \"A\",\n \"domain\": \"example.com\",\n \"details\": {\n \"a\": [\n \"203.0.113.1\"\n ],\n \"ns\": [\n \"ns1.example.com\"\n ],\n \"mx\": [\n {\n \"exchange\": \"mail.example.com\",\n \"priority\": 10\n }\n ],\n \"dmarc\": \"v=DMARC1; p=none; rua=mailto:dmarc-reports@example.com;\",\n \"dmarc_parsed\": {\n \"tags\": {\n \"v\": {\n \"value\": \"DMARC1\"\n },\n \"p\": {\n \"value\": \"none\"\n },\n \"rua\": {\n \"value\": \"mailto:dmarc-reports@example.com\"\n }\n },\n \"records\": \"string\",\n \"valid\": true,\n \"is_valid\": true\n },\n \"dkim\": [\n {\n \"selector\": \"default\",\n \"records\": [\n \"v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9...\"\n ],\n \"valid\": true,\n \"raw_data\": \"string\",\n \"tags\": {\n \"v\": {\n \"value\": \"DKIM1\"\n },\n \"k\": {\n \"value\": \"rsa\"\n },\n \"p\": {\n \"value\": \"MIIBIjANBgkqhkiG9...\"\n }\n },\n \"message\": \"DKIM record is valid\",\n \"record_check\": [\n {\n \"key\": \"DKIM record validity\",\n \"value\": \"Yes\",\n \"status\": true\n }\n ],\n \"errors\": [\n \"string\"\n ],\n \"warnings\": [\n \"string\"\n ]\n }\n ],\n \"spf\": \"v=spf1 ip4:203.0.113.0/24 -all\",\n \"spf_parsed\": {\n \"structure\": {\n \"values\": [\n {\n \"value\": \"ip4:203.0.113.0/24\",\n \"lookups\": 1\n }\n ],\n \"errors\": [\n \"string\"\n ],\n \"warnings\": [\n \"string\"\n ],\n \"lookups\": 1,\n \"void_lookups\": 0,\n \"text\": \"v=spf1 ip4:203.0.113.0/24 -all\",\n \"record\": \"v=spf1 ip4:203.0.113.0/24 -all\",\n \"records\": \"string\",\n \"nodes\": [\n {\n \"values\": [\n {\n \"value\": \"ip4:203.0.113.0/24\",\n \"lookups\": 0\n }\n ],\n \"errors\": [\n \"string\"\n ],\n \"warnings\": [\n \"string\"\n ],\n \"lookups\": 1,\n \"void_lookups\": 0,\n \"text\": \"include:example.com\",\n \"record\": \"v=spf1 ip4:203.0.113.0/24 -all\"\n }\n ]\n }\n }\n },\n \"lookup_date\": \"2020-01-01T09:17:11.343844Z\",\n \"inactive\": false,\n \"detected_dkim_selector\": \"some selector\"\n }\n}\n\n{\n \"message\": \"Unauthenticated\"\n}\n\n{\n \"message\": \"You are not authorized to access this resource.\"\n}\n\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nAnalyze a domain and return a PDF with the results of the analysis
\nResponses
\n200 Success response
\n401 Unauthenticated
\n{\n \"message\": \"Unauthenticated\"\n}\n\n{\n \"message\": \"You are not authorized to access this resource.\"\n}\n\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint returns the DMARC record of the provided domain or domains. The maximum count of domains that can be provided is 10.
POST /api/v1/mssp/power-tools/lookup/records/dmarcdomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint generates the DMARC record based on the provided data. The maximum count of generated DMARC records cannot exceed 10.
\nPOST /api/v1/mssp/power-tools/generators/dmarcdata (required):Description: An array of data. The entire data should be wrapped into data as an array object item.policy (required):type: stringavailable values: none, reject, quarantinedescription: The DMARC policy allows senders to dictate how emails failing theaggregate_report_email (required):type: arraydescription: The property takes an email addresses. Provide at least one email.forensic_feedback_email (required):type: arraydescription: The property takes an email addresses. Provide at least one email.subdomain_policy (optional):type: stringavailable values: none, reject, quarantinedescription: Select the policy you want to apply to emails sent from your subdomains. If unspecified, the policy applied to the main domain will be applied to the subdomain.dkim_alignment (optional):type: stringavailable values: strict, relaxeddescription: In DKIM, the domain value in the d= field of the DKIM-signature in the email header has to align with the domain found in the from header.spf_alignment (optional):type: stringavailable values: strict, relaxeddescription: In SPF, the domain in the ‘Return-Path’ header has to align with that in the from header.forensic_options (optional):type: stringavailable values: 0, 1, d, sdescription: Forensic options represents in which case you want to receive forensic reports. You can select one or more options.policy_percentage (optional):type: integeravailable values: accepts the range from 0 to 100description: The percentage tag instructs ISPs to only apply the DMARC policy to a percentage of failing emails. 'pct=50' will instruct receivers to only apply the policy for 50% of the emails that fail the DMARC check.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domains\": [\n \"The domains field is required and must contain inner object elements.\",\n \"The domains must be an array.\",\n \"The domains.Index.domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\",\n \"The selector value(s) is invalid.\",\n \"The domains inner elements must be an object\",\n \"The domains inner elements may not have more than 10 items.\",\n \"The domains.Index.selectors must be an array.\",\n \"No DKIM Record found\"\n ]\n }\n}\n\nThe endpoint generates the BIMI record based on the provided data. The maximum count of generated BIMI records cannot exceed 10.
\nPOST /api/v1/power-tools/generators/bimidata (required):Description: An array of data. The entire data should be wrapped into data as an array object item.domain (required):type: stringimage_url (required):type: stringdescription: A valid URL of an SVG file. The URL should have the .svg extension.certificate_url (optional):type: arraydescription: A valid URL of an PEM file. The URL should have the .pem extension.\"{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"data\": [\n \"The data is invalid.\",\n \"The data field must be an array.\",\n \"The data field is required\",\n \"The data.Index field is required\",\n \"The data.Index must be an array\",\n \"The data.Index may not have more than 10 items\"\n ],\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ],\n \"image_url\": [\n \"The image url field is required\",\n \"The image url format is invalid.\",\n \"The image url must end with one of the following: .svg.\"\n ],\n \"certificate_url\": [\n \"The certificate url format is invalid.\",\n \"The certificate url must end with one of the following: .pem.\"\n ]\n }\n}\n\nGET /api/v1/mssp/domain-health/{domainID}domainID (required): Pass any id under the accounts to get domain healt data.Get Domain Groups Reports
\n{\n \"data\": {\n \"total_mail_volume\": 0,\n \"dmarc_compliant_mail_volume\": 0,\n \"dmarc_compliance\": 0,\n \"dkim_verification_aligned_count\": 0,\n \"dkim_verification_aligned_percentage\": 0,\n \"dkim_verification_not_aligned_percentage\": 0,\n \"dkim_verification_not_aligned_count\": 0,\n \"dkim_verification_failed_percentage\": 0,\n \"dkim_verification_failed_count\": 0,\n \"spf_verification_aligned_percentage\": 0,\n \"spf_verification_aligned_count\": 0,\n \"spf_verification_not_aligned_percentage\": 0,\n \"spf_verification_not_aligned_count\": 0,\n \"spf_verification_failed_count\": 0,\n \"spf_verification_failed_percentage\": 0,\n \"domains\": [\n {\n \"id\": 123,\n \"name\": \"example.com\"\n }\n ]\n }\n}\n\n{\n \"message\": \"Unauthenticated\"\n}\n\n{\n \"message\": \"You are not authorized to access this resource.\"\n}\n\n{\n \"message\": \"Resource not found.\"\n}\n\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"dateBegin\": [\n \"The 'dateBegin' is not a valid date.\",\n \"The 'dateBegin' cannot be after today.\"\n ],\n \"dateEnd\": [\n \"The 'dateEnd' is not a valid date.\",\n \"The 'dateEnd' field is required when 'dateBegin' is present.\",\n \"The 'dateEnd' cannot be after today.\"\n ]\n }\n}\n\n(Required) Begin date
\n","type":"text/plain"},"key":"dateBegin","value":"2024-09-01"},{"description":{"content":"(Required) End date
\n","type":"text/plain"},"key":"dateEnd","value":"2024-09-16"}],"variable":[{"description":{"content":"(Required) Domain Group ID
\n","type":"text/plain"},"type":"any","value":"756","key":"domainGroup"}]}},"response":[{"id":"4c43d84f-45d0-43b9-87f4-f689a5ad5968","name":"Success response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://app.powerdmarc.com/api/v1/customers/domain-groups/:domainGroup/reports?dateBegin=2024-09-01&dateEnd=2024-09-16","host":["https://app.powerdmarc.com"],"path":["api","v1","customers","domain-groups",":domainGroup","reports"],"query":[{"key":"dateBegin","value":"2024-09-01","description":"(Required) Begin date"},{"key":"dateEnd","value":"2024-09-16","description":"(Required) End date"}],"variable":[{"key":"domainGroup","value":"756","description":"(Required) Domain Group ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 16 Sep 2024 12:24:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Ray","value":"8c40d623de067d41-EVN"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"max-age=3600, private"},{"key":"Content-Encoding","value":"gzip"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains; preload"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"cf-apo-via","value":"origin,host"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=d6mgZvj1VuhT8%2Fy6WVlYCOYx5xWfPWVJgOZgTn7lop6BDBfeQ4k9A5jngbhr6CVuMLhVIjie8e%2B6BDX1Rb81vPg%2F3uc2cOLku4dJj8DJu3rLu5xu946vFgts81TNArjv%2BQuIfg%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-site"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Server","value":"cloudflare"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"total_mail_volume\": 89,\n \"dmarc_compliant_mail_volume\": 47,\n \"dmarc_compliance\": 52.8,\n \"dkim_verification_aligned_count\": 47,\n \"dkim_verification_aligned_percentage\": 52.8,\n \"dkim_verification_not_aligned_percentage\": 3.4,\n \"dkim_verification_not_aligned_count\": 3,\n \"dkim_verification_failed_percentage\": 43.8,\n \"dkim_verification_failed_count\": 39,\n \"spf_verification_aligned_count\": 0,\n \"spf_verification_aligned_percentage\": 0,\n \"spf_verification_not_aligned_count\": 16,\n \"spf_verification_not_aligned_percentage\": 18,\n \"spf_verification_failed_count\": 73,\n \"spf_verification_failed_percentage\": 82,\n \"domains\": [\n {\n \"id\": 54057,\n \"name\": \"example.com\"\n },\n {\n \"id\": 60799,\n \"name\": \"mydomain.com\"\n },\n {\n \"id\": 60907,\n \"name\": \"new.example.com\"\n }\n ]\n }\n}"}],"_postman_id":"4a90974e-190d-4aac-b563-97b0cb1edceb"},{"name":"Get Domain Reports","id":"e45b5e15-0353-4ebb-9433-693e9130ff43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dateBegin\": \"2020-01-01\",\n \"dateEnd\": \"2024-09-16\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.powerdmarc.com/api/v1/mssp/domain-reports/64885","description":"GET /api/v1/mssp/domain-reports/{domainId}domainID (required):dateBegin (required):
type: date, string (YYYY-MM-DD)dateEnd (required):
type: date, string (YYYY-MM-DD){\n \"data\": {\n \"total_mail_volume\": 0,\n \"dmarc_compliant_mail_volume\": 0,\n \"dmarc_compliance\": 0,\n \"dmarc_noncompliant_mail_volume\": 0,\n \"dkim_verification_aligned_count\": 0,\n \"dkim_verification_aligned_percentage\": 0,\n \"dkim_verification_not_aligned_percentage\": 0,\n \"dkim_verification_not_aligned_count\": 0,\n \"dkim_verification_failed_percentage\": 0,\n \"dkim_verification_failed_count\": 0,\n \"policy_dmarc_none_count\": 0,\n \"policy_dmarc_none_percentage\": 0,\n \"policy_dmarc_reject_count\": 0,\n \"policy_dmarc_reject_percentage\": 0,\n \"policy_dmarc_quarantine_count\": 0,\n \"policy_dmarc_quarantine_percentage\": 0,\n \"spf_verification_aligned_count\": 0,\n \"spf_verification_aligned_percentage\": 0,\n \"spf_verification_not_aligned_percentage\": 0,\n \"spf_verification_not_aligned_count\": 0,\n \"spf_verification_failed_count\": 0,\n \"spf_verification_failed_percentage\": 0\n }\n}\n\n{\n \"message\": \"Unauthenticated\"\n}\n\n{\n \"message\": \"You are not authorized to access this resource.\"\n}\n\n{\n \"message\": \"Resource not found.\"\n}\n\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"dateBegin\": [\n \"The 'dateBegin' is not a valid date.\",\n \"The 'dateBegin' cannot be after today.\"\n ],\n \"dateEnd\": [\n \"The 'dateEnd' is not a valid date.\",\n \"The 'dateEnd' field is required when 'dateBegin' is present.\",\n \"The 'dateEnd' cannot be after today.\"\n ]\n }\n}\n\nPOST /api/v1/mssp/alerts/users/{userId}userId (required): Provide the user ID to specify the user for which this API call will be executedperPage (optional):
description: The response data is paginated, with a maximum of 50 items per page. The field is optional and has a default value of 15. You can specify a value between 15 and 50 for the count of items per page.page (optional):
description: The page field is intended for pagination. Pass a page number to get the data for the specific page.domain (optional):
type: string
description: Filtering data by domain name.
alertType (required):
type: string
available_values: forensic, threshold, dns
recordType (required if alertType is not treshold):
type: string
description: Filtering data by record type.
available_values: a, spf, ns, bimi, dkim, mx, dmarc
GET /api/v1/mssp/alerts/metricsGET /api/v1/mssp/alerts/users/{userId}/configurationuserId (required): Provide the user ID to specify the user for which this API call will be executeduserId (required): Pass userId to receive alerts for the current user.email (optional):description: Pass email to get filtered results based on the email.domain (optional):description: Pass domain name to get filtered results based on the domain name.perPage (optional):description: The response data is paginated, with a maximum of 50 items per page. The field is optional and has a default value of 15. You can specify a value between 15 and 50 for the count of items per page.page (optional):description: The page field is intended for pagination. Pass a page number to get the data for the specific page.POST /api/v1/mssp/alerts/users/{userId}/configuration-thresholduserId (required): Provide the user ID to specify the user for which this API call will be executeddomains_id (required if not set domain_groups_id):type: arraydescription: Pass at least one domain id in arraydomain_groups_id (required if not set domains_id):type: arraydescription: Pass at least one group id in arrayemails:type: arraydescription: Pass at least an email in arrayvalue (required):type: integercondition (required):type: stringavailable_values: g(great), ge(great or equal), l(lower), le(lover or equal)metric(required):type: stringdescription: To fetch available values for this field, you can use GET: api/v1/customers/alerts/metrics endpoint. This field expects a key from the the response body of that endpoint.interval (required):type - stringdescription - Add date casted in number + one of the keywords m(minutes), h(hours), d(days),is_percentage (required):type: booleanis_enabled (required):type: boolean{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domains_id\": [\n \"The domains_id.Index must be an integer.\",\n \"The 'domains id' field is required when none of 'domain groups id' are present.\",\n \"The domains id field contains invalid domain id.\"\n ],\n \"domain_groups_id\": [\n \"The domain_groups_id.Index must be an integer.\",\n \"The domain groups id field is required when none of domains id are present.\",\n \"The domain groups id field contains invalid domains group id.\"\n ],\n \"emails\": [\n \"The emails.Index must be a valid email address.\"\n ],\n \"value\": [\n \"The value must be an integer.\",\n \"The value must be at least 1.\",\n \"The value field is required\"\n ],\n \"condition\": [\n \"Invalid Condition\",\n \"The condition field is required\"\n ],\n \"metric\": [\n \"Undefined Metric\",\n \"The metric field is required\"\n ],\n \"interval\": [\n \"Invalid Metric\",\n \"The metric field is required\"\n ],\n \"type\": [\n \"The selected type is invalid.\",\n \"The type field is required\"\n ],\n \"is_percentage\": [\n \"The is 'is percentage' field is required.\"\n ],\n \"is_enabled\": [\n \"The is 'is enabled' field is required.\"\n ]\n }\n}\n\nPATCH /api/v1/mssp/alerts/users/{userId}/configuration-thresholddomain_config_ids and type is required to identify the configuration. Pass the same domain_config_ids as they are in configuration that you want to update.userId (required): Provide the user ID to specify the user for which this API call will be executeddomain_config_ids (required):type: arraydomains_id (required if not set domain_groups_id):type: arraydescription: Pass at least one domain id in arraydomain_groups_id (required if not set domains_id):type: arraydescription: Pass at least one group id in arrayemails:type: arraydescription: Pass at least an email in arrayvalue (required):type: integercondition (required):type: stringavailable_values: g(great), ge(great or equal), l(lower), le(lover or equal)metric(required):type: stringdescription: To fetch available values for this field, you can use GET: api/v1/customers/alerts/metrics endpoint. This field expects a key from the the response body of that endpoint.interval (required):type - stringdescription - Add date casted in number + one of the keywords m(minutes), h(hours), d(days),is_percentage (required):type: booleanis_enabled (required):type: boolean{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domains_id\": [\n \"The domains_id.Index must be an integer.\",\n \"The 'domains id' field is required when none of 'domain groups id' are present.\",\n \"The domains id field contains invalid domain id.\"\n ],\n \"domain_groups_id\": [\n \"The domain_groups_id.Index must be an integer.\",\n \"The domain groups id field is required when none of domains id are present.\",\n \"The domain groups id field contains invalid domains group id.\"\n ],\n \"emails\": [\n \"The emails.Index must be a valid email address.\"\n ],\n \"value\": [\n \"The value must be an integer.\",\n \"The value must be at least 1.\",\n \"The value field is required\"\n ],\n \"condition\": [\n \"Invalid Condition\",\n \"The condition field is required\"\n ],\n \"metric\": [\n \"Undefined Metric\",\n \"The metric field is required\"\n ],\n \"interval\": [\n \"Invalid Metric\",\n \"The metric field is required\"\n ],\n \"is_percentage\": [\n \"The is 'is percentage' field is required.\"\n ],\n \"is_enabled\": [\n \"The is 'is enabled' field is required.\"\n ]\n }\n}\n\nPOST /api/v1/mssp/alerts/users/{userId}/configuration-automaticuserId (required): Provide the user ID to specify the user for which this API call will be executeddomains_id (required if not set domain_groups_id):type: arraydescription: Pass at least one domain id in arraydomain_groups_id (required if not set domains_id):type: arraydescription: Pass at least one group id in arrayemails:type: arraydescription: Pass at least an email in arrayis_enabled (required):type: booleantype (required):available_values: dns, forensic{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domains_id\": [\n \"The domains_id.Index must be an integer.\",\n \"The 'domains id' field is required when none of 'domain groups id' are present.\",\n \"The domains id field contains invalid domain id.\"\n ],\n \"domain_groups_id\": [\n \"The domain_groups_id.Index must be an integer.\",\n \"The domain groups id field is required when none of domains id are present.\",\n \"The domain groups id field contains invalid domains group id.\"\n ],\n \"emails\": [\n \"The emails.Index must be a valid email address.\"\n ],\n \"value\": [\n \"The value must be an integer.\",\n \"The value must be at least 1.\",\n \"The value field is required\"\n ],\n \"condition\": [\n \"Invalid Condition\",\n \"The condition field is required\"\n ],\n \"metric\": [\n \"Undefined Metric\",\n \"The metric field is required\"\n ],\n \"interval\": [\n \"Invalid Metric\",\n \"The metric field is required\"\n ],\n \"type\": [\n \"The selected type is invalid.\",\n \"The type field is required\"\n ],\n \"is_percentage\": [\n \"The is 'is percentage' field is required.\"\n ],\n \"is_enabled\": [\n \"The is 'is enabled' field is required.\"\n ]\n }\n}\n\nPATCH /api/v1/mssp/alerts/users/{userId}/configuration-automaticdomain_config_ids and type is required to identify the configuration. Pass the same domain_config_ids as they are in configuration that you want to update.userId (required): Provide the user ID to specify the user for which this API call will be executeddomain_config_ids (required):type: arraydomains_id (required if not set domain_groups_id):type: arraydescription: Pass at least one domain id in arraydomain_groups_id (required if not set domains_id):type: arraydescription: Pass at least one group id in arrayemails:type: arraydescription: Pass at least an email in arrayis_enabled (required):type: booleantype (required):available_values: dns, forensic{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domains_id\": [\n \"The domains_id.Index must be an integer.\",\n \"The 'domains id' field is required when none of 'domain groups id' are present.\",\n \"The domains id field contains invalid domain id.\"\n ],\n \"domain_groups_id\": [\n \"The domain_groups_id.Index must be an integer.\",\n \"The domain groups id field is required when none of domains id are present.\",\n \"The domain groups id field contains invalid domains group id.\"\n ],\n \"emails\": [\n \"The emails.Index must be a valid email address.\"\n ],\n \"type\": [\n \"The selected type is invalid.\",\n \"The type field is required\"\n ],\n \"is_enabled\": [\n \"The is 'is enabled' field is required.\"\n ]\n }\n}\n\nDELETE /api/v1/mssp/alerts/users/{userId}/configurationuserId (required): Provide the user ID to specify the user for which this API call will be executedtype (required):available values: dns, forensic, thresholdids (required):type: arraytype of items: stringdescription: The field accepts an numeric id of configuration{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"type\": [\n \"The selected type is invalid.\",\n \"The type field is required.\"\n ],\n \"ids\": [\n \"The selected ids is invalid.\",\n \"The ids.Index must be a string.\",\n \"The ids field is required.\"\n ]\n }\n}\n\nDescription: Retrieves a consolidated list of alerts generated across all accounts managed under the MSSP.
\nperPage (optional):
description: The response data is paginated, with a maximum of 50 items per page. The field is optional and has a default value of 15. You can specify a value between 15 and 50 for the count of items per page.page (optional):
description: The page field is intended for pagination. Pass a page number to get the data for the specific page.domain (optional):
type: string
description: Filtering data by domain name.
recordType (optional):
type: string
available values: a, spf, ns, bimi, dkim, mx, dmarc
description: Filtering by DNS record type. Required if alertType ≠ threshold.
alertType (optional):
type: string
available values: dns, threshold, forensic
description: Filtering by alert type.
{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\"\n ],\n \"page\": [\n \"The page must be an integer.\"\n ],\n \"recordType\": [\n \"The selected record type is invalid.\",\n \"The record type field is required.\"\n ],\n \"alertType\": [\n \"The selected alert type is invalid.\",\n \"The alert type field is required.\"\n ],\n \"domain\": [\n \"The action type field is required when mechanism type is present.\"\n ]\n }\n}\n\nDescription: Retrieves a list of alerts generated for the specified account under the MSSP.
\naccountId (required):
type: integer
description: The ID of the account whose alerts will be retrieved.
perPage (optional):
description: The response data is paginated, with a maximum of 50 items per page. The field is optional and has a default value of 15. You can specify a value between 15 and 50 for the count of items per page.page (optional):
description: The page field is intended for pagination. Pass a page number to get the data for the specific page.domain (optional):
type: string
description: Filtering data by domain name.
recordType (optional):
type: string
available values: a, spf, ns, bimi, dkim, mx, dmarc
description: Filtering by DNS record type. Required if alertType ≠ threshold.
alertType (optional):
type: string
available values: dns, threshold, forensic
description: Filtering by alert type.
{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\"\n ],\n \"page\": [\n \"The page must be an integer.\"\n ],\n \"recordType\": [\n \"The selected record type is invalid.\",\n \"The record type field is required.\"\n ],\n \"alertType\": [\n \"The selected alert type is invalid.\",\n \"The alert type field is required.\"\n ],\n \"domain\": [\n \"The action type field is required when mechanism type is present.\"\n ]\n }\n}\n\nStartFragment
\nPOST /api/v1/mssp/dns-timeline/dns-changesdomain (required): type: integer
account_id (required): type: integer
start_date (optional): type: integer default: 1
end_date (optional): type: integer default: 15
tab1_page (required): type: integer
StartFragment
\nPOST /api/v1/mssp/dns-timeline/records-current-score?domain={domain}&account_id={account_id}domain (required): type: integer
account_id (required): type: integer
StartFragment
\nPOST /api/v1/mssp/dns-timeline/records-history?domain={domain}&account_id={account_id}&start_date={start_date}&end_date={end_date}domain (required): type: integer
account_id (required): type: integer
start_date (optional): type: integer default: 1
end_date (optional): type: integer default: 15
Some of the API endpoints provide functionality on behalf of account super users, so the super user should have appropriate access related to the endpoints' functionality. For example, if a user admin tries to use the end-user endpoint PATCH - api/v1/mssp/hosted/spf/{domainId}, the super user (owner) of this domain should have the powerspf.save resource access and an enabled PowerSpf plan. Additionally, some endpoints specify userId or accountId. For the userId endpoint call, the action is made on behalf of the related user. If accountId is specified without userId, for some of the endpoints the call will be made on behalf of the superuser of this account.
GET /api/v1/msspsThe endpoint provides a paginated list of child MSSPs of the requesting MSSP.
\nperPage (optional):
type: integer
description: Number of items per page.
page (optional):
type: integer
description: Page number.
GET /api/v1/mssps/{id}The endpoint returns details of a specific MSSP.
\nid (required):
type: integer
description: MSSP ID.
Post /api/v1/mssps/{id}The endpoint is intended for creating a new child MSSP of either the current MSSP or any descendant MSSP.
\nid (optional):
type: integer
description: Optional MSSP ID of the parent. If not provided, the current MSSP is used.
name: required
type: stringsubdomain required
type: stringmssp_clients_default_plan_id: required
type: integeradmin
name:required
type: stringemail:required
type: stringpassword:maxLength: 50
minLength: 8
type: stringphone:optional
type: stringinvitation:
type: boolean
default: false
client_plan_ids: required
type: integerapi_settings:required
type: boolean
default: true
api_usage_limitation:optional
type: integermssp_plans_enabled:
type: boolean
default: true
multiple_languages:
type: boolean
default: true
PATCH /api/v1/mssps/{id}This updates an identified MSSP data.
\nid (required):
\ntype: integer
description: MSSP ID is the identifier for which MSSP changes will be applied.
name: optional (MSSP Name must be unique)
type: stringdomain: optional (must be unique and not reserved)
type: stringmanage_children: permission to manage child MSSPs
type: booleanadmin
name: required
type: stringemail: required
type: stringpassword:maxLength: 50
minLength: 8
type: stringphone:optional
type: stringPATCH /api/v1/mssps/{id}/toggleThis toggles the status of an MSSP.
\nid: required
type: integer
description: MSSP ID is the identifier for which MSSP status toggle will be applied.
status:
type: booleanGET /api/v1/mssp/accounts/countDescription - The endpoint is intended to get MSSP Accounts active domain counts
\nGET /api/v1/mssp/domains/countGET /api/v1/mssp/accounts/perPage (required):description: Result show on each page. The maximum value is 50, the default will be 15, this will work without specifying the parameter.dateFrom (required)type: date, string (YYYY-MM-DDdateTo (required)type: date, string (YYYY-MM-DD){\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"perPage\": [\n \"The per page must be an integer.\",\n \"The per page may not be greater than 50.\"\n ],\n \"dateFrom\": [\n \"The 'date from' field is required\",\n \"The date from is not a valid date.\"\n ],\n \"dateTo\": [\n \"The 'date to' field is required\",\n \"The date to is not a valid date.\"\n ]\n }\n}\n\nDescription - The endpoint is intended to get MSSP Account Users By Account id
\nGET /api/v1/mssp/accounts/users/{accountId}accountId (required):perPagedescription: Result show on each page. The maximum value is 50, the default will be 15, this will work without specifying the parameter.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\"\n ]\n }\n}\n\nGET /api/v1/mssp/accounts/{accountId}accountId (required):type: integerdescription: Account ID is the user ID for whom changes will be applied.GET /api/v1/mssp/admins/{userId}userId (required):
type: integerGET /api/v1/mssp/domains/perPage (required):
description: The maximum value can be set to 50. The field is optional, and its default value is 15.dateFrom (required)
type: date, string (YYYY-MM-DDdateTo (required)
type: date, string (YYYY-MM-DD){\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"perPage\": [\n \"The per page must be an integer.\",\n \"The per page may not be greater than 50.\"\n ],\n \"dateFrom\": [\n \"The 'date from' field is required\",\n \"The date from is not a valid date.\"\n ],\n \"dateTo\": [\n \"The 'date to' field is required\",\n \"The date to is not a valid date.\"\n ]\n }\n}\n\nGET /api/v1/mssp/admins/perPage (optional):
description: Number of records to return per page. Default value is 15. Max 50 allowed.
type : integer
page (optional)
description : Page number to retrieve. Default value is 1.
type : integer
{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"perPage\": [\n \"The per page must be an integer.\",\n \"The per page may not be greater than 50.\"\n ]\n }\n}\n\nGET /api/v1/mssp/plansGET /api/v1/mssp/email/notificationsGET /api/v1/mssp/settingsGET /api/v1/mssp/gradient/tokenGET /api/v1/mssp/resourcesuserType (required):available_values: 1, 2description: The type 1 is intended to fetch Admin Resources and 2 for User ResourcesRetrieves audit log details when the requester has permission to access the Audit Logs.
\nPOST /api/v1/mssp/audit-logs/userId (optional):
type:integer
descritpion If the requester has Display MSSP-wide or Account-wide Audit Logs, they may provide the ID of any user within the MSSPs or accounts they have access to; if omitted, logs for the current user are returned.
perPage (optional):
type: integer
description: Number of records to return per page. Default value is 15. Max 50 allowed.
page (optional):
type: integer
description: Page number to retrieve. Default value is 1.
dateFrom (required):
type:string
description: Start date for filtering audit log records. Format: YYYY-MM-DD.
dateTo (required):
type:string
description: End date for filtering audit log records. Format: YYYY-MM-DD.
all_account_info (optional):
type: boolean
description: If userId corresponds to an account-level user, this flag determines whether to return logs for all users under that account (true) or only the specified user (false).
{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"userId\": [\n \"The selected user id is invalid.\"\n ],\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\"\n ],\n \"page\": [\n \"The page must be an integer.\"\n ],\n \"dateFrom\": [\n \"The 'date from' is not a valid date.\",\n \"The 'date from' field is required\",\n \"The 'date from' cannot be after today.\"\n ],\n \"dateTo\": [\n \"The 'date to' is not a valid date.\",\n \"The 'date to' field is required\",\n \"The 'date to' cannot be after today.\"\n ]\n }\n}\n\nPOST /api/v1/mssp/adminname (required)
email (required):
type: string
description: The email field must be a valid email address (RFC-compliant), belong to an existing domain with valid DNS records (MX, A, or AAAA), and not exceed 255 characters.
password (required):
type: string
description: Password should contain minimum 8 characters, at least one uppercase letter, one lowercase letter, one number and one special character without any spaces.
resource_group_id: Id of assigned resource group.
user_access_template : Id of the user access template to be specified for the user_role \"Custom\"
selected_accounts : An array of account ids, included customers will be managable for admin
give_access_to_newly_added_accounts:
type: boolean
default: false
description: When set to true, this flag automatically grants the user access to any accounts that are added in the future. If not specified, the default behavior is false, meaning the user will not receive access to new accounts unless explicitly assigned.
give_access_to_newly_added_mssps:
type: boolean
default: false
description: When set to true, this flag automatically grants the user access to any Child MSSPs that are added in the future. If not specified, the default behavior is false, meaning the user will not receive access to new Child MSSPs unless explicitly assigned.
{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"name\": [\n \"The name has already been taken\",\n \"The name must be a string.\",\n \"The name may not be greater than 255 characters.\",\n \"The name field is required.\"\n ],\n \"email\": [\n \"The email has already been taken\",\n \"The email field is required.\",\n \"The email may not be greater than 255 characters.\",\n \"The email must be a valid email address.\"\n ],\n \"password\": [\n \"The password field is required.\",\n \"Your password should contain minimum 8 characters, at least one uppercase letter, one lowercase letter, one number and one special character.\"\n ],\n \"selected_accounts\": [\n \"The selected accounts must be an array.\",\n \"The selected_accounts.Index must be an integer.\",\n \"The selected 'selected accounts' is invalid.\"\n ],\n \"resources_to_enable\": [\n \"The resources to enable must be an array.\",\n \"The 'resources_to_enable.Index' must be an integer.\"\n ],\n \"resources_to_disable\": [\n \"The 'resources to disable' must be an array.\",\n \"The 'resources_to_disable.Index' must be an integer.\"\n ],\n \"resource_group_id\": [\n \"The selected resource group id must be an integer.\",\n \"The selected resource group id is invalid.\"\n ]\n }\n}\n\nPOST /api/v1/mssp/accountsuser_name (required)
account_name (required)
user_email (required):
type: string
description: The email field must be a valid email address (RFC-compliant), belong to an existing domain with valid DNS records (MX, A, or AAAA), and not exceed 255 characters.
password (required):
type: string
description: Password should contain minimum 8 characters, at least one uppercase letter, one lowercase letter, one number and one special character without any spaces.
account_plan (required)
phone
user_role : Id of user role
user_access_template : Id of the user access template to be specified for the user_role \"Custom\"
limitations_domains
type: Boolean
default: false
description: If set to true, enforces the Account-Specific limit. If set to False, enforces the Plan-specific limit. If this parameter is set to true, the \"domains_limit\" parameter becomes mandatory. Otherwise, it is optional.
domains_limit
type: integer
description: Max number of domains allowed
limitations_mail_volume
type: Boolean
default: false
description: If set to true, enforces the Account-Specific limit. If set to False, enforces the Plan-specific limit. If this parameter is set to true, the \"mail_volume_limit\" parameter becomes mandatory. Otherwise, it is optional.
mail_volume_limit
type: integer
description: Max number of emails allowed
201 Successfully created.
\n422 Unprocessable entity error response: The possible error messages are as follows:
\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"user_name\": [\n \"The name has already been taken\",\n \"The name field is required.\"\n ],\n \"user_email\": [\n \"The email has already been taken\",\n \"The email field is required.\",\n \"The email must be a valid email address.\"\n ],\n \"password\": [\n \"The user password field is required\",\n \"Your password should contain minimum 8 characters, at least one uppercase letter, one lowercase letter, one number and one special character.\"\n ],\n \"phone\": [\n \"The phone field is required.\"\n ],\n \"account_plan\": [\n \"The account_plan field is required.\",\n \"The email must be a valid email address.\"\n ],\n \"resource_group_id\": [\n \"The selected resource group id must be an integer\",\n \"The selected resource group id is invalid.\"\n ],\n \"resources_to_enable\": [\n \"The resources to enable must be an array.\",\n \"The resources_to_enable.Index must be an integer\"\n ],\n \"resources_to_disable\": [\n \"The resources to disable must be an array.\",\n \"The resources_to_disable.Index must be an integer\"\n ]\n \"domains_limit\": [\n \"The domains limit must be a number.\",\n \"The domains limit must be less than 10 digits.\"\n ],\n \"mail_volume_limit\": [\n \"The mail volume limit must be a number.\",\n \"The mail volume limit must be less than 10 digits.\"\n ]\n \"limitation_domains\": [\n \"The limitation domains field must be true or false.\"\n ],\n \"limitation_mail_volume\": [\n \"The limitation mail volume field must be true or false.\"\n ]\n \n }\n}\n\nPOST /api/v1/mssp/toggle/tfastatus: booleandescription: True or false to enable or disable account{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"status\": [\n \"The status field is required\",\n \"The status field must be true or false.\"\n ]\n }\n}\n\nPOST /api/v1/mssp/gradient/syncPOST /api/v1/mssp/gradient/integratepartner_api_key (required if not set before)\n ^\n \"\n eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJvcmdhbml6YXRpb25JZCI6IjY0MGJiMzdlODg3YWIzZWVhMzJlZmYwMCIsImNyZWF0ZWRBdCI6IjIwMjMtMDMtMTBUMjI6NDc6MjYuOTE5WiIsInZlbmRvck9JZCI6IjY0MGJiNTUyODg3YWIzZWVhMzJmMWRkMiIsImFwaUtleSI6IjY0MzU1N2M1N2ZhODYzN2I1NjUxYzUxOCIsImlhdCI6MTY4MTIxNzQ3NywiZXhwIjoxNjgxMzAzODc3fQ.xKJkuS_0vBH4StwpyIP_cliMPv_7ejQfg8txoiRMDb0\"\n\n "}],"_postman_id":"b5e9d54a-65bc-4c73-b428-ce8c41503346"},{"name":"Edit Account Plan","id":"0a9c0c7e-7a32-45fc-b981-a22f3fcc76a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://app.powerdmarc.com/api/v1/mssp/accounts/{accountId}{planId}","description":"
PATCH /api/v1/mssp/accounts/{accountId}/{planId}account_id (required):type: integerdescription: Account ID is the account identifier for whom changes will be applied.plan_id (required):type: integerPATCH /api/v1/mssp/accounts/{account_id}accountId (required):
\ntype: integer
description: Account ID is the account identifier for whom changes will be applied.
Omit fields you don't want to update.
\naccount_name
purchase_order
customer_reference
account_plan
account_status
limitations_domains
type: Boolean
default: false
description: If set to true, enforces the Account-Specific limit. If set to False, enforces the Plan-specific limit. If this parameter is set to true, the \"domains_limit\" parameter becomes mandatory. Otherwise, it is optional.
domains_limit
type: integer
description: Max number of domains allowed
limitations_mail_volume
type: Boolean
default: false
description: If set to true, enforces the Account-Specific limit. If set to False, enforces the Plan-specific limit. If this parameter is set to true, the \"mail_volume_limit\" parameter becomes mandatory. Otherwise, it is optional.
mail_volume_limit
type: integer
description: Max number of emails allowed
{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"account_name\": [\n \"The account name may not be greater than 255 characters.\",\n \"The account name has already been taken by a Customer/an Admin. Please select another account name.\",\n \"The account name must be a string.\"\n ],\n \"account_status\": [\n \"The account status field must be true or false.\",\n \"Can not activate account, because it's waiting confirmation\"\n ],\n \"account_plan\": [\n \"The account plan must be an integer.\",\n \"The selected account plan is invalid.\"\n ],\n \"domains_limit\": [\n \"The domains limit must be less than 10 digits.\",\n \"The domains limit must be a number.\"\n ],\n \"mail_volume_limit\": [\n \"The domains limit must be less than 10 digits.\",\n \"The mail volume limit must be a number.\"\n ]\n \"limitation_domains\": [\n \"The limitation domains field must be true or false.\",\n \"The limitation domains field is required when domains limit is present\"\n ],\n \"limitation_mail_volume\": [\n \"The limitation mail volume field must be true or false.\",\n \"The limitation mail volume field is required when mail volume limit is present.\"\n ]\n }\n}\n\nPATCH /api/v1/mssp/accounts/users/{userId}userId (required):
type: integer
description: User ID is the user identifier for whom changes will be applied.
user_name
user_email (required):
type: string
description: The email field must be a valid email address (RFC-compliant), belong to an existing domain with valid DNS records (MX, A, or AAAA), and not exceed 255 characters.
user_password (required):
type: string
description: Password should contain minimum 8 characters, at least one uppercase letter, one lowercase letter, one number and one special character without any spaces.
phone
user_role : Id of user role
user_access_template : Id of the user access template to be specified for the user_role \"Custom\"
select_all_domains:
type: Boolean
Optional parameter: The default value = true if not specified in the request
Possible values: true, false
description: An optional parameter that sets the accessible domains for the created user. If set to true (default value), all existing domains in the account will be accessible by the created user.
If set to false, the domains accessible by the user will need to be specified in the “selected_domains” parameter described below
selected_domains:
type: Array
required: When select_all_domains is false
description:An array of domain ids that will be accessible by the created user
selected_domain_groups
type: Array
optional parameter:The default value is blank if not specified
description:An array of domain groups ids that will be accessible by the created user
assign_corresponding_domains
type: Boolean
optional parameter: The default is false
description:Corresponds to the “Assign corresponding domains to user” toggle on the “Accessible Domain Groups” section of the User Creation UI
assign_new_domains_to_user:
type: Boolean
optional parameter: The default value is true
description:Allows newly created domains to be assigned to the created user
{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"user_name\": [\n \"The user name may not be greater than 255 characters.\"\n ],\n \"user_email\": [\n \"The user email has already been taken\",\n \"The user email may not be greater than 255 characters.\",\n \"The user email must be a valid email address.\"\n ],\n \"user_password\": [\n \"Your password should contain minimum 8 characters, at least one uppercase letter, one lowercase letter, one number and one special character.\"\n ],\n \"resource_group_id\": [\n \"The selected resource group id must be an integer.\",\n \"The selected resource group id is invalid.\"\n ],\n \"resources_to_enable\": [\n \"The 'resources to enable' must be an array.\",\n \"The 'resources_to_enable.Index' must be an integer.\"\n ],\n \"resources_to_disable\": [\n \"The 'resources to disable' must be an array..\",\n \"The 'resources_to_disable.Index' must be an integer.\"\n ]\n }\n}\n\nPATCH /api/v1/mssp/admins/{userId}userId (required):
type: integer
description: User ID is the user identifier for whom changes will be applied.
name
email (required):
type: string
description: The email field must be a valid email address (RFC-compliant), belong to an existing domain with valid DNS records (MX, A, or AAAA), and not exceed 255 characters.
password (required):
type: string
description: Password should contain minimum 8 characters, at least one uppercase letter, one lowercase letter, one number and one special character without any spaces.
resource_group_id: Id of assigned resource group.
user_access_template : Id of the user access template to be specified for the user_role \"Custom\"
selected_accounts : An array of account ids, included customers will be managable for admin
give_access_to_newly_added_accounts:
type: boolean
default: false
description: When set to true, this flag automatically grants the user access to any accounts that are added in the future. If not specified, the default behavior is false, meaning the user will not receive access to new accounts unless explicitly assigned.
give_access_to_newly_added_mssps:
type: boolean
default: false
description: When set to true, this flag automatically grants the user access to any Child MSSPs that are added in the future. If not specified, the default behavior is false, meaning the user will not receive access to new Child MSSPs unless explicitly assigned.
{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"name\": [\n \"The user name may not be greater than 255 characters.\"\n ],\n \"email\": [\n \"The user email has already been taken\",\n \"The user email may not be greater than 255 characters.\",\n \"The user email must be a valid email address.\"\n ],\n \"password\": [\n \"Your password should contain minimum 8 characters, at least one uppercase letter, one lowercase letter, one number and one special character.\"\n ],\n \"resource_group_id\": [\n \"The selected resource group id must be an integer.\",\n \"The selected resource group id is invalid.\"\n ],\n \"selected_accounts\": [\n \"The 'selected accounts' must be an array.\",\n \"The 'selected_accounts.Index' must be an integer.\"\n ],\n \"resources_to_enable\": [\n \"The 'resources to enable' must be an array.\",\n \"The 'resources_to_enable.Index' must be an integer.\"\n ],\n \"resources_to_disable\": [\n \"The 'resources to disable' must be an array..\",\n \"The 'resources_to_disable.Index' must be an integer.\"\n ]\n }\n}\n\nPATCH /api/v1/email/notificationsidstype - arraydescription - An array of email notification ids idsenabletype - booleandescription - By setting true all the provided notifications will be enabled for user otherwise will be disabled.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"ids\": [\n \"The ids must be an array.\",\n \"The ids field is required.\",\n \"The ids.Index must be an integer.\",\n \"The selected ids.Index is invalid.\"\n ],\n \"enable\": [\n \"The enable field is required.\",\n \"The enable field must be true or false.\"\n ]\n }\n}\n\nPATCH /api/v1/mssp/accounts/toggle/{accountId}accountId (required):type: integerdescription: Account IDstatustype - boolean{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"status\": [\n \"The status field is required.\",\n \"The status field must be true or false.\"\n ]\n }\n}\n\nPATCH /api/v1/mssp/accounts/user/toggle/{userId}userId (required):type: integerdescription: User Idstatustype - booleandescription - Set the value true to enable or false to disable a user{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"status\": [\n \"The status field is required.\",\n \"The status field must be true or false.\"\n ]\n }\n}\n\nPATCH /api/v1/mssp/settingsvaluetype - booleanmssp_setting_idtype: integerdescription: An ID of mssp setting{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"mssp_setting_id\": [\n \"The 'mssp setting id' field is required\",\n \"The 'mssp setting id' field must be integer.\"\n ],\n \"value\": [\n \"The 'value' field is required\",\n \"The 'value' field must be true or false.\"\n ]\n }\n}\n\nGET /api/v1/mssp/resource-groups/perPage (required):description: The maximum value can be set to 50. The field is optional, and its default value is 15.roleId (required)type: integeravailable_values: 1, 2, pass 1 to get resource ADMIN resource groups, pass 2 to get USER resource groups{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\"\n ],\n \"roleId\": [\n \"The role id field is required\",\n \"The selected role id is invalid.\"\n ]\n }\n}\n\nPOST /api/v1/mssp/resource-groupsname (required)roleType (required):available values: 1, 2description: Role type 1 is intended for admins, while type 2 is intended for usersresources (required):available_values: 0, 1 for resource IDdescription: An array of resource ids, included ids will be enabled for user if the value is 1 and will be disabled if the value is 0.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"name\": [\n \"The name must be at least 5 characters.\",\n \"The name must be a string.\",\n \"The name may not be greater than 250 characters.\",\n \"The name has already been taken\"\n ],\n \"resources\": [\n \"The resources field is required.\"\n ],\n \"role_type\": [\n \"The 'role type' field is required.\",\n \"The selected 'role type' is invalid.\"\n ]\n }\n}\n\nThe endpoint is intended to delete resource group by ID.
\nDELETE /api/v1/mssp/resource-groups/{resourceGroupId}resourceGroupId (required):type: intdescription: ID of resource group204: Action completed successfully.404: Resource not found.The endpoint is intended to delete an admin by ID.
\nDELETE /api/v1/mssp/admins/{adminId}adminId (required):type: intDescription: An admin ID204: Action completed successfully.404: Resource not found.The endpoint is intended to delete an account by ID.
\nGET /api/v1/mssp/accounts/{accountId}accountId (required):type: intDescription: An id of account to delete404: Resource not found.204: Action completed successfully.POST /api/v1/mssp/domains/{userId}userId (required):description - The domain will be created under this user.domain (required):description - The domain name which will be created404 Resource not found
\n409 The entity already exists.
\n422 Unprocessable entity error response: The possible error messages are as follows:
\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The name may not be greater than 255 characters.\",\n \"Please enter a valid domain name, without http:// prefix\",\n \"The domain field is required.\"\n ]\n }\n}\n\nDelete /api/v1/mssp/domains/{userId}/{domainId}
userId (required):description - The user ID under which the domain will be created.domainId (required):description - The domain ID which need to be deletedEndpoint
\nPOST /api/v1/mssp/power-tools/lookup/records/dmarcThe endpoint returns the DMARC record of the provided domain or domains. The maximum count of domains that can be provided is 10.
domains (required): An array of domains. You need to provide at least one domain. Elements in the domains array must be valid domain without the prefix HTTP or HTTPS.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint generates the DMARC record based on the provided data. The maximum count of generated DMARC records cannot exceed 10.
\nPOST /api/v1/mssp/power-tools/generators/dmarcdata (required):Description: An array of data. The entire data should be wrapped into data as an array object item.policy (required):type: stringavailable values: none, reject, quarantinedescription: The DMARC policy allows senders to dictate how emails failing theaggregate_report_email (required):type: arraydescription: The property takes an email addresses. Provide at least one email.forensic_feedback_email (required):type: arraydescription: The property takes an email addresses. Provide at least one email.subdomain_policy (optional):type: stringavailable values: none, reject, quarantinedescription: Select the policy you want to apply to emails sent from your subdomains. If unspecified, the policy applied to the main domain will be applied to the subdomain.dkim_alignment (optional):type: stringavailable values: strict, relaxeddescription: In DKIM, the domain value in the d= field of the DKIM-signature in the email header has to align with the domain found in the from header.spf_alignment (optional):type: stringavailable values: strict, relaxeddescription: In SPF, the domain in the ‘Return-Path’ header has to align with that in the from header.forensic_options (optional):type: stringavailable values: 0, 1, d, sdescription: Forensic options represents in which case you want to receive forensic reports. You can select one or more options.policy_percentage (optional):type: integeravailable values: accepts the range from 0 to 100description: The percentage tag instructs ISPs to only apply the DMARC policy to a percentage of failing emails. 'pct=50' will instruct receivers to only apply the policy for 50% of the emails that fail the DMARC check.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domains\": [\n \"The domains field is required and must contain inner object elements.\",\n \"The domains must be an array.\",\n \"The domains.Index.domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\",\n \"The selector value(s) is invalid.\",\n \"The domains inner elements must be an object\",\n \"The domains inner elements may not have more than 10 items.\",\n \"The domains.Index.selectors must be an array.\",\n \"No DKIM Record found\"\n ]\n }\n}\n\nThe endpoint generates the BIMI record based on the provided data. The maximum count of generated BIMI records cannot exceed 10.
\nPOST /api/v1/power-tools/generators/bimidata (required):Description: An array of data. The entire data should be wrapped into data as an array object item.domain (required):type: stringimage_url (required):type: stringdescription: A valid URL of an SVG file. The URL should have the .svg extension.certificate_url (optional):type: arraydescription: A valid URL of an PEM file. The URL should have the .pem extension.\"{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"data\": [\n \"The data is invalid.\",\n \"The data field must be an array.\",\n \"The data field is required\",\n \"The data.Index field is required\",\n \"The data.Index must be an array\",\n \"The data.Index may not have more than 10 items\"\n ],\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ],\n \"image_url\": [\n \"The image url field is required\",\n \"The image url format is invalid.\",\n \"The image url must end with one of the following: .svg.\"\n ],\n \"certificate_url\": [\n \"The certificate url format is invalid.\",\n \"The certificate url must end with one of the following: .pem.\"\n ]\n }\n}\n\nPATCH /api/v1/mssp/accounts/reputation-monitoring/assets-limit/{accountId}accountId (required):
type: integer
description: Account ID is the account identifier for whom changes will be applied.
addressesLimitationCount (required):
type: integer
description: Assets limit Count
PATCH /api/v1/mssp/accounts/reputation-monitoring/frequncy/{accountId}accountId (required):
type: integer
description: Account ID is the account identifier for whom changes will be applied.
state (required):
type: boolean
description: Pass true to enable and false to disable frequency of check
204 Action completed successfully.
\n404 Resource not found.
\nPOST /api/v1/mssp/magic-linkemail (required):
type: string
Description: Email of user for which magic link is to be generated
domain (optional):
type: string
Description: Domain of MSSP on which user is registered
{\n \"login\": \"https://example.com/auth/1234/magic-link/1726581807?signature=90edcee163dc128d3d6d26a18ff37ab6ad6bb9b6d24ef7dd547f2aafbb65ebcd\",\n \"logout\": \"https://example.com/auth/1234/logout?signature=90edcee163dc128d3d6d26a18ff37ab6ad6bb9b6d24ef7dd547f2aafbb65ebcd\"\n}\n\n{\n \"message\": \"Unauthenticated\"\n}\n\n{\n \"message\": \"You are not authorized to access this resource.\"\n}\n\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"email\": [\n \"The email field is required.\",\n \"The email may not be greater than 255 characters.\",\n \"The email must be a valid email address.\",\n \"No user found associated with the email address.\"\n ],\n \"domain\": [\n \"\",\n \"The domain may not be greater than 255 characters.\",\n \"Cannot resolve the domain\"\n ]\n }\n}\n\nWelcome to the API documentation. This collection provides detailed information about the endpoints, request/response formats, and authentication methods.
\nAll endpoints in this API are relative to the following base URL: https://app.powerdmarc.com
\nAccept - application/jsonContent-Type - application/jsonAuthorization - Bearer tokenThis API enforces rate limits for usage. The rate limits are as follows:
\nExceeding these limits will result in a 429 Too Many Requests response.
The API endpoint may return the following response codes along with their corresponding error messages:
\n","_postman_id":"24f37f83-3a9c-4c13-910c-44c9bc749204","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c59a8893-fb97-408a-83d9-187451d212f9","id":"c59a8893-fb97-408a-83d9-187451d212f9","name":"API Collections of PowerDMARC","type":"collection"}}},{"name":"End User APIs","item":[{"name":"Account/User Management","item":[{"name":"Create new account member","id":"e0d1c88b-2a8e-45a5-a8cd-589ec0f59ed8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Lorem\",\n \"email\": \"example@gmail.com\",\n \"password\": \"password\",\n \"phone\": \"+12124567890\",\n \"user_role\": 73,\n \"user_access_template\": 37,\n \"select_all_domains\": true,\n \"selected_domains\":[24],\n \"selected_domain_groups\": [22],\n \"assign_corresponding_domains\": true,\n \"assign_new_domains_to_user\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://app.powerdmarc.com/api/v1/account/members","description":"The endpoint is intended for creating new account.
\nPOST/api/v1/account/membersname(required):
type: stringemail (required):
type: string
description: The email field must be a valid email address (RFC-compliant), belong to an existing domain with valid DNS records (MX, A, or AAAA), and not exceed 255 characters.
password (required):
type: string
description: Password should contain minimum 8 characters, at least one uppercase letter, one lowercase letter, one number and one special character without any spaces.
phone(optional):
type: stringuser_role: Id of user role
user_access_template: Id of the user access template to be specified for the user_role \"Custom\"
select_all_domains:
type: Boolean
Optional parameter: The default value = true if not specified in the request
Possible values: true, false
description: An optional parameter that sets the accessible domains for the created user. If set to true (default value), all existing domains in the account will be accessible by the created user.
If set to false, the domains accessible by the user will need to be specified in the “selected_domains” parameter described below.
selected_domains:
type: Array
required: When select_all_domains is false
description:An array of domain ids that will be accessible by the created user
selected_domain_groups
type: Array
optional parameter:The default value is blank if not specified
description:An array of domain groups ids that will be accessible by the created user
assign_corresponding_domains
type: Boolean
optional parameter: The default is false
description:Corresponds to the “Assign corresponding domains to user” toggle on the “Accessible Domain Groups” section of the User Creation UI
assign_new_domains_to_user:
type: Boolean
optional parameter: The default value is true
description: Allows newly created domains to be assigned to the created user
{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"user\": [\n \"The name field is required\",\n \"The email field is required\",\n \"The password field is required\"\n ]\n }\n}\n\nThe endpoint indicates to get an identified user details.
\nGET /api/v1/account/members/{user}Description: User IDtype: integerThe endpoint provides a paginated list of current account members.
\nGET/api/v1/account/membersperPage (optional):
type: integer
description: Number of items per page.
page (optional):
type: integer
description: Page number.
name (optional):
\ntype: string
description: The name of the user.
email (optional):
\ntype: string
description: The email of the user.
phone (optional):
\ntype: string
description: The phone of the user.
PATCH /api/v1/account/members/{user}/enforce-2fa/{status}user (required): User Id of the target user
\nstatus (required): It can be either enable or disable
The endpoint indicated to delete an identified user.
\nDELETE /api/v1/account/members/{user}type: integerdescription: User IDThe endpoint supports updating account end user data.
\nPATCH /api/v1/account/members/{user}user (required):
\ntype: integer
description: User ID of the user whose data should be updated.
name:
type: stringemail:
type: string
description: The email field must be a valid email address (RFC-compliant), belong to an existing domain with valid DNS records (MX, A, or AAAA), and not exceed 255 characters.
password:
type: string
description: Password should contain minimum 8 characters, at least one uppercase letter, one lowercase letter, one number and one special character without any spaces.
phone:
type: stringuser_role: Id of user role
user_access_template: Id of the user access template to be specified for the user_role \"Custom\"
select_all_domains:
type: Boolean
description: If set to true, all existing domains in the account will be accessible by the user.
If set to false, the domains accessible by the user will need to be specified in the “selected_domains” parameter described below.
selected_domains:
type: Array
required: When select_all_domains is false
description:An array of domain ids that will be accessible by the user
selected_domain_groups
type: Array
description:An array of domain groups ids that will be accessible by the user
assign_corresponding_domains
type: Boolean
description:Corresponds to the “Assign corresponding domains to user” toggle on the “Accessible Domain Groups” section of the User Creation UI
assign_new_domains_to_user:
type: Boolean
description: Allows newly created domains to be assigned to the created user
Endpoint supports partial update. Fields not included in the request will remain unchanged.
\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\",\n \"The name must be a string.\",\n \"The name may not be greater than 255 characters.\"\n ],\n \"email\": [\n \"The email field is required\",\n \"The email must be a valid email address\",\n \"The email has already been taken\",\n \"Email cannot be changed while SCIM is enabled.\"\n ],\n \"password\": [\n \"The password field is required\",\n \"The password must be a string\",\n \"The password must be at least 8 characters\",\n \"The password may not be greater than 50 characters.\",\n \"Your password should contain minimum 8 characters, at least one uppercase letter, one lowercase letter, one number and one special character without any spaces.\"\n ],\n \"phone\": [\n \"Enter a valid phone number in international format (e.g. +1234567890).\"\n ],\n \"user_role\": [\n \"The user role field is required.\",\n \"Permission Denied.\"\n ],\n \"user_access_template\": [\n \"The user_access_template field is required.\",\n \"Permission Denied.\"\n ],\n \"select_all_domains\": [\n \"The select all domains field must be true or false.\"\n ],\n \"selected_domains\": [\n \"Some of the selected domains are invalid or inaccessible.\"\n ],\n \"assign_corresponding_domains\": [\n \"The assign corresponding domains field must be true or false.\"\n ],\n \"selected_domain_groups\": [\n \"The selected domain groups field is required when assign corresponding domains is true.\",\n \"selected domain groups must be an array of integers.\"\n ],\n \"assign_new_domains_to_user\": [\n \"The assign new domains to user field must be true or false.\"\n ],\n \"request\": [\n \"At least one field must be provided.\"\n ]\n }\n}\n\n\nThis API returns profile and preference information for the currently authenticated user**.**
\nGET /api/v1/meTo access the API, you need to include an API key in the request headers. The API token can be generated in the portal by checking the 'Manage users (add, update and delete)' option. Once generated, you can set it as a Bearer token.
\n","_postman_id":"87ed3dee-1119-4799-808a-17668437c244","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c59a8893-fb97-408a-83d9-187451d212f9","id":"c59a8893-fb97-408a-83d9-187451d212f9","name":"API Collections of PowerDMARC","type":"collection"}}},{"name":"Alerts","item":[{"name":"Get Alerts Configurations","id":"766ce408-dddb-4883-98f9-a9f38bafddc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://app.powerdmarc.com/api/v1/customers/alerts/configuration?page=1","description":"GET /api/v1/customers/alerts/configuration/email (optional):description: Pass email to get filtered results based on the email.domain (optional):description: Pass domain name to get filtered results based on the domain name.perPage (optional):description: The response data is paginated, with a maximum of 50 items per page. The field is optional and has a default value of 15. You can specify a value between 15 and 50 for the count of items per page.page (optional):description: The page field is intended for pagination. Pass a page number to get the data for the specific page.POST /api/v1/customers/alerts/perPage (optional):description: The response data is paginated, with a maximum of 50 items per page. The field is optional and has a default value of 15. You can specify a value between 15 and 50 for the count of items per page.page (optional):description: The page field is intended for pagination. Pass a page number to get the data for the specific page.domain (optional):type: stringdescription: Filtering data by domain name.alertType (required):type: stringavailable_values: forensic, threshold, dnsrecordType (required if alertType is not treshold):type: stringdescription: Filtering data by record type.available_values: a, spf, ns, bimi, dkim, mx, dmarcPOST /api/v1/customers/alerts/threshold/configurationdomains_id (required if not set domain_groups_id):type: arraydescription: Pass at least one domain id in arraydomain_groups_id (required if not set domains_id):type: arraydescription: Pass at least one group id in arrayemails:type: arraydescription: Pass at least an email in arrayvalue (required):type: integercondition (required):type: stringavailable_values: g(great), ge(great or equal), l(lower), le(lover or equal)metric(required):type: stringdescription: To fetch available values for this field, you can use GET: api/v1/customers/alerts/metrics endpoint. This field expects a key from the the response body of that endpoint.interval (required):type - stringdescription - Add date casted in number + one of the keywords m(minutes), h(hours), d(days),is_percentage (required):type: booleanis_enabled (required):type: boolean{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domains_id\": [\n \"The domains_id.Index must be an integer.\",\n \"The 'domains id' field is required when none of 'domain groups id' are present.\",\n \"The domains id field contains invalid domain id.\"\n ],\n \"domain_groups_id\": [\n \"The domain_groups_id.Index must be an integer.\",\n \"The domain groups id field is required when none of domains id are present.\",\n \"The domain groups id field contains invalid domains group id.\"\n ],\n \"emails\": [\n \"The emails.Index must be a valid email address.\"\n ],\n \"value\": [\n \"The value must be an integer.\",\n \"The value must be at least 1.\",\n \"The value field is required\"\n ],\n \"condition\": [\n \"Invalid Condition\",\n \"The condition field is required\"\n ],\n \"metric\": [\n \"Undefined Metric\",\n \"The metric field is required\"\n ],\n \"interval\": [\n \"Invalid Metric\",\n \"The metric field is required\"\n ],\n \"type\": [\n \"The selected type is invalid.\",\n \"The type field is required\"\n ],\n \"is_percentage\": [\n \"The is 'is percentage' field is required.\"\n ],\n \"is_enabled\": [\n \"The is 'is enabled' field is required.\"\n ]\n }\n}\n\nPOST /api/v1/customers/alerts/automatic/configurationdomains_id (required if not set domain_groups_id):type: arraydescription: Pass at least one domain id in arraydomain_groups_id (required if not set domains_id):type: arraydescription: Pass at least one group id in arrayemails:type: arraydescription: Pass at least an email in arrayis_enabled (required):type: booleantype (required):available_values: dns, forensic{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domains_id\": [\n \"The domains_id.Index must be an integer.\",\n \"The 'domains id' field is required when none of 'domain groups id' are present.\",\n \"The domains id field contains invalid domain id.\"\n ],\n \"domain_groups_id\": [\n \"The domain_groups_id.Index must be an integer.\",\n \"The domain groups id field is required when none of domains id are present.\",\n \"The domain groups id field contains invalid domains group id.\"\n ],\n \"emails\": [\n \"The emails.Index must be a valid email address.\"\n ],\n \"value\": [\n \"The value must be an integer.\",\n \"The value must be at least 1.\",\n \"The value field is required\"\n ],\n \"condition\": [\n \"Invalid Condition\",\n \"The condition field is required\"\n ],\n \"metric\": [\n \"Undefined Metric\",\n \"The metric field is required\"\n ],\n \"interval\": [\n \"Invalid Metric\",\n \"The metric field is required\"\n ],\n \"type\": [\n \"The selected type is invalid.\",\n \"The type field is required\"\n ],\n \"is_percentage\": [\n \"The is 'is percentage' field is required.\"\n ],\n \"is_enabled\": [\n \"The is 'is enabled' field is required.\"\n ]\n }\n}\n\nPATCH /api/v1/customers/alerts/automatic/configurationdomain_config_ids and type is required to identify the configuration. Pass the same domain_config_ids as they are in configuration that you want to update.domain_config_ids (required):type: arraydomains_id (required if not set domain_groups_id):type: arraydescription: Pass at least one domain id in arraydomain_groups_id (required if not set domains_id):type: arraydescription: Pass at least one group id in arrayemails:type: arraydescription: Pass at least an email in arrayis_enabled (required):type: booleantype (required):available_values: dns, forensic{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domains_id\": [\n \"The domains_id.Index must be an integer.\",\n \"The 'domains id' field is required when none of 'domain groups id' are present.\",\n \"The domains id field contains invalid domain id.\"\n ],\n \"domain_groups_id\": [\n \"The domain_groups_id.Index must be an integer.\",\n \"The domain groups id field is required when none of domains id are present.\",\n \"The domain groups id field contains invalid domains group id.\"\n ],\n \"emails\": [\n \"The emails.Index must be a valid email address.\"\n ],\n \"type\": [\n \"The selected type is invalid.\",\n \"The type field is required\"\n ],\n \"is_enabled\": [\n \"The is 'is enabled' field is required.\"\n ]\n }\n}\n\nPATCH /api/v1/customers/alerts/threshold/configurationdomain_config_ids and type is required to identify the configuration. Pass the same domain_config_ids as they are in configuration that you want to update.domain_config_ids (required):type: arraydomains_id (required if not set domain_groups_id):type: arraydescription: Pass at least one domain id in arraydomain_groups_id (required if not set domains_id):type: arraydescription: Pass at least one group id in arrayemails:type: arraydescription: Pass at least an email in arrayvalue (required):type: integercondition (required):type: stringavailable_values: g(great), ge(great or equal), l(lower), le(lover or equal)metric(required):type: stringdescription: To fetch available values for this field, you can use GET: api/v1/customers/alerts/metrics endpoint. This field expects a key from the the response body of that endpoint.interval (required):type - stringdescription - Add date casted in number + one of the keywords m(minutes), h(hours), d(days),is_percentage (required):type: booleanis_enabled (required):type: boolean{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domains_id\": [\n \"The domains_id.Index must be an integer.\",\n \"The 'domains id' field is required when none of 'domain groups id' are present.\",\n \"The domains id field contains invalid domain id.\"\n ],\n \"domain_groups_id\": [\n \"The domain_groups_id.Index must be an integer.\",\n \"The domain groups id field is required when none of domains id are present.\",\n \"The domain groups id field contains invalid domains group id.\"\n ],\n \"emails\": [\n \"The emails.Index must be a valid email address.\"\n ],\n \"value\": [\n \"The value must be an integer.\",\n \"The value must be at least 1.\",\n \"The value field is required\"\n ],\n \"condition\": [\n \"Invalid Condition\",\n \"The condition field is required\"\n ],\n \"metric\": [\n \"Undefined Metric\",\n \"The metric field is required\"\n ],\n \"interval\": [\n \"Invalid Metric\",\n \"The metric field is required\"\n ],\n \"is_percentage\": [\n \"The is 'is percentage' field is required.\"\n ],\n \"is_enabled\": [\n \"The is 'is enabled' field is required.\"\n ]\n }\n}\n\nDELETE /api/v1/customers/alerts/configuration/type (required):available values: dns, forensic, thresholdids (required):type: arraytype of items: stringdescription: The field accepts an numeric id of configuration{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"type\": [\n \"The selected type is invalid.\",\n \"The type field is required.\"\n ],\n \"ids\": [\n \"The selected ids is invalid.\",\n \"The ids.Index must be a string.\",\n \"The ids field is required.\"\n ]\n }\n}\n\nGET /api/v1/customers/alerts/metricsRetrieves audit log details if the requester has permission to access the Audit Logs.
\nGET /api/v1/audit-logsperPage (optional):
\ntype: integer
description: Number of records to return per page. Default value is 15. Max 50 allowed.
page (optional):
\ntype: integer
description: Page number to retrieve. Default value is 1.
userID (optional):
\ntype: integer
description: Users with Display Account-wide Audit Logs can retrieve logs for any user within their account by providing the user’s ID; if omitted, logs for the current user are returned.
all_account_info (optional):
\ntype: boolean
description: Includes audit logs for all users in the account when the requester has account-wide access.
from (required):
\ntype:string
description: Start date for filtering audit log records. Format: YYYY-MM-DD.
to (required):
\ntype:string
description: End date for filtering audit log records. Format: YYYY-MM-DD.
{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"perPage\": [\n \"The per page must be an integer.\", \n \"The per page may not be greater than 50.\",\n \"The per page must be at least 1.\"\n ],\n \"page\": [\n \"The page must be an integer.\" \n ],\n \"from\": [\n \"The from is not a valid date.\",\n \"The from field is required\",\n \"The from cannot be after today.\"\n ],\n \"to\": [\n \"The to is not a valid date.\",\n \"The to field is required\",\n \"The to cannot be after today.\"\n ] \n }\n}\n\nTo access the API, you need to include an API key in the request headers. The API token can be generated in the portal by checking the 'View audit logs' option. Once generated, you can set it as a Bearer token.
\nThe following titles are included in the platform Audit Logs:
\n| Account created |
| Account delete |
| Account disable |
| Account enable |
| Account member added |
| Account toggle |
| Account updated |
| account.user.store |
| Add domain wizard |
| Added domain groups to user |
| analyzer.export |
| Avatart upload |
| BIMI record created |
| BIMI record updated |
| Confirm plan upgrade |
| Create new admin |
| Create new MSSP |
| Create new plan |
| csvexport |
| Deactivate SSO connection |
| Delete CSV report |
| Delete domain |
| Delete Mail Auth |
| Delete plan |
| Disable PowerSPF |
| Disable Store policy file manually |
| Domain group assigned to user |
| Domain group created |
| Domain group deleted |
| Domain group updated |
| Domains added to group |
| Download CSV report |
| Edit plan |
| Enable PowerSPF |
| Enable Store policy file manually |
| Finish domain wizard |
| Free plan |
| Hosted DKIM activated |
| Hosted DKIM add selector |
| Hosted DKIM delete selector |
| Hosted DKIM update selector |
| Hosted DMARC Activated |
| Hosted DMARC Updated |
| IP blacklist |
| IP unblacklist |
| IP unwhitelist |
| IP whitelist |
| lang.account.toggle |
| Login |
| Logout |
| mssp.toggle |
| mssps.store |
| mssps.toggle |
| mssps.update |
| mta-sts.update.policy |
| New account |
| New alert created |
| New domain |
| New Plan |
| New user |
| Password changed |
| Password reset |
| Password updated |
| password.reset.post |
| password.save |
| Plan update |
| plans.destroy |
| plans.free |
| plans.store |
| plans.update |
| plans.upgrade.confirm |
| poweranalyzer.exportpdf |
| PowerSPF created |
| PowerSPF updated |
| powerspf.remove |
| powerspf.save |
| PowerSPF Enable |
| PowerSPF Disable |
| Register |
| Register verify |
| register.post |
| register.verify |
| Remove admin |
| report.download |
| Save password |
| settings.tokens.create |
| settings.tokens.delete |
| settings.tokens.update |
| super.user.change |
| Toggle MSSP account |
| Trial extend |
| Update admin |
| Update MSSP |
| Updated attached domain groups |
| Updated attached domains |
| User activated |
| User deactivated |
| User deleted |
| User domain groups assigned |
| User domain groups updated |
| User unverify |
| User update |
| User verify |
| user.avatar.upload |
| user.main.change |
| user.main.remove |
| user.profile.delete-account |
| user.remove |
| user.unverify |
| user.verify |
| users.destroy |
| workOS.auth.callback |
| workOS.organization.create |
| workOS.organization.domain.create |
| workOS.organization.update |
| XML reports Upload |
| Remove email authentication |
The endpoint is intended to convert the BIMI svg logo-file in TINY-SVG format.
\nPOST /api/v1/power-tools/converters/bimi-svgpublic_url (required):type: stringdescription: The property should be a valid URL of SVG file.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"public_url\": [\n \"The public url field is required\",\n \"The public url format is invalid.\",\n \"The public url must end with one of the following: .svg.\",\n \"Unable to convert file by provided url, please try again.\"\n ]\n }\n}\n\nGET/api/v1/customers/hosted/bimi/{domainID}domainID (required):POST /api/v1/customers/hosted/bimi/{domainID}domainID (required):certificate_url:description: The field requires a valid certificate file URL with .pem extension.certificate_file:type: filedescription: The field requires a valid .pem file, the max size of file should not exceed 2 MB.logo_url:description: The field requires a valid SVG logo file URL with .svg extension.logo_file:type: stringdescription: The field requires a valid .svg file encoded to base64.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"certificate_url\": [\n \"The certificate url format is invalid.\",\n \"The selected action type is invalid.\",\n \"The action type must be a number.\"\n ],\n \"certificate_file\": [\n \"The certificate file must be a file.\",\n \"The certificate file is either invalid pem file or not compatible.\",\n \"The certificate file may not be greater than 2 megabyte.\"\n ],\n \"logo_url\": [\n \"The logo url format is invalid.\"\n ],\n \"logo_file\": [\n \"The logo file must be a string.\"\n ]\n }\n}\n\nTo access the API, you need to include an API key in the request headers. The API token can be generated in the portal by checking the 'PowerToolbox' option. Once generated, you can set it as a Bearer token.
\n","_postman_id":"847b1d80-26e8-453a-8960-25b9470e9000","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c59a8893-fb97-408a-83d9-187451d212f9","id":"c59a8893-fb97-408a-83d9-187451d212f9","name":"API Collections of PowerDMARC","type":"collection"}}},{"name":"DMARC","item":[{"name":"Get Hosted DMARC By Domain ID","id":"b788e59a-63e6-422a-a71a-f0efd79ef171","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://app.powerdmarc.com/api/v1/customers/hosted/dmarc/2218","description":"POST /api/v1/customers/hosted/dmarc/{domainID}domainID (required):POST /api/v1/customers/hosted/dmarc/{domainID}domainID (required):dmarc_policy (required):available_values: none,reject,quarantinepolicy_percentage (required):type: numericavailable_values: from 0 to 100subdomains_policy:available_values: none,reject,quarantineforensic_options:type: arrayavailable_values_in_array: 0, 1, d, sdescription: Meaning of tags 0 - DKIM and SPF don't pass or align, 1 - DKIM doesn't pass or align, d - DKIM doesn't pass or align, s - SPF doesn't pass or align.dmarc_rua: (required)type: arrayarray_element_type: emaildmarc_ruf:type: arrayarray_element_type: emailspf_alignment:type: stringavailable_values: s, rdescription: Meaning of tags s - Strict, r - Relaxeddkim_alignment:type: stringavailable_values: s, rdescription: Meaning of tags s - Strict, r - Relaxed{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"dmarc_policy\": [\n \"The dmarc policy field is required\",\n \"The selected dmarc policy is invalid.\"\n ],\n \"policy_percentage\": [\n \"The policy percentage field is required\",\n \"The policy percentage must be a number.\",\n \"The policy percentage must be at least 0.\",\n \"The policy percentage may not be greater than 100.\"\n ],\n \"subdomains_policy\": [\n \"The selected subdomains policy is invalid.\"\n ],\n \"forensic_options\": [\n \"The selected forensic_options.Index is invalid\",\n \"The forensic options must be an array.\",\n \"The forensic_options.Index field has a duplicate value.\"\n ],\n \"dmarc_rua\": [\n \"The dmarc rua must be an array.\",\n \"The dmarc_rua.Index must be a valid email address.\",\n \"The dmarc_rua.Index field has a duplicate value.\"\n ],\n \"dmarc_ruf\": [\n \"The dmarc ruf must be an array.\",\n \"The dmarc_ruf.Index must be a valid email address.\",\n \"The dmarc_ruf.Index field has a duplicate value.\"\n ],\n \"spf_alignment\": [\n \"The selected spf alignment is invalid.\"\n ],\n \"dkim_alignment\": [\n \"The selected dkim alignment is invalid.\"\n ]\n }\n}\n\nThe endpoint is indicated to get DMARC Aggregate report per sending source.
\nGET /api/v1/reports/aggregate/per-sending-sourcefrom (required):
\ntype: date/string
description: Begin date
to (required):
\ntype: date/string
description: End date
status (required):
\ntype: string
description: Status
available values: compliant, failed, forwarded
domain_id (optional)
\ntype: integer
description: If provided, results for that specific domain will be retrieved.
perPage (optional):
\ntype: integer
description: Number of items per page
page (optional):
\ntype: integer
description: Page number
{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"status\": [\n \"The status field is required\",\n \"The selected status is invalid.\"\n ],\n \"from\": [\n \"The from field is required\",\n \"The from is not a valid date.\"\n ],\n \"to\": [\n \"The to field is required\",\n \"The to is not a valid date.\"\n ],\n \"domain_id\": [\n \"The domain id must be an integer.\",\n \"The selected domain id is invalid.\"\n ]\n }\n}\n\n(Required) Begin date
\n","type":"text/plain"},"key":"from","value":"2023-03-22"},{"disabled":true,"description":{"content":"(Required) End date
\n","type":"text/plain"},"key":"to","value":"2023-05-22"},{"disabled":true,"description":{"content":"(Required) Status
\n","type":"text/plain"},"key":"status","value":"compliant"},{"disabled":true,"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"perPage","value":"10"},{"disabled":true,"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"d02061ab-7634-49bc-a631-fbc8d90e0362","name":"Get DMARC Aggregate report per sending source","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://app.powerdmarc.com/api/v1/reports/aggregate/per-sending-source?from=2023-03-22&to=2023-05-22&status=compliant&perPage=10&page=1","protocol":"https","host":["app","powerdmarc","com"],"path":["api","v1","reports","aggregate","per-sending-source"],"query":[{"key":"from","value":"2023-03-22","description":"(Required) Begin date"},{"key":"to","value":"2023-05-22","description":"(Required) End date"},{"key":"status","value":"compliant","description":"(Required) Status"},{"key":"perPage","value":"10","description":"Number of items per page"},{"key":"page","value":"1","description":"Page number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"domain_id\": 1,\n \"domain_name\": \"example.com\",\n \"status\": \"compliant\",\n \"org\": \"ZOHO (ZOHOC)\",\n \"policy_dmarc_pass_percentage\": \"100.00\",\n \"policy_dmarc_fail_percentage\": \"0.00\",\n \"policy_dmarc_pass_count\": 4,\n \"policy_dmarc_fail_count\": 0,\n \"policy_applied_forwarded\": 0,\n \"policy_applied_other\": 0,\n \"volume\": 4,\n \"policy_dkim_pass_count\": 0,\n \"policy_dkim_pass_percentage\": \"0.0\",\n \"policy_dkim_align_count\": 0,\n \"policy_dkim_align_percentage\": \"0.0\",\n \"policy_dkim_fail_count\": 4,\n \"policy_dkim_fail_percentage\": \"100.0\",\n \"policy_spf_pass_count\": 4,\n \"policy_spf_pass_percentage\": \"100.0\",\n \"policy_spf_align_count\": 0,\n \"policy_spf_align_percentage\": \"0.0\",\n \"policy_spf_fail_count\": 0,\n \"policy_spf_fail_percentage\": \"0.0\",\n \"policy_dmarc_none_percentage\": \"100.0\",\n \"policy_dmarc_reject_percentage\": \"0.0\",\n \"policy_dmarc_quarantine_percentage\": \"0.0\"\n }\n ]\n}"}],"_postman_id":"5c367cd0-b421-452e-bef2-85bd20db6ef7"},{"name":"Get DMARC Aggregate report per result","id":"73472a66-2723-472d-bfb2-a7f1cf4a8b3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.powerdmarc.com/api/v1/reports/aggregate/per-result","description":"The endpoint is indicated to get DMARC Aggregate report per result.
\nGET /api/v1/reports/aggregate/per-resulttype: integerdescription: Select number of items per pagetype: integerdescription: Select page numberNumber of items per page
\n","type":"text/plain"},"key":"perPage","value":"10"},{"disabled":true,"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"3aca9667-8bb2-441c-9f4e-d67fdec92f0b","name":"Get DMARC Aggregate report per result","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://app.powerdmarc.com/api/v1/reports/aggregate/per-result?perPage=10&page=1","protocol":"https","host":["app","powerdmarc","com"],"path":["api","v1","reports","aggregate","per-result"],"query":[{"key":"perPage","value":"10","description":"Number of items per page"},{"key":"page","value":"1","description":"Page number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"domain\": \"atezt.online\",\n \"subdomain\": \"atezt.online\",\n \"has_data\": true,\n \"is_dmarc_record_correct\": true\n },\n {\n \"domain\": \"google.com\",\n \"subdomain\": \"google.com\",\n \"has_data\": false,\n \"is_dmarc_record_correct\": false\n },\n {\n \"domain\": \"müller.com\",\n \"subdomain\": \"müller.com\",\n \"has_data\": false,\n \"is_dmarc_record_correct\": false\n },\n {\n \"domain\": \"powerdmarc.com\",\n \"subdomain\": \"app.powerdmarc.com\",\n \"has_data\": false,\n \"is_dmarc_record_correct\": false\n },\n {\n \"domain\": \"powerdmarc.com\",\n \"subdomain\": \"powerdmarc.com\",\n \"has_data\": false,\n \"is_dmarc_record_correct\": false\n },\n {\n \"domain\": \"powerdmarc.com\",\n \"subdomain\": \"rua.powerdmarc.com\",\n \"has_data\": false,\n \"is_dmarc_record_correct\": false\n },\n {\n \"domain\": \"powerdmarc.com\",\n \"subdomain\": \"ruf.powerdmarc.com\",\n \"has_data\": false,\n \"is_dmarc_record_correct\": false\n },\n {\n \"domain\": \"test33.com\",\n \"subdomain\": \"test33.com\",\n \"has_data\": false,\n \"is_dmarc_record_correct\": false\n },\n {\n \"domain\": \"test77.com\",\n \"subdomain\": \"test77.com\",\n \"has_data\": false,\n \"is_dmarc_record_correct\": false\n },\n {\n \"domain\": \"test.com\",\n \"subdomain\": \"test.com\",\n \"has_data\": false,\n \"is_dmarc_record_correct\": false\n }\n ],\n \"links\": {\n \"first\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/per-result?page=1\",\n \"last\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/per-result?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/per-result\",\n \"per_page\": 10,\n \"to\": 10,\n \"total\": 10\n }\n}"}],"_postman_id":"73472a66-2723-472d-bfb2-a7f1cf4a8b3a"},{"name":"Get DMARC Aggregate report per organization","id":"b600c27f-5a73-4e1e-a0f4-a22b9c3ec62f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from\": \"2022-05-12\",\n \"to\": \"2023-01-01\",\n \"domains\": [\n \"google.com\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://app.powerdmarc.com/api/v1/reports/aggregate/per-organization","description":"The endpoint is intended to get DMARC Aggregate report per organization.
\nPOST /api/v1/reports/aggregate/per-organizationtype: date/stringdescription: Begin datetype: date/stringdescription: End datetype: stringtype: integerdescription: Number of items per pagetype: integerdescription: Page number{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"from\": [\n \"The from field is required\",\n \"The from is not a valid date.\"\n ],\n \"to\": [\n \"The to field is required\",\n \"The to is not a valid date.\"\n ],\n \"domains.0\": [\n \"The domains.0 must be a string.\"\n ]\n }\n}\n\nNumber of items per page
\n","type":"text/plain"},"key":"perPage","value":"10"},{"disabled":true,"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"1d63f499-b652-458e-8b59-a536c070ca0c","name":"Get DMARC Aggregate report per organization","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from\": \"2023-03-26\",\n \"to\": \"2023-06-26\",\n \"domains\": [\n \"atezt.online\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://app.powerdmarc.com/api/v1/reports/aggregate/per-organization","protocol":"https","host":["app","powerdmarc","com"],"path":["api","v1","reports","aggregate","per-organization"],"query":[{"key":"perPage","value":"10","description":"Number of items per page","disabled":true},{"key":"page","value":"1","description":"Page number","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"ZOHO (ZOHOC)\",\n \"org_name\": \"ZOHO (ZOHOC)\",\n \"volume\": 4,\n \"policy_dmarc_pass_count\": 4,\n \"policy_dmarc_fail_count\": 0,\n \"policy_dmarc_pass_percentage\": \"100.00\",\n \"policy_dmarc_fail_percentage\": \"0.00\",\n \"policy_domain_dmarc_percentage\": 0,\n \"policy_dkim_fail_count\": 4,\n \"policy_dkim_fail_percentage\": \"100.0\",\n \"policy_spf_fail_count\": 0,\n \"policy_spf_fail_percentage\": \"0.0\",\n \"policy_dkim_pass_count\": 0,\n \"policy_dkim_pass_percentage\": \"0.0\",\n \"policy_dkim_align_count\": 0,\n \"policy_dkim_align_percentage\": \"0.0\",\n \"policy_spf_pass_count\": 4,\n \"policy_spf_pass_percentage\": \"100.0\",\n \"policy_spf_align_count\": 0,\n \"policy_spf_align_percentage\": \"0.0\"\n }\n ],\n \"links\": {\n \"first\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/per-organization?page=1\",\n \"last\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/per-organization?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/per-organization\",\n \"per_page\": 10,\n \"to\": 1,\n \"total\": 1\n }\n}"}],"_postman_id":"b600c27f-5a73-4e1e-a0f4-a22b9c3ec62f"},{"name":"Get DMARC Aggregate report per host","id":"042d7ef3-7bd5-45ed-b51b-5f60f466aedc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.powerdmarc.com/api/v1/reports/aggregate/per-host","description":"The endpoint is intended to get DMARC Aggregate report per host.
\nGET /api/v1/reports/aggregate/per-hosttype: date/stringdescription: Begin datetype: date/stringdescription: End datetype: stringdescription: Statusavailable values: compliant, failed, forwardedtype: integerdescription: Number of items per pagetype: integerdescription: Page number{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"status\": [\n \"The status field is required\",\n \"The selected status is invalid.\"\n ],\n \"from\": [\n \"The from field is required\",\n \"The from is not a valid date.\"\n ],\n \"to\": [\n \"The to field is required\",\n \"The to is not a valid date.\"\n ]\n }\n}\n\n(Required) Begin date
\n","type":"text/plain"},"key":"from","value":"2023-04-22"},{"disabled":true,"description":{"content":"(Required) End date
\n","type":"text/plain"},"key":"to","value":"2023-05-22"},{"disabled":true,"description":{"content":"(Required) Status
\n","type":"text/plain"},"key":"status","value":"failed"},{"disabled":true,"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"perPage","value":"10"},{"disabled":true,"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"45ec36aa-a560-4b55-9857-c7358bf44342","name":"Get DMARC Aggregate report per host","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://app.powerdmarc.com/api/v1/reports/aggregate/per-host?from=2023-04-22&to=2023-05-22&status=failed&perPage=10&page=1","protocol":"https","host":["app","powerdmarc","com"],"path":["api","v1","reports","aggregate","per-host"],"query":[{"key":"from","value":"2023-04-22","description":"(Required) Begin date"},{"key":"to","value":"2023-05-22","description":"(Required) End date"},{"key":"status","value":"failed","description":"(Required) Status"},{"key":"perPage","value":"10","description":"Number of items per page"},{"key":"page","value":"1","description":"Page number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"sender4-of-o55.zoho.com\",\n \"source_domain\": \"sender4-of-o55.zoho.com\",\n \"volume\": 4,\n \"policy_dmarc_pass_count\": 4,\n \"policy_dmarc_fail_count\": 0,\n \"policy_dmarc_pass_percentage\": \"100.00\",\n \"policy_dmarc_fail_percentage\": \"0.00\",\n \"policy_domain_dmarc_percentage\": 0,\n \"policy_dkim_fail_count\": 4,\n \"policy_dkim_fail_percentage\": \"100.0\",\n \"policy_spf_fail_count\": 0,\n \"policy_spf_fail_percentage\": \"0.0\",\n \"policy_dkim_pass_count\": 0,\n \"policy_dkim_pass_percentage\": \"0.0\",\n \"policy_dkim_align_count\": 0,\n \"policy_dkim_align_percentage\": \"0.0\",\n \"policy_spf_pass_count\": 4,\n \"policy_spf_pass_percentage\": \"100.0\",\n \"policy_spf_align_count\": 0,\n \"policy_spf_align_percentage\": \"0.0\"\n }\n ],\n \"links\": {\n \"first\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/per-host?page=1\",\n \"last\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/per-host?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/per-host\",\n \"per_page\": 10,\n \"to\": 1,\n \"total\": 1\n },\n \"chart_data\": {\n \"volume\": 4,\n \"dmarc_correct\": 4,\n \"dmarc_valid\": 0,\n \"dkim_and_spf_invalid\": 0\n }\n}"}],"_postman_id":"042d7ef3-7bd5-45ed-b51b-5f60f466aedc"},{"name":"Get DMARC Aggregate report detailed stats","id":"2ff19e76-2cbc-492b-9ffb-7af27b8919ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from\": \"2021-05-12\",\n \"to\": \"2023-01-01\",\n \"host_name\": \"gmail\",\n \"org_name\": \"string\",\n \"ip\": \"123.89.46.72\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://app.powerdmarc.com/api/v1/reports/aggregate/detailed-stats","description":"The endpoint is intended to get DMARC Aggregate report detailed stats.
\nPOST /api/v1/reports/aggregate/detailed-statstype: stringdescription: Begin datetype: stringdescription: End datetype: stringtype: stringtype: stringtype: integerdescription: Number of items per pagetype: integerdescription: Page number422 Unprocessable entity error response: The possible error messages are as follows:
\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"from\": [\n \"The from field is required\",\n \"The from is not a valid date.\"\n ],\n \"to\": [\n \"The to field is required\",\n \"The to is not a valid date.\"\n ],\n \"host_name\": [\n \"The host_name must be string\"\n ],\n \"org_name\": [\n \"The org_name must be a string.\"\n ],\n \"ip\": [\n \"The ip must be a valid IP address.\"\n ]\n }\n}\n\nNumber of items per page
\n","type":"text/plain"},"key":"perPage","value":"10"},{"disabled":true,"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"f787f7cb-a36a-4aea-ab37-c956f531a83c","name":"Get DMARC Aggregate report detailed stats","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from\": \"2023-03-26\",\n \"to\": \"2023-06-26\",\n \"host_name\": \"mail-cwlgbr01hn2249.outbound.protection.outlook.com\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://app.powerdmarc.com/api/v1/reports/aggregate/detailed-stats?perPage=50&page=1","protocol":"https","host":["app","powerdmarc","com"],"path":["api","v1","reports","aggregate","detailed-stats"],"query":[{"key":"perPage","value":"50","description":"Number of items per page"},{"key":"page","value":"1","description":"Page number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"source_domain\": \"mail-cwlgbr01hn2249.outbound.protection.outlook.com\",\n \"source_ip\": \"52.100.178.249\",\n \"org\": \"Microsoft Corporation (MSFT)\",\n \"country_code\": \"GB\",\n \"id\": \"mail-cwlgbr01hn2249.outbound.protection.outlook.com\",\n \"volume\": 1,\n \"policy_dmarc_pass_count\": 1,\n \"policy_dmarc_fail_count\": 0,\n \"policy_dmarc_pass_percentage\": \"100.00\",\n \"policy_dmarc_fail_percentage\": \"0.00\",\n \"policy_domain_dmarc_percentage\": 0,\n \"policy_dkim_fail_count\": 0,\n \"policy_dkim_fail_percentage\": \"0.0\",\n \"policy_spf_fail_count\": 0,\n \"policy_spf_fail_percentage\": \"0.0\",\n \"policy_dkim_pass_count\": 1,\n \"policy_dkim_pass_percentage\": \"100.0\",\n \"policy_dkim_align_count\": 0,\n \"policy_dkim_align_percentage\": \"0.0\",\n \"policy_spf_pass_count\": 0,\n \"policy_spf_pass_percentage\": \"0.0\",\n \"policy_spf_align_count\": 1,\n \"policy_spf_align_percentage\": \"100.0\"\n }\n ],\n \"links\": {\n \"first\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/detailed-stats?page=1\",\n \"last\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/detailed-stats?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/detailed-stats\",\n \"per_page\": 50,\n \"to\": 1,\n \"total\": 1\n }\n}"}],"_postman_id":"2ff19e76-2cbc-492b-9ffb-7af27b8919ac"},{"name":"Get DMARC Aggregate report per country","id":"930aa315-b4a4-42a8-81be-3cd5451d038a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.powerdmarc.com/api/v1/reports/aggregate/per-country","description":"The endpoint is intended to get DMARC Aggregate report per country.
\nGET /api/v1/reports/aggregate/per-countrytype: stringdescription: Begin datetype: stringdescription: End datetype: integerdescription: Number of items per pagetype: integerdescription: Page number{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"from\": [\n \"The from field is required\",\n \"The from is not a valid date.\"\n ],\n \"to\": [\n \"The to field is required\",\n \"The to is not a valid date.\"\n ]\n }\n}\n\n(Required) Begin date
\n","type":"text/plain"},"key":"from","value":"2023-04-22"},{"disabled":true,"description":{"content":"(Required) End date
\n","type":"text/plain"},"key":"to","value":"2023-05-22"},{"disabled":true,"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"perPage","value":"10"},{"disabled":true,"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"c37de303-6d1e-425a-bc6d-87a8960cb1f9","name":"Get DMARC Aggregate report per country","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://app.powerdmarc.com/api/v1/reports/aggregate/per-country?from=2023-04-22&to=2023-05-22&perPage=10&page=1","protocol":"https","host":["app","powerdmarc","com"],"path":["api","v1","reports","aggregate","per-country"],"query":[{"key":"from","value":"2023-04-22","description":"(Required) Begin date"},{"key":"to","value":"2023-05-22","description":"(Required) End date"},{"key":"perPage","value":"10","description":"Number of items per page"},{"key":"page","value":"1","description":"Page number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"United States\",\n \"country_name\": \"United States\",\n \"source_ip\": \"136.143.188.55\",\n \"country_code\": \"US\",\n \"source_domain\": \"sender4-of-o55.zoho.com\",\n \"volume\": 4,\n \"policy_dmarc_pass_count\": 4,\n \"policy_dmarc_fail_count\": 0,\n \"policy_dmarc_pass_percentage\": \"100.00\",\n \"policy_dmarc_fail_percentage\": \"0.00\",\n \"policy_dkim_fail_count\": 4,\n \"policy_dkim_fail_percentage\": \"100.0\",\n \"policy_spf_fail_count\": 0,\n \"policy_spf_fail_percentage\": \"0.0\",\n \"policy_dkim_pass_count\": 0,\n \"policy_dkim_pass_percentage\": \"0.0\",\n \"policy_dkim_align_count\": 0,\n \"policy_dkim_align_percentage\": \"0.0\",\n \"policy_spf_pass_count\": 4,\n \"policy_spf_pass_percentage\": \"100.0\",\n \"policy_spf_align_count\": 0,\n \"policy_spf_align_percentage\": \"0.0\",\n \"source_full_domain\": \"sender4-of-o55.zoho.com\"\n }\n ],\n \"links\": {\n \"first\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/per-country?page=1\",\n \"last\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/per-country?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https://app.powerdmarc.com/api/v1/reports/aggregate/per-country\",\n \"per_page\": 10,\n \"to\": 1,\n \"total\": 1\n }\n}"}],"_postman_id":"930aa315-b4a4-42a8-81be-3cd5451d038a"},{"name":"Get DMARC Aggregate report per source details","id":"b2b24ae4-9728-49ed-ae96-7e72992b463e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The endpoint is intended to get DMARC Aggregate report per country.
\n/api/v1/reports/agg/per-source/details● date.date_begin
○ Type: Integer (Unix timestamp)
○ Description: Start of the reporting period
● date.date_end
○ Type: Integer (Unix timestamp)
○ Description: End of the reporting period
● pagination.page
○ Type: Integer
○ Description: Page number to fetch
● pagination.perpage
○ Type: Integer
○ Description: Number of records per page
● asn
○ Type: String
○ Description: Filter results by Autonomous System Number / sending provider
● report_type
○ Type: String
○ Description: DMARC report type filter (e.g. compliant, non-compliant)
● domain_ids
○ Type: String
○ Description: Filter by one or more header-from domains by domain_ids (implementation-defined). If empty return all domains
● query
○ Type: String
○ Description: Free-text search across supported fields
● dynamic_filters
○ Type: Array
○ Description: Advanced filters applied to report data
The endpoint is intended to get DMARC Aggregate report per country.
\n/api/v1/reports/agg/hostname-details● date.date_begin
○ Type: Integer (Unix timestamp)
○ Description: Start of the reporting period
● date.date_end
○ Type: Integer (Unix timestamp)
○ Description: End of the reporting period
● pagination.page
○ Type: Integer
○ Description: Page number to fetch
● pagination.perpage
○ Type: Integer
○ Description: Number of records per page
● domains_ids
○ Type: Array of Strings
○ Description: Filter results by one or more domains. All domains if this is not provided
● asn
○ Type: String
○ Description: Filter results by Autonomous System / provider (e.g., “Google LLC (GOGL)”)
● report_type
○ Type: String
○ Description: DMARC report type filter (e.g. compliant, non-compliant)
● query
○ Type: String
○ Description: Free-text search across supported fields
● dynamic_filters
○ Type: Array
○ Description: Advanced filters applied to report data
To access the API, you need to include an API key in the request headers. The API token can be generated in the portal by checking the 'DMARC Aggregate Report' options. Once generated, you can set it as a Bearer token.
\n","_postman_id":"abcdba5d-0665-44ab-943f-a865cd6aa9de","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c59a8893-fb97-408a-83d9-187451d212f9","id":"c59a8893-fb97-408a-83d9-187451d212f9","name":"API Collections of PowerDMARC","type":"collection"}}},{"name":"DMARC Forensic Report","item":[{"name":"Get DMARC forensic report detail","id":"42f768ec-b0c1-43b1-b37a-6b13e9ade832","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from\": \"2023-05-12\",\n \"to\": \"2023-01-01\",\n \"subject\": \"Lurem ipsum\",\n \"domains\": [\n \"www.google.com\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://app.powerdmarc.com/api/v1/reports/forensic/detail","description":"The endpoint retrieves forensic report detail.
\nPOST /api/v1/reports/forensic/detaildescription: Number of items per pagetype: integerdescription: From dateto (required):type: stringdescription: To datesubject (optional) :type: stringdescription: Subject{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"from\": [\n \"The from field is required\",\n \"The from is not a valid date.\"\n ],\n \"to\": [\n \"The to field is required\",\n \"The to is not a valid date.\"\n ],\n \"subject\": [\n \"The subject must be a string.\"\n ]\n }\n}\n\nNumber of items per page
\n","type":"text/plain"},"key":"perPage","value":"10"},{"disabled":true,"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"b76355fc-214e-4a1a-a7b9-8f2ca62eb79d","name":"Get DMARC forensic report detail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from\": \"2023-04-12\",\n \"to\": \"2023-05-22\",\n \"subject\": \"Lurem ipsum\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://app.powerdmarc.com/api/v1/reports/forensic/detail?perPage=10&page=1","protocol":"https","host":["app","powerdmarc","com"],"path":["api","v1","reports","forensic","detail"],"query":[{"key":"perPage","value":"10","description":"Number of items per page"},{"key":"page","value":"1","description":"Page number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"country_code\": \"US\",\n \"domain\": \"example.com\",\n \"email_key\": \"davoyyyuqpcre56op18fiu75c6gli2tos4js3pfa81\",\n \"from\": \"crm@example.com>\",\n \"mail_header\": \"lurem ipsum\",\n \"receive_date\": \"2020-12-08\",\n \"source_full_domain\": \"mail123.example.net\",\n \"source_ip\": \"4.4.4.4\"\n }\n ],\n \"links\": {\n \"first\": \"https://app.powerdmarc.com/api/v1/reports/forensic/detail?page=1\",\n \"last\": \"https://app.powerdmarc.com/api/v1/reports/forensic/detail?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": null,\n \"last_page\": 1,\n \"path\": \"https://app.powerdmarc.com/api/v1/reports/forensic/detail\",\n \"per_page\": 10,\n \"to\": null,\n \"total\": 0\n }\n}"}],"_postman_id":"42f768ec-b0c1-43b1-b37a-6b13e9ade832"},{"name":"Get DMARC forensic report data","id":"1a24d849-c8de-40e7-96a0-b5cf27bbc733","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from\": \"2021-05-12\",\n \"to\": \"2022-01-01\",\n \"subject\": \"Lurem ipsum\",\n \"domains\": [\n \"google.com\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://app.powerdmarc.com/api/v1/reports/forensic/data","description":"The endpoint retrieves forensic report data.
\nPOST /api/v1/reports/forensic/datatype: integerdescription: Number of items per Pagepage (optional):type: integerdescription: Page numbertype: integerdescription: From datetype: stringdescription: To datetype: stringdescription: Stringtype: string{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"from\": [\n \"The from field is required\",\n \"The from is not a valid date.\"\n ],\n \"to\": [\n \"The to field is required\",\n \"The to is not a valid date.\"\n ],\n \"subject\": [\n \"The subject must be a string.\"\n ],\n \"domains.0\": [\n \"The domains.0 must be a string.\"\n ]\n }\n}\n\nNumber of items per page
\n","type":"text/plain"},"key":"perPage","value":"10"},{"disabled":true,"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"52007e44-c2d9-4ea9-9b63-758853164ad2","name":"Get DMARC forensic report data","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from\": \"2021-05-12\",\n \"to\": \"2022-01-01\",\n \"subject\": \"Lurem ipsum\",\n \"domains\": [\n \"google.com\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://app.powerdmarc.com/api/v1/reports/forensic/data?perPage=10&page=1","protocol":"https","host":["app","powerdmarc","com"],"path":["api","v1","reports","forensic","data"],"query":[{"key":"perPage","value":"10","description":"Number of items per page"},{"key":"page","value":"1","description":"Page number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"subject\": \"Lurem ipsum\",\n \"count\": \"3\"\n }\n ],\n \"links\": {\n \"first\": \"https://app.powerdmarc.com/api/v1/reports/forensic/data?page=1\",\n \"last\": \"https://app.powerdmarc.com/api/v1/reports/forensic/data?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": null,\n \"last_page\": 1,\n \"path\": \"https://app.powerdmarc.com/api/v1/reports/forensic/data\",\n \"per_page\": 10,\n \"to\": null,\n \"total\": 0\n }\n}"}],"_postman_id":"1a24d849-c8de-40e7-96a0-b5cf27bbc733"}],"id":"e46105c8-97f3-4ed3-bd48-18b7bfc63457","description":"To access the API, you need to include an API key in the request headers. The API token can be generated in the portal by checking the 'DMARC Forensic Report' options. Once generated, you can set it as a Bearer token.
\n","_postman_id":"e46105c8-97f3-4ed3-bd48-18b7bfc63457","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c59a8893-fb97-408a-83d9-187451d212f9","id":"c59a8893-fb97-408a-83d9-187451d212f9","name":"API Collections of PowerDMARC","type":"collection"}}},{"name":"DKIM","item":[{"name":"Get HostedDKIM By Domain ID","id":"46f88085-6ee4-4708-9589-f2e222219e26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://app.powerdmarc.com/api/v1/customers/hosted/dkim/2218","description":"GET /api/v1/customers/hosted/dkim/{domainId}domainID (required):GET /api/v1/customers/hosted/dkim-selector/{domainID}domainID (required):selector(required):
description: Name of a selectorrecord_type(required):
type: string
available_values: txt, cname, public_key
record(required):
description: If the record_type is name insert generated DKIM Record value (after the \"p=\" tag)comment (optional):
type: stringsender_service_id (optional):
ttl (optional):
type: integer
min:60, max:604800
404 Resource not found
\n423 Something went wrong. It is possible that there is a configuration mismatch in your DNS settings.
\n422 Unprocessable entity error response: The possible error messages are as follows:
\n {\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"selector\": [\n \"The selector field is required\",\n \"The selector may not be greater than 120 characters.\",\n \"Current field must be without spaces\",\n \"The selector must be a string\"\n ],\n \"record_type\": [\n \"The record type field is required\",\n \"The selected record type is invalid.\"\n ],\n \"record\": [\n \"The record field is required\",\n \"The record may not be greater than 2400 characters.\",\n \"Please enter a valid domain name, without http:// prefix\"\n ],\n \"comment\": [\n \"The comment may not be greater than 500 characters.\",\n \"The comment must be a string.\"\n ],\n \"sender_service_id\": [\n \"The sender service id must be an integer.\",\n \"The selected sender service id is invalid.\"\n ]\n }\n }\n\nPATCH /api/v1/customers/hosted/dkim-selector/{selectorID}selector ID.selectorId (required):selector(required):
description: Name of a selectorrecord_type(required):
type: string|enum
available_values: txt, cname, public_key
record(required):
description: If the record_type is name insert generated DKIM Record value (after the \"p=\" tag)comment (optional):
type: stringsender_service_id (optional):
ttl (optional):
type: integer
min:60, max:604800
404 Resource not found
\n422 Unprocessable entity error response: The possible error messages are as follows:
\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"selector\": [\n \"The selector field is required\",\n \"The selector may not be greater than 120 characters.\",\n \"Current field must be without spaces\",\n \"The selector must be a string\"\n ],\n \"record_type\": [\n \"The record type field is required\",\n \"The selected record type is invalid.\"\n ],\n \"record\": [\n \"The record field is required\",\n \"The record may not be greater than 2400 characters.\",\n \"Please enter a valid domain name, without http:// prefix\"\n ],\n \"comment\": [\n \"The comment may not be greater than 500 characters.\",\n \"The comment must be a string.\"\n ],\n \"sender_service_id\": [\n \"The sender service id must be an integer.\",\n \"The selected sender service id is invalid.\"\n ]\n }\n}\n\nDelete /api/v1/customers/hosted/dkim-selector/{selectorID}selectorID (required):domainId(required):
type: integer
Description: Unique identifier of the domain whose MTA-STS policy should be retrieved
\n{\n\"message\": \"Hosted MTA-STS is not activated for this domain.\"\n}\n\n\ndomainId(required):
type: integer
Description: ID of the domain whose policy is being updated
policy(required):
type: string
Description: The MTA-STS policy content, submitted as a single string. Each directive (e.g., mode, mx) must be on its own line.
{\nFormat Errors\n\"message\": \"Invalid line format. Expected 'key: value'.\"\n\"message\": \"Duplicate directive.\"\n\"message\": \"Unrecognized directive.\"\n\"message\": \"At least one valid directive must be provided.\"\nVersion\n\"message\":\"Version value is required.\"\n\"message\": \"Version must be 'STSv1'.\"\nMode\n\"message\":\"Mode value is required.\"\n\"message\":\"Mode must be one of: enforce, testing or none.\"\nMax-Age\n\"message\":\"Max-Age value is required.\"\n\"message\":\"Max-Age must be a positive integer.\"\n\"message\":\"Max-Age cannot exceed 31,557,600 seconds (1 year).\"\nMX\n\"message\":\"MX value is required.\"\n\"message\":\"MX value must be a valid domain name.\"\nGeneral Errors\n\"message\": \"MTA-STS mode cannot be updated because hosted MTA-STS is not activated for this domain.\"\n}\n\ndomainId(required):
type: integer
Description: Unique identifier of the domain whose MTA-STS policy is being reset.
{\n\"message\": \"MTA-STS mode cannot be updated because hosted MTA-STS is not activated for this domain.\"\n}\n\n\ndomainId(required):
type: integer
Description: Unique identifier of the domain to update the MTA-STS Mode
mode(required):
type: string
Description: The MTA-STS mode to set for the domain. Allowed values: \"none\", \"testing\", \"enforce\".
{\n\"message\": \"MTA-STS mode cannot be updated because hosted MTA-STS is not activated for this domain.\"\n\"message\": \"Invalid 'mode' value provided. Supported values are:'none', 'testing', 'enforce'\"\n}\n\n\nPOST /api/v1/customers/domains-group/name (required):description (optional):domains_id (required):type: arraytype of items: numbersdescription: The field accepts valid domains ID.color (optional) :description: The field accepts color code in hexadecimal format{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"name\": [\n \"The name has already been taken\",\n \"The name must be at least 3 characters.\",\n \"The action type must be a string.\",\n \"The name field is required.\"\n ],\n \"description\": [\n \"The description may not be greater than 500 characters.\",\n \"The mechanism is invalid.\",\n \"The per page must be at least 1.\"\n ],\n \"domains_id\": [\n \"The domains id may not have more than 1000 items.\",\n \"The domains id must have at least 1 items\",\n \"The domains id must be an array.\",\n \"The domains id field is required.\"\n ],\n \"color\": [\n \"The color format is invalid\"\n ]\n }\n}\n\nGET /api/v1/customers/domains-group/target (optional):description: Pass group name to find occurance.PATCH /api/v1/customers/domains-group/{groupId}groupId (required):name (optional):description (optional):domains_id (optional):type: arraytype of items: integerdescription: The field accepts valid domains ID.color (optional) :description: The field accepts color code in hexadecimal format{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"name\": [\n \"The name has already been taken\",\n \"The name must be at least 3 characters.\",\n \"The action type must be a string.\",\n \"The name field is required.\"\n ],\n \"description\": [\n \"The description may not be greater than 500 characters.\",\n \"The mechanism is invalid.\",\n \"The per page must be at least 1.\"\n ],\n \"domains_id\": [\n \"The domains id may not have more than 1000 items.\",\n \"The domains id must have at least 1 items\",\n \"The domains id must be an array.\",\n \"The domains id field is required.\"\n ],\n \"color\": [\n \"The color format is invalid\"\n ]\n }\n}\n\nDELETE /api/v1/customers/domains-group/{groupID}/groupID (required):The endpoint indicates to create a new domain.
\nPOST /api/v1/domainstype: integerdescription: domain422 Unprocessable entity error response: The possible error messages are as follows:
\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\"\n ]\n }\n}\n\nThe endpoint indicates to bulk create domains
\nPOST /api/v1/domains/bulkdomains (required)
\ntype: integer
description: domains list
notification_email (optional)
\ntype: string
description: email, to send notification about job completion status
The endpoint indicates to send bulk DNS records fetch command
\nPOST /api/v1/domains/dns-records/bulkdomains (required)
\ntype: integer
description: domains list
notification_email (optional)
\ntype: string
description: email, to send notification about job completion status
include_services (optional)
\ntype: array
description: Services, to make lookup and fetch data (DMARC, DKIM, SPF, MTA_STS, TLS)
fetch_all_domains (optional)
\ntype: boolean
description: if this flag is true, all provided domains will be ignored. Platform will get all user accessible domains and fetch records
The endpoint indicates to get user domains details.
\nGET /api/v1/domains/{domain}domain (required)
\ntype: integer
description: domain
The endpoint indicates to get user domains details.
\nGET /api/v1/domains/bulk/{job_id}job_id (required)
\ntype: uuid
description: job uuid to get job status
The endpoint indicates to get a domain details.
\nGET /api/v1/domains/perPage (optional):
\ntype: integer
description: Number of items per page
page (optional):
\ntype: integer
description: Page number
Number of items per page
\n","type":"text/plain"},"key":"perPage","value":"10"},{"disabled":true,"description":{"content":"Page number
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"def6255f-5dbc-4915-8373-9bfc2d402dfa","name":"Get user domains details","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://app.powerdmarc.com/api/v1/domains?perPage=10&page=1","protocol":"https","host":["app","powerdmarc","com"],"path":["api","v1","domains"],"query":[{"key":"perPage","value":"10","description":"Number of items per page"},{"key":"page","value":"1","description":"Page number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 29894,\n \"name\": \"test33.com\",\n \"is_dmarc_record_correct\": false,\n \"is_setup_completed\": false\n },\n {\n \"id\": 29895,\n \"name\": \"test77.com\",\n \"is_dmarc_record_correct\": false,\n \"is_setup_completed\": false\n },\n {\n \"id\": 29366,\n \"name\": \"atezt.online\",\n \"is_dmarc_record_correct\": true,\n \"is_setup_completed\": true\n },\n {\n \"id\": 29696,\n \"name\": \"müller.com\",\n \"is_dmarc_record_correct\": false,\n \"is_setup_completed\": false\n },\n {\n \"id\": 28238,\n \"name\": \"test.com\",\n \"is_dmarc_record_correct\": false,\n \"is_setup_completed\": false\n }\n ],\n \"links\": {\n \"first\": \"https://app.powerdmarc.com/api/v1/domains?page=1\",\n \"last\": \"https://app.powerdmarc.com/api/v1/domains?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https://app.powerdmarc.com/api/v1/domains\",\n \"per_page\": 10,\n \"to\": 5,\n \"total\": 5\n }\n}"}],"_postman_id":"e9804c6c-f5da-4428-95e3-35ee625ef99b"},{"name":"Get DNS Fetch Result","id":"9c9034cb-9e9a-4a21-8360-843ba1546d6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"}],"url":"https://app.powerdmarc.com/api/v1/domains/dns-records/bulk/12345678-9abc-def0-1234-567890abcdef","description":"The endpoint indicates to get bulk dns fetch job status
\njob_id (required)
\ntype: uuid
description: job uuid to get job status
The endpoint indicates to delete a domain
\nDELETE /api/v1/domains/{domain}type: integerdescription: Domain ID**Description:
**This API powers the Manage Domains page at the account level. It provides a summary of domain metrics and a paginated list of domains with their configuration, DMARC status, hosted services and compliance data.
\n
URL: /v1/manage-domains
\n| Parameter | Type | Default | Description |\n| domainType | enum | All | active, inactive, all |\n| dmarcPolicy | enum | All | reject, quarantine, none, -, all |\n| hostedDmarcConfigured | enum | All | Yes, No, All |\n| hostedSPFConfigured | enum | All | Yes, No, All |\n| hostedDkimConfigured | enum | All | Yes, No, All |\n| hostedMta_stsConfigured | enum | All | Yes, No, All |\n| hostedBimiConfigured | enum | All | Yes, No, All |\n| page | integer | 1 | Page number |\n| perPage | integer | 15 | Number of records per page. Max 50. |
\n","urlObject":{"path":["api","v1","manage-domains"],"host":["https://app.powerdmarc.com"],"query":[],"variable":[]}},"response":[{"id":"0330bdee-24a7-4c9d-a401-796fe21b5cf3","name":"Manage domains","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pagination\": {\r\n \"page\": 1,\r\n \"perpage\": 5\r\n },\r\n \"isAdvancedViewChecked\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"www.powerdmarc.site/api/v1/manage-domains"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 18 Mar 2026 17:25:34 GMT"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Content-Encoding","value":"gzip"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, Authorization"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 6fe26da85f49bf5aff6d6b0b178164ae.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SOF50-P2"},{"key":"X-Amz-Cf-Id","value":"ZmVg-_YV41-jhj3-j1AxFP8d09qWA3tw25KcyGRmuy74VWksqulZGw=="}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"summary\": {\n \"totalDomains\": 25,\n \"totalGroups\": 6,\n \"activeDomains\": 23,\n \"inactiveDomains\": 2,\n \"autoDetectedSubdomains\": 1\n },\n \"domains\": [\n {\n \"domainId\": 1,\n \"domainName\": \"example1.com\",\n \"subdomains_count\": null,\n \"domainGroups\": null,\n \"domainType\": \"Active\",\n \"dmarc\": {\n \"policy\": \"-\",\n \"ruaReportCount\": 236,\n \"rufReportCount\": 0,\n \"complianceRate\": 100,\n \"lastAggregateReportAt\": \"2026-03-04\",\n \"lastForensicReportAt\": null\n },\n \"createdAt\": \"2026-03-04T07:24:29.000000Z\"\n },\n {\n \"domainId\": 2,\n \"domainName\": \"example2.com\",\n \"subdomains_count\": 1,\n \"domainGroups\": \"[{\\\"id\\\": 266, \\\"name\\\": \\\"new group\\\", \\\"color\\\": \\\"#000000\\\"}]\",\n \"domainType\": \"Active\",\n \"dmarc\": {\n \"policy\": \"none\",\n \"ruaReportCount\": 0,\n \"rufReportCount\": 0,\n \"complianceRate\": 0,\n \"lastAggregateReportAt\": null,\n \"lastForensicReportAt\": null\n },\n \"createdAt\": \"2026-03-02T12:58:04.000000Z\"\n },\n {\n \"domainId\": 3,\n \"domainName\": \"example3.com\",\n \"subdomains_count\": null,\n \"domainGroups\": null,\n \"domainType\": \"Active\",\n \"dmarc\": {\n \"policy\": \"-\",\n \"ruaReportCount\": 0,\n \"rufReportCount\": 0,\n \"complianceRate\": 0,\n \"lastAggregateReportAt\": null,\n \"lastForensicReportAt\": null\n },\n \"createdAt\": \"2026-03-18T11:51:51.000000Z\"\n },\n {\n \"domainId\": 4,\n \"domainName\": \"example4.com\",\n \"subdomains_count\": null,\n \"domainGroups\": \"[{\\\"id\\\": 205, \\\"name\\\": \\\"Test Grouping\\\", \\\"color\\\": \\\"#fbc959\\\"}, {\\\"id\\\": 207, \\\"name\\\": \\\"Test Example Mode\\\", \\\"color\\\": \\\"#ffd966\\\"}]\",\n \"domainType\": \"Inactive\",\n \"dmarc\": {\n \"policy\": \"-\",\n \"ruaReportCount\": 0,\n \"rufReportCount\": 0,\n \"complianceRate\": 0,\n \"lastAggregateReportAt\": null,\n \"lastForensicReportAt\": null\n },\n \"createdAt\": \"2026-02-16T12:17:33.000000Z\"\n },\n {\n \"domainId\": 5,\n \"domainName\": \"example5.com\",\n \"subdomains_count\": null,\n \"domainGroups\": null,\n \"domainType\": \"Active\",\n \"dmarc\": {\n \"policy\": \"-\",\n \"ruaReportCount\": 0,\n \"rufReportCount\": 0,\n \"complianceRate\": 0,\n \"lastAggregateReportAt\": null,\n \"lastForensicReportAt\": null\n },\n \"createdAt\": \"2026-03-16T11:44:52.000000Z\"\n }\n ],\n \"pagination\": {\n \"total\": 25,\n \"perPage\": 5,\n \"currentPage\": 1\n }\n }\n}"}],"_postman_id":"42117904-e54d-4553-8f45-4957818be8ed"}],"id":"2add6490-cc62-4b5d-a03a-6c04df6afd8a","description":"To access the API, you need to include an API key in the request headers. The API token can be generated in the portal by checking the 'Domain Management' option. Once generated, you can set it as a Bearer token.
\n","_postman_id":"2add6490-cc62-4b5d-a03a-6c04df6afd8a","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c59a8893-fb97-408a-83d9-187451d212f9","id":"c59a8893-fb97-408a-83d9-187451d212f9","name":"API Collections of PowerDMARC","type":"collection"}}},{"name":"Domain Reports","item":[{"name":"Get Domain Health By Domain ID","id":"9834251c-9ada-4c2a-9837-67d8589a59c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://app.powerdmarc.com/api/v1/customers/domain-health/147","description":"GET /api/v1/customers/domain-health/{domainID}domainID (required):Get Domain Groups Reports
\n{\n \"data\": {\n \"total_mail_volume\": 0,\n \"dmarc_compliant_mail_volume\": 0,\n \"dmarc_compliance\": 0,\n \"dkim_verification_aligned_count\": 0,\n \"dkim_verification_aligned_percentage\": 0,\n \"dkim_verification_not_aligned_percentage\": 0,\n \"dkim_verification_not_aligned_count\": 0,\n \"dkim_verification_failed_percentage\": 0,\n \"dkim_verification_failed_count\": 0,\n \"spf_verification_aligned_percentage\": 0,\n \"spf_verification_aligned_count\": 0,\n \"spf_verification_not_aligned_percentage\": 0,\n \"spf_verification_not_aligned_count\": 0,\n \"spf_verification_failed_count\": 0,\n \"spf_verification_failed_percentage\": 0,\n \"domains\": [\n {\n \"id\": 123,\n \"name\": \"example.com\"\n }\n ]\n }\n}\n\n{\n \"message\": \"Unauthenticated\"\n}\n\n{\n \"message\": \"You are not authorized to access this resource.\"\n}\n\n{\n \"message\": \"Resource not found.\"\n}\n\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"dateBegin\": [\n \"The 'dateBegin' is not a valid date.\",\n \"The 'dateBegin' cannot be after today.\"\n ],\n \"dateEnd\": [\n \"The 'dateEnd' is not a valid date.\",\n \"The 'dateEnd' field is required when 'dateBegin' is present.\",\n \"The 'dateEnd' cannot be after today.\"\n ]\n }\n}\n\n(Required) Begin date
\n","type":"text/plain"},"key":"dateBegin","value":"2024-09-01"},{"description":{"content":"(Required) End date
\n","type":"text/plain"},"key":"dateEnd","value":"2024-09-16"}],"variable":[{"description":{"content":"(Required) Domain Group ID
\n","type":"text/plain"},"type":"any","value":"756","key":"domainGroup"}]}},"response":[{"id":"a28790c2-7da3-4f0a-816e-844e800da85e","name":"Success response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://app.powerdmarc.com/api/v1/customers/domain-groups/:domainGroup/reports?dateBegin=2024-09-01&dateEnd=2024-09-16","host":["https://app.powerdmarc.com"],"path":["api","v1","customers","domain-groups",":domainGroup","reports"],"query":[{"key":"dateBegin","value":"2024-09-01","description":"(Required) Begin date"},{"key":"dateEnd","value":"2024-09-16","description":"(Required) End date"}],"variable":[{"key":"domainGroup","value":"756","description":"(Required) Domain Group ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 16 Sep 2024 12:24:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Ray","value":"8c40d623de067d41-EVN"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"max-age=3600, private"},{"key":"Content-Encoding","value":"gzip"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains; preload"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"cf-apo-via","value":"origin,host"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=d6mgZvj1VuhT8%2Fy6WVlYCOYx5xWfPWVJgOZgTn7lop6BDBfeQ4k9A5jngbhr6CVuMLhVIjie8e%2B6BDX1Rb81vPg%2F3uc2cOLku4dJj8DJu3rLu5xu946vFgts81TNArjv%2BQuIfg%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-site"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Server","value":"cloudflare"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"total_mail_volume\": 89,\n \"dmarc_compliant_mail_volume\": 47,\n \"dmarc_compliance\": 52.8,\n \"dkim_verification_aligned_count\": 47,\n \"dkim_verification_aligned_percentage\": 52.8,\n \"dkim_verification_not_aligned_percentage\": 3.4,\n \"dkim_verification_not_aligned_count\": 3,\n \"dkim_verification_failed_percentage\": 43.8,\n \"dkim_verification_failed_count\": 39,\n \"spf_verification_aligned_count\": 0,\n \"spf_verification_aligned_percentage\": 0,\n \"spf_verification_not_aligned_count\": 16,\n \"spf_verification_not_aligned_percentage\": 18,\n \"spf_verification_failed_count\": 73,\n \"spf_verification_failed_percentage\": 82,\n \"domains\": [\n {\n \"id\": 54057,\n \"name\": \"example.com\"\n },\n {\n \"id\": 60799,\n \"name\": \"mydomain.com\"\n },\n {\n \"id\": 60907,\n \"name\": \"new.example.com\"\n }\n ]\n }\n}"}],"_postman_id":"4817d522-e50c-4abe-ba87-c4a62a0979e7"},{"name":"Get Domain Reports","id":"5bfb8ece-20c2-475b-9668-4774b0f98d99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"GET /api/v1/customers/domain-reports/{domainId}domainID (required):dateBegin (required):
type: date, string (YYYY-MM-DD)dateEnd (required):
type: date, string (YYYY-MM-DD){\n \"data\": {\n \"total_mail_volume\": 0,\n \"dmarc_compliant_mail_volume\": 0,\n \"dmarc_compliance\": 0,\n \"dmarc_noncompliant_mail_volume\": 0,\n \"dkim_verification_aligned_count\": 0,\n \"dkim_verification_aligned_percentage\": 0,\n \"dkim_verification_not_aligned_percentage\": 0,\n \"dkim_verification_not_aligned_count\": 0,\n \"dkim_verification_failed_percentage\": 0,\n \"dkim_verification_failed_count\": 0,\n \"policy_dmarc_none_count\": 0,\n \"policy_dmarc_none_percentage\": 0,\n \"policy_dmarc_reject_count\": 0,\n \"policy_dmarc_reject_percentage\": 0,\n \"policy_dmarc_quarantine_count\": 0,\n \"policy_dmarc_quarantine_percentage\": 0,\n \"spf_verification_aligned_count\": 0,\n \"spf_verification_aligned_percentage\": 0,\n \"spf_verification_not_aligned_percentage\": 0,\n \"spf_verification_not_aligned_count\": 0,\n \"spf_verification_failed_count\": 0,\n \"spf_verification_failed_percentage\": 0\n }\n}\n\n{\n \"message\": \"Unauthenticated\"\n}\n\n{\n \"message\": \"You are not authorized to access this resource.\"\n}\n\n{\n \"message\": \"Resource not found.\"\n}\n\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"dateBegin\": [\n \"The 'dateBegin' is not a valid date.\",\n \"The 'dateBegin' cannot be after today.\"\n ],\n \"dateEnd\": [\n \"The 'dateEnd' is not a valid date.\",\n \"The 'dateEnd' field is required when 'dateBegin' is present.\",\n \"The 'dateEnd' cannot be after today.\"\n ]\n }\n}\n\nGET /api/v1/customers/reports/dkim-analytics/{domainId}?from={from}&to={to}&page={pageNumber}&per_page={per_page}domainID (required):
type: integer
description: Domain id, to get analyze report
from (date - optional)
type: string
description: Start date for filtering analytics data. Format: YYYY-MM-DD.
to (date-optional)
type: string
description: End date for filtering analytics data. Format: YYYY-MM-DD.
page (pagination page number, optional)
type: integer
description: Page number to retrieve. Default value is 1.
per_page (items count per page, optional, default 50)
type: integer
description: Number of records to return per page.
POST /api/v1/customers/hostedspf/{domainID}URL Parameters
\ndomainID (required):PATCH /api/v1/customers/hostedspf/{domainID}URL Parameters
\ndomainID (required):actionType (required if adding or deleting mechanism):
description: This only applies to mechanisms. If you intend to create or delete a mechanism, then this parameter is required.
available_values: 0 or 1, pass 0 to delete the mechanism or 1 to create
mechanismType (required with mechanismValue):
type: string
available_values: a,mx,ip4,ip6,include,exists,ptr,redirect
mechanismValue required with mechanismType:
type: stringallMechanismsPrefix: (optional)
available_values: + (Pass) ,- (fail), ~ (soft fail) ,? (neutral)404 Resource not found
\n422 Unprocessable entity error response: The possible error messages are as follows:
\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"actionType\": [\n \"The action type field is required when mechanism type is present.\",\n \"The selected action type is invalid.\",\n \"The action type must be a number.\"\n ],\n \"mechanismValue\": [\n \"The mechanism value field is required when mechanism type is present.\",\n \"The mechanism is invalid.\",\n \"The per page must be at least 1.\"\n ],\n \"mechanismType\": [\n \"The mechanism type field is required when mechanism value is present.\",\n \"The selected mechanism type is invalid.\",\n \"The mechanism type must be a string.\"\n ],\n \"allMechanismPrefix\": [\n \"The selected all mechanism prefix is invalid.\"\n ]\n }\n}\n\nThe endpoint generates the DMARC record based on the provided data. The maximum count of generated DMARC records cannot exceed 10.
\nGET /api/v1/power-tools/generators/dmarcdata (required):Description: An array of data. The entire data should be wrapped into data as an array object item.policy (required):type: stringavailable values: none, reject, quarantinedescription: The DMARC policy allows senders to dictate how emails failing theaggregate_report_email (required):type: arraydescription: The property takes an email addresses. Provide at least one email.forensic_feedback_email (required):type: arraydescription: The property takes an email addresses. Provide at least one email.subdomain_policy (optional):type: stringavailable values: none, reject, quarantinedescription: Select the policy you want to apply to emails sent from your subdomains. If unspecified, the policy applied to the main domain will be applied to the subdomain.dkim_alignment (optional):type: stringavailable values: strict, relaxeddescription: In DKIM, the domain value in the d= field of the DKIM-signature in the email header has to align with the domain found in the from header.spf_alignment (optional):type: stringavailable values: strict, relaxeddescription: In SPF, the domain in the ‘Return-Path’ header has to align with that in the from header.forensic_options (optional):type: stringavailable values: 0, 1, d, sdescription: Forensic options represents in which case you want to receive forensic reports. You can select one or more options.policy_percentage (optional):type: integeravailable values: accepts the range from 0 to 100description: The percentage tag instructs ISPs to only apply the DMARC policy to a percentage of failing emails. 'pct=50' will instruct receivers to only apply the policy for 50% of the emails that fail the DMARC check.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domains\": [\n \"The domains field is required and must contain inner object elements.\",\n \"The domains must be an array.\",\n \"The domains.Index.domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\",\n \"The selector value(s) is invalid.\",\n \"The domains inner elements must be an object\",\n \"The domains inner elements may not have more than 10 items.\",\n \"The domains.Index.selectors must be an array.\",\n \"No DKIM Record found\"\n ]\n }\n}\n\nThe endpoint generates the BIMI record based on the provided data. The maximum count of generated BIMI records cannot exceed 10.
\nPOST /api/v1/power-tools/generators/bimidata (required):Description: An array of data. The entire data should be wrapped into data as an array object item.domain (required):type: stringimage_url (required):type: stringdescription: A valid URL of an SVG file. The URL should have the .svg extension.certificate_url (optional):type: arraydescription: A valid URL of an PEM file. The URL should have the .pem extension.\"{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"data\": [\n \"The data is invalid.\",\n \"The data field must be an array.\",\n \"The data field is required\",\n \"The data.Index field is required\",\n \"The data.Index must be an array\",\n \"The data.Index may not have more than 10 items\"\n ],\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ],\n \"image_url\": [\n \"The image url field is required\",\n \"The image url format is invalid.\",\n \"The image url must end with one of the following: .svg.\"\n ],\n \"certificate_url\": [\n \"The certificate url format is invalid.\",\n \"The certificate url must end with one of the following: .pem.\"\n ]\n }\n}\n\nThe endpoint generates the TLS-RPT record based on the provided data. The maximum count of generated TLS-RPT records cannot exceed 10.
\nPOST /api/v1/power-tools/generators/tls-reportdata (required):Description: An array of data. The entire data should be wrapped into data as an array object item.aggregate_report_emails (required):type: arraydescription: This array should contain aggregate report email addresses, The number of emails in aggregate_report_emails cannot exceed 10.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"data\": [\n \"The data is invalid.\",\n \"The data field must be an array.\",\n \"The data field is required\",\n \"The data.Index field is required\",\n \"The data.Index must be an array\",\n \"The data.Index may not have more than 10 items\"\n ],\n \"aggregate_report_emails\": [\n \"The data.Index.aggregate_report_emails field is required\",\n \"The data.Index.aggregate_report_emails.index must be a valid email address.\",\n \"The data.Index.aggregate_report_emails may not have more than 10 items.\"\n ]\n }\n}\n\nThe endpoint generates the DKIM record based on the provided data. The maximum count of generated DKIM records cannot exceed 10.
\nPOST /api/v1/power-tools/generators/dkimkey_size (required):type: integeravailable values: 1024, 2048, 4096description: Key size for DKIM record generation.count (optional):type: integeravailable values: 1-10description: The count for generating DKIM records should not exceed 10. If the count is not specified, it will create one record.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"key_size\": [\n \"The key size must be an integer.\",\n \"The selected key size is invalid.\"\n ],\n \"count\": [\n \"The count must be a number.\",\n \"The count may not be greater than 10.\"\n ]\n }\n}\n\nThe endpoint generates the SPF record based on the provided data. The maximum count of generated SPF records cannot exceed 10.
\nPOST /api/v1/power-tools/generators/spfdata (required):Description: An array of data. The entire data should be wrapped into data as an array object item.authorize_servers_in_mx (optional):type: stringavailable values: 1description: Authorize servers listed in your domain's MX records, value 1 means yes.authorize_servers_in_a (optional):type: stringavailable values: 1description: Authorize servers listed in your domain's A records, value 1 means yes.ipv4_address (optional):type: arraydescription: The inner items should be ipv4 addresses.ipv6_address (optional):type: arraydescription: The inner items should be ipv6 addresses.authorize_servers_in_mx_record (optional):type: arraydescription: Authorize servers listed in another domain's MX records. This field should contain a valid domain address without HTTP/HTTPauthorize_servers_in_a_record (optional):type: arraydescription: Authorize servers listed in another domain's A records. This field should contain a valid domain address without HTTP/HTTPauth_senders_3p (optional):type: arraydescription: Authorize domains or 3rd party services that send emails on behalf of this domain. This field should contain a valid domain address without HTTP/HTTPexists_mechanism_senders (optional):type: arraydescription: Authorize domains or 3rd party senders using the 'exists' mechanism. This field should contain a valid domain address without HTTP/HTTPserver_email_strictness (optional):type: stringavailable values: -, ~, ?description: This is about how strict should the servers treating the emails be? '-' means Fail, '~' means Soft-fail, '?' means Neutral{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"authorize_servers_in_mx\": [\n \"The selected authorize_servers_in_mx is invalid.\"\n ],\n \"authorize_servers_in_a\": [\n \"The selected authorize_servers_in_a is invalid.\"\n ],\n \"ipv4_address\": [\n \"The ipv4_address.index must be a valid IPv4 address.\"\n ],\n \"ipv6_address\": [\n \"The ipv6_address.index must be a valid IPv6 address.\"\n ],\n \"authorize_servers_in_mx_record\": [\n \"Please enter a valid domain name, without http:// prefix\"\n ],\n \"authorize_servers_in_a_record\": [\n \"Please enter a valid domain name, without http:// prefix\"\n ],\n \"auth_senders_3p\": [\n \"Please enter a valid domain name, without http:// prefix\"\n ],\n \"exists_mechanism_senders\": [\n \"Please enter a valid domain name, without http:// prefix\"\n ],\n \"server_email_strictness\": [\n \"The selected server email strictness is invalid.\"\n ]\n }\n}\n\nAll endpoints under this folder support bulk functionality with a maximum count of 10 items per request. Therefore, you can provide a maximum of 10 domains, IPs, or other supported data for each endpoint.
To access the API, you need to include an API key in the request headers. The API token can be generated in the portal by checking the 'PowerToolbox' option. Once generated, you can set it as a Bearer token.
\n","_postman_id":"dd771d2c-214e-43c8-9e13-92b6e29d7cab","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c59a8893-fb97-408a-83d9-187451d212f9","id":"c59a8893-fb97-408a-83d9-187451d212f9","name":"API Collections of PowerDMARC","type":"collection"}}},{"name":"Record Lookup Tools","item":[{"name":"A Record","event":[{"listen":"test","script":{"id":"a151b5db-60a0-4ba5-bf58-19d98e09219b","exec":[""],"type":"text/javascript"}}],"id":"2ca5ae7b-b424-42d8-afcf-505fefdad451","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"domains\": [\n \"google.com\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.powerdmarc.com/api/v1/power-tools/lookup/records/a","description":"The endpoint returns the A record of the provided domain or domains. The maximum count of domains that can be provided is 10.
\nPOST /api/v1/power-tools/lookup/records/adomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint returns the AAAA record of the provided domain or domains. The maximum count of domains that can be provided is 10.
POST /api/v1/power-tools/lookup/records/aaaadomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint returns the SPF record of the provided domain or domains. The maximum count of domains that can be provided is 10.
The \"valid\" field indicates if the SPF record is syntactically correct (true) or not (false).
POST /api/v1/power-tools/lookup/records/spfdomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint returns the BIMI record of the provided domain or domains. The maximum count of domains that can be provided is 10.
POST /api/v1/power-tools/lookup/records/bimidomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint returns the CNAME record of the provided domain or domains. The maximum count of domains that can be provided is 10.
POST /api/v1/power-tools/lookup/records/cnamedomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS. The domain should contain a DNS label, as exemplified in the example below.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint returns the DKIM record of the provided domain or domains. The maximum count of domains that can be provided is 10.
POST /api/v1/power-tools/lookup/records/dkimdomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS. The domains should contain objects with the following properties.name (required) | type - string: This will contain a domain name.selectors (optional) | type - array:An array of selectors for the current domain.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domains\": [\n \"The domains field is required and must contain inner object elements.\",\n \"The domains must be an array.\",\n \"The domains.Index.domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\",\n \"The selector value(s) is invalid.\",\n \"The domains inner elements must be an object\",\n \"The domains inner elements may not have more than 10 items.\",\n \"The domains.Index.selectors must be an array.\",\n \"No DKIM Record found\"\n ]\n }\n}\n\nThe endpoint returns the DMARC record of the provided domain or domains. The maximum count of domains that can be provided is 10.
POST /api/v1/power-tools/lookup/records/dmarcdomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint returns the FCRDNS record of the provided IP or IPs. The maximum count of IPs that can be provided is 10.
POST /api/v1/power-tools/lookup/fcrdnsips (required): An array of IPs. You need to provide at least one IP. Elements in the IPs array must be a valid IP.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"ips\": [\n \"The ips must be an array.\",\n \"The ips field is required\",\n \"The ips.Index must be a valid IP address.\"\n ]\n }\n}\n\nThe endpoint returns the MTA-STS TLS-RPT record of the provided domain or domains. The maximum count of domains that can be provided is 10.
POST /api/v1/power-tools/lookup/records/mtastsdomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint returns the MX record of the provided domain or domains. The maximum count of domains that can be provided is 10.
POST /api/v1/power-tools/lookup/records/mxdomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint returns the NS record of the provided domain or domains. The maximum count of domains that can be provided is 10.
POST /api/v1/power-tools/lookup/records/nsdomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint returns the PTR record of the provided IP or IPs. The maximum count of IPs that can be provided is 10.
POST /api/v1/power-tools/lookup/records/ptrips (required): An array of IPs. You need to provide at least one IP. Elements in the IPs array must be a valid IPs without the prefix HTTP or HTTPS.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"ips\": [\n \"The ips must be an array.\",\n \"The ips field is required\",\n \"The ips.Index must be a valid IP address.\"\n ]\n }\n}\n\nThe endpoint returns the SOA record of the provided domain or domains. The maximum count of domains that can be provided is 10.
POST /api/v1/power-tools/lookup/records/soadomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint returns the CAA record of the provided domain or domains. The maximum count of domains that can be provided is 10.
POST /api/v1/power-tools/lookup/records/caadomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS.{\n \"data\": [\n {\n \"domain\": \"example.com\",\n \"value\": [\n {\n \"ttl\": \"3600\",\n \"value\": \"0 issue \\\"comodoca.com\"\n }\n ]\n }\n ]\n}\n\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint returns the TXT record of the provided domain or domains. The maximum count of domains that can be provided is 10.
POST /api/v1/power-tools/lookup/records/txtdomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint returns the WHOIS record of the provided domain or domains. The maximum count of domains that can be provided is 10.
POST /api/v1/power-tools/lookup/records/whoisdomains (required): An array of domains.You need to provide at least one domain. Elements in the domains array must be a valid domain without the prefix HTTP or HTTPS.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"The domain field is required\",\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nAll endpoints under this folder support bulk functionality with a maximum count of 10 items per request. Therefore, you can provide a maximum of 10 domains, IPs, or other supported data for each endpoint.
To access the API, you need to include an API key in the request headers. The API token can be generated in the portal by checking the 'PowerToolbox' option. Once generated, you can set it as a Bearer token.
\n","_postman_id":"54f297e9-dd36-40c7-a5d4-212ff565f0f0","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c59a8893-fb97-408a-83d9-187451d212f9","id":"c59a8893-fb97-408a-83d9-187451d212f9","name":"API Collections of PowerDMARC","type":"collection"}}},{"name":"Domain Analyzer","item":[{"name":"Lookup","item":[{"name":"Start Lookalike Domain Analysis","id":"6757f5ca-f705-4c93-a2ce-dbd519c70b2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"POST /api/v1/power-tools/lookup/lookalikedomain (required) type: string:POST /api/v1/power-tools/lookup/lookalike/{job_id}perpage (optional) default 15:
page (optional) default 1:
job_id (required):
type: string
description: generated id from Start Lookalike Domain Analysis request
Get a domain and return the results of the analysis
\nResponses
\n{\n \"data\": {\n \"percent\": 100,\n \"score\": 100,\n \"score_mark\": \"A\",\n \"domain\": \"example.com\",\n \"details\": {\n \"a\": [\n \"203.0.113.1\"\n ],\n \"ns\": [\n \"ns1.example.com\"\n ],\n \"mx\": [\n {\n \"exchange\": \"mail.example.com\",\n \"priority\": 10\n }\n ],\n \"dmarc\": \"v=DMARC1; p=none; rua=mailto:dmarc-reports@example.com;\",\n \"dmarc_parsed\": {\n \"tags\": {\n \"v\": {\n \"value\": \"DMARC1\"\n },\n \"p\": {\n \"value\": \"none\"\n },\n \"rua\": {\n \"value\": \"mailto:dmarc-reports@example.com\"\n }\n },\n \"records\": \"string\",\n \"valid\": true,\n \"is_valid\": true\n },\n \"dkim\": [\n {\n \"selector\": \"default\",\n \"records\": [\n \"v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9...\"\n ],\n \"valid\": true,\n \"raw_data\": \"string\",\n \"tags\": {\n \"v\": {\n \"value\": \"DKIM1\"\n },\n \"k\": {\n \"value\": \"rsa\"\n },\n \"p\": {\n \"value\": \"MIIBIjANBgkqhkiG9...\"\n }\n },\n \"message\": \"DKIM record is valid\",\n \"record_check\": [\n {\n \"key\": \"DKIM record validity\",\n \"value\": \"Yes\",\n \"status\": true\n }\n ],\n \"errors\": [\n \"string\"\n ],\n \"warnings\": [\n \"string\"\n ]\n }\n ],\n \"spf\": \"v=spf1 ip4:203.0.113.0/24 -all\",\n \"spf_parsed\": {\n \"structure\": {\n \"values\": [\n {\n \"value\": \"ip4:203.0.113.0/24\",\n \"lookups\": 1\n }\n ],\n \"errors\": [\n \"string\"\n ],\n \"warnings\": [\n \"string\"\n ],\n \"lookups\": 1,\n \"void_lookups\": 0,\n \"text\": \"v=spf1 ip4:203.0.113.0/24 -all\",\n \"record\": \"v=spf1 ip4:203.0.113.0/24 -all\",\n \"records\": \"string\",\n \"nodes\": [\n {\n \"values\": [\n {\n \"value\": \"ip4:203.0.113.0/24\",\n \"lookups\": 0\n }\n ],\n \"errors\": [\n \"string\"\n ],\n \"warnings\": [\n \"string\"\n ],\n \"lookups\": 1,\n \"void_lookups\": 0,\n \"text\": \"include:example.com\",\n \"record\": \"v=spf1 ip4:203.0.113.0/24 -all\"\n }\n ]\n }\n }\n },\n \"lookup_date\": \"2020-01-01T09:17:11.343844Z\",\n \"inactive\": false,\n \"detected_dkim_selector\": \"some selector\"\n }\n}\n\n{\n \"message\": \"Unauthenticated\"\n}\n\n{\n \"message\": \"You are not authorized to access this resource.\"\n}\n\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nAnalyze a domain and return a PDF with the results of the analysis
\nResponses
\n200 Success response
\n401 Unauthenticated
\n{\n \"message\": \"Unauthenticated\"\n}\n\n{\n \"message\": \"You are not authorized to access this resource.\"\n}\n\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domain\": [\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nThe endpoint gets whois ASN information of an IP address.
\nGET /api/v1/dns/whois/asnip (required):
\ntype: stringdescription: IP address{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"ip\": [\n \"The ip field is required\",\n \"The ip must be a valid IP address.\"\n ]\n }\n}\n\nIP address
\n","type":"text/plain"},"key":"ip","value":"4.4.4.4"}],"variable":[]}},"response":[{"id":"d264493d-219c-44c1-9466-d1a04996f1e8","name":"Get Whois ASN","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://app.powerdmarc.com/api/v1/dns/whois/asn?ip=4.4.4.4","protocol":"https","host":["app","powerdmarc","com"],"path":["api","v1","dns","whois","asn"],"query":[{"key":"ip","value":"4.4.4.4","description":"IP address"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"asn\": {\n \"whois\": [\n {\n \"as\": \"3356\",\n \"ip\": \"4.4.4.4\",\n \"prefix\": \"4.0.0.0/9\",\n \"country\": \"US\",\n \"registry\": \"arin\",\n \"allocated\": \"1992-12-01\",\n \"name\": \"LEVEL3, US\"\n }\n ],\n \"whois_peer\": [\n {\n \"as\": \"209\",\n \"ip\": \"4.4.4.4\",\n \"prefix\": \"4.0.0.0/9\",\n \"country\": \"US\",\n \"registry\": \"arin\",\n \"allocated\": \"1992-12-01\",\n \"name\": \"CENTURYLINK-US-LEGACY-QWEST, US\"\n },\n {\n \"as\": \"1239\",\n \"ip\": \"4.4.4.4\",\n \"prefix\": \"4.0.0.0/9\",\n \"country\": \"US\",\n \"registry\": \"arin\",\n \"allocated\": \"1992-12-01\",\n \"name\": \"SPRINTLINK, US\"\n },\n {\n \"as\": \"1299\",\n \"ip\": \"4.4.4.4\",\n \"prefix\": \"4.0.0.0/9\",\n \"country\": \"US\",\n \"registry\": \"arin\",\n \"allocated\": \"1992-12-01\",\n \"name\": \"TWELVE99 Arelion, fka Telia Carrier, SE\"\n },\n {\n \"as\": \"2914\",\n \"ip\": \"4.4.4.4\",\n \"prefix\": \"4.0.0.0/9\",\n \"country\": \"US\",\n \"registry\": \"arin\",\n \"allocated\": \"1992-12-01\",\n \"name\": \"NTT-LTD-2914, US\"\n },\n {\n \"as\": \"3257\",\n \"ip\": \"4.4.4.4\",\n \"prefix\": \"4.0.0.0/9\",\n \"country\": \"US\",\n \"registry\": \"arin\",\n \"allocated\": \"1992-12-01\",\n \"name\": \"GTT-BACKBONE GTT, US\"\n },\n {\n \"as\": \"6939\",\n \"ip\": \"4.4.4.4\",\n \"prefix\": \"4.0.0.0/9\",\n \"country\": \"US\",\n \"registry\": \"arin\",\n \"allocated\": \"1992-12-01\",\n \"name\": \"HURRICANE, US\"\n },\n {\n \"as\": \"7195\",\n \"ip\": \"4.4.4.4\",\n \"prefix\": \"4.0.0.0/9\",\n \"country\": \"US\",\n \"registry\": \"arin\",\n \"allocated\": \"1992-12-01\",\n \"name\": \"EDGEUNO SAS, CO\"\n }\n ]\n }\n }\n}"}],"_postman_id":"622497f2-55a5-4eb0-bb48-e75e5735cabf"},{"name":"Whois an IP","id":"6a153534-e162-4ed0-8d48-e7070b1aaec3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.powerdmarc.com/api/v1/dns/whois","description":"The endpoint gets whois information of an IP address.
\nGET /api/v1/dns/whoisip (required):
\ntype: stringdescription: IP addressEndFragment
\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"ip\": [\n \"The ip field is required\",\n \"The ip must be a valid IP address.\"\n ]\n }\n}\n\nIP address
\n","type":"text/plain"},"key":"ip","value":"4.4.4.4"}],"variable":[]}},"response":[{"id":"79bf7e81-a0df-41b0-a55a-ba8184c5c9ea","name":"Whois an IP","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://app.powerdmarc.com/api/v1/dns/whois?ip=4.4.4.4","protocol":"https","host":["app","powerdmarc","com"],"path":["api","v1","dns","whois"],"query":[{"key":"ip","value":"4.4.4.4","description":"IP address"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"NetRange\": \"4.4.0.0 - 4.4.255.255\",\n \"CIDR\": \"4.4.0.0/16\",\n \"NetName\": \"LVLT-STATIC-4-4-16\",\n \"NetHandle\": \"NET-4-4-0-0-1\",\n \"Parent\": \"LVLT-ORG-4-8 (NET-4-0-0-0-1)\",\n \"NetType\": \"Reallocated\",\n \"OriginAS\": \"\",\n \"Organization\": \"Level 3 Communications, Inc. (LVLT)\",\n \"RegDate\": \"1998-05-22\",\n \"Updated\": \"2023-02-21\",\n \"Ref\": \"https://rdap.arin.net/registry/entity/LVLT\",\n \"OrgName\": \"Level 3 Communications, Inc.\",\n \"OrgId\": \"LVLT\",\n \"Address\": \"1025 Eldorado Blvd.\",\n \"City\": \"Broomfield\",\n \"StateProv\": \"CO\",\n \"PostalCode\": \"80021\",\n \"Country\": \"US\",\n \"Comment\": \"Without these we will be unable to identify the correct owner of the IP address at that point in time.\",\n \"OrgAbuseHandle\": \"LAC56-ARIN\",\n \"OrgAbuseName\": \"L3 Abuse Contact\",\n \"OrgAbusePhone\": \"+1-877-453-8353\",\n \"OrgAbuseEmail\": \"abuse@level3.com\",\n \"OrgAbuseRef\": \"https://rdap.arin.net/registry/entity/LAC56-ARIN\",\n \"OrgTechHandle\": \"APL7-ARIN\",\n \"OrgTechName\": \"ADMIN POC LVLT\",\n \"OrgTechPhone\": \"+1-877-453-8353\",\n \"OrgTechEmail\": \"ipadmin@lumen.com\",\n \"OrgTechRef\": \"https://rdap.arin.net/registry/entity/APL7-ARIN\",\n \"OrgNOCHandle\": \"NOCSU27-ARIN\",\n \"OrgNOCName\": \"NOC Support\",\n \"OrgNOCPhone\": \"+1-877-453-8353\",\n \"OrgNOCEmail\": \"noc.coreip@level3.com\",\n \"OrgNOCRef\": \"https://rdap.arin.net/registry/entity/NOCSU27-ARIN\"\n }\n}"}],"_postman_id":"6a153534-e162-4ed0-8d48-e7070b1aaec3"},{"name":"Get geolocation","id":"58b26d0a-2b1f-4de2-a63f-fac64131cb25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.powerdmarc.com/api/v1/dns/lookup","description":"The endpoint gets geolocation of an IP address.
\nGET /api/v1/dns/lookupip (required):
\ntype: stringdescription: IP address{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"ip\": [\n \"The ip field is required\",\n \"The ip must be a valid IP address.\"\n ]\n }\n}\n\nIP address
\n","type":"text/plain"},"key":"ip","value":"4.4.4.4"}],"variable":[]}},"response":[{"id":"23ecb539-9b2f-44db-864d-641ad263c9d7","name":"Get geolocation","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://app.powerdmarc.com/api/v1/dns/lookup?ip=4.4.4.4","protocol":"https","host":["app","powerdmarc","com"],"path":["api","v1","dns","lookup"],"query":[{"key":"ip","value":"4.4.4.4","description":"IP address"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"ip\": \"4.4.4.4\",\n \"type\": \"ipv4\",\n \"continent_code\": \"NA\",\n \"continent_name\": \"North America\",\n \"country_code\": \"US\",\n \"region_code\": \"CA\",\n \"region_name\": \"California\",\n \"city\": \"Pasadena\",\n \"zip\": \"91107\",\n \"latitude\": 34.15000915527344,\n \"longitude\": -118.08110046386719\n }\n}"}],"_postman_id":"58b26d0a-2b1f-4de2-a63f-fac64131cb25"}],"id":"6b5e2985-38c7-4f6a-b8f6-3357504fcfed","description":"To access the API, you need to include an API key in the request headers. The API token can be generated in the portal by checking the 'Threat Intelligence' option. Once generated, you can set it as a Bearer token.
\n","_postman_id":"6b5e2985-38c7-4f6a-b8f6-3357504fcfed","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c59a8893-fb97-408a-83d9-187451d212f9","id":"c59a8893-fb97-408a-83d9-187451d212f9","name":"API Collections of PowerDMARC","type":"collection"}}},{"name":"TLS Reports","item":[{"name":"Get TLS-RPT Per Sending Source","id":"d28e72dc-16e7-4470-8307-414dc4f76d25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dateFrom\": \"2023-07-16\",\n \"dateTo\": \"2023-07-23\",\n \"perPage\": 5,\n \"domain\": \"example.com\" \n}","options":{"raw":{"language":"json"}}},"url":"https://app.powerdmarc.com/api/v1/customers/tls/sending-source","description":"POST /api/v1/customers/tls/sending-source/perPage (optional):description: The response data is paginated, with a maximum of 50 items per page. The field is optional and has a default value of 15. You can specify a value between 15 and 50 for the count of items per page.page (optional):description: The page field is intended for pagination. Pass a page number to get the data for the specific page.dateFrom (optional):type: date, string (YYYY-MM-DD)dateTo (optional, required if dateFrom is present):type: date, string (YYYY-MM-DD)domain (optional):{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"dateFrom\": [\n \"The 'date from' is not a valid date.\",\n \"The date from does not match the format Y-m-d.\",\n \"The 'date from' does not match the format Y-m-d.\"\n ],\n \"dateTo\": [\n \"The 'date to' is not a valid date.\",\n \"The 'date to' field is required when 'date from' is present.\",\n \"The 'date to' does not match the format Y-m-d.\"\n ],\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"page\": [\n \"The page must be an integer.\",\n \"The page must be at least 1.\"\n ],\n \"domain\": [\n \"Please enter a valid domain name, without http:// prefix\"\n ]\n }\n}\n\nPOST /api/v1/customers/tls/sending-source-details/organizationName (required):policyType (required):type: stringavailable_values: sts, no-policy-found, tlsaperPage (optional):description: Result show on each page. The maximum value is 50, the default will be 15, this will work without specifying the parameter.dateFrom (optional):type: date, string (YYYY-MM-DD)dateTo (optional, required if dateFrom is present):type: date, string (YYYY-MM-DD)page (optional):type: integer{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"dateFrom\": [\n \"The 'date from' is not a valid date.\",\n \"The 'date from' does not match the format Y-m-d.\"\n ],\n \"dateTo\": [\n \"The 'date to' is not a valid date.\",\n \"The 'date to' field is required when 'date from' is present.\",\n \"The 'date from' does not match the format Y-m-d.\"\n ],\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"page\": [\n \"The page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"organizationName\": [\n \"The organization name field is required\",\n \"The organization name must be a string.\"\n ],\n \"policyType\": [\n \"The policy type field is required\",\n \"The selected policy type is invalid.\"\n ]\n }\n}\n\nPOST /api/v1/customers/tls/per-result/type (required):type: stringavailable_values: failed, successfuldateFrom (optional):type: date, string (YYYY-MM-DD)dateTo (optional, required if dateFrom is present):type: date, string (YYYY-MM-DD)perPage (optional):description: The response data is paginated, with a maximum of 50 items per page. The field is optional and has a default value of 15. You can specify a value between 15 and 50 for the count of items per page.page (optional):description: The page field is intended for pagination. Pass a page number to get the data for the specific page.domain (optional):type: stringdescription: Filter by domain name.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"dateFrom\": [\n \"The 'date from' is not a valid date.\",\n \"The date from cannot be after today.\"\n ],\n \"dateTo\": [\n \"The 'date to' is not a valid date.\",\n \"The 'date to' field is required when 'date from' is present.\",\n \"The date to cannot be after today.\"\n ],\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"page\": [\n \"The page must be an integer.\",\n \"The per page must be at least 1.\"\n ]\n }\n}\n\nPOST /api/v1/customers/tls/per-result-details/organizationName (required):policyType (required):type: stringavailable_values: sts, no-policy-found, tlsadateFrom (optional):type: date, string (YYYY-MM-DD)dateTo (optional, required if dateFrom is present):type: date, string (YYYY-MM-DD)perPage (optional):description: The response data is paginated, with a maximum of 50 items per page. The field is optional and has a default value of 15. You can specify a value between 15 and 50 for the count of items per page.page (optional):description: The page field is intended for pagination. Pass a page number to get the data for the specific page.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"dateFrom\": [\n \"The 'date from' is not a valid date.\"\n ],\n \"dateTo\": [\n \"The 'date to' is not a valid date.\",\n \"The 'date to' field is required when 'date from' is present.\"\n ],\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"page\": [\n \"The page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"organizationName\": [\n \"The organization name field is required\",\n \"The organization name must be a string.\"\n ]\n }\n}\n\nGET /api/v1/customers/tls/failure-details/id (required):description: Per Result IDperPage (optional):description: The response data is paginated, with a maximum of 50 items per page. The field is optional and has a default value of 15. You can specify a value between 15 and 50 for the count of items per page.page (optional):description: The page field is intended for pagination. Pass a page number to get the data for the specific page.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"id\": [\n \"The id field is required\",\n \"The id must be an integer.\"\n ],\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"page\": [\n \"The page must be an integer.\",\n \"The per page must be at least 1.\"\n ]\n }\n}\n\nGET /api/v1/reputation-monitoring/configurations/getnotificationIntegrationId (optional):type: integerdescription: Pass the ID of a notification integration to retrieve the reputation monitoring configurations associated with the current notification integrationisEnabled (optional):type: booleandescription: Filtration by state of configurations, pass true to get enabled or false to get disabled configurationssearch (optional):type: stringdescription: Filtration by asset name contained in configurationsperPage (optional):type: integerdescription: The response data comes in a paginated format, allowing a maximum of 50 items on each page. While the field is optional, it defaults to 15 items per page. You have the option to set this value to anything between 1 and 50, depending on how many items of data you prefer to view per page.page (optional):type: integerdescription: The page field is intended for pagination. Pass a page number to get the data for the specific page.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"page\": [\n \"The page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"notificationIntegrationId\": [\n \"The notification integration id must be a number.\",\n \"The selected notification integration id is invalid.\"\n ],\n \"isEnabled\": [\n \"The is enabled field must be true or false.\"\n ],\n \"search\": [\n \"The search must be a string.\"\n ]\n }\n}\n\nGET /api/v1/reputation-monitoring/summaryGET /api/v1/reputation-monitoring/asset-historyasset (required):type: stringdescription: Pass an asset to get history. Available asset types are only IPv4, IPv6, domain.dateFrom(optional, required if dateTo is present):type: date|stringdescription: Filtration by date requires passing the date in the Y-m-d format as a start date.dateTo (optional, required if dateFrom is present):type: date|stringdescription: Filtration by date requires passing the date in the Y-m-d format as an end date.perPage (optional):type: integerdescription: The response data comes in a paginated format, allowing a maximum of 50 items on each page. While the field is optional, it defaults to 15 items per page. You have the option to set this value to anything between 1 and 50, depending on how many items of data you prefer to view per page.page (optional):type: integerdescription: The page field is intended for pagination. Pass a page number to get the data for the specific page.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"page\": [\n \"The page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"asset\": [\n \"The asset field is required\",\n \"The Value is invalid asset\",\n \"The asset may not be greater than 254 characters.\"\n ],\n \"dateFrom\": [\n \"The 'date from' is not a valid date.\",\n \"The 'date from' does not match the format Y-m-d.\",\n \"The 'date to' field is required when 'date from' is present.\"\n ],\n \"dateTo\": [\n \"The 'date to' is not a valid date.\",\n \"The 'date to' does not match the format Y-m-d.\",\n \"The 'date from' field is required when 'date to' is present.\"\n ]\n }\n}\n\nPOST /api/v1/reputation-monitoring/configurationsname (required):type: stringdescription: Name of the configuration.assets (required):type: arrayarray_element_type: 'string'description: An array of assets, available asset types are only IPv4, IPv6, domain.notificationIntegrationId (optional):type: integerdescription: Pass an id of notification to enable webhooks and emails for the assets of this group. The field is not required and can be left empty.frequencyOfMonitoring (optional):type: integeravailable_value: 1800, 3600, 10800, 21600, 43200description: The available values in seconds, which is equal to 30 minutes - 1800s, 1 hour - 3600s, 3 hours - 10800s, 6 hours - 21600s, 12 hours - 43200s. If the field is left empty because the account does not have access to frequency management, the default value of 12 hours - 43200s will be applied.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\",\n \"The name has already been taken\",\n \"The name may not be greater than 36 characters.\",\n \"The action type must be a string.\",\n \"The assets.Index field has a duplicate value.\"\n ],\n \"assets\": [\n \"The assets is invalid asset\",\n \"The assets must be an array.\",\n \"The assets.Index field has a duplicate value.\"\n ],\n \"notificationIntegrationId\": [\n \"The selected notification integration id is invalid.\"\n ],\n \"frequencyOfMonitoring\": [\n \"The selected frequency of monitoring is invalid.\"\n ]\n }\n}\n\nPOST /api/v1/reputation-monitoring/configurations/add-assets/{configId}configId (required):description: An ID of configuration to be updated.assets (required):type: arrayarray_element_type: 'string'description: An array of assets, available asset types are only IPv4, IPv6, domain.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"assets\": [\n \"The value is invalid asset\",\n \"The assets field is required\",\n \"The assets must have at least 1 items.\",\n \"The assets must be an array.\",\n \"The assets.Index field has a duplicate value.\"\n ]\n }\n}\n\nPATCH /api/v1/reputation-monitoring/configurations/{configId}configId (required):description: An ID of configuration to be updated.notificationIntegrationId (optional):type: integerdescription: Pass an id of notification to enable webhooks and emails for the assets of this group or you can pass a null value or leave it empty to detach the integration.frequencyOfMonitoring (optional):type: integeravailable_value: null, 1800, 3600, 10800, 21600, 43200description: The available values in seconds, which is equal to 30 minutes - 1800s, 1 hour - 3600s, 3 hours - 10800s, 6 hours - 21600s, 12 hours - 43200s. If the field is left empty because the account does not have access to frequency management, the default value of 12 hours - 43200s will be applied.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"notificationIntegrationId\": [\n \"The selected notification integration id is invalid.\"\n ],\n \"frequencyOfMonitoring\": [\n \"The selected frequency of monitoring is invalid.\"\n ]\n }\n}\n\nPATCH /api/v1/reputation-monitoring/configurations/toggle/{config}config (required):
type: integerdescription: An ID of the configuration to be updated.state (required):type: booleandescription:Pass true to enable and false to disable configuration{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"state\": [\n \"The state field must be true or false.\",\n \"The state field is required\"\n ]\n }\n}\n\nGET /api/v1/reputation-monitoring/alerts-historytype (optional):type: enum|stringavailable_values: ipv4, ipv6, domaindescription: Filter by asset type.dateFrom(optional, required if dateTo is present):type: date|stringdescription: Filtration by date requires passing the date in the Y-m-d format as a start date.dateTo (optional, required if dateFrom is present):type: date|stringdescription: Filtration by date requires passing the date in the Y-m-d format as an end date.search (optional):type: stringdescription: Filtration by asset nameperPage (optional):type: integerdescription: The response data comes in a paginated format, allowing a maximum of 50 items on each page. While the field is optional, it defaults to 15 items per page. You have the option to set this value to anything between 1 and 50, depending on how many items of data you prefer to view per page.page (optional):type: integerdescription: The page field is intended for pagination. Pass a page number to get the data for the specific page.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"page\": [\n \"The page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"dateFrom\": [\n \"The 'date from' is not a valid date.\",\n \"The 'date from' does not match the format Y-m-d.\",\n \"The date to field is required when date from is present.\"\n ],\n \"dateTo\": [\n \"The 'date to' is not a valid date.\",\n \"The 'date to' does not match the format Y-m-d.\",\n \"The date from field is required when date to is present.\"\n ],\n \"type\": [\n \"The selected type is invalid.\"\n ],\n \"search\": [\n \"The search must be a string.\",\n \"The search may not be greater than 254 characters.\"\n ]\n }\n}\n\nDELETE /api/v1/reputation-monitoring/configurations/{configurationID}configurationId (required):type: integerdescription: An id of configuration to delete404: Resource not found.204: Action completed successfully.DELETE /api/v1/reputation-monitoring/configurations/delete-assets/{configurationID}assetsId (required):type: arrayarray_element_type: 'integer'description: An array of asset IDs to be deleted.configurationId (required):type: integerdescription: An id of configuration to delete404: Resource not found.204: Action completed successfully.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"assetsId\": [\n \"The selected assetsId.Index is invalid.\",\n \"The assetsId.Index must be an integer.\",\n \"The assets id field is required.\",\n \"The assets id must be an array.\"\n ]\n }\n}\n\nDELETE /api/v1/reputation-monitoring/configurations/alerts-history?asset=...asset (required):description: The name of the asset whose history needs to be deleted.404: Resource not found.204: Action completed successfully.POST /api/v1/customers/mail-volume-history/domains (optional):type: arraydescription: Max count of domains in array is 15.dateFrom (optional):type: date, string (YYYY-MM-DD)dateTo (optional, required if dateFrom is present):type: date, string (YYYY-MM-DD)perPage (optional):description: The response data is paginated, with a maximum of 50 items per page. The field is optional and has a default value of 15. You can specify a value between 15 and 50 for the count of items per page.page (optional):description: The page field is intended for pagination. Pass a page number to get the data for the specific page.{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"domains\": [\n \"The domains field is required\",\n \"The domains must be an array.\",\n \"Please enter a valid domain name, without http:// prefix.\"\n ],\n \"dateFrom\": [\n \"The 'date from' is not a valid date.\"\n ],\n \"dateTo\": [\n \"The 'date to' is not a valid date.\",\n \"The 'date to' field is required when 'date from' is present.\"\n ],\n \"perPage\": [\n \"The per page may not be greater than 50.\",\n \"The per page must be an integer.\",\n \"The per page must be at least 1.\"\n ],\n \"page\": [\n \"The page must be an integer.\",\n \"The per page must be at least 1.\"\n ]\n }\n}\n\nGET /api/v1/customers/pgp-keyGET /api/v1/customers/dkim/sending-servicesGETstart_date (date - optional)
type: string
description: Start date for filtering analytics data. Format: YYYY-MM-DD.
end_date (date-optional)
type: string
description: End date for filtering analytics data. Format: YYYY-MM-DD.
page (pagination page number, optional)
type: integer
description: Page number to retrieve. Default value is 1.
per_page (items count per page, optional, default 50)
type: integer
description: Number of records to return per page.
Retrieves one or more DNS alert configurations, optionally filtered by domain, domain group, or notification group.
\nQuery parameters
\nStartFragmentperPageType: integerDescription: Number of items per page. Max is 50.Default: 15.
pageType: integerDescription: Current page number.Default: 1
domainType: stringDescription: Filter by domain name. If not specified, returns all domains. Cannot be used together with domain group.
domain_groupType: stringDescription: Filter by domain group. Cannot be used together with domain.
notification_groupType: stringDescription: Filter by notification group ID. If not specified, returns all groups.EndFragment
domain_idsType: array of integersDescription: List of domain IDs that the alert configuration applies to.Required: Yes, if domain_group_ids is empty.Validation: At least one domain or domain group must be provided.
*domain_group_ids
*Type: array of integersDescription: List of domain group IDs.Required: Yes, if domain_ids is empty.
Note: Both domain_ids and domain_group_ids can be provided together.
\nselect_all_conditionsType: booleanDescription: If true, the configuration includes all available condition combinations automatically (15 conditions overall).
Default: false
conditionsType: array of objectsDescription: Defines what types of DNS events should trigger the alert.
Each condition is a combination of:
- event_type (Values: \"DMARC, SPF, DKIM, BIMI, MTA-STS, TLS-RPT, A, MX, NS\")
- trigger (Values: \"Record Changed\", \"Validation Failed\")
- severity (Values: \"Critical\", \"Warning\", \"Informational\")Required: Yes, unless select_all_conditions = true.Validation: At least one condition must exist if not selecting all.
event_type, trigger and severity are mandatory within each object.
If both fields are present (select_all_conditions and conditions):
System should prioritize select_all_conditions = true.
The conditions array should be ignored entirely.
**notification_group_ids
**Type: Integer
If specified, considers to which recipients send the alert notifications.
URL Parameters:
config_idType: integerRequired: Yes
Description: Unique identifier of the DNS Alert Configuration to be edited.
domain_idsType: array of integersDescription: List of domain IDs that the alert configuration applies to.Required: Yes, if domain_groups is empty.Validation: At least one domain or domain group must be provided.
domain_group_idsType: array of integersDescription: List of domain group IDs.Required: Yes, if domain_ids is empty.
Note: Both domains and domain_groups can be provided together.
\nselect_all_conditionsType: booleanDescription: If true, the configuration includes all available condition combinations automatically (15 conditions overall).Default: falseValidation:
If true: conditions array can be empty.
If false: conditions array must include at least one item.
conditionsType: array of objectsDescription: Defines what types of DNS events should trigger the alert.
Each condition is a combination of:
- event_type (Values: \"DMARC, SPF, DKIM, BIMI, MTA-STS, TLS-RPT, A, MX, NS\")
- trigger (Values: \"Record Changed\", \"Validation Failed\")
- severity (Values: \"Critical\", \"Warning\", \"Informational\")Required: Yes, unless select_all_conditions = true.Validation: At least one condition must exist if not selecting all.
event_type, trigger and severity are mandatory within each object.
If both fields are present (select_all_conditions and conditions):
System should prioritize select_all_conditions = true.
The conditions array should be ignored entirely.
Deletes one or more DNS alert configurations by specifying their configuration IDs.
\nidsType: array of integersDescription: An array of configuration IDs to delete.EndFragment