The APIMConfig API from Microsoft Defender — 2 operation(s) for apimconfig.
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-defender:microsoft-defender-apimconfig-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 Defender for Cloud REST API (Microsoft.Security)…
version: stable-composite
description: Composite of the latest stable Microsoft.Security resource-manager swagger files published by Microsoft in Azure/azure-rest-api-specs. Each path keeps its own api-version via x-source.
x-source-repo: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/security/resource-manager/Microsoft.Security/Security
servers:
- url: https://management.azure.com
security:
- azure_auth:
- user_impersonation
tags:
- name: APIMConfig
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/providers/Microsoft.Security/apiCollections
: get:
operationId: APICollections_ListByAzureApiManagementService
tags:
- APIMConfig
summary: Gets a list of onboarded Azure API Management APIs
description: Gets a list of Azure API Management APIs that have been onboarded to Microsoft Defender for APIs. If an Azure API Management API is onboarded to Microsoft Defender for APIs, the system will monitor the operations within the Azure API Management API for intrusive behaviors and provide alerts for attacks that have been detected.
parameters:
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: serviceName
in: path
description: The name of the API Management service.
required: true
schema:
type: string
maxLength: 50
minLength: 1
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCollectionList'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Gets a list of Azure API Management APIs that have been onboarded to Microsoft Defender for APIs:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2023-11-15/examples/ApiCollections/APICollections_ListByAzureApiManagementService_example.json
x-ms-pageable:
nextLinkName: nextLink
x-source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2023-11-15/apiCollections.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/providers/Microsoft.Security/apiCollections/{apiId}
: get:
operationId: APICollections_GetByAzureApiManagementService
tags:
- APIMConfig
summary: Gets an onboarded Azure API Management API
description: Gets an Azure API Management API if it has been onboarded to Microsoft Defender for APIs. If an Azure API Management API is onboarded to Microsoft Defender for APIs, the system will monitor the operations within the Azure API Management API for intrusive behaviors and provide alerts for attacks that have been detected.
parameters:
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: serviceName
in: path
description: The name of the API Management service.
required: true
schema:
type: string
maxLength: 50
minLength: 1
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
- name: apiId
in: path
description: API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
required: true
schema:
type: string
maxLength: 256
minLength: 1
pattern: ^[^*#&+:<>?]+$
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCollection'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Gets an Azure API Management API if it has been onboarded to Microsoft Defender for APIs:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2023-11-15/examples/ApiCollections/APICollections_GetByAzureApiManagementService_example.json
x-source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2023-11-15/apiCollections.json
put:
operationId: APICollections_OnboardAzureApiManagementApi
tags:
- APIMConfig
summary: Onboard an Azure API Management API to Microsoft Defender for APIs
description: Onboard an Azure API Management API to Microsoft Defender for APIs. The system will start monitoring the operations within the Azure Management API for intrusive behaviors and provide alerts for attacks that have been detected.
parameters:
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: serviceName
in: path
description: The name of the API Management service.
required: true
schema:
type: string
maxLength: 50
minLength: 1
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
- name: apiId
in: path
description: API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
required: true
schema:
type: string
maxLength: 256
minLength: 1
pattern: ^[^*#&+:<>?]+$
responses:
'200':
description: Resource 'ApiCollection' update operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCollection'
'201':
description: Resource 'ApiCollection' create operation succeeded
headers:
Location:
description: The Location header contains the URL where the status of the long running operation can be checked.
schema:
type: string
Retry-After:
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
schema:
type: integer
format: int32
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCollection'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Onboard an Azure API Management API to Microsoft Defender for APIs:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2023-11-15/examples/ApiCollections/APICollections_OnboardAzureApiManagementApi_example.json
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/ApiCollection'
x-ms-long-running-operation: true
x-source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2023-11-15/apiCollections.json
delete:
operationId: APICollections_OffboardAzureApiManagementApi
tags:
- APIMConfig
summary: Offboard an Azure API Management API from Microsoft Defender for APIs
description: Offboard an Azure API Management API from Microsoft Defender for APIs. The system will stop monitoring the operations within the Azure API Management API for intrusive behaviors.
parameters:
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: serviceName
in: path
description: The name of the API Management service.
required: true
schema:
type: string
maxLength: 50
minLength: 1
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
- name: apiId
in: path
description: API revision identifier. Must be unique in the API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
required: true
schema:
type: string
maxLength: 256
minLength: 1
pattern: ^[^*#&+:<>?]+$
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Offboard an Azure API Management API from Microsoft Defender for APIs:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2023-11-15/examples/ApiCollections/APICollections_OffboardAzureApiManagementApi_example.json
x-source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2023-11-15/apiCollections.json
components:
schemas:
ApiCollectionList:
type: object
description: Page of a list of API collections as represented by Microsoft Defender for APIs.
properties:
value:
type: array
description: API collections in this page.
items:
$ref: '#/components/schemas/ApiCollection'
readOnly: true
nextLink:
type: string
description: The URI to fetch the next page.
readOnly: true
ApiCollectionProperties:
type: object
description: Describes the properties of an API collection.
properties:
provisioningState:
$ref: '#/components/schemas/Common.ProvisioningState'
description: Gets the provisioning state of the API collection.
readOnly: true
displayName:
type: string
description: The display name of the API collection.
readOnly: true
discoveredVia:
type: string
format: arm-id
description: The resource Id of the resource from where this API collection was discovered.
readOnly: true
x-ms-arm-id-details:
allowedResources:
- type: Microsoft.ApiManagement/service
baseUrl:
type: string
format: uri
description: The base URI for this API collection. All endpoints of this API collection extend this base URI.
readOnly: true
numberOfApiEndpoints:
type: integer
format: int64
description: The number of API endpoints discovered in this API collection.
readOnly: true
numberOfInactiveApiEndpoints:
type: integer
format: int64
description: The number of API endpoints in this API collection that have not received any API traffic in the last 30 days.
readOnly: true
numberOfUnauthenticatedApiEndpoints:
type: integer
format: int64
description: The number of API endpoints in this API collection that are unauthenticated.
readOnly: true
numberOfExternalApiEndpoints:
type: integer
format: int64
description: The number of API endpoints in this API collection for which API traffic from the internet was observed.
readOnly: true
numberOfApiEndpointsWithSensitiveDataExposed:
type: integer
format: int64
description: The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses.
readOnly: true
sensitivityLabel:
type: string
description: The highest priority sensitivity label from Microsoft Purview in this API collection.
readOnly: true
Common.ProvisioningState:
type: string
description: The current provisioning state of the resource. Indicates the status of the last operation performed on the resource.
enum:
- Succeeded
- Creating
- Updating
- Deleting
- Failed
- Canceled
- InProgress
x-ms-enum:
name: ProvisioningState
modelAsString: true
values:
- name: Succeeded
value: Succeeded
description: The resource has been successfully provisioned and is ready for use.
- name: Creating
value: Creating
description: The resource is being created. This is a transitional state.
- name: Updating
value: Updating
description: The resource is being updated. This is a transitional state.
- name: Deleting
value: Deleting
description: The resource is being deleted. This is a transitional state.
- name: Failed
value: Failed
description: The last operation on the resource failed. Check the error details for more information.
- name: Canceled
value: Canceled
description: The operation was canceled before completion.
- name: InProgress
value: InProgress
description: InProgress
ApiCollection:
type: object
description: An API collection as represented by Microsoft Defender for APIs.
properties:
properties:
$ref: '#/components/schemas/ApiCollectionProperties'
description: Describes the properties of an API collection.
x-ms-client-flatten: true
allOf:
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/types.json#/definitions/ProxyResource
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.