Skip to content

Delete a simulator

← HTTP API reference
View source specification ↗
DELETE /endpoint-simulators

Deletes an endpoint simulator and its associated endpoint, auth link, and route.

Requires a signed user/session or the existing authenticated client flow. The anonymous DCR delegated device profile cannot invoke this operation.

Required scope

Any authenticated access token

Request body

Fields

idstringRequired

The simulator identifier.

pattern: "^(port1/principals/[^/]+/endpoint-simulators/[^/]+|port1\\.simulator\\..+)$"

Returns

200

Simulator deleted successfully

No response body.

Errors

400 BAD_REQUEST

Invalid request payload

Check the request fields and any validation details, then correct the payload.

401 UNAUTHORIZED

Unauthorized - invalid or missing authentication token

Obtain a valid access token, then retry.

403 FORBIDDEN

Forbidden - insufficient permissions

Check the linked account and its permissions for the device or resource.

404 NOT_FOUND

Simulator not found

Verify the target identifier and that its endpoint or plugin route still exists.

500 INTERNAL

Internal server error

Retry with backoff only when the operation is safe to repeat. Include the error code when reporting persistent failures.