EPepilot
Entities

wipeAllEntities

Changed on

Creates a request to queue the deletion of all entities in the system. This is a destructive operation and should only be used in sandbox environments.

The request is persisted as a wipe job whose progress can be followed with listWipeJobs. Omit schemas to wipe all schemas of the organization. An empty schemas array is rejected.

Only one wipe can run per schema at a time: a request that overlaps a running wipe (same schema, or any schema while a wipe of all schemas is running) is rejected with 409. Wipe executions are limited to 23 hours so they stop before their 24-hour locks expire.

post/v1/entity:wipeAllEntities

Request

  • Base URL
    https://entity.sls.epilot.io
  • URL
    https://entity.sls.epilot.io/v1/entity:wipeAllEntities
  • Auth
    • HTTP bearer
    • or API key in header x-epilot-org-id

Request body

schemasEntitySlug[]

Schemas to wipe. Omit to wipe all schemas. An empty array is rejected with 400.

Example request

{
  "schemas": [
    "contact"
  ]
}

Response

Wipe request was created

idstring required
schemasEntitySlug[] nullable required

The schemas being wiped. null means all schemas.

status'running' | 'succeeded' | 'failed' required
current_step'SANITY_CHECK' | 'DELETE_ELASTIC_INDICES' | 'DELETE_DYNAMODB_ENTITIES' | 'DELETE_DYNAMODB_RELATIONS' | 'DELETE_DYNAMODB_ACTIVITIES' | 'DELETE_CLICKHOUSE_ENTITIES' | 'DELETE_CLICKHOUSE_ENTITY_OPERATIONS' | 'DELETE_S3_FILES' | 'SUCCESS' | 'FAIL' required
created_atstring date-time required
updated_atstring date-time required
finished_atstring date-time
entity_totalsobject required

Number of entities per schema at the time the wipe was requested

total_entitiesinteger required

Sum of entity_totals

errorstring

Example response

{
  "schemas": [
    "contact"
  ]
}

Changes

  • fb91b46a1b73Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status