# Post Quantum

# Origin

## Get Origin Post-Quantum Data Summary

`radar.post_quantum.origin.summary(Literal["KEY_AGREEMENT"]dimension, OriginSummaryParams**kwargs)  -> OriginSummaryResponse`

**get** `/radar/post_quantum/origin/summary/{dimension}`

Returns a summary of origin post-quantum data grouped by the specified dimension.

### Parameters

- `dimension: Literal["KEY_AGREEMENT"]`

  Specifies the origin post-quantum data dimension by which to group the results.

  - `"KEY_AGREEMENT"`

- `date_end: Optional[Sequence[Union[str, datetime]]]`

  End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.

- `date_range: Optional[Sequence[str]]`

  Filters results by relative date range ending at the current time, with each value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`). Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `7dcontrol` covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass `7d` and `7dcontrol` to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including `control`) satisfy this automatically. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).

- `date_start: Optional[Sequence[Union[str, datetime]]]`

  Start of the date range. Alternative to `dateRange`; provide together with `dateEnd`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.

- `format: Optional[Literal["JSON", "CSV"]]`

  Format in which results will be returned.

  - `"JSON"`

  - `"CSV"`

- `name: Optional[Sequence[str]]`

  Array of names used to label the series in the response.

### Returns

- `class OriginSummaryResponse: …`

  - `meta: Meta`

    Metadata for the results.

    - `confidence_info: MetaConfidenceInfo`

      - `annotations: List[MetaConfidenceInfoAnnotation]`

        - `data_source: Literal["ALL", "AI_BOTS", "AI_GATEWAY", 22 more]`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: str`

        - `end_date: datetime`

        - `event_type: Literal["EVENT", "GENERAL", "OUTAGE", 3 more]`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `is_instantaneous: bool`

          Whether event is a single point in time or a time range.

        - `linked_url: str`

        - `start_date: datetime`

        - `tags: Optional[List[str]]`

      - `level: int`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `date_range: List[MetaDateRange]`

      - `end_time: datetime`

        Adjusted end of date range.

      - `start_time: datetime`

        Adjusted start of date range.

    - `last_updated: datetime`

      Timestamp of the last dataset update.

    - `normalization: Literal["PERCENTAGE", "MIN0_MAX", "MIN_MAX", 5 more]`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: List[MetaUnit]`

      Measurement units for the results.

      - `name: str`

      - `value: str`

  - `summary_0: Dict[str, str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.radar.post_quantum.origin.summary(
    dimension="KEY_AGREEMENT",
)
print(response.meta)
```

#### Response

```json
{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "isInstantaneous": true,
            "linkedUrl": "https://example.com",
            "startDate": "2019-12-27T18:11:19.117Z",
            "tags": [
              "BOT_CLASS"
            ]
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z",
      "normalization": "PERCENTAGE",
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "summary_0": {
      "CurveP256": "99.1234",
      "CurveP384": "85.5678",
      "CurveP521": "45.9012",
      "X25519": "98.3456",
      "X25519MLKEM768": "12.7890"
    }
  },
  "success": true
}
```

## Get Origin Post-Quantum Data Over Time

`radar.post_quantum.origin.timeseries_groups(Literal["KEY_AGREEMENT"]dimension, OriginTimeseriesGroupsParams**kwargs)  -> OriginTimeseriesGroupsResponse`

**get** `/radar/post_quantum/origin/timeseries_groups/{dimension}`

Returns a timeseries of origin post-quantum data grouped by the specified dimension.

### Parameters

- `dimension: Literal["KEY_AGREEMENT"]`

  Specifies the origin post-quantum data dimension by which to group the results.

  - `"KEY_AGREEMENT"`

- `date_end: Optional[Sequence[Union[str, datetime]]]`

  End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.

- `date_range: Optional[Sequence[str]]`

  Filters results by relative date range ending at the current time, with each value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`). Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window's length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `7dcontrol` covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass `7d` and `7dcontrol` to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including `control`) satisfy this automatically. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).

- `date_start: Optional[Sequence[Union[str, datetime]]]`

  Start of the date range. Alternative to `dateRange`; provide together with `dateEnd`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.

- `format: Optional[Literal["JSON", "CSV"]]`

  Format in which results will be returned.

  - `"JSON"`

  - `"CSV"`

- `name: Optional[Sequence[str]]`

  Array of names used to label the series in the response.

### Returns

