Microsoft Fabric Managed Private Endpoints API
The ManagedPrivateEndpoints API from Microsoft Fabric — 2 operation(s) for managedprivateendpoints.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-fabric:microsoft-fabric-managedprivateendpoints-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
openapi: 3.2.0
info:
title: Microsoft Fabric Platform REST Managed Private Endpoints API
version: v1
x-source: 'https://github.com/microsoft/fabric-rest-api-specs (bundled from openapi/_original/fabric-rest-api-specs: platform/swagger.json)'
servers:
- url: https://api.fabric.microsoft.com/v1
security: []
tags:
- name: ManagedPrivateEndpoints
paths:
/workspaces/{workspaceId}/managedPrivateEndpoints:
get:
summary: Returns a list of managed private endpoints associated with the specified…
description: '## Permissions
The caller must have *viewer* or higher workspace role.
## Required Delegated Scopes
Workspace.Read.All or Workspace.ReadWrite.All
## Microsoft Entra supported identities
This API supports the Microsoft identities listed in this section.
| Identity | Support |
|-|-|
| User | Yes |
| Service principal and Managed identities | Yes |
## Interface'
tags:
- ManagedPrivateEndpoints
operationId: ManagedPrivateEndpoints_ListWorkspaceManagedPrivateEndpoints
x-ms-pageable:
nextLinkName: continuationUri
parameters:
- in: path
name: workspaceId
description: The workspace ID.
required: true
schema:
type: string
format: uuid
- in: query
name: continuationToken
description: A token for retrieving the next page of results.
required: false
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedPrivateEndpoints'
'429':
description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
x-ms-error-response: true
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
default:
description: 'Common error codes:
* UnknownError - An error occurred.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
summary: Creates a managed private endpoint in the specified workspace
description: '## Permissions
The caller must have *admin* workspace role.
## Required Delegated Scopes
Workspace.ReadWrite.All.
## Limitations
- To create managed private endpoint the workspace must be on a supported Fabric capacity. For more information see: Microsoft Fabric license types.
## Microsoft Entra supported identities
This API supports the Microsoft identities listed in this section.
| Identity | Support |
|-|-|
| User | Yes |
| Service principal and Managed identities | Yes |
## Interface'
tags:
- ManagedPrivateEndpoints
operationId: ManagedPrivateEndpoints_CreateWorkspaceManagedPrivateEndpoint
parameters:
- in: path
name: workspaceId
description: The workspace ID.
required: true
schema:
type: string
format: uuid
responses:
'201':
description: Request completed successfully.
headers:
Location:
description: The URL of the created managed private endpoint.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedPrivateEndpoint'
'429':
description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
x-ms-error-response: true
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
default:
description: 'Common error codes:
* UnknownError - An error occurred.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateManagedPrivateEndpointRequest'
description: Create managed private endpoint request payload.
required: true
/workspaces/{workspaceId}/managedPrivateEndpoints/{managedPrivateEndpointId}:
delete:
summary: Deletes the specified managed private endpoint
description: '## Permissions
The caller must have *admin* workspace role.
## Required Delegated Scopes
Workspace.ReadWrite.All
## Microsoft Entra supported identities
This API supports the Microsoft identities listed in this section.
| Identity | Support |
|-|-|
| User | Yes |
| Service principal and Managed identities | Yes |
## Interface'
tags:
- ManagedPrivateEndpoints
operationId: ManagedPrivateEndpoints_DeleteWorkspaceManagedPrivateEndpoint
parameters:
- in: path
name: workspaceId
description: The workspace ID.
required: true
schema:
type: string
format: uuid
- in: path
name: managedPrivateEndpointId
description: The managed private endpoint ID.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Request completed successfully.
'429':
description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
x-ms-error-response: true
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
default:
description: 'Common error codes:
* UnknownError - An error occurred.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
get:
summary: Gets the specified managed private endpoint
description: '## Permissions
The caller must have *viewer* or higher workspace role.
## Required Delegated Scopes
Workspace.Read.All or Workspace.ReadWrite.All
## Microsoft Entra supported identities
This API supports the Microsoft identities listed in this section.
| Identity | Support |
|-|-|
| User | Yes |
| Service principal and Managed identities | Yes |
## Interface'
tags:
- ManagedPrivateEndpoints
operationId: ManagedPrivateEndpoints_GetWorkspaceManagedPrivateEndpoint
parameters:
- in: path
name: workspaceId
description: The workspace ID.
required: true
schema:
type: string
format: uuid
- in: path
name: managedPrivateEndpointId
description: The managed private endpoint ID.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedPrivateEndpoint'
'429':
description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
x-ms-error-response: true
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
default:
description: 'Common error codes:
* UnknownError - An error occurred.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
ErrorResponse:
description: The error response.
required:
- message
- errorCode
allOf:
- $ref: '#/components/schemas/ErrorResponseDetails'
properties:
requestId:
type: string
format: uuid
description: ID of the request associated with the error.
readOnly: true
moreDetails:
description: List of additional error details.
type: array
items:
$ref: '#/components/schemas/ErrorResponseDetails'
readOnly: true
isRetriable:
type: boolean
description: When true, the request can be retried. Use the `Retry-After` response header to determine the delay, if available.
readOnly: true
ManagedPrivateEndpoint:
description: Managed private endpoint.
type: object
properties:
id:
format: uuid
description: Managed private endpoint Id.
type: string
name:
description: The private endpoint name.
type: string
targetPrivateLinkResourceId:
description: Resource Id of data source for which private endpoint is created
type: string
targetSubresourceType:
description: Sub-resource pointing to [Private-link resoure](/azure/private-link/private-endpoint-overview#private-link-resource).
type: string
provisioningState:
$ref: '#/components/schemas/ProvisioningState'
connectionState:
$ref: '#/components/schemas/PrivateEndpointConnectionState'
ConnectionStatus:
description: Private endpoint connection status. Additional connection status may be added over time.
type: string
enum:
- Pending
- Approved
- Rejected
- Disconnected
x-ms-enum:
name: ConnectionStatus
modelAsString: true
values:
- value: Pending
description: Pending approval
- value: Approved
description: Endpoint approved
- value: Rejected
description: Endpoint rejected
- value: Disconnected
description: Endpoint disconnected
ManagedPrivateEndpoints:
required:
- value
type: object
properties:
value:
description: A list of managed private endpoints.
type: array
items:
$ref: '#/components/schemas/ManagedPrivateEndpoint'
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
CreateManagedPrivateEndpointRequest:
description: Create managed private endpoint request payload.
required:
- name
- targetPrivateLinkResourceId
properties:
name:
description: The private endpoint name. Should not be more than 64 characters.
type: string
readOnly: false
targetPrivateLinkResourceId:
description: Resource Id of data source for which private endpoint needs to be created.
type: string
readOnly: false
targetSubresourceType:
description: Sub-resource pointing to [Private-link resoure](/azure/private-link/private-endpoint-overview#private-link-resource).
type: string
readOnly: false
requestMessage:
description: Message to approve private endpoint request. Should not be more than 140 characters.
type: string
readOnly: false
targetFQDNs:
description: Fully qualified domain names (FQDNs) to be associated with the private endpoint. Should not be more than 20 FQDNs.
type: array
items:
type: string
readOnly: false
ErrorResponseDetails:
description: The error response details.
type: object
required:
- message
- errorCode
properties:
errorCode:
type: string
description: A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
readOnly: true
message:
type: string
description: A human readable representation of the error.
readOnly: true
relatedResource:
$ref: '#/components/schemas/ErrorRelatedResource'
parameters:
description: Structured parameters providing additional machine-readable context about the error.
type: array
items:
$ref: '#/components/schemas/ErrorParameter'
readOnly: true
ErrorRelatedResource:
description: The error related resource details object.
type: object
required:
- resourceId
- resourceType
properties:
resourceId:
type: string
description: The resource ID that's involved in the error.
readOnly: true
resourceType:
type: string
description: The type of the resource that's involved in the error.
readOnly: true
PaginatedResponse:
properties:
continuationToken:
type: string
description: The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri:
type: string
description: The URI of the next result set batch. If there are no more records, it's removed from the response.
ErrorParameter:
description: A structured parameter providing additional machine-readable context about an error.
type: object
properties:
name:
type: string
description: The parameter identifier.
readOnly: true
value:
type: string
description: The parameter value.
readOnly: true
message:
type: string
description: A human-readable description of the parameter's meaning.
readOnly: true
PrivateEndpointConnectionState:
description: Private endpoint connection state
type: object
properties:
status:
$ref: '#/components/schemas/ConnectionStatus'
description:
description: Description message (if any) provided on approving or rejecting the end point.
type: string
actionsRequired:
description: Actions required to establish connection.
type: string
ProvisioningState:
type: string
description: PrivateEndpointProvisioningState type. Additional Provisioning state may be added over time.
enum:
- Provisioning
- Succeeded
- Updating
- Deleting
- Failed
x-ms-enum:
name: PrivateEndpointProvisioningState
modelAsString: true
values:
- value: Provisioning
description: Private endpoint in provisioning is in-progress
- value: Succeeded
description: Private endpoint provisioning Succeeded
- value: Updating
description: Private endpoint updating
- value: Deleting
description: Private endpoint deleting
- value: Failed
description: Private endpoint provisioning failed