Microsoft Sentinel Incidents API

The Incidents API from Microsoft Sentinel — 2 operation(s) for incidents.

GitHub OpenAPI
Business capability
Threat Detection & Response Management BC-620.30

Operations 4

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents Incidents list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId} Incidents get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId} Incidents create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId} Incidents delete #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-sentinel:microsoft-sentinel-incidents-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-sentinel-incidents-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Security Insights Incidents API
  version: '2025-09-01'
  description: API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Incidents
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents
  : get:
      operationId: Incidents_List
      tags:
      - Incidents
      description: Gets all incidents.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: workspaceName
        in: path
        description: The name of the monitor workspace.
        required: true
        schema:
          type: string
          maxLength: 90
          minLength: 1
          pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition. Optional.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results. Optional.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results. Optional.
        required: false
        schema:
          type: integer
          format: int32
          maximum: 1000
      - name: $skipToken
        in: query
        description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncidentList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Incidents list
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}
  : get:
      operationId: Incidents_Get
      tags:
      - Incidents
      description: Gets a given incident.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: workspaceName
        in: path
        description: The name of the monitor workspace.
        required: true
        schema:
          type: string
          maxLength: 90
          minLength: 1
          pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
      - name: incidentId
        in: path
        description: Incident ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Incident'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      summary: Incidents get
      x-summary-source: derived
    put:
      operationId: Incidents_CreateOrUpdate
      tags:
      - Incidents
      description: Creates or updates an incident.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: workspaceName
        in: path
        description: The name of the monitor workspace.
        required: true
        schema:
          type: string
          maxLength: 90
          minLength: 1
          pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
      - name: incidentId
        in: path
        description: Incident ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'Incident' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Incident'
        '201':
          description: Resource 'Incident' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Incident'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Incident'
        description: The incident
        required: true
      summary: Incidents create or update
      x-summary-source: derived
    delete:
      operationId: Incidents_Delete
      tags:
      - Incidents
      description: Deletes a given incident.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: workspaceName
        in: path
        description: The name of the monitor workspace.
        required: true
        schema:
          type: string
          maxLength: 90
          minLength: 1
          pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
      - name: incidentId
        in: path
        description: Incident ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      summary: Incidents delete
      x-summary-source: derived
