API Delete Camera Preset

From IVS Wiki
Jump to: navigation, search

This API call deletes an existing preset from a camera.

Resource URL

http://valt.example.com/api/v3/cameras/{camera}/presets/{preset}

Replace {camera} with the ID of the camera and {preset} with the ID of the preset.

Resource Information

Method DELETE
Headers Content-Type: application/json
Response Type None
Authentication Required Yes

Parameters

Path Parameters

Parameter Description Example
camera The ID of the camera the preset belongs to. 1
preset The ID of the preset to delete. 7b931a86-2142-4121-a6f8-2e3197d4c5bf

Response

Code Reason
204 Preset Deleted Successfully (No Content)
400 Invalid Request (See Response for Specific Error)
401 Unauthorized
404 Camera or Preset Not Found
500 Internal Server Error

A 204 No Content response indicates the preset was deleted successfully. No response body is returned.

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/cameras/1/presets/7b931a86-2142-4121-a6f8-2e3197d4c5bf?access_token=e82632d19c523678fea3d1016c6df9e9

Not Found Response

Returned when no camera or preset exists with the specified IDs.

{
  "title": "An error occurred",
  "status": 404,
  "detail": "Not Found"
}

Failure Response

Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.

{
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}