Open documentation ↗Overview
The key vault client performs cryptographic key operations and vault operations against the Key Vault service.
KeyVaultClient is a cloud platforms API from azure.com. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 78 endpoints.
At a glance
- Authentication
- No auth
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Base URL
https://azure.local- Version
- 7.0-preview
- Endpoints
- 78
- OpenAPI
- Specification ↗
- Spec updated
- 2018-03-10
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://azure.local/certificates" \
-H "Accept: application/json"const response = await fetch("https://azure.local/certificates", {
method: "GET",
headers: {
"Accept": "application/json",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://azure.local/certificates",
headers={
"Accept": "application/json",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /certificates | List certificates in a specified key vault |
| GET | /certificates/contacts | Lists the certificate contacts for a specified key vault. |
| PUT | /certificates/contacts | Sets the certificate contacts for the specified key vault. |
| DELETE | /certificates/contacts | Deletes the certificate contacts for a specified key vault. |
| GET | /certificates/issuers | List certificate issuers for a specified key vault. |
| GET | /certificates/issuers/{issuer-name} | Lists the specified certificate issuer. |
| PUT | /certificates/issuers/{issuer-name} | Sets the specified certificate issuer. |
| PATCH | /certificates/issuers/{issuer-name} | Updates the specified certificate issuer. |
| DELETE | /certificates/issuers/{issuer-name} | Deletes the specified certificate issuer. |
| POST | /certificates/restore | Restores a backed up certificate to a vault. |
| DELETE | /certificates/{certificate-name} | Deletes a certificate from a specified key vault. |
| POST | /certificates/{certificate-name}/backup | Backs up the specified certificate. |
| POST | /certificates/{certificate-name}/create | Creates a new certificate. |
| POST | /certificates/{certificate-name}/import | Imports a certificate into a specified key vault. |
| GET | /certificates/{certificate-name}/pending | Gets the creation operation of a certificate. |
| PATCH | /certificates/{certificate-name}/pending | Updates a certificate operation. |
| DELETE | /certificates/{certificate-name}/pending | Deletes the creation operation for a specific certificate. |
| POST | /certificates/{certificate-name}/pending/merge | Merges a certificate or a certificate chain with a key pair existing on the server. |
| GET | /certificates/{certificate-name}/policy | Lists the policy for a certificate. |
| PATCH | /certificates/{certificate-name}/policy | Updates the policy for a certificate. |
| GET | /certificates/{certificate-name}/versions | List the versions of a certificate. |
| GET | /certificates/{certificate-name}/{certificate-version} | Gets information about a certificate. |
| PATCH | /certificates/{certificate-name}/{certificate-version} | Updates the specified attributes associated with the given certificate. |
| GET | /deletedcertificates | Lists the deleted certificates in the specified vault currently available for recovery. |
| GET | /deletedcertificates/{certificate-name} | Retrieves information about the specified deleted certificate. |
| DELETE | /deletedcertificates/{certificate-name} | Permanently deletes the specified deleted certificate. |
| POST | /deletedcertificates/{certificate-name}/recover | Recovers the deleted certificate back to its current version under /certificates. |
| GET | /deletedkeys | Lists the deleted keys in the specified vault. |
| GET | /deletedkeys/{key-name} | Gets the public part of a deleted key. |
| DELETE | /deletedkeys/{key-name} | Permanently deletes the specified key. |
| POST | /deletedkeys/{key-name}/recover | Recovers the deleted key to its latest version. |
| GET | /deletedsecrets | Lists deleted secrets for the specified vault. |
| GET | /deletedsecrets/{secret-name} | Gets the specified deleted secret. |
| DELETE | /deletedsecrets/{secret-name} | Permanently deletes the specified secret. |
| POST | /deletedsecrets/{secret-name}/recover | Recovers the deleted secret to the latest version. |
| GET | /deletedstorage | Lists deleted storage accounts for the specified vault. |
| GET | /deletedstorage/{storage-account-name} | Gets the specified deleted storage account. |
| DELETE | /deletedstorage/{storage-account-name} | Permanently deletes the specified storage account. |
| POST | /deletedstorage/{storage-account-name}/recover | Recovers the deleted storage account. |
| GET | /deletedstorage/{storage-account-name}/sas | Lists deleted SAS definitions for the specified vault and storage account. |
| GET | /deletedstorage/{storage-account-name}/sas/{sas-definition-name} | Gets the specified deleted sas definition. |
| POST | /deletedstorage/{storage-account-name}/sas/{sas-definition-name}/recover | Recovers the deleted SAS definition. |
| GET | /keys | List keys in the specified vault. |
| POST | /keys/restore | Restores a backed up key to a vault. |
| PUT | /keys/{key-name} | Imports an externally created key, stores it, and returns key parameters and attributes to the client. |
| DELETE | /keys/{key-name} | Deletes a key of any type from storage in Azure Key Vault. |
| POST | /keys/{key-name}/backup | Requests that a backup of the specified key be downloaded to the client. |
| POST | /keys/{key-name}/create | Creates a new key, stores it, then returns key parameters and attributes to the client. |
| GET | /keys/{key-name}/versions | Retrieves a list of individual key versions with the same key name. |
| GET | /keys/{key-name}/{key-version} | Gets the public part of a stored key. |
| PATCH | /keys/{key-name}/{key-version} | The update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault. |
| POST | /keys/{key-name}/{key-version}/decrypt | Decrypts a single block of encrypted data. |
| POST | /keys/{key-name}/{key-version}/encrypt | Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault. |
| POST | /keys/{key-name}/{key-version}/sign | Creates a signature from a digest using the specified key. |
| POST | /keys/{key-name}/{key-version}/unwrapkey | Unwraps a symmetric key using the specified key that was initially used for wrapping that key. |
| POST | /keys/{key-name}/{key-version}/verify | Verifies a signature using a specified key. |
| POST | /keys/{key-name}/{key-version}/wrapkey | Wraps a symmetric key using a specified key. |
| GET | /secrets | List secrets in a specified key vault. |
| POST | /secrets/restore | Restores a backed up secret to a vault. |
| PUT | /secrets/{secret-name} | Sets a secret in a specified key vault. |
| DELETE | /secrets/{secret-name} | Deletes a secret from a specified key vault. |
| POST | /secrets/{secret-name}/backup | Backs up the specified secret. |
| GET | /secrets/{secret-name}/versions | List all versions of the specified secret. |
| GET | /secrets/{secret-name}/{secret-version} | Get a specified secret from a given key vault. |
| PATCH | /secrets/{secret-name}/{secret-version} | Updates the attributes associated with a specified secret in a given key vault. |
| GET | /storage | List storage accounts managed by the specified key vault. This operation requires the storage/list permission. |
| POST | /storage/restore | Restores a backed up storage account to a vault. |
| GET | /storage/{storage-account-name} | Gets information about a specified storage account. This operation requires the storage/get permission. |
| PUT | /storage/{storage-account-name} | Creates or updates a new storage account. This operation requires the storage/set permission. |
| PATCH | /storage/{storage-account-name} | Updates the specified attributes associated with the given storage account. This operation requires the storage/set/update permission. |
| DELETE | /storage/{storage-account-name} | Deletes a storage account. This operation requires the storage/delete permission. |
| POST | /storage/{storage-account-name}/backup | Backs up the specified storage account. |
| POST | /storage/{storage-account-name}/regeneratekey | Regenerates the specified key value for the given storage account. This operation requires the storage/regeneratekey permission. |
| GET | /storage/{storage-account-name}/sas | List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission. |
| GET | /storage/{storage-account-name}/sas/{sas-definition-name} | Gets information about a SAS definition for the specified storage account. This operation requires the storage/getsas permission. |
| PUT | /storage/{storage-account-name}/sas/{sas-definition-name} | Creates or updates a new SAS definition for the specified storage account. This operation requires the storage/setsas permission. |
| PATCH | /storage/{storage-account-name}/sas/{sas-definition-name} | Updates the specified attributes associated with the given SAS definition. This operation requires the storage/setsas permission. |
| DELETE | /storage/{storage-account-name}/sas/{sas-definition-name} | Deletes a SAS definition from a specified storage account. This operation requires the storage/deletesas permission. |
Questions
Does the KeyVaultClient API need an API key?
No. The KeyVaultClient API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.
Does the KeyVaultClient API support HTTPS?
Yes, the KeyVaultClient API is served over HTTPS.
How many endpoints does the KeyVaultClient API have?
Its OpenAPI description lists 78 endpoints in version 7.0-preview. All of them are shown on this page.
What are alternatives to the KeyVaultClient 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).