openapi: 3.0.0
info:
version: 2015-07-09
x-release: v4
title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Radar Email Security API
description:
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Radar Email Security paths: /radar/email/security/summary/arc: get: description: Percentage distribution of emails classified per ARC validation. operationId: radar-get-email-security-summary-by-arc parameters: - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: properties: confidenceInfo: properties: annotations: items: properties: dataSource: example: ALL type: string description: example: Cable cut in Tonga type: string endTime: format: date-time type: string eventType: example: OUTAGE type: string isInstantaneous: example: true type: boolean linkedUrl: type: string startTime: format: date-time type: string required: - dataSource - eventType - description - isInstantaneous type: object type: array level: type: integer type: object dateRange: items: properties: endTime: description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' format: date-time type: string startTime: description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' format: date-time type: string required: - startTime - endTime type: object type: array lastUpdated: example: '2023-07-26T08:59:57Z' type: string normalization: example: PERCENTAGE type: string required: - dateRange - normalization - lastUpdated type: object summary_0: properties: FAIL: example: '2' type: string NONE: example: '53' type: string PASS: example: '45' type: string required: - NONE - PASS - FAIL type: object required: - meta - summary_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get ARC Validations Summary tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/summary/dkim: get: description: Percentage distribution of emails classified per DKIM validation. operationId: radar-get-email-security-summary-by-dkim parameters: - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: properties: confidenceInfo: properties: annotations: items: properties: dataSource: example: ALL type: string description: example: Cable cut in Tonga type: string endTime: format: date-time type: string eventType: example: OUTAGE type: string isInstantaneous: example: true type: boolean linkedUrl: type: string startTime: format: date-time type: string required: - dataSource - eventType - description - isInstantaneous type: object type: array level: type: integer type: object dateRange: items: properties: endTime: description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' format: date-time type: string startTime: description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' format: date-time type: string required: - startTime - endTime type: object type: array lastUpdated: example: '2023-07-26T08:59:57Z' type: string normalization: example: PERCENTAGE type: string required: - dateRange - normalization - lastUpdated type: object summary_0: properties: FAIL: example: '2' type: string NONE: example: '53' type: string PASS: example: '45' type: string required: - NONE - PASS - FAIL type: object required: - meta - summary_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get DKIM Validations Summary tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/summary/dmarc: get: description: Percentage distribution of emails classified per DMARC validation. operationId: radar-get-email-security-summary-by-dmarc parameters: - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: properties: confidenceInfo: properties: annotations: items: properties: dataSource: example: ALL type: string description: example: Cable cut in Tonga type: string endTime: format: date-time type: string eventType: example: OUTAGE type: string isInstantaneous: example: true type: boolean linkedUrl: type: string startTime: format: date-time type: string required: - dataSource - eventType - description - isInstantaneous type: object type: array level: type: integer type: object dateRange: items: properties: endTime: description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' format: date-time type: string startTime: description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' format: date-time type: string required: - startTime - endTime type: object type: array lastUpdated: example: '2023-07-26T08:59:57Z' type: string normalization: example: PERCENTAGE type: string required: - dateRange - normalization - lastUpdated type: object summary_0: properties: FAIL: example: '2' type: string NONE: example: '53' type: string PASS: example: '45' type: string required: - NONE - PASS - FAIL type: object required: - meta - summary_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get DMARC Validations Summary tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/summary/malicious: get: description: Percentage distribution of emails classified as MALICIOUS. operationId: radar-get-email-security-summary-by-malicious parameters: - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: properties: confidenceInfo: properties: annotations: items: properties: dataSource: example: ALL type: string description: example: Cable cut in Tonga type: string endTime: format: date-time type: string eventType: example: OUTAGE type: string isInstantaneous: example: true type: boolean linkedUrl: type: string startTime: format: date-time type: string required: - dataSource - eventType - description - isInstantaneous type: object type: array level: type: integer type: object dateRange: items: properties: endTime: description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' format: date-time type: string startTime: description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' format: date-time type: string required: - startTime - endTime type: object type: array lastUpdated: example: '2023-07-26T08:59:57Z' type: string normalization: example: PERCENTAGE type: string required: - dateRange - normalization - lastUpdated type: object summary_0: properties: MALICIOUS: example: '65' type: string NOT_MALICIOUS: example: '35' type: string required: - MALICIOUS - NOT_MALICIOUS type: object required: - meta - summary_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get MALICIOUS Validations Summary tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/summary/spam: get: description: Proportion of emails categorized as either spam or legitimate (non-spam). operationId: radar-get-email-security-summary-by-spam parameters: - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: properties: confidenceInfo: properties: annotations: items: properties: dataSource: example: ALL type: string description: example: Cable cut in Tonga type: string endTime: format: date-time type: string eventType: example: OUTAGE type: string isInstantaneous: example: true type: boolean linkedUrl: type: string startTime: format: date-time type: string required: - dataSource - eventType - description - isInstantaneous type: object type: array level: type: integer type: object dateRange: items: properties: endTime: description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' format: date-time type: string startTime: description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' format: date-time type: string required: - startTime - endTime type: object type: array lastUpdated: example: '2023-07-26T08:59:57Z' type: string normalization: example: PERCENTAGE type: string required: - dateRange - normalization - lastUpdated type: object summary_0: properties: NOT_SPAM: example: '35' type: string SPAM: example: '65' type: string required: - SPAM - NOT_SPAM type: object required: - meta - summary_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get SPAM Summary tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/summary/spf: get: description: Percentage distribution of emails classified per SPF validation. operationId: radar-get-email-security-summary-by-spf parameters: - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: properties: confidenceInfo: properties: annotations: items: properties: dataSource: example: ALL type: string description: example: Cable cut in Tonga type: string endTime: format: date-time type: string eventType: example: OUTAGE type: string isInstantaneous: example: true type: boolean linkedUrl: type: string startTime: format: date-time type: string required: - dataSource - eventType - description - isInstantaneous type: object type: array level: type: integer type: object dateRange: items: properties: endTime: description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' format: date-time type: string startTime: description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' format: date-time type: string required: - startTime - endTime type: object type: array lastUpdated: example: '2023-07-26T08:59:57Z' type: string normalization: example: PERCENTAGE type: string required: - dateRange - normalization - lastUpdated type: object summary_0: properties: FAIL: example: '2' type: string NONE: example: '53' type: string PASS: example: '45' type: string required: - NONE - PASS - FAIL type: object required: - meta - summary_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get SPF Validations Summary tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/summary/spoof: get: description: Proportion of emails categorized as either spoof or legitimate (non-spoof). operationId: radar-get-email-security-summary-by-spoof parameters: - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: properties: confidenceInfo: properties: annotations: items: properties: dataSource: example: ALL type: string description: example: Cable cut in Tonga type: string endTime: format: date-time type: string eventType: example: OUTAGE type: string isInstantaneous: example: true type: boolean linkedUrl: type: string startTime: format: date-time type: string required: - dataSource - eventType - description - isInstantaneous type: object type: array level: type: integer type: object dateRange: items: properties: endTime: description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' format: date-time type: string startTime: description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' format: date-time type: string required: - startTime - endTime type: object type: array lastUpdated: example: '2023-07-26T08:59:57Z' type: string normalization: example: PERCENTAGE type: string required: - dateRange - normalization - lastUpdated type: object summary_0: properties: NOT_SPOOF: example: '35' type: string SPOOF: example: '65' type: string required: - SPOOF - NOT_SPOOF type: object required: - meta - summary_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get SPOOF Summary tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/summary/threat_category: get: description: Percentage distribution of emails classified in Threat Categories. operationId: radar-get-email-security-summary-by-threat-category parameters: - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: properties: confidenceInfo: properties: annotations: items: properties: dataSource: example: ALL type: string description: example: Cable cut in Tonga type: string endTime: format: date-time type: string eventType: example: OUTAGE type: string isInstantaneous: example: true type: boolean linkedUrl: type: string startTime: format: date-time type: string required: - dataSource - eventType - description - isInstantaneous type: object type: array level: type: integer type: object dateRange: items: properties: endTime: description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' format: date-time type: string startTime: description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' format: date-time type: string required: - startTime - endTime type: object type: array lastUpdated: example: '2023-07-26T08:59:57Z' type: string normalization: example: PERCENTAGE type: string required: - dateRange - normalization - lastUpdated type: object summary_0: properties: BrandImpersonation: example: '35' type: string CredentialHarvester: example: '32' type: string IdentityDeception: example: '47' type: string Link: example: '43' type: string required: - IdentityDeception - Link - BrandImpersonation - CredentialHarvester type: object required: - meta - summary_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get Threat Categories Summary tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/summary/tls_version: get: description: Percentage distribution of emails classified per TLS Version. operationId: radar-get-email-security-summary-by-tls-version parameters: - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: properties: confidenceInfo: properties: annotations: items: properties: dataSource: example: ALL type: string description: example: Cable cut in Tonga type: string endTime: format: date-time type: string eventType: example: OUTAGE type: string isInstantaneous: example: true type: boolean linkedUrl: type: string startTime: format: date-time type: string required: - dataSource - eventType - description - isInstantaneous type: object type: array level: type: integer type: object dateRange: items: properties: endTime: description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' format: date-time type: string startTime: description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' format: date-time type: string required: - startTime - endTime type: object type: array lastUpdated: example: '2023-07-26T08:59:57Z' type: string normalization: example: PERCENTAGE type: string required: - dateRange - normalization - lastUpdated type: object summary_0: properties: TLS 1.0: example: '3' type: string TLS 1.1: example: '12' type: string TLS 1.2: example: '41' type: string TLS 1.3: example: '44' type: string required: - TLS 1.0 - TLS 1.1 - TLS 1.2 - TLS 1.3 type: object required: - meta - summary_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get TLS Version Summary tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/timeseries_groups/arc: get: description: Percentage distribution of emails classified per Arc validation over time. operationId: radar-get-email-security-timeseries-group-by-arc parameters: - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). in: query name: aggInterval schema: description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h type: string - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: type: object serie_0: properties: FAIL: items: example: '2' type: string type: array NONE: items: example: '53' type: string type: array PASS: items: example: '45' type: string type: array required: - NONE - PASS - FAIL type: object required: - meta - serie_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get ARC Validations Time Series tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/timeseries_groups/dkim: get: description: Percentage distribution of emails classified per DKIM validation over time. operationId: radar-get-email-security-timeseries-group-by-dkim parameters: - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). in: query name: aggInterval schema: description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h type: string - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: type: object serie_0: properties: FAIL: items: example: '2' type: string type: array NONE: items: example: '53' type: string type: array PASS: items: example: '45' type: string type: array required: - NONE - PASS - FAIL type: object required: - meta - serie_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get DKIM Validations Time Series tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/timeseries_groups/dmarc: get: description: Percentage distribution of emails classified per DMARC validation over time. operationId: radar-get-email-security-timeseries-group-by-dmarc parameters: - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). in: query name: aggInterval schema: description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h type: string - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: type: object serie_0: properties: FAIL: items: example: '2' type: string type: array NONE: items: example: '53' type: string type: array PASS: items: example: '45' type: string type: array required: - NONE - PASS - FAIL type: object required: - meta - serie_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get DMARC Validations Time Series tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/timeseries_groups/malicious: get: description: Percentage distribution of emails classified as MALICIOUS over time. operationId: radar-get-email-security-timeseries-group-by-malicious parameters: - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). in: query name: aggInterval schema: description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h type: string - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: type: object serie_0: properties: MALICIOUS: items: example: '65' type: string type: array NOT_MALICIOUS: items: example: '35' type: string type: array required: - MALICIOUS - NOT_MALICIOUS type: object required: - meta - serie_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get MALICIOUS Validations Time Series tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/timeseries_groups/spam: get: description: Percentage distribution of emails classified as SPAM over time. operationId: radar-get-email-security-timeseries-group-by-spam parameters: - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). in: query name: aggInterval schema: description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h type: string - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: type: object serie_0: properties: NOT_SPAM: items: example: '35' type: string type: array SPAM: items: example: '65' type: string type: array required: - SPAM - NOT_SPAM type: object required: - meta - serie_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get SPAM Validations Time Series tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/timeseries_groups/spf: get: description: Percentage distribution of emails classified per SPF validation over time. operationId: radar-get-email-security-timeseries-group-by-spf parameters: - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). in: query name: aggInterval schema: description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h type: string - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: type: object serie_0: properties: FAIL: items: example: '2' type: string type: array NONE: items: example: '53' type: string type: array PASS: items: example: '45' type: string type: array required: - NONE - PASS - FAIL type: object required: - meta - serie_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get SPF Validations Time Series tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/timeseries_groups/spoof: get: description: Percentage distribution of emails classified as SPOOF over time. operationId: radar-get-email-security-timeseries-group-by-spoof parameters: - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). in: query name: aggInterval schema: description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h type: string - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: type: object serie_0: properties: NOT_SPOOF: items: example: '35' type: string type: array SPOOF: items: example: '65' type: string type: array required: - SPOOF - NOT_SPOOF type: object required: - meta - serie_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get SPOOF Validations Time Series tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/timeseries_groups/threat_category: get: description: Percentage distribution of emails classified in Threat Categories over time. operationId: radar-get-email-security-timeseries-group-by-threat-category parameters: - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). in: query name: aggInterval schema: description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h type: string - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: type: object serie_0: properties: BrandImpersonation: items: example: '35' type: string type: array CredentialHarvester: items: example: '32' type: string type: array IdentityDeception: items: example: '47' type: string type: array Link: items: example: '43' type: string type: array required: - IdentityDeception - Link - BrandImpersonation - CredentialHarvester type: object required: - meta - serie_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get Threat Categories Time Series tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/timeseries_groups/tls_version: get: description: Percentage distribution of emails classified per TLS Version over time. operationId: radar-get-email-security-timeseries-group-by-tls-version parameters: - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). in: query name: aggInterval schema: description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h type: string - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: type: object serie_0: properties: TLS 1.0: items: example: '3' type: string type: array TLS 1.1: items: example: '12' type: string type: array TLS 1.2: items: example: '41' type: string type: array TLS 1.3: items: example: '44' type: string type: array required: - TLS 1.0 - TLS 1.1 - TLS 1.2 - TLS 1.3 type: object required: - meta - serie_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get TLS Version Time Series tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/top/tlds: get: description: Get the top TLDs by email messages. Values are a percentage out of the total emails. operationId: radar-get-email-security-top-tlds-by-messages parameters: - description: Limit the number of objects in the response. in: query name: limit schema: description: Limit the number of objects in the response. example: 5 type: integer - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Filter for TLDs by category. in: query name: tldCategory schema: description: Filter for TLDs by category. enum: - CLASSIC - COUNTRY example: CLASSIC type: string - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: properties: confidenceInfo: properties: annotations: items: properties: dataSource: example: ALL type: string description: example: Cable cut in Tonga type: string endTime: format: date-time type: string eventType: example: OUTAGE type: string isInstantaneous: example: true type: boolean linkedUrl: type: string startTime: format: date-time type: string required: - dataSource - eventType - description - isInstantaneous type: object type: array level: type: integer type: object dateRange: items: properties: endTime: description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' format: date-time type: string startTime: description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' format: date-time type: string required: - startTime - endTime type: object type: array lastUpdated: example: '2023-07-26T08:59:57Z' type: string required: - dateRange - lastUpdated type: object top_0: items: properties: name: example: com. type: string value: example: '65' type: string required: - name - value type: object type: array required: - meta - top_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '404': content: application/json: schema: properties: error: example: Not Found type: string required: - error type: object description: Not found security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get Top TLDs By Email Messages tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/top/tlds/malicious/{malicious}: get: description: Get the TLDs by emails classified as malicious or not. operationId: radar-get-email-security-top-tlds-by-malicious parameters: - description: Malicious. in: path name: malicious required: true schema: description: Malicious. enum: - MALICIOUS - NOT_MALICIOUS example: MALICIOUS type: string - description: Limit the number of objects in the response. in: query name: limit schema: description: Limit the number of objects in the response. example: 5 type: integer - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Filter for TLDs by category. in: query name: tldCategory schema: description: Filter for TLDs by category. enum: - CLASSIC - COUNTRY example: CLASSIC type: string - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: properties: confidenceInfo: properties: annotations: items: properties: dataSource: example: ALL type: string description: example: Cable cut in Tonga type: string endTime: format: date-time type: string eventType: example: OUTAGE type: string isInstantaneous: example: true type: boolean linkedUrl: type: string startTime: format: date-time type: string required: - dataSource - eventType - description - isInstantaneous type: object type: array level: type: integer type: object dateRange: items: properties: endTime: description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' format: date-time type: string startTime: description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' format: date-time type: string required: - startTime - endTime type: object type: array lastUpdated: example: '2023-07-26T08:59:57Z' type: string required: - dateRange - lastUpdated type: object top_0: items: properties: name: example: com. type: string value: example: '65' type: string required: - name - value type: object type: array required: - meta - top_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '404': content: application/json: schema: properties: error: example: Not Found type: string required: - error type: object description: Not found security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get Top TLDs By Malicious Classification tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/top/tlds/spam/{spam}: get: description: Get the top TLDs by emails classified as Spam or not. operationId: radar-get-email-security-top-tlds-by-spam parameters: - description: Spam. in: path name: spam required: true schema: description: Spam. enum: - SPAM - NOT_SPAM example: SPAM type: string - description: Limit the number of objects in the response. in: query name: limit schema: description: Limit the number of objects in the response. example: 5 type: integer - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Filter for TLDs by category. in: query name: tldCategory schema: description: Filter for TLDs by category. enum: - CLASSIC - COUNTRY example: CLASSIC type: string - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: properties: confidenceInfo: properties: annotations: items: properties: dataSource: example: ALL type: string description: example: Cable cut in Tonga type: string endTime: format: date-time type: string eventType: example: OUTAGE type: string isInstantaneous: example: true type: boolean linkedUrl: type: string startTime: format: date-time type: string required: - dataSource - eventType - description - isInstantaneous type: object type: array level: type: integer type: object dateRange: items: properties: endTime: description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' format: date-time type: string startTime: description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' format: date-time type: string required: - startTime - endTime type: object type: array lastUpdated: example: '2023-07-26T08:59:57Z' type: string required: - dateRange - lastUpdated type: object top_0: items: properties: name: example: com. type: string value: example: '65' type: string required: - name - value type: object type: array required: - meta - top_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '404': content: application/json: schema: properties: error: example: Not Found type: string required: - error type: object description: Not found security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get Top TLDs By Spam Classification tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true /radar/email/security/top/tlds/spoof/{spoof}: get: description: Get the TLDs by emails classified as spoof or not. operationId: radar-get-email-security-top-tlds-by-spoof parameters: - description: Spoof. in: path name: spoof required: true schema: description: Spoof. enum: - SPOOF - NOT_SPOOF example: SPOOF type: string - description: Limit the number of objects in the response. in: query name: limit schema: description: Limit the number of objects in the response. example: 5 type: integer - description: Array of names that will be used to name the series in responses. in: query name: name schema: description: Array of names that will be used to name the series in responses. example: main_series items: type: string type: array - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). in: query name: dateRange schema: description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). example: 7d items: example: 7d pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$ type: string type: array - description: Array of datetimes to filter the start of a series. in: query name: dateStart schema: description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: End of the date range (inclusive). in: query name: dateEnd schema: description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: format: date-time type: string type: array - description: Filter for arc (Authenticated Received Chain). in: query name: arc schema: description: Filter for arc (Authenticated Received Chain). example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dkim. in: query name: dkim schema: description: Filter for dkim. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for dmarc. in: query name: dmarc schema: description: Filter for dmarc. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for spf. in: query name: spf schema: description: Filter for spf. example: PASS items: enum: - PASS - NONE - FAIL type: string type: array - description: Filter for tls version. in: query name: tlsVersion schema: description: Filter for tls version. example: TLSv1_2 items: enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 type: string type: array - description: Filter for TLDs by category. in: query name: tldCategory schema: description: Filter for TLDs by category. enum: - CLASSIC - COUNTRY example: CLASSIC type: string - description: Format results are returned in. in: query name: format schema: description: Format results are returned in. enum: - JSON - CSV example: json type: string responses: '200': content: application/json: schema: properties: result: properties: meta: properties: confidenceInfo: properties: annotations: items: properties: dataSource: example: ALL type: string description: example: Cable cut in Tonga type: string endTime: format: date-time type: string eventType: example: OUTAGE type: string isInstantaneous: example: true type: boolean linkedUrl: type: string startTime: format: date-time type: string required: - dataSource - eventType - description - isInstantaneous type: object type: array level: type: integer type: object dateRange: items: properties: endTime: description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' format: date-time type: string startTime: description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' format: date-time type: string required: - startTime - endTime type: object type: array lastUpdated: example: '2023-07-26T08:59:57Z' type: string required: - dateRange - lastUpdated type: object top_0: items: properties: name: example: com. type: string value: example: '65' type: string required: - name - value type: object type: array required: - meta - top_0 type: object success: example: true type: boolean required: - result - success type: object description: Successful Response '404': content: application/json: schema: properties: error: example: Not Found type: string required: - error type: object description: Not found security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Get Top TLDs By Spoof Classification tags: - Radar Email Security x-cfPermissionsRequired: enum: - com.cloudflare.api.user.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true components: securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true