Check Boot Media Availability

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

Indicates whether media creation has been attempted, is in progress, or has completed successfully or with a failure.

Request URL

https://{serverurl}/emsapi/osdeployer/media/status

Scope

DesktopCentralCloud.OSDMedia.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/mediaStatus.v1+jsonapplication/mediaStatus.v1+jsonCopied!

- Query Parameters

mediaTypestringOptional

The media type (USB, ISO, or PXE) indicates the specific type with the version being checked. This parameter can be omitted if the response covers all media types.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/emsapi/osdeployer/media/status \
  --header 'Accept: application/mediaStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/mediaStatus.v1+json
JSON Object
Hide Sub-Attributes
isMediaCreatedSuccessfullyboolean

true if at least one bootable media has been created successfully for this customer (scoped to mediaType if supplied).

isMediaCreationInProgressboolean

true if a media-creation job is currently running for this customer.

isMediaCreationFailedboolean

true if the most recent media-creation attempt ended in failure.

isMediaCreationTriedboolean

true if media creation has been attempted at least once; false if no attempt has ever been made.

mediaStatusinteger

Current media lock/operation state: 0 = FREE, 1 = CREATION, 2 = MODIFICATION, 3 = COPY, 4 = UPDATING.

isBSODDriverEnabledboolean

true if BSOD driver injection is enabled for this customer via the OSD customer parameter ENABLE_BSOD_DRIVERS.

isDSMediaCreationEnabledboolean

true if DS (Distributed Server) media creation is enabled for this customer.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Media has been created and is ready; no operation is in progress

Copied!
  {
    "isMediaCreationFailed": false,
    "isMediaCreationTried": true,
    "isDSMediaCreationEnabled": true,
    "isBSODDriverEnabled": false,
    "isMediaCreationInProgress": false,
    "mediaStatus": 0,
    "isMediaCreatedSuccessfully": true
  }
                
Show full

Media creation is currently running

Copied!
  {
    "isMediaCreationFailed": false,
    "isMediaCreationTried": true,
    "isDSMediaCreationEnabled": true,
    "isBSODDriverEnabled": false,
    "isMediaCreationInProgress": true,
    "mediaStatus": 1,
    "isMediaCreatedSuccessfully": false
  }
                
Show full

The last media-creation attempt failed

Copied!
  {
    "isMediaCreationFailed": true,
    "isMediaCreationTried": true,
    "isDSMediaCreationEnabled": true,
    "isBSODDriverEnabled": false,
    "isMediaCreationInProgress": false,
    "mediaStatus": 0,
    "isMediaCreatedSuccessfully": false
  }
                
Show full

Duration: 1 minute | Threshold: 50 | 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.