Retrieve the current processing status of a previously uploaded file

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns the processing status and metadata for a file identified by its file_id. Use this to verify whether a file upload has completed before referencing it in other API calls.

Request URL

https://{serverurl}/api/v1/mdm/files/{file_id}/status

Scope

MDMOnDemand.MDMDeviceMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Path Parameters

file_idlongMandatory

Unique identifier of the uploaded file. Obtain this from the response of Upload a File to MDM or Upload a File Using Module Configuration

- Query Parameters

delta-tokenstringOptional

Token used for delta/incremental fetches. Pass the token returned from a previous response to retrieve only items modified since that point

skip-tokenstringOptional

Pagination continuation token returned by a previous response. Pass it to fetch the next page of results

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/files/{file_id}/status \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object
Hide Sub-Attributes
statusstring

Current processing status of the file. Possible values: PENDING (queued for processing), PROCESSING (upload in progress), COMPLETED (file ready for use), FAILED (upload or processing failed)

file_idlong

Unique identifier of the uploaded file

file_namestring

Name of the uploaded file including its extension

content_typestring

MIME type of the uploaded file. Common values: application/vnd.android.package-archive (apk), application/x-itunes-ipa (ipa), application/zip (appxbundle, xap, appx, msix), application/x-ms-installer (msi)

content_lengthstring

Length of the uploaded file in bytes

expiry_timelong

Unix timestamp (in milliseconds) until when the uploaded file is valid

created_timelong

Unix timestamp (in milliseconds) when the file was originally uploaded

Possible HTTP Status Codes

200HTTP code

Sample Response: HTTP 200

File processing completed and ready for use

Copied!
  {
    "created_time": 1735603200000,
    "content_type": "application/vnd.android.package-archive",
    "file_name": "zylker-app.apk",
    "file_id": 9007199254741076,
    "expiry_time": 15987913528,
    "content_length": 2048576,
    "status": "COMPLETED"
  }
                
Show full

File is queued and waiting to be processed

Copied!
  {
    "created_time": 1735603200000,
    "content_type": "application/x-ms-installer",
    "file_name": "large-installer.msi",
    "file_id": 9007199254741078,
    "expiry_time": 15987913528,
    "content_length": 52428800,
    "status": "PENDING"
  }
                
Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.