Open documentation ↗Overview
API spec for Microsoft.Security (Azure Security Center) resource provider
Security Center is a cloud platforms API from azure.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 123 endpoints.
At a glance
- Authentication
- OAuth
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Base URL
https://management.azure.com- Version
- 2019-01-01-preview
- Endpoints
- 123
- OpenAPI
- Specification ↗
- Spec updated
- 2020-03-17
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://management.azure.com/providers/Microsoft.Security/assessmentMetadata" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN"const response = await fetch("https://management.azure.com/providers/Microsoft.Security/assessmentMetadata", {
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.Security/assessmentMetadata",
headers={
"Accept": "application/json",
"Authorization": "Bearer YOUR_TOKEN",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings | Gets a list of Adaptive Network Hardenings resources in scope of an extended resource. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings/{adaptiveNetworkHardeningResourceName} | Gets a single Adaptive Network Hardening resource |
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings/{adaptiveNetworkHardeningResourceName}/{adaptiveNetworkHardeningEnforceAction} | Enforces the given rules on the NSG(s) listed in the request |
| GET | /{resourceId}/providers/Microsoft.Security/advancedThreatProtectionSettings/{settingName} | Gets the Advanced Threat Protection settings for the specified resource. |
| PUT | /{resourceId}/providers/Microsoft.Security/advancedThreatProtectionSettings/{settingName} | Creates or updates the Advanced Threat Protection settings on a specified resource. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/alerts | List all the alerts that are associated with the subscription |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts | List all the alerts that are associated with the subscription that are stored in a specific location |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName} | Get an alert that is associated with a subscription |
| POST | /subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/dismiss | Update the alert's state |
| POST | /subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/reactivate | Update the alert's state |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/alerts | List all the alerts that are associated with the resource group |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts | List all the alerts that are associated with the resource group that are stored in a specific location |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName} | Get an alert that is associated a resource group or a resource in a resource group |
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/dismiss | Update the alert's state |
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/reactivate | Update the alert's state |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/allowedConnections | Gets the list of all possible traffic between resources for the subscription |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/allowedConnections | Gets the list of all possible traffic between resources for the subscription and location. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/allowedConnections/{connectionType} | Gets the list of all possible traffic between resources for the subscription and location, based on connection type. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/applicationWhitelistings | Gets a list of application control VM/server groups for the subscription. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/applicationWhitelistings/{groupName} | Gets an application control VM/server group. |
| PUT | /subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/applicationWhitelistings/{groupName} | Update an application control VM/server group |
| GET | /providers/Microsoft.Security/assessmentMetadata | Get metadata information on all assessment types |
| GET | /providers/Microsoft.Security/assessmentMetadata/{assessmentMetadataName} | Get metadata information on an assessment type |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/assessmentMetadata | Get metadata information on all assessment types in a specific subscription |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/assessmentMetadata/{assessmentMetadataName} | Get metadata information on an assessment type in a specific subscription |
| PUT | /subscriptions/{subscriptionId}/providers/Microsoft.Security/assessmentMetadata/{assessmentMetadataName} | Create metadata information on an assessment type in a specific subscription |
| DELETE | /subscriptions/{subscriptionId}/providers/Microsoft.Security/assessmentMetadata/{assessmentMetadataName} | Delete metadata information on an assessment type in a specific subscription, will cause the deletion of all the assessments of that type in that subscription |
| GET | /{resourceId}/providers/Microsoft.Security/assessments/{assessmentName} | Get a security assessment on your scanned resource |
| PUT | /{resourceId}/providers/Microsoft.Security/assessments/{assessmentName} | Create a security assessment on your resource. An assessment metadata that describes this assessment must be predefined with the same name before inserting the |
| DELETE | /{resourceId}/providers/Microsoft.Security/assessments/{assessmentName} | Delete a security assessment on your resource. An assessment metadata that describes this assessment must be predefined with the same name before inserting the |
| GET | /{scope}/providers/Microsoft.Security/assessments | Get security assessments on all your scanned resources inside a scope |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/autoProvisioningSettings | Exposes the auto provisioning settings of the subscriptions |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/autoProvisioningSettings/{settingName} | Details of a specific setting |
| PUT | /subscriptions/{subscriptionId}/providers/Microsoft.Security/autoProvisioningSettings/{settingName} | Details of a specific setting |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/automations | Lists all the security automations in the specified subscription. Use the 'nextLink' property in the response to get the next page of security automations for t |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations | Lists all the security automations in the specified resource group. Use the 'nextLink' property in the response to get the next page of security automations for |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName} | Retrieves information about the model of a security automation. |
| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName} | Creates or updates a security automation. If a security automation is already created and a subsequent request is issued for the same automation id, then it wil |
| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName} | Deletes a security automation. |
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName}/validate | Validates the security automation model before create or update. Any validation errors are returned to the client. |
| GET | /{resourceId}/providers/Microsoft.Security/complianceResults/{complianceResultName} | Security Compliance Result |
| GET | /{scope}/providers/Microsoft.Security/complianceResults | Security compliance results in the subscription |
| GET | /{scope}/providers/Microsoft.Security/compliances | The Compliance scores of the specific management group. |
| GET | /{scope}/providers/Microsoft.Security/compliances/{complianceName} | Details of a specific Compliance. |
| GET | /{resourceId}/providers/Microsoft.Security/deviceSecurityGroups | Use this method get the list of device security groups for the specified IoT Hub resource. |
| GET | /{resourceId}/providers/Microsoft.Security/deviceSecurityGroups/{deviceSecurityGroupName} | Use this method to get the device security group for the specified IoT Hub resource. |
| PUT | /{resourceId}/providers/Microsoft.Security/deviceSecurityGroups/{deviceSecurityGroupName} | Use this method to creates or updates the device security group on a specified IoT Hub resource. |
| DELETE | /{resourceId}/providers/Microsoft.Security/deviceSecurityGroups/{deviceSecurityGroupName} | User this method to deletes the device security group. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/discoveredSecuritySolutions | Gets a list of discovered Security Solutions for the subscription. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/discoveredSecuritySolutions | Gets a list of discovered Security Solutions for the subscription and location. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/discoveredSecuritySolutions/{discoveredSecuritySolutionName} | Gets a specific discovered Security Solution. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/externalSecuritySolutions | Gets a list of external security solutions for the subscription. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/ExternalSecuritySolutions | Gets a list of external Security Solutions for the subscription and location. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/ExternalSecuritySolutions/{externalSecuritySolutionsName} | Gets a specific external Security Solution. |
| GET | /{scope}/providers/Microsoft.Security/informationProtectionPolicies | Information protection policies of a specific management group. |
| GET | /{scope}/providers/Microsoft.Security/informationProtectionPolicies/{informationProtectionPolicyName} | Details of the information protection policy. |
| PUT | /{scope}/providers/Microsoft.Security/informationProtectionPolicies/{informationProtectionPolicyName} | Details of the information protection policy. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/analyticsModels | Use this method to get IoT security Analytics metrics in an array. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/analyticsModels/default | Use this method to get IoT Security Analytics metrics. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/analyticsModels/default/aggregatedAlerts | Use this method to get the aggregated alert list of yours IoT Security solution. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/analyticsModels/default/aggregatedAlerts/{aggregatedAlertName} | Use this method to get a single the aggregated alert of yours IoT Security solution. This aggregation is performed by alert name. |
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/analyticsModels/default/aggregatedAlerts/{aggregatedAlertName}/dismiss | Use this method to dismiss an aggregated IoT Security Solution Alert. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/analyticsModels/default/aggregatedRecommendations | Use this method to get the list of aggregated security analytics recommendations of yours IoT Security solution. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/analyticsModels/default/aggregatedRecommendations/{aggregatedRecommendationName} | Use this method to get the aggregated security analytics recommendation of yours IoT Security solution. This aggregation is performed by recommendation name. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/iotSecuritySolutions | Use this method to get the list of IoT Security solutions by subscription. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions | Use this method to get the list IoT Security solutions organized by resource group. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName} | User this method to get details of a specific IoT Security solution based on solution name |
| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName} | Use this method to create or update yours IoT Security solution |
| PATCH | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName} | Use this method to update existing IoT Security solution tags or user defined resources. To update other fields use the CreateOrUpdate method. |
| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName} | Use this method to delete yours IoT Security solution |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/jitNetworkAccessPolicies | Policies for protecting resources using Just-in-Time access control. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies | Policies for protecting resources using Just-in-Time access control for the subscription, location |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/jitNetworkAccessPolicies | Policies for protecting resources using Just-in-Time access control for the subscription, location |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies | Policies for protecting resources using Just-in-Time access control for the subscription, location |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies/{jitNetworkAccessPolicyName} | Policies for protecting resources using Just-in-Time access control for the subscription, location |
| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies/{jitNetworkAccessPolicyName} | Create a policy for protecting resources using Just-in-Time access control |
| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies/{jitNetworkAccessPolicyName} | Delete a Just-in-Time access control policy. |
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies/{jitNetworkAccessPolicyName}/{jitNetworkAccessPolicyInitiateType} | Initiate a JIT access from a specific Just-in-Time policy configuration. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/locations | The location of the responsible ASC of the specific subscription (home region). For each subscription there is only one responsible location. The location in th |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation} | Details of a specific location |
| GET | /providers/Microsoft.Security/operations | Exposes all available operations for discovery purposes. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings | Lists Security Center pricing configurations in the subscription. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName} | Gets a provided Security Center pricing configuration in the subscription. |
| PUT | /subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName} | Updates a provided Security Center pricing configuration in the subscription. |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/regulatoryComplianceStandards | Supported regulatory compliance standards details and state |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName} | Supported regulatory compliance details state for selected standard |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName}/regulatoryComplianceControls | All supported regulatory compliance controls details and state for selected standard |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName}/regulatoryComplianceControls/{regulatoryComplianceControlName} | Selected regulatory compliance control details and state |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName}/regulatoryComplianceControls/{regulatoryComplianceControlName}/regulatoryComplianceAssessments | Details and state of assessments mapped to selected regulatory compliance control |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName}/regulatoryComplianceControls/{regulatoryComplianceControlName}/regulatoryComplianceAssessments/{regulatoryComplianceAssessmentName} | Supported regulatory compliance details and state for selected assessment |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts | Security contact configurations for the subscription |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName} | Security contact configurations for the subscription |
| PUT | /subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName} | Security contact configurations for the subscription |
| PATCH | /subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName} | Security contact configurations for the subscription |
| DELETE | /subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName} | Security contact configurations for the subscription |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/serverVulnerabilityAssessments | Gets a list of server vulnerability assessment onboarding statuses on a given resource. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/serverVulnerabilityAssessments/{serverVulnerabilityAssessment} | Gets a server vulnerability assessment onboarding statuses on a given resource. |
| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/serverVulnerabilityAssessments/{serverVulnerabilityAssessment} | Creating a server vulnerability assessment on a resource, which will onboard a resource for having a vulnerability assessment on it |
| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/serverVulnerabilityAssessments/{serverVulnerabilityAssessment} | Removing server vulnerability assessment from a resource. |
| GET | /{scope}/providers/Microsoft.Security/assessments/{assessmentName}/subAssessments | Get security sub-assessments on all your scanned resources inside a scope |
Showing the first 100 of 123 endpoints; the full list is in the documentation.
Questions
Does the Security Center API need an API key?
Yes. The Security Center API uses OAuth authentication; the documentation explains how to get credentials.
Does the Security Center API support HTTPS?
Yes, the Security Center API is served over HTTPS.
How many endpoints does the Security Center API have?
Its OpenAPI description lists 123 endpoints in version 2019-01-01-preview. The first 100 are shown on this page.
What are alternatives to the Security Center 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).