delete-datahub-events-by-filter

restish dci delete-datahub-events-by-filter

Deletes specific events using filters. Note that the two filters, eventIds and time ranges, are mutually exclusive.

Request

Content-Type: application/json

Schema

{
  "type": "object",
  "description": "Exactly one of \"eventIds\" or \"time ranges\" must be provided.",
  "required": [
    "dataset"
  ],
  "properties": {
    "dataset": {
      "type": "string",
      "description": "The dataset (provider) of the events to be deleted.",
      "example": "Datadog"
    },
    "eventIds": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Id of the event to be deleted.",
        "example": "beb21d99-a8c9-4dc0-8a69-5d684cc41e6c"
      }
    },
    "startTime": {
      "type": "string",
      "format": "date-time",
      "description": "The start timestamp of the time range in RFC3339 format.",
      "example": "2024-03-10T23:00:00Z"
    },
    "endTime": {
      "type": "string",
      "format": "date-time",
      "description": "The end timestamp of the time range in RFC3339 format.",
      "example": "2024-03-12T23:00:00Z"
    }
  },
  "minProperties": 1,
  "maxProperties": 1
}

Responses

200 (application/json)

OK - Events deleted.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "Delete success"
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

500 (application/json)

Internal Server Error - Something went wrong with the DoiT API server.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: delete-datahub-events-by-filter, deletedatahubeventsbyfilter