Remediations | Heeler User Guide

Get Remediation Terms

get

Authorizations

Responses

200

Successful Response

application/json

404

Not found

get

GET /api/services/remediations/_terms HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "terms": [
    {
      "name": "text",
      "type": "Int",
      "terms": [
        {
          "lowerBound": 1,
          "upperBound": 1,
          "count": 1
        }
      ]
    }
  ]
}

Get All Service Remediations

get

Authorizations

Query parameters

pageintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Body

itemsany ofOptional

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/services/remediations HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "id": 1,
      "package_name": "text",
      "package_manager": "default",
      "title": "text",
      "created": "2025-06-27T12:00:14.936Z",
      "solutions": [
        {
          "action": "text",
          "details": "text",
          "fixed_vulnerabilities": [
            "text"
          ],
          "fix_version_range": "text",
          "fix_version": "text",
          "complexity": "easy",
          "type": "specific_version"
        }
      ],
      "assignee": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "suggested_assignees": [
        {
          "identity": {
            "id": 1,
            "name": "text",
            "email": "text",
            "alternate_emails": [
              "text"
            ],
            "is_hidden": true
          },
          "lines_of_code": 1,
          "last_commit_time": "2025-06-27T12:00:14.936Z"
        }
      ],
      "service_id": 1,
      "service_name": "text",
      "affected_deployment_ids": [
        1
      ],
      "slo_seconds_remaining": 1,
      "slo_seconds_total": 1,
      "priority": "DEFER",
      "num_findings": 1,
      "issues": [
        {
          "issue_id": 1,
          "name": "text",
          "status": "text",
          "status_category": "text",
          "issue_type": "text",
          "issue_type_icon_url": "text",
          "url": "text",
          "summary": "text",
          "remediation_id": 1
        }
      ],
      "affected_versions": [
        "text"
      ],
      "resource_count": 1,
      "source_type": "The language of the service",
      "application_path": "The service application path.",
      "application_params": "The service application params.",
      "complexity": "The complexity of the remediation."
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get All Service Remediations

post

Authorizations

Query parameters

pageintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Body

itemsany ofOptional

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

POST /api/services/remediations HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "id": 1,
      "package_name": "text",
      "package_manager": "default",
      "title": "text",
      "created": "2025-06-27T12:00:14.936Z",
      "solutions": [
        {
          "action": "text",
          "details": "text",
          "fixed_vulnerabilities": [
            "text"
          ],
          "fix_version_range": "text",
          "fix_version": "text",
          "complexity": "easy",
          "type": "specific_version"
        }
      ],
      "assignee": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "suggested_assignees": [
        {
          "identity": {
            "id": 1,
            "name": "text",
            "email": "text",
            "alternate_emails": [
              "text"
            ],
            "is_hidden": true
          },
          "lines_of_code": 1,
          "last_commit_time": "2025-06-27T12:00:14.936Z"
        }
      ],
      "service_id": 1,
      "service_name": "text",
      "affected_deployment_ids": [
        1
      ],
      "slo_seconds_remaining": 1,
      "slo_seconds_total": 1,
      "priority": "DEFER",
      "num_findings": 1,
      "issues": [
        {
          "issue_id": 1,
          "name": "text",
          "status": "text",
          "status_category": "text",
          "issue_type": "text",
          "issue_type_icon_url": "text",
          "url": "text",
          "summary": "text",
          "remediation_id": 1
        }
      ],
      "affected_versions": [
        "text"
      ],
      "resource_count": 1,
      "source_type": "The language of the service",
      "application_path": "The service application path.",
      "application_params": "The service application params.",
      "complexity": "The complexity of the remediation."
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Service Remediations Route

get

Authorizations

Path parameters

service_idintegerRequired

Query parameters

pageintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Body

itemsany ofOptional

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/services/{service_id}/remediations HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "id": 1,
      "package_name": "text",
      "package_manager": "default",
      "title": "text",
      "created": "2025-06-27T12:00:14.936Z",
      "solutions": [
        {
          "action": "text",
          "details": "text",
          "fixed_vulnerabilities": [
            "text"
          ],
          "fix_version_range": "text",
          "fix_version": "text",
          "complexity": "easy",
          "type": "specific_version"
        }
      ],
      "assignee": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "suggested_assignees": [
        {
          "identity": {
            "id": 1,
            "name": "text",
            "email": "text",
            "alternate_emails": [
              "text"
            ],
            "is_hidden": true
          },
          "lines_of_code": 1,
          "last_commit_time": "2025-06-27T12:00:14.936Z"
        }
      ],
      "service_id": 1,
      "service_name": "text",
      "affected_deployment_ids": [
        1
      ],
      "slo_seconds_remaining": 1,
      "slo_seconds_total": 1,
      "priority": "DEFER",
      "num_findings": 1,
      "issues": [
        {
          "issue_id": 1,
          "name": "text",
          "status": "text",
          "status_category": "text",
          "issue_type": "text",
          "issue_type_icon_url": "text",
          "url": "text",
          "summary": "text",
          "remediation_id": 1
        }
      ],
      "affected_versions": [
        "text"
      ],
      "resource_count": 1,
      "source_type": "The language of the service",
      "application_path": "The service application path.",
      "application_params": "The service application params.",
      "complexity": "The complexity of the remediation."
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Service Remediations Route

