Microsoft Azure

Azure API Management: Apimworkspacecertificates

Use these REST APIs for performing operations on Certificate entity in your Azure API Management deployment. Certificates can be used to setup mutual…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Use these REST APIs for performing operations on Certificate entity in your Azure API Management deployment. Certificates can be used to setup mutual authentication with your Backend in API Management. For more information refer to How to secure backend using Mutual Auth Certificate.

Endpoints 6

Certificate

  • GETWorkspaceCertificate_ListByWorkspace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/certificates?$filter=string&isKeyVaultRefreshFailed=trueLists a collection of all certificates in the specified workspace.
  • GETWorkspaceCertificate_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/certificates/:certificateIdGets the details of the certificate specified by its identifier.
  • PUTWorkspaceCertificate_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/certificates/:certificateIdCreates or updates the certificate being used for authentication with the backend.
  • DELETEWorkspaceCertificate_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/certificates/:certificateIdDeletes specific certificate.
  • HEADWorkspaceCertificate_GetEntityTag/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/certificates/:certificateIdGets the entity state (Etag) version of the certificate specified by its identifier.
  • POSTWorkspaceCertificate_RefreshSecret/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/certificates/:certificateId/refreshSecretFrom KeyVault, Refresh the certificate being used for authentication with the backend.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
6 operations on 3 pathsGET 2PUT 1HEAD 1POST 1DELETE 1
Main resources
Certificate 6
Response formats
application/json
Description format
Swagger 2.0, API version 2024-05-01

How to test the Azure API Management: Apimworkspacecertificates in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure API Management: Apimworkspacecertificates collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “WorkspaceCertificate_ListByWorkspace” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/workspaces/:workspaceId/certificates?$filter=string&isKeyVaultRefreshFailed=true), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure API Management: Apimworkspacecertificates?

Use these REST APIs for performing operations on Certificate entity in your Azure API Management deployment. Certificates can be used to setup mutual… It is listed under Developer tools and has 6 endpoints.

Who publishes the Azure API Management: Apimworkspacecertificates?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure API Management: Apimworkspacecertificates?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure API Management: Apimworkspacecertificates?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure API Management: Apimworkspacecertificates have?

6 operations on 3 paths (2 GET, 1 PUT, 1 HEAD, 1 POST, 1 DELETE). The largest groups are Certificate.

Is forking the Azure API Management: Apimworkspacecertificates free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.