Delete a field definition

Base URL: https://{kibana_url}

DELETE /api/cases/field_definitions/{field_definition_id}
DELETE /s/{space_id}/api/cases/field_definitions/{field_definition_id}

Refer to Spaces for more information.

Deletes a field definition. You must have the "Manage templates" sub-privilege for the Cases feature of the owning solution. A field definition cannot be deleted while it is referenced by an active template or linked to an active custom field in the Cases configuration. Requires the Cases feature to be enabled in the space.

Authentication

Path parameters

Responses

204

The field definition was deleted.

Authorization information is missing or invalid.

application/json

The user does not have the manage templates privilege for the owner.

application/json

The field definition was not found.

application/json

The field definition is referenced by one or more active templates, or is linked to an active custom field in the Cases configuration.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

DELETE kbn:/api/cases/field_definitions/FIELD_DEFINITION_ID

Generated from the API spec

curl Shell

curl -X DELETE "${KIBANA_URL}/api/cases/field_definitions/${FIELD_DEFINITION_ID}" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "error": "Unauthorized",
  "message": "Unable to authenticate with the provided credentials.",
  "statusCode": 401
}

{
  "error": "Forbidden",
  "message": "Unauthorized to access cases",
  "statusCode": 403
}

{
  "error": "Not Found",
  "message": "Saved object [cases-template/9da1ea2a-09f8-4d0e-bf9d-09bf8c9d0f42] not found",
  "statusCode": 404
}

{
  "error": "Conflict",
  "message": "Template name \u0022Security incident\u0022 already exists for owner \u0022cases\u0022",
  "statusCode": 409
}