The Private Endpoint Connections API from Microsoft Defender — 2 operation(s) for private endpoint connections.
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-private-endpoint-connections-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: Private Endpoint Connections
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/privateLinks/{privateLinkName}/privateEndpointConnections
: get:
operationId: PrivateEndpointConnections_List
tags:
- Private Endpoint Connections
description: Gets all private endpoint connections for a private link. Returns the list of private endpoints that are connected or in the process of connecting to this private link.
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: privateLinkName
in: path
description: The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
required: true
schema:
type: string
maxLength: 63
minLength: 3
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateEndpointConnectionListResult'
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:
List private endpoint connections:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2026-01-01/examples/PrivateEndpointConnections/PrivateEndpointConnections_List.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/2026-01-01/privateLinks.json
summary: Private endpoint connections list
x-summary-source: derived
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/privateLinks/{privateLinkName}/privateEndpointConnections/{privateEndpointConnectionName}
: get:
operationId: PrivateEndpointConnections_Get
tags:
- Private Endpoint Connections
description: Gets the specified private endpoint connection associated with the private link. Returns the connection details, status, and configuration for a specific private endpoint.
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: privateLinkName
in: path
description: The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
required: true
schema:
type: string
maxLength: 63
minLength: 3
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection
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:
Get private endpoint connection:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2026-01-01/examples/PrivateEndpointConnections/PrivateEndpointConnections_Get.json
x-source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2026-01-01/privateLinks.json
summary: Private endpoint connections get
x-summary-source: derived
put:
operationId: PrivateEndpointConnections_CreateOrUpdate
tags:
- Private Endpoint Connections
description: Update the state of specified private endpoint connection associated with the private link. This operation is typically used to approve or reject pending private endpoint connections.
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: privateLinkName
in: path
description: The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
required: true
schema:
type: string
maxLength: 63
minLength: 3
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName
responses:
'200':
description: Resource 'PrivateEndpointConnection' update operation succeeded
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection
'201':
description: Resource 'PrivateEndpointConnection' create operation succeeded
headers:
Azure-AsyncOperation:
description: A link to the status monitor
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: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection
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:
Create or update private endpoint connection:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2026-01-01/examples/PrivateEndpointConnections/PrivateEndpointConnections_CreateOrUpdate.json
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
final-state-schema: ../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection
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/2026-01-01/privateLinks.json
requestBody:
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection
description: The private endpoint connection resource.
required: true
summary: Private endpoint connections create or update
x-summary-source: derived
delete:
operationId: PrivateEndpointConnections_Delete
tags:
- Private Endpoint Connections
description: Deletes the specified private endpoint connection associated with the private link. This operation will disconnect the private endpoint and remove the connection configuration.
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: privateLinkName
in: path
description: The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
required: true
schema:
type: string
maxLength: 63
minLength: 3
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
- $ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName
responses:
'202':
description: Resource deletion accepted.
headers:
Azure-AsyncOperation:
description: A link to the status monitor
schema:
type: string
format: uri
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
'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:
Delete private endpoint connection:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/security/resource-manager/Microsoft.Security/Security/stable/2026-01-01/examples/PrivateEndpointConnections/PrivateEndpointConnections_Delete.json
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
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/2026-01-01/privateLinks.json
summary: Private endpoint connections delete
x-summary-source: derived
components:
schemas:
PrivateEndpointConnectionListResult:
type: object
description: The response of a PrivateEndpointConnection list operation.
properties:
value:
type: array
description: The PrivateEndpointConnection items on this page
items:
$ref: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
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.