Snapshot - Delete
Delete an existing snapshot according to the snapshotId. All object data and information in the snapshot will also be deleted. Only the source subscription who took the snapshot can delete the snapshot. If the user does not delete a snapshot with this API, the snapshot will still be automatically deleted in 48 hours after creation.
DELETE {Endpoint}/face/v1.0-preview/snapshots/{snapshotId}URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
Endpoint
|
path | True |
string |
Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). |
|
snapshot
|
path | True |
string uuid |
Id referencing a particular snapshot. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | True |
string |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
A successful call returns an empty response body. |
|
| Other Status Codes |
Error response. |
Security
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Examples
Delete snapshot example
Sample request
DELETE {Endpoint}/face/v1.0-preview/snapshots/e58b3f08-1e8b-4165-81df-aa9858f233dc
Sample response
Definitions
| Name | Description |
|---|---|
| APIError |
Error information returned by the API |
| Error |
Error body. |
APIError
Error information returned by the API
| Name | Type | Description |
|---|---|---|
| error |
Error body. |
Error
Error body.
| Name | Type | Description |
|---|---|---|
| code |
string |
|
| message |
string |