Open documentation ↗Overview
REST APIs for Azure Active Directory Connect Health
ADHybridHealthService is a cloud platforms API from azure.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 74 endpoints.
At a glance
- Authentication
- OAuth
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Base URL
https://management.azure.com- Version
- 2014-01-01
- Endpoints
- 74
- OpenAPI
- Specification ↗
- Spec updated
- 2018-11-20
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://management.azure.com/providers/Microsoft.ADHybridHealthService/addsservices" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN"const response = await fetch("https://management.azure.com/providers/Microsoft.ADHybridHealthService/addsservices", {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": "Bearer YOUR_TOKEN",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://management.azure.com/providers/Microsoft.ADHybridHealthService/addsservices",
headers={
"Accept": "application/json",
"Authorization": "Bearer YOUR_TOKEN",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /providers/Microsoft.ADHybridHealthService/addsservices | Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health. |
| POST | /providers/Microsoft.ADHybridHealthService/addsservices | Onboards a service for a given tenant in Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/premiumCheck | Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName} | Gets the details of an Active Directory Domain Service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health. |
| PATCH | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName} | Updates an Active Directory Domain Service properties of an onboarded service. |
| DELETE | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName} | Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addomainservicemembers | Gets the details of the servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers | Gets the details of the Active Directory Domain servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Healt |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts | Gets the alerts for a given Active Directory Domain Service. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration | Gets the service configurations. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/dimensions/{dimension} | Gets the dimensions for a given dimension type in a server. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference | Gets the user preferences for a given feature. |
| POST | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference | Adds the user preferences for a given feature. |
| DELETE | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference | Deletes the user preferences for a given feature. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/forestsummary | Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata | Gets the service related metrics information. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName} | Gets the service related metric information. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}/groups/{groupName} | Gets the service related metrics for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName} | Gets the server related metrics for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/average | Gets the average of the metric values for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/sum | Gets the sum of the metric values for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationdetails | Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Con |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationstatus | Gets Replication status for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationsummary | Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Con |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers | Gets the details of the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service. |
| POST | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers | Onboards a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId} | Gets the details of a server, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service. |
| DELETE | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId} | Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/alerts | Gets the details of an alert for a given Active Directory Domain Controller service and server combination. |
| GET | /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/credentials | Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service. |
| GET | /providers/Microsoft.ADHybridHealthService/configuration | Gets the details of a tenant onboarded to Azure Active Directory Connect Health. |
| POST | /providers/Microsoft.ADHybridHealthService/configuration | Onboards a tenant in Azure Active Directory Connect Health. |
| PATCH | /providers/Microsoft.ADHybridHealthService/configuration | Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/operations | Lists the available Azure Data Factory API operations. |
| GET | /providers/Microsoft.ADHybridHealthService/reports/DevOps/IsDevOps | Checks if the user is enabled for Dev Ops access. |
| GET | /providers/Microsoft.ADHybridHealthService/service/{serviceName}/servicemembers/{serviceMemberId}/connectors | Gets the connector details for a service. |
| GET | /providers/Microsoft.ADHybridHealthService/services | Gets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health. |
| POST | /providers/Microsoft.ADHybridHealthService/services | Onboards a service for a given tenant in Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/services/premiumCheck | Gets the details of services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName} | Gets the details of a service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health. |
| PATCH | /providers/Microsoft.ADHybridHealthService/services/{serviceName} | Updates the service properties of an onboarded service. |
| DELETE | /providers/Microsoft.ADHybridHealthService/services/{serviceName} | Deletes a service which is onboarded to Azure Active Directory Connect Health. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/TenantWhitelisting/{featureName} | Checks if the tenant, to which a service is registered, is whitelisted to use a feature. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/alerts | Gets the alerts for a given service. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/checkServiceFeatureAvailibility/{featureName} | Checks if the service has all the pre-requisites met to use a feature. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/counts | Gets the count of latest AAD export errors. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/listV2 | Gets the categorized export errors. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exportstatus | Gets the export status. |
| POST | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/feedback | Adds an alert feedback submitted by customer. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/{shortName}/alertfeedback | Gets a list of all alert feedback for a given tenant and alert type. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata | Gets the service related metrics information. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName} | Gets the service related metrics information. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}/groups/{groupName} | Gets the service related metrics for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName} | Gets the server related metrics for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/average | Gets the average of the metric values for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/sum | Gets the sum of the metric values for a given metric and group combination. |
| PATCH | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfiguration | Updates the service level monitoring configuration. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfigurations | Gets the service level monitoring configurations. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/badpassword/details/user | Gets the bad password login attempt report for an user |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/riskyIp/blobUris | Gets all Risky IP report URIs for the last 7 days. |
| POST | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/riskyIp/generateBlobUri | Initiate the generation of a new Risky IP report. Returns the URI for the new one. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers | Gets the details of the servers, for a given service, that are onboarded to Azure Active Directory Connect Health Service. |
| POST | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers | Onboards a server, for a given service, to Azure Active Directory Connect Health Service. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId} | Gets the details of a server, for a given service, that are onboarded to Azure Active Directory Connect Health Service. |
| DELETE | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId} | Deletes a server that has been onboarded to Azure Active Directory Connect Health Service. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/alerts | Gets the details of an alert for a given service and server combination. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/credentials | Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service. |
| DELETE | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/data | Deletes the data uploaded by the server to Azure Active Directory Connect Health Service. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/datafreshness | Gets the last time when the server uploaded data to Azure Active Directory Connect Health Service. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/exportstatus | Gets the export status. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/globalconfiguration | Gets the global configuration. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName} | Gets the list of connectors and run profile names. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}/groups/{groupName} | Gets the server related metrics for a given metric and group combination. |
| GET | /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/serviceconfiguration | Gets the service configuration. |
Questions
Does the ADHybridHealthService API need an API key?
Yes. The ADHybridHealthService API uses OAuth authentication; the documentation explains how to get credentials.
Does the ADHybridHealthService API support HTTPS?
Yes, the ADHybridHealthService API is served over HTTPS.
How many endpoints does the ADHybridHealthService API have?
Its OpenAPI description lists 74 endpoints in version 2014-01-01. All of them are shown on this page.
What are alternatives to the ADHybridHealthService API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
Linode API
Cloud Platforms## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se
DigitalOcean API
Cloud Platforms# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).