> For the complete documentation index, see [llms.txt](https://docs.ox.security/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ox.security/api-documentation/api-reference/api--response-center/queries/get-incident-remediation.md).

# getIncidentRemediation

Remediation rollup for one incident: PRs, tickets, fixability and the by-resource view.

### Examples

{% tabs %}
{% tab title="GraphQL" %}

```graphql
query GetIncidentRemediation($incidentId: String!) {
  getIncidentRemediation(incidentId: $incidentId) {
    summary {
      pullRequests {
        total
        merged
        open
        draft
      }
      tickets {
        total
        done
        inProgress
        blocked
      }
      fixability {
        fixableIndicators
        totalIndicators
        downgradeOnly
      }
      deployGap
      activeIssues
      activeIssuesPrAvailable
      activeIssuesWithTicket
      activeIssuesWithPullRequest
    }
    pullRequests {
      id
      incidentId
      itemType
      externalId
      title
      provider
      project
      author
      assignee
      team
      appId
      appName
      appTags
      businessUnits {
        id
        name
      }
      ticketStatus
      upgradeType
      ciStatus
      reviewStatus
      state
      resourceName
      issueId
      linkedIndicatorValues
      url
      isDeployed
      eventAt
    }
    tickets {
      id
      incidentId
      itemType
      externalId
      title
      provider
      project
      author
      assignee
      team
      appId
      appName
      appTags
      businessUnits {
        id
        name
      }
      ticketStatus
      upgradeType
      ciStatus
      reviewStatus
      state
      resourceName
      issueId
      linkedIndicatorValues
      url
      isDeployed
      eventAt
    }
    byResource {
      resourceName
      pullRequest {
        id
        incidentId
        itemType
        externalId
        title
        provider
        project
        author
        assignee
        team
        appId
        appName
        appTags
        businessUnits {
          id
          name
        }
        ticketStatus
        upgradeType
        ciStatus
        reviewStatus
        state
        resourceName
        issueId
        linkedIndicatorValues
        url
        isDeployed
        eventAt
      }
      ticket {
        id
        incidentId
        itemType
        externalId
        title
        provider
        project
        author
        assignee
        team
        appId
        appName
        appTags
        businessUnits {
          id
          name
        }
        ticketStatus
        upgradeType
        ciStatus
        reviewStatus
        state
        resourceName
        issueId
        linkedIndicatorValues
        url
        isDeployed
        eventAt
      }
      netStatus
      updatedAt
    }
    availableFixes {
      issueId
      title
      severity
      category
      resourceName
      appName
      fixType
      upgradeType
      appTags
      businessUnits {
        id
        name
      }
      hitIndicatorValues
    }
  }
}
```

#### Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

```json
{
  "incidentId": "example"
}
```

{% endtab %}

{% tab title="cURL" %}

```shell
curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "query GetIncidentRemediation($incidentId: String!) { getIncidentRemediation(incidentId: $incidentId) { summary { pullRequests { total merged open draft } tickets { total done inProgress blocked } fixability { fixableIndicators totalIndicators downgradeOnly } deployGap activeIssues activeIssuesPrAvailable activeIssuesWithTicket activeIssuesWithPullRequest } pullRequests { id incidentId itemType externalId title provider project author assignee team appId appName appTags businessUnits { id name } ticketStatus upgradeType ciStatus reviewStatus state resourceName issueId linkedIndicatorValues url isDeployed eventAt } tickets { id incidentId itemType externalId title provider project author assignee team appId appName appTags businessUnits { id name } ticketStatus upgradeType ciStatus reviewStatus state resourceName issueId linkedIndicatorValues url isDeployed eventAt } byResource { resourceName pullRequest { id incidentId itemType externalId title provider project author assignee team appId appName appTags businessUnits { id name } ticketStatus upgradeType ciStatus reviewStatus state resourceName issueId linkedIndicatorValues url isDeployed eventAt } ticket { id incidentId itemType externalId title provider project author assignee team appId appName appTags businessUnits { id name } ticketStatus upgradeType ciStatus reviewStatus state resourceName issueId linkedIndicatorValues url isDeployed eventAt } netStatus updatedAt } availableFixes { issueId title severity category resourceName appName fixType upgradeType appTags businessUnits { id name } hitIndicatorValues } } }",
 "variables": {
    "incidentId": "example"
  }
}'
```

{% endtab %}

{% tab title="Node.js" %}

```javascript
const query = 'query GetIncidentRemediation($incidentId: String!) { getIncidentRemediation(incidentId: $incidentId) { summary { pullRequests { total merged open draft } tickets { total done inProgress blocked } fixability { fixableIndicators totalIndicators downgradeOnly } deployGap activeIssues activeIssuesPrAvailable activeIssuesWithTicket activeIssuesWithPullRequest } pullRequests { id incidentId itemType externalId title provider project author assignee team appId appName appTags businessUnits { id name } ticketStatus upgradeType ciStatus reviewStatus state resourceName issueId linkedIndicatorValues url isDeployed eventAt } tickets { id incidentId itemType externalId title provider project author assignee team appId appName appTags businessUnits { id name } ticketStatus upgradeType ciStatus reviewStatus state resourceName issueId linkedIndicatorValues url isDeployed eventAt } byResource { resourceName pullRequest { id incidentId itemType externalId title provider project author assignee team appId appName appTags businessUnits { id name } ticketStatus upgradeType ciStatus reviewStatus state resourceName issueId linkedIndicatorValues url isDeployed eventAt } ticket { id incidentId itemType externalId title provider project author assignee team appId appName appTags businessUnits { id name } ticketStatus upgradeType ciStatus reviewStatus state resourceName issueId linkedIndicatorValues url isDeployed eventAt } netStatus updatedAt } availableFixes { issueId title severity category resourceName appName fixType upgradeType appTags businessUnits { id name } hitIndicatorValues } } }';

fetch("https://api.cloud.ox.security/api/apollo-gateway", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
    query: query,
    // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    variables: {
      incidentId: "example"
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

query = 'query GetIncidentRemediation($incidentId: String!) { getIncidentRemediation(incidentId: $incidentId) { summary { pullRequests { total merged open draft } tickets { total done inProgress blocked } fixability { fixableIndicators totalIndicators downgradeOnly } deployGap activeIssues activeIssuesPrAvailable activeIssuesWithTicket activeIssuesWithPullRequest } pullRequests { id incidentId itemType externalId title provider project author assignee team appId appName appTags businessUnits { id name } ticketStatus upgradeType ciStatus reviewStatus state resourceName issueId linkedIndicatorValues url isDeployed eventAt } tickets { id incidentId itemType externalId title provider project author assignee team appId appName appTags businessUnits { id name } ticketStatus upgradeType ciStatus reviewStatus state resourceName issueId linkedIndicatorValues url isDeployed eventAt } byResource { resourceName pullRequest { id incidentId itemType externalId title provider project author assignee team appId appName appTags businessUnits { id name } ticketStatus upgradeType ciStatus reviewStatus state resourceName issueId linkedIndicatorValues url isDeployed eventAt } ticket { id incidentId itemType externalId title provider project author assignee team appId appName appTags businessUnits { id name } ticketStatus upgradeType ciStatus reviewStatus state resourceName issueId linkedIndicatorValues url isDeployed eventAt } netStatus updatedAt } availableFixes { issueId title severity category resourceName appName fixType upgradeType appTags businessUnits { id name } hitIndicatorValues } } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query,
    # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    "variables": {
      "incidentId": "example"
    }
  }
)

if response.status_code == 200:
    result = response.json()
    print(result)
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```

{% endtab %}
{% endtabs %}

### Arguments

You can use the following argument(s) to customize your `getIncidentRemediation` query.

| Argument                                                                           | Description | Supported fields |
| ---------------------------------------------------------------------------------- | ----------- | ---------------- |
| incidentId `String!` <mark style="color:red;background-color:red;">required</mark> |             |                  |

### Fields

Return type: [`IncidentRemediation!`](/api-documentation/api-reference/api--response-center/types/objects/incident-remediation.md)

You can use the following field(s) to specify what information your `getIncidentRemediation` query will return. Please note that some fields may have their own subfields.

| Field                                                                                                                                            | Description | Supported fields                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| summary [`RemediationSummary!`](/api-documentation/api-reference/api--response-center/types/objects/remediation-summary.md)                      |             | <p>pullRequests <a href="/api-documentation/api-reference/api--response-center/types/objects/remediation-pr-summary.md"><code>RemediationPrSummary!</code></a><br>tickets <a href="/api-documentation/api-reference/api--response-center/types/objects/remediation-ticket-summary.md"><code>RemediationTicketSummary!</code></a><br>fixability <a href="/api-documentation/api-reference/api--response-center/types/objects/remediation-fixability.md"><code>RemediationFixability!</code></a><br>deployGap <code>Int!</code><br>activeIssues <code>Int!</code><br>activeIssuesPrAvailable <code>Int!</code><br>activeIssuesWithTicket <code>Int</code><br>activeIssuesWithPullRequest <code>Int</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| pullRequests [`[IncidentRemediationItem!]!`](/api-documentation/api-reference/api--response-center/types/objects/incident-remediation-item.md)   |             | <p>id <code>String!</code><br>incidentId <code>String!</code><br>itemType <a href="/api-documentation/api-reference/api--response-center/types/enums/remediation-item-type.md"><code>RemediationItemType!</code></a><br>externalId <code>String!</code><br>title <code>String!</code><br>provider <code>String!</code><br>project <code>String</code><br>author <code>String</code><br>assignee <code>String</code><br>team <code>String</code><br>appId <code>String</code><br>appName <code>String</code><br>appTags <code>\[String!]!</code><br>businessUnits <a href="/api-documentation/api-reference/api--response-center/types/objects/incident-business-unit-ref.md"><code>\[IncidentBusinessUnitRef!]!</code></a><br>ticketStatus <code>String</code><br>upgradeType <a href="/api-documentation/api-reference/api--response-center/types/enums/remediation-upgrade-type.md"><code>RemediationUpgradeType</code></a><br>ciStatus <a href="/api-documentation/api-reference/api--response-center/types/enums/remediation-ci-status.md"><code>RemediationCiStatus</code></a><br>reviewStatus <a href="/api-documentation/api-reference/api--response-center/types/enums/remediation-review-status.md"><code>RemediationReviewStatus</code></a><br>state <a href="/api-documentation/api-reference/api--response-center/types/enums/remediation-state.md"><code>RemediationState!</code></a><br>resourceName <code>String</code><br>issueId <code>String</code><br>linkedIndicatorValues <code>\[String!]!</code><br>url <code>String</code><br>isDeployed <code>Boolean</code><br>eventAt <code>DateTime!</code></p> |
| tickets [`[IncidentRemediationItem!]!`](/api-documentation/api-reference/api--response-center/types/objects/incident-remediation-item.md)        |             | <p>id <code>String!</code><br>incidentId <code>String!</code><br>itemType <a href="/api-documentation/api-reference/api--response-center/types/enums/remediation-item-type.md"><code>RemediationItemType!</code></a><br>externalId <code>String!</code><br>title <code>String!</code><br>provider <code>String!</code><br>project <code>String</code><br>author <code>String</code><br>assignee <code>String</code><br>team <code>String</code><br>appId <code>String</code><br>appName <code>String</code><br>appTags <code>\[String!]!</code><br>businessUnits <a href="/api-documentation/api-reference/api--response-center/types/objects/incident-business-unit-ref.md"><code>\[IncidentBusinessUnitRef!]!</code></a><br>ticketStatus <code>String</code><br>upgradeType <a href="/api-documentation/api-reference/api--response-center/types/enums/remediation-upgrade-type.md"><code>RemediationUpgradeType</code></a><br>ciStatus <a href="/api-documentation/api-reference/api--response-center/types/enums/remediation-ci-status.md"><code>RemediationCiStatus</code></a><br>reviewStatus <a href="/api-documentation/api-reference/api--response-center/types/enums/remediation-review-status.md"><code>RemediationReviewStatus</code></a><br>state <a href="/api-documentation/api-reference/api--response-center/types/enums/remediation-state.md"><code>RemediationState!</code></a><br>resourceName <code>String</code><br>issueId <code>String</code><br>linkedIndicatorValues <code>\[String!]!</code><br>url <code>String</code><br>isDeployed <code>Boolean</code><br>eventAt <code>DateTime!</code></p> |
| byResource [`[RemediationByResource!]!`](/api-documentation/api-reference/api--response-center/types/objects/remediation-by-resource.md)         |             | <p>resourceName <code>String!</code><br>pullRequest <a href="/api-documentation/api-reference/api--response-center/types/objects/incident-remediation-item.md"><code>IncidentRemediationItem</code></a><br>ticket <a href="/api-documentation/api-reference/api--response-center/types/objects/incident-remediation-item.md"><code>IncidentRemediationItem</code></a><br>netStatus <a href="/api-documentation/api-reference/api--response-center/types/enums/affected-resource-status.md"><code>AffectedResourceStatus!</code></a><br>updatedAt <code>DateTime</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| availableFixes [`[RemediationAvailableFix!]!`](/api-documentation/api-reference/api--response-center/types/objects/remediation-available-fix.md) |             | <p>issueId <code>String!</code><br>title <code>String!</code><br>severity <code>String</code><br>category <code>String</code><br>resourceName <code>String</code><br>appName <code>String</code><br>fixType <code>String</code><br>upgradeType <a href="/api-documentation/api-reference/api--response-center/types/enums/remediation-upgrade-type.md"><code>RemediationUpgradeType</code></a><br>appTags <code>\[String!]!</code><br>businessUnits <a href="/api-documentation/api-reference/api--response-center/types/objects/incident-business-unit-ref.md"><code>\[IncidentBusinessUnitRef!]!</code></a><br>hitIndicatorValues <code>\[String!]!</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ox.security/api-documentation/api-reference/api--response-center/queries/get-incident-remediation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
