As of December 31st, 2023 ThreadFix 2.X has reached End of Life and is no longer supported. For any further information please contact the Success and Implementation team.

List Scheduled Email Reports - API

/rest/{version}/scheduledEmailReport/list


Descriptor

Value

HTTP Method

GET

Description

Retrieves all scheduled email reports.

Required Permission

Manage Email Reports (Global level)

Version Introduced2.7.4


Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

A value of ‘application/json’ must be provided.


Sample Call:


curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/scheduledEmailReport/list


Sample Output:


{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": [
        {
            "id": 15,
            "hour": 0,
            "minute": 0,
            "period": "",
            "day": "",
            "frequency": "",
            "scheduleType": "CRON",
            "cronExpression": "0 6 * * ?",
            "severityLevel": {
                "id": 1,
                "name": "High",
                "intValue": 4,
                "displayName": "High"
            },
            "emailLists": [
                {
                    "id": 1,
                    "name": "List",
                    "emailAddresses": [
                        "asdf@domain.com"
                    ]
                }
            ],
            "emailAddresses": [
                "test@domain.com",
                "test2@domain.com"
            ],
            "organizations": [
                {
                    "id": 1,
                    "name": "Team"
                },
                {
                    "id": 2,
                    "name": "Extra"
                }
            ],
            "scheduledDate": "at 06:00",
            "cronTranslation": "at 06:00"
        }
    ]
}

www.threadfix.it | www.coalfire.com
Copyright © 2024 Coalfire. All rights reserved.

This Information Security Policy is CoalFire - Public: Distribution of this material is not limited.