post

Authorizations

Path parameters

service_idintegerRequired

Query parameters

pageintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Body

itemsany ofOptional

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

POST /api/services/{service_id}/remediations HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "id": 1,
      "package_name": "text",
      "package_manager": "default",
      "title": "text",
      "created": "2025-06-27T12:00:14.936Z",
      "solutions": [
        {
          "action": "text",
          "details": "text",
          "fixed_vulnerabilities": [
            "text"
          ],
          "fix_version_range": "text",
          "fix_version": "text",
          "complexity": "easy",
          "type": "specific_version"
        }
      ],
      "assignee": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "suggested_assignees": [
        {
          "identity": {
            "id": 1,
            "name": "text",
            "email": "text",
            "alternate_emails": [
              "text"
            ],
            "is_hidden": true
          },
          "lines_of_code": 1,
          "last_commit_time": "2025-06-27T12:00:14.936Z"
        }
      ],
      "service_id": 1,
      "service_name": "text",
      "affected_deployment_ids": [
        1
      ],
      "slo_seconds_remaining": 1,
      "slo_seconds_total": 1,
      "priority": "DEFER",
      "num_findings": 1,
      "issues": [
        {
          "issue_id": 1,
          "name": "text",
          "status": "text",
          "status_category": "text",
          "issue_type": "text",
          "issue_type_icon_url": "text",
          "url": "text",
          "summary": "text",
          "remediation_id": 1
        }
      ],
      "affected_versions": [
        "text"
      ],
      "resource_count": 1,
      "source_type": "The language of the service",
      "application_path": "The service application path.",
      "application_params": "The service application params.",
      "complexity": "The complexity of the remediation."
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Remediation Details

get

Authorizations

Path parameters

