How to: Delete Entity

2min
Overview
Developers can call the DeleteEntity endpoint to delete entity instances by specifying the entityTypePluralName and entityId.
Example
The following example deletes the vehicles entity instance.
Curl
curl --location --request DELETE 'https://developfdn1.nonprod.fxtrt.io/core/api/v2/entity/vehicles/vehicle:283b3843-42b6-590a-94b4-08f881173313' \
--header 'X-COREOS-REQUEST-ID: dcb9d98e-f5cc-4be3-9124-97fbcc84492e' \
--header 'X-COREOS-TID: <tenant>' \
--header 'X-COREOS-ACCESS: <token>' \
--header 'X-COREOS-CALLBACK-SECRET: <callback secret>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
  "callback": {
    "url": "https://webhook.site/2aaef2ee-20c6-47a0-bf24-5b2bba098714"
  }
}'
curl --location --request DELETE 'https://developfdn1.nonprod.fxtrt.io/core/api/v2/entity/vehicles/vehicle:283b3843-42b6-590a-94b4-08f881173313' \
--header 'X-COREOS-REQUEST-ID: dcb9d98e-f5cc-4be3-9124-97fbcc84492e' \
--header 'X-COREOS-TID: <tenant>' \
--header 'X-COREOS-ACCESS: <token>' \
--header 'X-COREOS-CALLBACK-SECRET: <callback secret>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
  "callback": {
    "url": "https://webhook.site/2aaef2ee-20c6-47a0-bf24-5b2bba098714"
  }
}'
﻿
Note: Use this API cautiously, as deleted data cannot be easily recovered. Ensure proper testing in non-production environments before implementing in production.
Updated 28 Jun 2024
Did this page help you?
How to: Update Entity
How to: Retrieve Entity State