The SentinelOnboardingStates API from Microsoft Sentinel — 2 operation(s) for sentinelonboardingstates.
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-sentinelonboardingstates-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 Sentinel Onboarding States API
version: '2025-09-01'
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
description: 'Operations tagged SentinelOnboardingStates 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: SentinelOnboardingStates
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates
: get:
operationId: SentinelOnboardingStates_List
tags:
- SentinelOnboardingStates
description: Gets all Sentinel onboarding states
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 workspace.
required: true
schema:
type: string
maxLength: 90
minLength: 1
pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/SentinelOnboardingStatesList'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
x-ms-examples:
Get all Sentinel onboarding states:
$ref: ./examples/onboardingStates/GetAllSentinelOnboardingStates.json
summary: Sentinel onboarding states list
x-summary-source: derived
servers:
- url: https://management.azure.com
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates/{sentinelOnboardingStateName}
: get:
operationId: SentinelOnboardingStates_Get
tags:
- SentinelOnboardingStates
description: Get Sentinel onboarding state
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: sentinelOnboardingStateName
in: path
description: The Sentinel onboarding state name. Supports - default
required: true
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/SentinelOnboardingState'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
x-ms-examples:
Get Sentinel onboarding state:
$ref: ./examples/onboardingStates/GetSentinelOnboardingState.json
summary: Sentinel onboarding states get
x-summary-source: derived
put:
operationId: SentinelOnboardingStates_Create
tags:
- SentinelOnboardingStates
description: Create Sentinel onboarding state
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 workspace.
required: true
schema:
type: string
maxLength: 90
minLength: 1
pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
- name: sentinelOnboardingStateName
in: path
description: The Sentinel onboarding state name. Supports - default
required: true
schema:
type: string
responses:
'200':
description: Resource 'SentinelOnboardingState' update operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/SentinelOnboardingState'
'201':
description: Resource 'SentinelOnboardingState' create operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/SentinelOnboardingState'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CloudError'
x-ms-examples:
Create Sentinel onboarding state:
$ref: ./examples/onboardingStates/CreateSentinelOnboardingState.json
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SentinelOnboardingState'
description: The Sentinel onboarding state parameter
summary: Sentinel onboarding states create
x-summary-source: derived
delete:
operationId: SentinelOnboardingStates_Delete
tags:
- SentinelOnboardingStates
description: Delete Sentinel onboarding state
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: sentinelOnboardingStateName
in: path
description: The Sentinel onboarding state name. Supports - default
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'
x-ms-examples:
Delete Sentinel onboarding state:
$ref: ./examples/onboardingStates/DeleteSentinelOnboardingState.json
summary: Sentinel onboarding states delete
x-summary-source: derived
servers:
- url: https://management.azure.com
components:
schemas:
SentinelOnboardingStatesList:
type: object
description: List of the Sentinel onboarding states
properties:
value:
type: array
description: Array of Sentinel onboarding states
items:
$ref: '#/components/schemas/SentinelOnboardingState'
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
SentinelOnboardingState:
type: object
description: Sentinel onboarding state
properties:
properties:
$ref: '#/components/schemas/SentinelOnboardingStateProperties'
description: The Sentinel onboarding state object
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
CloudError:
type: object
description: Error response structure.
properties:
error:
$ref: '#/components/schemas/CloudErrorBody'
description: Error data
SentinelOnboardingStateProperties:
type: object
description: The Sentinel onboarding state properties
properties:
customerManagedKey:
type: boolean
description: Flag that indicates the status of the CMK setting
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