remediation_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/services/remediations/{remediation_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "package_name": "text",
  "package_manager": "default",
  "title": "text",
  "created": "2025-06-27T12:00:14.936Z",
  "solutions": [
    {
      "action": "text",
      "details": "text",
      "fixed_vulnerabilities": [
        "text"
      ],
      "fix_version_range": "text",
      "fix_version": "text",
      "complexity": "easy",
      "type": "specific_version"
    }
  ],
  "assignee": {
    "id": 1,
    "name": "text",
    "email": "text",
    "alternate_emails": [
      "text"
    ],
    "is_hidden": true
  },
  "suggested_assignees": [
    {
      "identity": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "lines_of_code": 1,
      "last_commit_time": "2025-06-27T12:00:14.936Z"
    }
  ],
  "service_id": 1,
  "service_name": "text",
  "affected_deployment_ids": [
    1
  ],
  "slo_seconds_remaining": 1,
  "slo_seconds_total": 1,
  "priority": "DEFER",
  "num_findings": 1,
  "issues": [
    {
      "issue_id": 1,
      "name": "text",
      "status": "text",
      "status_category": "text",
      "issue_type": "text",
      "issue_type_icon_url": "text",
      "url": "text",
      "summary": "text",
      "remediation_id": 1
    }
  ],
  "affected_versions": [
    "text"
  ],
  "resource_count": 1,
  "source_type": "The language of the service",
  "application_path": "The service application path.",
  "application_params": "The service application params.",
  "complexity": "The complexity of the remediation.",
  "findings": [
    {
      "id": 1,
      "package_name": "text",
      "package_versions": [
        "text"
      ],
      "vulnerability": {
        "vuln_id": "text",
        "title": "text",
        "description": "text",
        "severity": "CRITICAL",
        "severity_source": "text",
        "found": "2025-06-27T12:00:14.936Z",
        "status": "text",
        "fix_versions": [
          "text"
        ],
        "package_version": "text",
        "references": [
          "text"
        ],
        "cwe_ids": [
          "text"
        ],
        "cvss_source": "text",
        "cvss_v3": {
          "attack_vector": "N",
          "attack_complexity": "L",
          "privileges_required": "N",
          "user_interaction": "N",
          "scope": "U",
          "confidentiality_impact": "N",
          "integrity_impact": "N",
          "availability_impact": "N",
          "exploit_code_maturity": "X",
          "remediation_level": "X",
          "report_confidence": "X",
          "base_score": 1,
          "base_severity": "CRITICAL",
          "base_vector": "text"
        },
        "cvss_v2": {
          "access_vector": "L",
          "access_complexity": "H",
          "authentication": "M",
          "confidentiality_impact": "N",
          "integrity_impact": "N",
          "availability_impact": "N",
          "base_score": 1,
          "base_vector": "text",
          "base_severity": "CRITICAL"
        },
        "published_date": "text",
        "last_modified_date": "text",
        "vulnerable_versions": [
          "text"
        ],
        "patched_versions": [
          "text"
        ],
        "unaffected_versions": [
          "text"
        ],
        "exploitation": {
          "epss_score": 1,
          "epss_percentile": 1,
          "exploited": true,
          "ransomware": true,
          "level": "LIKELY_NOT_EXPLOITED"
        }
      },
      "created": "2025-06-27T12:00:14.936Z",
      "updated": "2025-06-27T12:00:14.936Z",
      "assignee": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "issues": [
        {
          "issue_id": 1,
          "name": "text",
          "status": "text",
          "status_category": "text",
          "issue_type": "text",
          "issue_type_icon_url": "text",
          "url": "text",
          "summary": "text",
          "remediation_id": 1
        }
      ],
      "service_id": "text",
      "num_deployments": 1,
      "coded": "text",
      "coded_changeset": "text",
      "coded_dependency": {
        "reponame": "text",
        "name": "text",
        "version": "text",
        "owner": "text",
        "provider": "text",
        "lockfile": "text",
        "lockcommited": false,
        "startline": 1,
        "endline": 1,
        "url": "text"
      },
      "introduced_changeset": "text",
      "introduced": "2025-06-27T12:00:14.936Z",
      "introduced_version": "text",
      "introduced_dependency": {
        "reponame": "text",
        "name": "text",
        "version": "text",
        "owner": "text",
        "provider": "text",
        "lockfile": "text",
        "lockcommited": false,
        "startline": 1,
        "endline": 1,
        "url": "text"
      },
      "affected_deployments": [
        {
          "heeler_id": "text",
          "provider_id": "text",
          "source_changeset": "text",
          "source_changeset_time": "2025-06-27T12:00:14.936Z",
          "repo_html_url": "text",
          "environment": "text",
          "deployment_type": "text",
          "cloud_type": "text",
          "account_id": "text",
          "account_name": "text",
          "fix_deployed": true,
          "vuln_count": 1,
          "secret_count": 1
        }
      ],
      "deployed_datetime": "2025-06-27T12:00:14.936Z",
      "affected_deployments_count": 0,
      "resolved_deployments_count": 0,
      "deployed": 1,
      "remediation": {
        "id": 1,
        "package_name": "text",
        "package_manager": "default",
        "title": "text",
        "created": "2025-06-27T12:00:14.936Z",
        "solutions": [
          {
            "action": "text",
            "details": "text",
            "fixed_vulnerabilities": [
              "text"
            ],
            "fix_version_range": "text",
            "fix_version": "text",
            "complexity": "easy",
            "type": "specific_version"
          }
        ],
        "assignee": {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        },
        "suggested_assignees": [
          {
            "identity": {
              "id": 1,
              "name": "text",
              "email": "text",
              "alternate_emails": [
                "text"
              ],
              "is_hidden": true
            },
            "lines_of_code": 1,
            "last_commit_time": "2025-06-27T12:00:14.936Z"
          }
        ],
        "service_id": 1,
        "service_name": "text",
        "affected_deployment_ids": [
          1
        ],
        "slo_seconds_remaining": 1,
        "slo_seconds_total": 1,
        "priority": "DEFER",
        "num_findings": 1,
        "issues": [
          {
            "issue_id": 1,
            "name": "text",
            "status": "text",
            "status_category": "text",
            "issue_type": "text",
            "issue_type_icon_url": "text",
            "url": "text",
            "summary": "text",
            "remediation_id": 1
          }
        ],
        "affected_versions": [
          "text"
        ],
        "resource_count": 1,
        "source_type": "The language of the service",
        "application_path": "The service application path.",
        "application_params": "The service application params.",
        "complexity": "The complexity of the remediation.",
        "findings": [
          "[Circular Reference]"
        ]
      },
      "source": "text",
      "affected_resources": 1,
      "priority": "DEFER",
      "business_impact": {
        "level": "LOW",
        "tier": "TIER_4",
        "environment": "text"
      },
      "environment_impact": {
        "level": "LOW",
        "accessibility": true,
        "accessibility_meta": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "compromise": "NONE",
        "compromise_meta": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "chaining": true,
        "chaining_meta": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "threat_impact": {
        "level": "LOW",
        "exploit": "LIKELY_NOT_EXPLOITED"
      },
      "slo_seconds_remaining": 1,
      "slo_seconds_total": 1,
      "evidence_graph": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Set Remediation Assignee

post

Authorizations

Path parameters

remediation_idintegerRequired

Body

identity_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

POST /api/services/remediations/{remediation_id}/assignee HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "identity_id": 1
}

{
  "ok": true,
  "message": "text"
}

Delete Remediation Assignee

delete

Authorizations

Path parameters

remediation_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

delete

DELETE /api/services/remediations/{remediation_id}/assignee HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ok": true,
  "message": "text"
}

Get Deployments For Remediation

get

Authorizations

Path parameters

remediation_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/services/remediations/{remediation_id}/deployments HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "service_id": 1,
    "connection_id": 1,
    "environment": "text",
    "provider_id": "text",
    "display_name": "text",
    "cloud_type": "text",
    "heeler_id": "text",
    "status": "text",
    "last_seen": "text",
    "repository": {
      "source_id": "text",
      "source_changeset": "text",
      "source_type": "text",
      "tags": [],
      "html_url": "text"
    },
    "findings_count": 1,
    "critical_findings_count": 1,
    "high_findings_count": 1,
    "medium_findings_count": 1,
    "low_findings_count": 1,
    "info_findings_count": 1,
    "vuln_count": 1,
    "vuln_critical_count": 1,
    "vuln_high_count": 1,
    "vuln_medium_count": 1,
    "vuln_low_count": 1,
    "vuln_info_count": 1,
    "secret_count": 1,
    "secret_critical_count": 1,
    "secret_high_count": 1,
    "secret_low_count": 1,
    "secret_info_count": 1,
    "changeset_url": "text",
    "application_url": "text",
    "created": "text",
    "updated": "text",
    "deployment_type": "text",
    "deleted_at": "text",
    "correlation_proof": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "annotations": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "urgent": 0,
    "plan": 0,
    "defer": 0,
    "dns_names": [
      "text"
    ]
  }
]

