Initiate Media ZIP Packaging

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

Initiates ZIP packaging for the specified media at the given remote office. Returns a status response indicating the packaging progress. Poll this endpoint until zipStatus is COMPLETED, then call the Download Media API to retrieve the packaged media bundle.

Request URL

https://{server-hostname}:8383/emsapi/osdeployer/media/{mediaId}/createZipFile

Scope

OSDMedia.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/mediaZipCreationStatus.v1+jsonapplication/mediaZipCreationStatus.v1+jsonCopied!
Content-TypestringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

mediaIdstringMandatory

ID of OS deployer Media zip Creation.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/emsapi/osdeployer/media/{mediaId}/createZipFile \
  --header 'Accept: application/mediaZipCreationStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json'

Response Parameters

- HTTP code 200

Response Body - application/mediaZipFileStatus.v1+json
JSON Object
Hide Sub-Attributes
isZipCreationInitiatedboolean

True if the ZIP packaging process was successfully started; false if it could not be initiated.

mediaStatusinteger

Current media status code. Present only when creating a ZIP for a remote office (value 14 = creating ZIP for remote office). Absent for primary office requests.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

ZIP packaging started for a remote office; mediaStatus 14 indicates ZIP creation in progress

Copied!
  {
    "isZipCreationInitiated": true,
    "mediaStatus": 14
  }
                
Show full

ZIP packaging started for the primary office; mediaStatus is absent for local office

Copied!
  {
    "isZipCreationInitiated": true
  }
                
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.