components:
  schemas:
    AttackTactic:
      type: string
      description: The severity for alerts created by this alert rule.
      enum:
      - Reconnaissance
      - ResourceDevelopment
      - InitialAccess
      - Execution
      - Persistence
      - PrivilegeEscalation
      - DefenseEvasion
      - CredentialAccess
      - Discovery
      - LateralMovement
      - Collection
      - Exfiltration
      - CommandAndControl
      - Impact
      - PreAttack
      - ImpairProcessControl
      - InhibitResponseFunction
      x-ms-enum:
        name: AttackTactic
        modelAsString: true
        values:
        - name: Reconnaissance
          value: Reconnaissance
          description: Reconnaissance
        - name: ResourceDevelopment
          value: ResourceDevelopment
          description: ResourceDevelopment
        - name: InitialAccess
          value: InitialAccess
          description: InitialAccess
        - name: Execution
          value: Execution
          description: Execution
        - name: Persistence
          value: Persistence
          description: Persistence
        - name: PrivilegeEscalation
          value: PrivilegeEscalation
          description: PrivilegeEscalation
        - name: DefenseEvasion
          value: DefenseEvasion
          description: DefenseEvasion
        - name: CredentialAccess
          value: CredentialAccess
          description: CredentialAccess
        - name: Discovery
          value: Discovery
          description: Discovery
        - name: LateralMovement
          value: LateralMovement
          description: LateralMovement
        - name: Collection
          value: Collection
          description: Collection
        - name: Exfiltration
          value: Exfiltration
          description: Exfiltration
        - name: CommandAndControl
          value: CommandAndControl
          description: CommandAndControl
        - name: Impact
          value: Impact
          description: Impact
        - name: PreAttack
          value: PreAttack
          description: PreAttack
        - name: ImpairProcessControl
          value: ImpairProcessControl
          description: ImpairProcessControl
        - name: InhibitResponseFunction
          value: InhibitResponseFunction
          description: InhibitResponseFunction
    Resource:
      type: object
      title: Resource
      description: Common fields that are returned in the response for all Azure Resource Manager resources
      properties:
        id:
          type: string
          format: arm-id
          description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
          readOnly: true
        name:
          type: string
          description: The name of the resource
          readOnly: true
        type:
          type: string
          description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
          readOnly: true
        systemData:
          $ref: '#/components/schemas/systemData'
          description: Azure Resource Manager metadata containing createdBy and modifiedBy information.
          readOnly: true
      x-ms-azure-resource: true
    IncidentClassification:
      type: string
      description: The reason the incident was closed
      enum:
      - Undetermined
      - TruePositive
      - BenignPositive
      - FalsePositive
      x-ms-enum:
        name: IncidentClassification
        modelAsString: true
        values:
        - name: Undetermined
          value: Undetermined
          description: Incident classification was undetermined
        - name: TruePositive
          value: TruePositive
          description: Incident was true positive
        - name: BenignPositive
          value: BenignPositive
          description: Incident was benign positive
        - name: FalsePositive
          value: FalsePositive
          description: Incident was false positive
    IncidentLabelType:
      type: string
      description: The type of the label
      enum:
      - User
      - AutoAssigned
      x-ms-enum:
        name: IncidentLabelType
        modelAsString: true
        values:
        - name: User
          value: User
          description: Label manually created by a user
        - name: AutoAssigned
          value: AutoAssigned
          description: Label automatically created by the system
    ProxyResource:
      type: object
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      allOf:
      - $ref: '#/components/schemas/Resource'
    IncidentLabel:
      type: object
      description: Represents an incident label
      properties:
        labelName:
          type: string
          description: The name of the label
        labelType:
          $ref: '#/components/schemas/IncidentLabelType'
          description: The type of the label
          readOnly: true
      required:
      - labelName
    Azure.Core.uuid:
      type: string
      format: uuid
      description: Universally Unique Identifier
    IncidentList:
      type: object
      description: List all the incidents.
      properties:
        value:
          type: array
          description: The Incident items on this page
          items:
            $ref: '#/components/schemas/Incident'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
          readOnly: true
      required:
      - value
    IncidentOwnerInfo:
      type: object
      description: Information on the user an incident is assigned to
      properties:
        email:
          type: string
          description: The email of the user the incident is assigned to.
        assignedTo:
          type: string
          description: The name of the user the incident is assigned to.
        objectId:
          $ref: '#/components/schemas/Azure.Core.uuid'
          description: The object id of the user the incident is assigned to.
        userPrincipalName:
          type: string
          description: The user principal name of the user the incident is assigned to.
        ownerType:
          $ref: '#/components/schemas/OwnerType'
          description: The type of the owner the incident is assigned to.
    IncidentProperties:
      type: object
      description: Describes incident properties
      properties:
        title:
          type: string
          description: The title of the incident
        description:
          type: string
          description: The description of the incident
        severity:
          $ref: '#/components/schemas/IncidentSeverity'
          description: The severity of the incident
        status:
          $ref: '#/components/schemas/IncidentStatus'
          description: The status of the incident
        classification:
          $ref: '#/components/schemas/IncidentClassification'
          description: The reason the incident was closed
        classificationReason:
          $ref: '#/components/schemas/IncidentClassificationReason'
          description: The classification reason the incident was closed with
        classificationComment:
          type: string
          description: Describes the reason the incident was closed
        owner:
          $ref: '#/components/schemas/IncidentOwnerInfo'
          description: Describes a user that the incident is assigned to
        labels:
          type: array
          description: List of labels relevant to this incident
          items:
            $ref: '#/components/schemas/IncidentLabel'
          x-ms-identifiers: []
        firstActivityTimeUtc:
          type: string
          format: date-time
          description: The time of the first activity in the incident
        lastActivityTimeUtc:
          type: string
          format: date-time
          description: The time of the last activity in the incident
        lastModifiedTimeUtc:
          type: string
          format: date-time
          description: The last time the incident was updated
          readOnly: true
        createdTimeUtc:
          type: string
          format: date-time
          description: The time the incident was created
          readOnly: true
        incidentNumber:
          type: integer
          format: int32
          description: A sequential number
          readOnly: true
        additionalData:
          $ref: '#/components/schemas/IncidentAdditionalData'
          description: Additional data on the incident
          readOnly: true
        relatedAnalyticRuleIds:
          type: array
          description: List of resource ids of Analytic rules related to the incident
          items:
            type: string
            format: arm-id
            description: Related Analytic rule resource id
            x-ms-arm-id-details:
              allowedResources:
              - scopes:
                - Extension
                type: Microsoft.SecurityInsights/alertRules
          readOnly: true
        incidentUrl:
          type: string
          description: The deep-link url to the incident in Azure portal
          readOnly: true
        providerName:
          type: string
          description: The name of the source provider that generated the incident
          readOnly: true
        providerIncidentId:
          type: string
          description: The incident ID assigned by the incident provider
          readOnly: true
      required:
      - title
      - severity
      - status
    IncidentClassificationReason:
      type: string
      description: The classification reason the incident was closed with
      enum:
      - SuspiciousActivity
      - SuspiciousButExpected
      - IncorrectAlertLogic
      - InaccurateData
      x-ms-enum:
        name: IncidentClassificationReason
        modelAsString: true
        values:
        - name: SuspiciousActivity
          value: SuspiciousActivity
          description: Classification reason was suspicious activity
        - name: SuspiciousButExpected
          value: SuspiciousButExpected
          description: Classification reason was suspicious but expected
        - name: IncorrectAlertLogic
          value: IncorrectAlertLogic
          description: Classification reason was incorrect alert logic
        - name: InaccurateData
          value: InaccurateData
          description: Classification reason was inaccurate data
    IncidentStatus:
      type: string
      description: The status of the incident
      enum:
      - New
      - Active
      - Closed
      x-ms-enum:
        name: IncidentStatus
        modelAsString: true
        values:
        - name: New
          value: New
          description: An active incident which isn't being handled currently
        - name: Active
          value: Active
          description: An active incident which is being handled
        - name: Closed
          value: Closed
          description: A non-active incident
    Incident:
      type: object
      description: Represents an incident in Azure Security Insights.
      properties:
        properties:
          $ref: '#/components/schemas/IncidentProperties'
          description: Incident properties
          x-ms-client-flatten: true
        etag:
          type: string
          description: Etag of the azure resource
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    IncidentAdditionalData:
      type: object
      description: Incident additional data property bag.
      properties:
        alertsCount:
          type: integer
          format: int32
          description: The number of alerts in the incident
          readOnly: true
        bookmarksCount:
          type: integer
          format: int32
          description: The number of bookmarks in the incident
          readOnly: true
        commentsCount:
          type: integer
          format: int32
          description: The number of comments in the incident
          readOnly: true
        alertProductNames:
          type: array
          description: List of product names of alerts in the incident
          items:
            type: string
          readOnly: true
        tactics:
          type: array
          description: The tactics associated with incident
          items:
            $ref: '#/components/schemas/AttackTactic'
          readOnly: true
        providerIncidentUrl:
          type: string
          description: The provider incident url to the incident in Microsoft 365 Defender portal
          readOnly: true
    CloudError:
      type: object
      description: Error response structure.
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
          description: Error data
    OwnerType:
      type: string
      description: The type of the owner the hunt is assigned to.
      enum:
      - Unknown
      - User
      - Group
      x-ms-enum:
        name: OwnerType
        modelAsString: true
        values:
        - name: Unknown
          value: Unknown
          description: The hunt owner type is unknown
        - name: User
          value: User
          description: The hunt owner type is an AAD user
        - name: Group
          value: Group
          description: The hunt owner type is an AAD group
    CloudErrorBody:
      type: object
      description: Error details.
      properties:
        code:
          type: string
          description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
          readOnly: true
        message:
          type: string
          description: A message describing the error, intended to be suitable for display in a user interface.
          readOnly: true
    IncidentSeverity:
      type: string
      description: The severity of the incident
      enum:
      - High
      - Medium
      - Low
      - Informational
      x-ms-enum:
        name: IncidentSeverity
        modelAsString: true
        values:
        - name: High
          value: High
          description: High severity
        - name: Medium
          value: Medium
          description: Medium severity
        - name: Low
          value: Low
          description: Low severity
        - name: Informational
          value: Informational
          description: Informational severity
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.