Delete Preset

This endpoint allows you to delete an existing preset from the system. This operation is permanent and cannot be undone.

🔹 Endpoint Details

DELETE /api/v1/presets/{presetId}

🔒 Authentication

Header	Required	Description
Content-Type	Yes	Must be application/json
Authorization	Yes	Format: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

📝 Path Parameters

Parameter	Type	Required	Description
presetId	string	Yes	ID of the preset to delete

🧩 Request Example

curl -X DELETE "https://openapi.onlive.site/api/v1/presets/123e4567-e89b-12d3-a456-426614174001" \
-H "Content-Type: application/json" \
-H "Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature"

📥 Response

Success Response (200 OK)

Field	Type	Description
id	string	ID of the deleted preset
status	string	Status of the operation
deletedAt	string (ISO 8601)	Timestamp when the preset was deleted

Response Example

{
  "id": "123e4567-e89b-12d3-a456-426614174001",
  "status": "deleted",
  "deletedAt": "2025-05-28T12:34:56Z"
}

📘 Notes

• Deleting a preset is permanent and cannot be undone
• Associated assets are not deleted, only the association is removed
• If a preset is referenced by other resources, the operation may fail
• You must have appropriate permissions to delete presets

❌ Error Responses

Error Response Examples

404 Not Found

{
  "statusCode": 404,
  "message": "Preset not found",
  "error": "Not Found"
}

403 Forbidden

{
  "statusCode": 403,
  "message": "Insufficient permissions to delete this preset",
  "error": "Forbidden"
}

409 Conflict

{
  "statusCode": 409,
  "message": "Preset cannot be deleted because it is currently in use by other resources",
  "error": "Conflict"
}

✅ Common Use Cases

• 🧹 Cleanup Unused Presets: Remove presets that are no longer needed
• 🔄 Replace Outdated Configurations: Delete old presets before creating updated versions
• 🗑️ Remove Test Presets: Clean up presets created for testing purposes
• 🔒 Security Management: Remove presets with sensitive configurations

400 Bad Request

{
  "statusCode": 400,
  "message": "Invalid preset ID format"
}

401 Unauthorized

{
  "statusCode": 401,
  "message": "Unauthorized access",
  "error": "Unauthorized"
}