Create Jira Issue For Remediation

post

Authorizations

Path parameters

remediation_idintegerRequired

solution_idintegerRequired

Body

connection_idintegerRequired

project_idstringRequired

issue_typestringRequired

labelsany ofOptional

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

POST /api/services/remediations/{remediation_id}/solutions/{solution_id}/issue HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "connection_id": 1,
  "project_id": "text",
  "issue_type": "text",
  "fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "labels": [
    "text"
  ]
}

{
  "issue_id": 1,
  "name": "text",
  "status": "text",
  "status_category": "text",
  "issue_type": "text",
  "issue_type_icon_url": "text",
  "url": "text",
  "summary": "text",
  "remediation_id": 1
}

Get Suggested Jira Issue Fields

get

Authorizations

Path parameters

remediation_idintegerRequired

solution_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/services/remediations/{remediation_id}/solution/{solution_id}/issue HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "project": {
    "project_id": "text",
    "name": "text",
    "key": "text",
    "source": "text",
    "connection_id": 1
  },
  "team": {
    "team_id": "text",
    "name": "text",
    "source": "text"
  },
  "ticket_type": {
    "ticket_type_id": "text",
    "name": "text",
    "image_url": "text"
  },
  "summary": "text",
  "reporter": "text",
  "assignee": "text",
  "description": "text",
  "labels": [
    "text"
  ]
}

Delete Ticket From Remediation

post

Authorizations

Path parameters

remediation_idintegerRequired

Body

issue_idintegerRequired

finding_idany ofOptional

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

POST /api/services/remediations/{remediation_id}/unlink HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "issue_id": 1,
  "finding_id": 1
}

No content

Link Ticket To Remediation

post

Authorizations

Path parameters

remediation_idintegerRequired

solution_idintegerRequired

Body

issue_idintegerRequired

finding_idany ofOptional

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

post

POST /api/services/remediations/{remediation_id}/solution/{solution_id}/link HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "issue_id": 1,
  "finding_id": 1
}

No content