- `class OriginTimeseriesGroupsResponse: …`

  - `meta: Meta`

    Metadata for the results.

    - `agg_interval: Literal["FIFTEEN_MINUTES", "ONE_HOUR", "ONE_DAY", 2 more]`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidence_info: MetaConfidenceInfo`

      - `annotations: List[MetaConfidenceInfoAnnotation]`

        - `data_source: Literal["ALL", "AI_BOTS", "AI_GATEWAY", 22 more]`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: str`

        - `end_date: datetime`

        - `event_type: Literal["EVENT", "GENERAL", "OUTAGE", 3 more]`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `is_instantaneous: bool`

          Whether event is a single point in time or a time range.

        - `linked_url: str`

        - `start_date: datetime`

        - `tags: Optional[List[str]]`

      - `level: int`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `date_range: List[MetaDateRange]`

      - `end_time: datetime`

        Adjusted end of date range.

      - `start_time: datetime`

        Adjusted start of date range.

    - `last_updated: datetime`

      Timestamp of the last dataset update.

    - `normalization: Literal["PERCENTAGE", "MIN0_MAX", "MIN_MAX", 5 more]`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: List[MetaUnit]`

      Measurement units for the results.

      - `name: str`

      - `value: str`

  - `serie_0: Serie0`

    - `timestamps: List[datetime]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.radar.post_quantum.origin.timeseries_groups(
    dimension="KEY_AGREEMENT",
)
print(response.meta)
```

#### Response

```json
{
  "result": {
    "meta": {
      "aggInterval": "FIFTEEN_MINUTES",
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "isInstantaneous": true,
            "linkedUrl": "https://example.com",
            "startDate": "2019-12-27T18:11:19.117Z",
            "tags": [
              "BOT_CLASS"
            ]
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z",
      "normalization": "PERCENTAGE",
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "serie_0": {
      "timestamps": [
        "2023-08-08T10:15:00Z"
      ]
    }
  },
  "success": true
}
```

## Domain Types

### Origin Summary Response

- `class OriginSummaryResponse: …`

  - `meta: Meta`

    Metadata for the results.

    - `confidence_info: MetaConfidenceInfo`

      - `annotations: List[MetaConfidenceInfoAnnotation]`

        - `data_source: Literal["ALL", "AI_BOTS", "AI_GATEWAY", 22 more]`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: str`

        - `end_date: datetime`

        - `event_type: Literal["EVENT", "GENERAL", "OUTAGE", 3 more]`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `is_instantaneous: bool`

          Whether event is a single point in time or a time range.

        - `linked_url: str`

        - `start_date: datetime`

        - `tags: Optional[List[str]]`

      - `level: int`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `date_range: List[MetaDateRange]`

      - `end_time: datetime`

        Adjusted end of date range.

      - `start_time: datetime`

        Adjusted start of date range.

    - `last_updated: datetime`

      Timestamp of the last dataset update.

    - `normalization: Literal["PERCENTAGE", "MIN0_MAX", "MIN_MAX", 5 more]`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: List[MetaUnit]`

      Measurement units for the results.

      - `name: str`

      - `value: str`

  - `summary_0: Dict[str, str]`

### Origin Timeseries Groups Response

- `class OriginTimeseriesGroupsResponse: …`

  - `meta: Meta`

    Metadata for the results.

    - `agg_interval: Literal["FIFTEEN_MINUTES", "ONE_HOUR", "ONE_DAY", 2 more]`

      Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://edgetunnel-b2h.pages.dev/radar/concepts/aggregation-intervals/).

      - `"FIFTEEN_MINUTES"`

      - `"ONE_HOUR"`

      - `"ONE_DAY"`

      - `"ONE_WEEK"`

      - `"ONE_MONTH"`

    - `confidence_info: MetaConfidenceInfo`

      - `annotations: List[MetaConfidenceInfoAnnotation]`

        - `data_source: Literal["ALL", "AI_BOTS", "AI_GATEWAY", 22 more]`

          Data source for annotations.

          - `"ALL"`

          - `"AI_BOTS"`

          - `"AI_GATEWAY"`

          - `"BGP"`

          - `"BOTS"`

          - `"CONNECTION_ANOMALY"`

          - `"CT"`

          - `"DNS"`

          - `"DNS_MAGNITUDE"`

          - `"DNS_AS112"`

          - `"DOS"`

          - `"EMAIL_ROUTING"`

          - `"EMAIL_SECURITY"`

          - `"FW"`

          - `"FW_PG"`

          - `"HTTP"`

          - `"HTTP_CONTROL"`

          - `"HTTP_CRAWLER_REFERER"`

          - `"HTTP_ORIGINS"`

          - `"IQI"`

          - `"LEAKED_CREDENTIALS"`

          - `"NET"`

          - `"ROBOTS_TXT"`

          - `"SPEED"`

          - `"WORKERS_AI"`

        - `description: str`

        - `end_date: datetime`

        - `event_type: Literal["EVENT", "GENERAL", "OUTAGE", 3 more]`

          Event type for annotations.

          - `"EVENT"`

          - `"GENERAL"`

          - `"OUTAGE"`

          - `"PARTIAL_PROJECTION"`

          - `"PIPELINE"`

          - `"TRAFFIC_ANOMALY"`

        - `is_instantaneous: bool`

          Whether event is a single point in time or a time range.

        - `linked_url: str`

        - `start_date: datetime`

        - `tags: Optional[List[str]]`

      - `level: int`

        Provides an indication of how much confidence Cloudflare has in the data.

    - `date_range: List[MetaDateRange]`

      - `end_time: datetime`

        Adjusted end of date range.

      - `start_time: datetime`

        Adjusted start of date range.

    - `last_updated: datetime`

      Timestamp of the last dataset update.

    - `normalization: Literal["PERCENTAGE", "MIN0_MAX", "MIN_MAX", 5 more]`

      Normalization method applied to the results. Refer to [Normalization methods](https://edgetunnel-b2h.pages.dev/radar/concepts/normalization/).

      - `"PERCENTAGE"`

      - `"MIN0_MAX"`

      - `"MIN_MAX"`

      - `"RAW_VALUES"`

      - `"PERCENTAGE_CHANGE"`

      - `"ROLLING_AVERAGE"`

      - `"OVERLAPPED_PERCENTAGE"`

      - `"RATIO"`

    - `units: List[MetaUnit]`

      Measurement units for the results.

      - `name: str`

      - `value: str`

  - `serie_0: Serie0`

    - `timestamps: List[datetime]`

# TLS

## Check Post-Quantum TLS support

`radar.post_quantum.tls.support(TLSSupportParams**kwargs)  -> TLSSupportResponse`

**get** `/radar/post_quantum/tls/support`

Tests whether a hostname or IP address supports Post-Quantum (PQ) TLS key exchange. Returns information about the negotiated key exchange algorithm, whether it uses PQ cryptography, and any detected TLS implementation bugs (Split ClientHello, HRR failure, etc.).

### Parameters

- `host: str`

  Hostname or IP address to test for Post-Quantum TLS support, optionally with port (defaults to 443).

### Returns

- `class TLSSupportResponse: …`

  - `bugs: Bugs`

    - `hrr_failure: bool`

      Server sends a HelloRetryRequest but fails to complete the handshake after the client sends the second ClientHello. Often caused by non-compliant TLS 1.3 implementations on shared hosting providers.

    - `split_client_hello: bool`

      Server rejects fragmented ClientHello caused by large PQ keyshare, but accepts classical (non-PQ) handshakes. Typically caused by middleboxes or firewalls that cannot reassemble split TLS ClientHello messages.

    - `unknown_keyshare: bool`

      Server cannot handle an unknown key exchange algorithm in the ClientHello keyshare extension. Compliant servers should respond with HelloRetryRequest for a supported algorithm.

  - `host: str`

    The host that was tested

  - `kex: float`

    TLS CurveID of the negotiated key exchange

  - `kex_name: str`

    Human-readable name of the key exchange algorithm

  - `pq: bool`

    Whether the negotiated key exchange uses Post-Quantum cryptography (specifically X25519MLKEM768)

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.radar.post_quantum.tls.support(
    host="cloudflare.com",
)
print(response.bugs)
```

#### Response

```json
{
  "result": {
    "bugs": {
      "hrrFailure": true,
      "splitClientHello": true,
      "unknownKeyshare": true
    },
    "host": "host",
    "kex": 0,
    "kexName": "kexName",
    "pq": true
  },
  "success": true
}
```

## Domain Types

### TLS Support Response

- `class TLSSupportResponse: …`

  - `bugs: Bugs`

    - `hrr_failure: bool`

      Server sends a HelloRetryRequest but fails to complete the handshake after the client sends the second ClientHello. Often caused by non-compliant TLS 1.3 implementations on shared hosting providers.

    - `split_client_hello: bool`

      Server rejects fragmented ClientHello caused by large PQ keyshare, but accepts classical (non-PQ) handshakes. Typically caused by middleboxes or firewalls that cannot reassemble split TLS ClientHello messages.

    - `unknown_keyshare: bool`

      Server cannot handle an unknown key exchange algorithm in the ClientHello keyshare extension. Compliant servers should respond with HelloRetryRequest for a supported algorithm.

  - `host: str`

    The host that was tested

  - `kex: float`

    TLS CurveID of the negotiated key exchange

  - `kex_name: str`

    Human-readable name of the key exchange algorithm

  - `pq: bool`

    Whether the negotiated key exchange uses Post-Quantum cryptography (specifically X25519MLKEM768)