Skip to content
URL:
https://<root>/system/upgrades/history/exports/<requestID>
Methods:
POST
Version Introduced:
11.1

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 generateToken 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.


Learn how to generate a token

Description

This operation uploads to the deployment the curated warnings and events for a particular upgrade or update, which can then be downloaded and used to troubleshoot any failures or errors that occurred during the upgrade.

Request parameters

ParameterDetails

datatype

Specifies the information included in the exported upgrade data. This parameter only supports one value.

Values: warningsEvents

Example usage

The following is a sample POST request for the export operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /<context>/admin/system/upgrades/history/exports/64426e0b-1089-4500-863e-2dc58ddbdc35 HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

datatype=warningsEvents&token=aOjrLVEnRpuwfgK-G-PGdyWUQhpJDlGVAt70Z3vrHd1mihME8yx8E1EgRCoIpl3mLm2DSDVjFVbyFeQVD_Sp6DrXAIrwED7NYmMTF_GkLurVWAe-MBROTxqu5781_8qj5S_3tqoINj6OmjG8zfeztCKTUCbV-xrsNp5-50g2-UCX62H_qT0r1fIgqh_KFsFF9f3cC9kzWum47eRH9PmmZHdKGN3XjY3GghswTGCELNJbEQ_q84sz8zYE5q6jx8Cl

Accessing the export data

Once the export request is submitted, the page will redirect to an asynchronous job resource. To download the export information, navigate to the uploaded item in the Enterprise Admin directory or use the URL returned in the job's details to directly access the uploaded item.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "result": {"URL": "https://organization.example.com/<context>/admin/uploads/5d3ee06f-2f77-45fd-bf2d-1459fc2b1e31"},
  "updatedtime": 1681770556182,
  "jobid": "ja2570377-d41a-48c5-b7c7-4b2f7d31ab9b",
  "resource": {"name": "Upgrade warnings and events"},
  "requestID": "2a31cb79-1738-4288-ade1-4d72cc911798",
  "name": "exportUpgradeEventsAndWarnings",
  "endtime": 1681770556186,
  "starttime": 1681770555920,
  "operationURI": "/arcgis/admin/system/upgrades/history/exports/17e97078-3cd6-465a-997f-aa9cac33d7e7",
  "status": "COMPLETED",
  "username": "administrator"
}

Choosing to download the upgrade data will download a .zip folder containing the warning and event information from the upgrade.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.