- URL:
- https://<root>/logs/errorreports
- Methods:
GET- Operations:
- Find Error Report IDs
- Child Resources:
- Error Report
- Version Introduced:
- 11.5
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The errorreports resource returns a list of all error (crash) reports generated for GIS services. The response for this operation includes the service name, type, ID, and folder location of the service which generated the report, as well as the error report file name and the size of the error report.
The number of reports that can be stored at a given time is determined by the max value, returned by the Log Settings resource. This value can be updated using the Edit Log Settings operation. By default, a maximum of 10 reports can be stored. Once the maximum number of error reports has been exceeded, the oldest error report is deleted to allow for the newest generated report to be stored.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the errorreports resource:
https://organization.example.com/<context>/admin/logs/errorreports?f=pjsonJSON Response syntax
{
"errorReports": [
{
"serviceType": "<service type>",
"errorReportId": "<error report ID>",
"folderName": "<service folder name, left empty if service is on root folder>",
"serviceId": "<service ID>",
"serviceName": "<service name>",
"errorReportFilename": "<error report .zip file name>",
"sizeBytes": <report size>
}
]
}JSON Response example
{
"errorReports": [
{
"serviceType": "MapServer",
"errorReportId": "b7ead586-35b9-43a7-9c08-d16dcc8e802f",
"folderName": "",
"serviceId": "seey886y53xggiov0trdg",
"serviceName": "SampleWorldCities",
"errorReportFilename": "SampleWorldCities_MapServer_20250516_180551_616.ldmp.zip",
"sizeBytes": 15543
},
{
"serviceType": "MapServer",
"errorReportId": "a48a550b-bd21-4643-b0e6-87b8ceff2a15",
"folderName": "Maintenance",
"serviceId": "sr0bx399h6064r6gkk9a4",
"serviceName": "FirePerimeterChecks",
"errorReportFilename": "FirePerimeterChecks_MapServer_20250516_180550_608.ldmp.zip",
"sizeBytes": 15584
}
]
}