Azure API Management: Apimdocumentations
Use these REST APIs for performing operations on Documentation entity.
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 Documentation entity.
Endpoints 6
Documentation
- GETDocumentation_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/documentations?$filter=stringLists all Documentations of the API Management service instance. - GETDocumentation_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/documentations/:documentationIdGets the details of the Documentation specified by its identifier. - PUTDocumentation_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/documentations/:documentationIdCreates a new Documentation or updates an existing one. - DELETEDocumentation_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/documentations/:documentationIdDeletes the specified Documentation from an API. - HEADDocumentation_GetEntityTag
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/documentations/:documentationIdGets the entity state (Etag) version of the Documentation by its identifier. - PATCHDocumentation_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/documentations/:documentationIdUpdates the details of the Documentation for an API specified by its identifier.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 6 operations on 2 pathsGET 2PUT 1HEAD 1PATCH 1DELETE 1
- Main resources
- Documentation 6
- Response formats
application/json- Description format
- Swagger 2.0, API version
2024-05-01 - Links
- OpenAPI document
How to test the Azure API Management: Apimdocumentations in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure API Management: Apimdocumentations collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Documentation_ListByService” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/documentations?$filter=string), 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: Apimdocumentations?
Use these REST APIs for performing operations on Documentation entity. It is listed under Developer tools and has 6 endpoints.
Who publishes the Azure API Management: Apimdocumentations?
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: Apimdocumentations?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure API Management: Apimdocumentations?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure API Management: Apimdocumentations have?
6 operations on 2 paths (2 GET, 1 PUT, 1 HEAD, 1 PATCH, 1 DELETE). The largest groups are Documentation.
Is forking the Azure API Management: Apimdocumentations free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.