How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Endpoints API

The Endpoints API from Microsoft Azure — 16 operation(s) for endpoints.

Microsoft Azure Endpoints API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 27 operations across 16 paths, and defines 53 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

27 operations 16 paths 53 schemas 4 DELETE8 GET3 PATCH8 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 27

Across 16 paths, the API surfaces 27 operations — 4 DELETE, 8 GET, 3 PATCH, 8 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Endpoints 27
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Digitaltwins Digitaltwinsinstances Resourcename Endpoints
microsoftAzureDigitaltwinsendpointList 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Digitaltwins Digitaltwinsinstances Resourcename Endpoints Endpointname
microsoftAzureDigitaltwinsendpointGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Digitaltwins Digitaltwinsinstances Resourcename Endpoints Endpointname
microsoftAzureDigitaltwinsendpointCreateorupdate 5 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Digitaltwins Digitaltwinsinstances Resourcename Endpoints Endpointname
microsoftAzureDigitaltwinsendpointDelete 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints
microsoftAzureEndpointsListbyprofile 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname
microsoftAzureEndpointsGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname
microsoftAzureEndpointsCreate 5 params body → 200201202default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname
microsoftAzureEndpointsUpdate 5 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname
microsoftAzureEndpointsDelete 5 params → 200202204default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Start
microsoftAzureEndpointsStart 5 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Stop
microsoftAzureEndpointsStop 5 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Purge
microsoftAzureEndpointsPurgecontent 5 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Load
microsoftAzureEndpointsLoadcontent 5 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Validatecustomdomain
microsoftAzureEndpointsValidatecustomdomain 5 params body → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Checkresourceusage
microsoftAzureEndpointsListresourceusage 5 params → 200default
GET
/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints
Microsoft Azure Get Resourceuri Providers Microsoft Hybridconnectivity Endpoints
microsoftAzureEndpointsList 2 params → 200default
GET
/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}
Microsoft Azure Get Resourceuri Providers Microsoft Hybridconnectivity Endpoints Endpointname
microsoftAzureEndpointsGet 3 params → 200default
PUT
/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}
Microsoft Azure Put Resourceuri Providers Microsoft Hybridconnectivity Endpoints Endpointname
microsoftAzureEndpointsCreateorupdate 3 params body → 200default
PATCH
/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}
Microsoft Azure Patch Resourceuri Providers Microsoft Hybridconnectivity Endpoints Endpointname
microsoftAzureEndpointsUpdate 3 params body → 200default
DELETE
/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}
Microsoft Azure Delete Resourceuri Providers Microsoft Hybridconnectivity Endpoints Endpointname
microsoftAzureEndpointsDelete 3 params → 200204default
POST
/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listCredentials
Microsoft Azure Post Resourceuri Providers Microsoft Hybridconnectivity Endpoints Endpointname Listcredentials
microsoftAzureEndpointsListcredentials 4 params → 200default
POST
/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listManagedProxyDetails
Microsoft Azure Post Resourceuri Providers Microsoft Hybridconnectivity Endpoints Endpointname Listmanagedproxydetails
microsoftAzureEndpointsListmanagedproxydetails 3 params body → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagemover Storagemovers Storagemovername Endpoints
microsoftAzureEndpointsList 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints/{endpointName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagemover Storagemovers Storagemovername Endpoints Endpointname
microsoftAzureEndpointsGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints/{endpointName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagemover Storagemovers Storagemovername Endpoints Endpointname
microsoftAzureEndpointsCreateorupdate 5 params body → 200default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints/{endpointName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagemover Storagemovers Storagemovername Endpoints Endpointname
microsoftAzureEndpointsUpdate 5 params body → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints/{endpointName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagemover Storagemovers Storagemovername Endpoints Endpointname
microsoftAzureEndpointsDelete 5 params → 200202204default

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are EndpointPropertiesUpdateParameters (14 properties), DeepCreatedOriginProperties (12 properties), EndpointProperties (6 properties), KeyVaultSigningKeyParameters (6 properties). Each schema is shown below with its type and property counts.

PrivateEndpointStatus
string
The approval status for the connection to the Private Link
DeepCreatedCustomDomainProperties
object
Properties of the custom domain created on the CDN endpoint.
2 properties 1 required
DeepCreatedOrigin
object
The main origin of CDN content which is added when creating a CDN endpoint.
2 properties 1 required
RelayNamespaceAccessProperties
object
Azure relay hybrid connection access properties
5 properties 3 required
HealthProbeParameters
object
The JSON object that contains the properties to send health probes to origin.
4 properties
EndpointListResult
object
Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.
2 properties
Endpoint
object
CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN e…
1 property
DeliveryRuleAction
object
An action for the delivery rule.
1 property 1 required
PurgeParameters
object
Parameters required for content purge.
1 property 1 required
ErrorResponse_2
object
Error response indicates Azure Front Door Standard or Azure Front Door Premium or CDN service is not able to process the incoming request. The reason is provid…
1 property
EndpointUpdateParameters
object
Properties required to create or update an endpoint.
2 properties
EndpointBaseUpdateParameters
object
The Endpoint resource.
1 property
ResourceUsage
object
Output of check resource usage API.
4 properties
EndpointProperties
object
The JSON object that contains the properties required to create an endpoint.
6 properties 1 required
ExternalResource
object
Definition of a Resource.
3 properties
DigitalTwinsEndpointResourceListResult
object
A list of DigitalTwinsInstance Endpoints with a next link.
2 properties
DeepCreatedCustomDomain
object
Custom domains created on the CDN endpoint.
2 properties 1 required
ResourceReference
object
Reference to another resource.
1 property
ResponseBasedOriginErrorDetectionParameters
object
The JSON object that contains the properties to determine origin health using real requests/responses.
3 properties
EndpointProperties_2
object
Endpoint details
3 properties 1 required
DigitalTwinsEndpointResource
object
DigitalTwinsInstance endpoint resource.
1 property
Resource
object
The core properties of ARM resources
4 properties
EndpointsList
object
The list of endpoints.
2 properties
UrlSigningKey
object
Url signing key
2 properties 2 required
ValidateCustomDomainInput
object
Input of the custom domain to be validated for DNS mapping.
1 property 1 required
IdentityType
string
The type of identity that creates/modifies resources
DigitalTwinsEndpointResourceProperties
object
Properties related to Digital Twins Endpoint
4 properties 1 required
EndpointPropertiesUpdateParameters
object
The JSON object containing endpoint update parameters.
14 properties
ValidateCustomDomainOutput
object
Output of custom domain validation.
3 properties
EndpointAccessResource
object
The endpoint access for the target resource.
1 property
DeepCreatedOriginGroup
object
The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health.
2 properties 1 required
DeliveryRule
object
A rule that specifies a set of actions and conditions
4 properties 2 required
HttpErrorRangeParameters
object
The JSON object that represents the range for http status codes
2 properties
SystemData
object
Read only system data
6 properties
DeliveryRuleCondition
object
A condition for the delivery rule.
1 property 1 required
ErrorDefinition
object
Error definition.
3 properties
GeoFilter
object
Rules defining user's geo access within a CDN endpoint.
3 properties 3 required
ResourceUsageListResult
object
Output of check resource usage API.
2 properties
KeyVaultSigningKeyParameters
object
Describes the parameters for using a user's KeyVault for URL Signing Key.
6 properties 6 required
ManagedProxyResource
object
Managed Proxy
2 properties 2 required
ErrorResponse
object
Error response.
1 property
QueryStringCachingBehavior
string
Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain quer…
EndpointList
object
List of Endpoints.
2 properties
DeepCreatedOriginProperties
object
Properties of the origin created on the CDN endpoint.
12 properties 1 required
ManagedProxyRequest
object
Represent ManageProxy Request object.
2 properties 1 required
TrackedResource
object
The resource model definition for a ARM tracked top level resource.
2 properties 1 required
EndpointBaseProperties
object
The resource specific properties for the Storage Mover resource.
3 properties 1 required
Endpoint_2
object
The Endpoint resource, which contains information about file sources and targets.
2 properties 1 required
EndpointBaseUpdateProperties
object
The Endpoint resource, which contains information about file sources and targets.
1 property
DeepCreatedOriginGroupProperties
object
Properties of the origin group created on the CDN endpoint.
4 properties 1 required
OptimizationType
string
Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven opt…
LoadParameters
object
Parameters required for content load.
1 property 1 required
EndpointResource
object
The endpoint for the target resource.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-endpoints-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Endpoints API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.