Store the cluster's scheduled security report (browser session)

Creates or replaces the cluster’s scheduled security report: frequency (weekly or monthly), up to 20 email recipients, and enabled (default true, which needs at least one recipient). Requires clusters.write and returns the stored schedule.

PUT /org/clusters/imported/{cluster_id}/security/report-schedule

Store the cluster's scheduled security report (browser session)

Python

import requests

url = "https://api.platform.ankra.app/org/clusters/imported/{cluster_id}/security/report-schedule"

payload = {}
headers = {
    "cookie": "ankra_session=",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

200

{
  "configured": true,
  "schedule": {
    "frequency": "weekly",
    "recipients": [
      "<string>"
    ],
    "enabled": true,
    "last_sent_at": "2023-11-07T05:31:56Z",
    "next_due_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

ankra_session · string · cookie · required

Browser session. Mutations also require X-Ankra-CSRF.

Path Parameters

cluster_id · string<uuid> · required

Body

application/json

frequency · enum<string> · required

Available options: weekly, monthly

recipients · string[]

Email addresses, at most 20; at least one when enabled.

Maximum array length: 20

enabled · boolean · default: true

Response

200

application/json

The stored schedule after the write.

configured · boolean · required

schedule · object | null · required

Show child attributes