Skip to main content

Delete Multimedia

This endpoint allows you to permanently delete a multimedia item from the system. Once deleted, the multimedia content and all associated metadata will no longer be accessible.

πŸ”Ή Endpoint Details​

DELETE /api/v1/multimedia/{multimediaId}

πŸ”’ Authentication​

HeaderRequiredDescription
Content-TypeYesMust be application/json
AuthorizationYesFormat: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

πŸ“ Path Parameters​

ParameterTypeRequiredDescription
multimediaIdstring (UUID)YesUnique identifier of the multimedia to delete

🧩 Request Example​

curl -X DELETE "https://openapi.onlive.site/api/v1/multimedia/7a1c8d4b-3f2e-5697-9a8b-106c4d8e7f9a" \
-H "Content-Type: application/json" \
-H "Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature"

πŸ“€ Response Format​

Success Response (200 OK)​

{
"id": "string",
"organizationId": "string",
"name": "string",
"app": {
"type": "string",
"source": {
"url": "string",
"security": "string"
},
"resource": "string",
"args": "string"
},
"url": "string",
"format": "string",
"description": "string",
"size": 0,
"duration": 0,
"status": "string",
"environment": {},
"coverVideo": {
"id": "string",
"url": "string",
"size": 0,
"format": "string",
"duration": 0
},
"options": {
"usePixelStreaming": true,
"timeout": 0,
"showBooking": true,
"showRegister": true
}
}

❌ Error Responses​

403 Forbidden​

{
"statusCode": 403,
"message": "Insufficient permissions to delete this multimedia content"
}

404 Not Found​

{
"statusCode": 404,
"message": "Multimedia with ID '7a1c8d4b-3f2e-5697-9a8b-106c4d8e7f9a' not found"
}

409 Conflict​

{
"statusCode": 409,
"message": "Cannot delete multimedia that is currently in use by other resources"
}

πŸ“˜ Notes​

  • Deletion is permanent and cannot be undone
  • The system returns the complete details of the deleted multimedia content in the response
  • Associated resources like cover videos are also deleted
  • Content URLs may continue to be accessible for a short time due to CDN caching
  • Active sessions using the multimedia will not be affected immediately
  • Deletion confirmation is not required through the API

πŸ’‘ Best Practices​

  1. Pre-Deletion Checks

    • Verify that the content is not referenced elsewhere in your application
    • Create backups of important content before deletion
    • Consider soft deletion through status changes for recoverable content
  2. Resource Management

    • Clean up associated resources that might not be automatically deleted
    • Update any references to the deleted content in your application
    • Monitor storage usage before and after bulk deletions
  3. User Experience

    • Provide clear feedback to users about deletion success
    • Implement confirmation flows in your application interface