The IncidentRelations API from Microsoft Sentinel — 2 operation(s) for incidentrelations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/microsoft-sentinel:microsoft-sentinel-incidentrelations-api"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.
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: 3.2.0
info:
title: Microsoft Sentinel Incident Relations API
version: '2025-09-01'
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
description: 'Operations tagged IncidentRelations across 2 of this provider''s published API definitions: microsoft-sentinel-securityinsights-2025-09-01.json, microsoft-sentinel-securityinsights-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
- user_impersonation
tags:
- name: IncidentRelations
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations
: get:
operationId: IncidentRelations_List
tags:
- IncidentRelations
description: Gets all relations for a given incident.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/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
- 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
- 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/RelationList'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
x-ms-examples:
Get all incident relations.:
$ref: ./examples/incidents/relations/GetAllIncidentRelations.json
x-ms-pageable:
nextLinkName: nextLink
summary: Incident relations list
x-summary-source: derived
servers:
- url: https://management.azure.com
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations/{relationName}
: get:
operationId: IncidentRelations_Get
tags:
- IncidentRelations
description: Gets a relation for a given incident.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/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
- name: relationName
in: path
description: Relation Name
required: true
schema:
type: string
maxLength: 63
minLength: 3
pattern: ^[a-zA-Z0-9-]{3,63}$
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Relation'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
x-ms-examples:
Get an incident relation.:
$ref: ./examples/incidents/relations/GetIncidentRelationByName.json
summary: Incident relations get
x-summary-source: derived
put:
operationId: IncidentRelations_CreateOrUpdate
tags:
- IncidentRelations
description: Creates or updates the incident relation.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/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
- name: relationName
in: path
description: Relation Name
required: true
schema:
type: string
maxLength: 63
minLength: 3
pattern: ^[a-zA-Z0-9-]{3,63}$
responses:
'200':
description: Resource 'Relation' update operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/Relation'
'201':
description: Resource 'Relation' create operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/Relation'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
x-ms-examples:
Creates or updates an incident relation.:
$ref: ./examples/incidents/relations/CreateIncidentRelation.json
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Relation'
description: The relation model
required: true
summary: Incident relations create or update
x-summary-source: derived
delete:
operationId: IncidentRelations_Delete
tags:
- IncidentRelations
description: Deletes a relation for a given incident.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/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
- name: relationName
in: path
description: Relation Name
required: true
schema:
type: string
maxLength: 63
minLength: 3
pattern: ^[a-zA-Z0-9-]{3,63}$
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'
x-ms-examples:
Delete the incident relation.:
$ref: ./examples/incidents/relations/DeleteIncidentRelation.json
summary: Incident relations delete
x-summary-source: derived
servers:
- url: https://management.azure.com
components:
schemas:
Relation:
type: object
description: Represents a relation between two resources
properties:
properties:
$ref: '#/components/schemas/RelationProperties'
description: Relation properties
x-ms-client-flatten: true
etag:
type: string
description: Etag of the azure resource
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
RelationList:
type: object
description: List of relations.
properties:
value:
type: array
description: The Relation items on this page
items:
$ref: '#/components/schemas/Relation'
nextLink:
type: string
format: uri
description: The link to the next page of items
readOnly: true
required:
- value
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
RelationProperties:
type: object
description: Relation property bag.
properties:
relatedResourceId:
type: string
description: The resource ID of the related resource
relatedResourceName:
type: string
description: The name of the related resource
readOnly: true
relatedResourceType:
type: string
description: The resource type of the related resource
readOnly: true
relatedResourceKind:
type: string
description: The resource kind of the related resource
readOnly: true
required:
- relatedResourceId
CloudError:
type: object
description: Error response structure.
properties:
error:
$ref: '#/components/schemas/CloudErrorBody'
description: Error data
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.
x-refined-from:
- microsoft-sentinel-securityinsights-2025-09-01.json
- microsoft-sentinel-securityinsights-openapi.yml