Remediations

Get remediation for a rule result

get

Retrieves remediation details for the specified rule result.

Path parameters

rule_result_idstringRequired

Rule result ID

Responses

200

Remediation response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal Server Error

application/json

get/api/rule_results/{rule_result_id}/remediation

HTTPcURLJavaScriptPython

GET /api/rule_results/{rule_result_id}/remediation HTTP/1.1
Accept: */*

{
  "_actions": {
    "create": {
      "href": "/api/rule_results/1/remediation",
      "method": "POST"
    },
    "delete": {
      "href": "/api/rule_results/1/remediation",
      "method": "DELETE"
    },
    "show": {
      "href": "/api/rule_results/1/remediation",
      "method": "GET"
    },
    "update": {
      "href": "/api/rule_results/1/remediation",
      "method": "PATCH"
    }
  },
  "data": {
    "df_content": {
      "texto": "new text"
    },
    "df_name": "template1",
    "dynamic_content": {
      "texto": {
        "origin": "user",
        "value": "new text"
      }
    },
    "id": 1,
    "inserted_at": "2026-06-24T10:00:00Z",
    "updated_at": "2026-06-24T10:00:00Z"
  }
}

Create remediation for a rule result

post

Creates remediation for the specified rule result.

Path parameters

rule_result_idstringRequired

Rule result ID

Body

application/json

rule_result_idintegerOptional

Rule result ID (also provided in path)

Responses

201

Remediation response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/api/rule_results/{rule_result_id}/remediation

HTTPcURLJavaScriptPython

POST /api/rule_results/{rule_result_id}/remediation HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "remediation": {
    "df_content": {
      "texto": "new text"
    },
    "df_name": "template1"
  },
  "rule_result_id": 1
}

{
  "_actions": {
    "create": {
      "href": "/api/rule_results/1/remediation",
      "method": "POST"
    },
    "delete": {
      "href": "/api/rule_results/1/remediation",
      "method": "DELETE"
    },
    "show": {
      "href": "/api/rule_results/1/remediation",
      "method": "GET"
    },
    "update": {
      "href": "/api/rule_results/1/remediation",
      "method": "PATCH"
    }
  },
  "data": {
    "df_content": {
      "texto": "new text"
    },
    "df_name": "template1",
    "dynamic_content": {
      "texto": {
        "origin": "user",
        "value": "new text"
      }
    },
    "id": 1,
    "inserted_at": "2026-06-24T10:00:00Z",
    "updated_at": "2026-06-24T10:00:00Z"
  }
}

Update remediation for a rule result

put

Updates remediation for the specified rule result.

Path parameters

rule_result_idstringRequired

Rule result ID

Body

application/json

rule_result_idintegerOptional

Rule result ID (also provided in path)

Responses

200

Remediation response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

put/api/rule_results/{rule_result_id}/remediation

HTTPcURLJavaScriptPython

PUT /api/rule_results/{rule_result_id}/remediation HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "remediation": {
    "df_content": {
      "texto": "new text"
    },
    "df_name": "template1"
  },
  "rule_result_id": 1
}

{
  "_actions": {
    "create": {
      "href": "/api/rule_results/1/remediation",
      "method": "POST"
    },
    "delete": {
      "href": "/api/rule_results/1/remediation",
      "method": "DELETE"
    },
    "show": {
      "href": "/api/rule_results/1/remediation",
      "method": "GET"
    },
    "update": {
      "href": "/api/rule_results/1/remediation",
      "method": "PATCH"
    }
  },
  "data": {
    "df_content": {
      "texto": "new text"
    },
    "df_name": "template1",
    "dynamic_content": {
      "texto": {
        "origin": "user",
        "value": "new text"
      }
    },
    "id": 1,
    "inserted_at": "2026-06-24T10:00:00Z",
    "updated_at": "2026-06-24T10:00:00Z"
  }
}

Delete remediation for a rule result

delete

Deletes remediation associated with the specified rule result.

Path parameters

rule_result_idstringRequired

Rule result ID

Responses

204

Remediation deleted

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal Server Error

application/json

delete/api/rule_results/{rule_result_id}/remediation

HTTPcURLJavaScriptPython

DELETE /api/rule_results/{rule_result_id}/remediation HTTP/1.1
Accept: */*

No content

Update remediation for a rule result

patch

Updates remediation for the specified rule result.

Path parameters

rule_result_idstringRequired

Rule result ID

Body

application/json

rule_result_idintegerOptional

Rule result ID (also provided in path)

Responses

200

Remediation response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

patch/api/rule_results/{rule_result_id}/remediation

HTTPcURLJavaScriptPython

PATCH /api/rule_results/{rule_result_id}/remediation HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "remediation": {
    "df_content": {
      "texto": "new text"
    },
    "df_name": "template1"
  },
  "rule_result_id": 1
}

{
  "_actions": {
    "create": {
      "href": "/api/rule_results/1/remediation",
      "method": "POST"
    },
    "delete": {
      "href": "/api/rule_results/1/remediation",
      "method": "DELETE"
    },
    "show": {
      "href": "/api/rule_results/1/remediation",
      "method": "GET"
    },
    "update": {
      "href": "/api/rule_results/1/remediation",
      "method": "PATCH"
    }
  },
  "data": {
    "df_content": {
      "texto": "new text"
    },
    "df_name": "template1",
    "dynamic_content": {
      "texto": {
        "origin": "user",
        "value": "new text"
      }
    },
    "id": 1,
    "inserted_at": "2026-06-24T10:00:00Z",
    "updated_at": "2026-06-24T10:00:00Z"
  }
}