Apis - List By Service
Lists all APIs of the API Management service instance.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis?api-version=2024-05-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis?$filter={$filter}&$top={$top}&$skip={$skip}&tags={tags}&expandApiVersionSet={expandApiVersionSet}&api-version=2024-05-01
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
service
|
path | True |
string |
The name of the API Management service. Regex pattern: |
subscription
|
path | True |
string uuid |
The ID of the target subscription. The value must be an UUID. |
api-version
|
query | True |
string |
The API version to use for this operation. |
$filter
|
query |
string |
| Field | Usage | Supported operators | Supported functions | |
|
$skip
|
query |
integer int32 |
Number of records to skip. |
|
$top
|
query |
integer int32 |
Number of records to return. |
|
expand
|
query |
boolean |
Include full ApiVersionSet resource in response |
|
tags
|
query |
string |
Include tags in the response. |
Name | Type | Description |
---|---|---|
200 OK |
Paged Result response of Apis. |
|
Other Status Codes |
Error response describing why the operation failed. |
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Sample request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis?api-version=2024-05-01
Sample response
{
"value": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1",
"type": "Microsoft.ApiManagement/service/apis",
"name": "a1",
"properties": {
"displayName": "api1",
"apiRevision": "1",
"serviceUrl": "http://echoapi.cloudapp.net/api",
"path": "api1",
"protocols": [
"https"
],
"isCurrent": true,
"apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4"
}
},
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a73933b8f27f7cc82a2d533",
"type": "Microsoft.ApiManagement/service/apis",
"name": "5a73933b8f27f7cc82a2d533",
"properties": {
"displayName": "api1",
"apiRevision": "1",
"serviceUrl": "http://echoapi.cloudapp.net/api",
"path": "api1",
"protocols": [
"https"
],
"isCurrent": true,
"apiVersion": "v1",
"apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4"
}
},
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api",
"type": "Microsoft.ApiManagement/service/apis",
"name": "echo-api",
"properties": {
"displayName": "Echo API",
"apiRevision": "1",
"serviceUrl": "http://echoapi.cloudapp.net/api",
"path": "echo",
"protocols": [
"https"
],
"isCurrent": true
}
},
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a7390baa5816a110435aee0",
"type": "Microsoft.ApiManagement/service/apis",
"name": "5a7390baa5816a110435aee0",
"properties": {
"displayName": "Swagger Petstore Extensive",
"apiRevision": "1",
"description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
"serviceUrl": "http://petstore.swagger.wordnik.com/api",
"path": "vvv",
"protocols": [
"https"
],
"isCurrent": true
}
}
],
"count": 4,
"nextLink": ""
}
Name | Description |
---|---|
Api |
Paged API list representation. |
Api |
API contact information |
Api |
API details. |
Api |
API license information |
Api |
Type of API. |
Api |
An API Version Set contains the common configuration for a set of API Versions relating |
Authentication |
API Authentication Settings. |
bearer |
How to send token to the server. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
OAuth2Authentication |
API OAuth2 Authentication settings details. |
Open |
API OAuth2 Authentication settings details. |
Protocol |
Describes on which protocols the operations in this API can be invoked. |
Subscription |
Subscription key parameter names details. |
versioning |
An value that determines where the API Version identifier will be located in a HTTP request. |
Paged API list representation.
Name | Type | Description |
---|---|---|
count |
integer |
Total record count number across all pages. |
nextLink |
string |
Next page link if any. |
value |
Page values. |
API contact information
Name | Type | Description |
---|---|---|
string |
The email address of the contact person/organization. MUST be in the format of an email address |
|
name |
string |
The identifying name of the contact person/organization |
url |
string |
The URL pointing to the contact information. MUST be in the format of a URL |
API details.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties.apiRevision |
string |
Describes the revision of the API. If no value is provided, default revision 1 is created |
properties.apiRevisionDescription |
string |
Description of the API Revision. |
properties.apiVersion |
string |
Indicates the version identifier of the API if the API is versioned |
properties.apiVersionDescription |
string |
Description of the API Version. |
properties.apiVersionSet |
Version set details |
|
properties.apiVersionSetId |
string |
A resource identifier for the related ApiVersionSet. |
properties.authenticationSettings |
Collection of authentication settings included into this API. |
|
properties.contact |
Contact information for the API. |
|
properties.description |
string |
Description of the API. May include HTML formatting tags. |
properties.displayName |
string |
API name. Must be 1 to 300 characters long. |
properties.isCurrent |
boolean |
Indicates if API revision is current api revision. |
properties.isOnline |
boolean |
Indicates if API revision is accessible via the gateway. |
properties.license |
License information for the API. |
|
properties.path |
string |
Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. |
properties.protocols |
Protocol[] |
Describes on which protocols the operations in this API can be invoked. |
properties.provisioningState |
string |
The provisioning state |
properties.serviceUrl |
string |
Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. |
properties.sourceApiId |
string |
API identifier of the source API. |
properties.subscriptionKeyParameterNames |
Protocols over which API is made available. |
|
properties.subscriptionRequired |
boolean |
Specifies whether an API or Product subscription is required for accessing the API. |
properties.termsOfServiceUrl |
string |
A URL to the Terms of Service for the API. MUST be in the format of a URL. |
properties.type |
Type of API. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
API license information
Name | Type | Description |
---|---|---|
name |
string |
The license name used for the API |
url |
string |
A URL to the license used for the API. MUST be in the format of a URL |
Type of API.
Name | Type | Description |
---|---|---|
graphql |
string |
|
grpc |
string |
|
http |
string |
|
odata |
string |
|
soap |
string |
|
websocket |
string |
An API Version Set contains the common configuration for a set of API Versions relating
Name | Type | Description |
---|---|---|
description |
string |
Description of API Version Set. |
id |
string |
Identifier for existing API Version Set. Omit this value to create a new Version Set. |
name |
string |
The display Name of the API Version Set. |
versionHeaderName |
string |
Name of HTTP header parameter that indicates the API Version if versioningScheme is set to |
versionQueryName |
string |
Name of query parameter that indicates the API Version if versioningScheme is set to |
versioningScheme |
An value that determines where the API Version identifier will be located in a HTTP request. |
API Authentication Settings.
Name | Type | Description |
---|---|---|
oAuth2 |
OAuth2 Authentication settings |
|
oAuth2AuthenticationSettings |
Collection of OAuth2 authentication settings included into this API. |
|
openid |
OpenID Connect Authentication Settings |
|
openidAuthenticationSettings |
Collection of Open ID Connect authentication settings included into this API. |
How to send token to the server.
Name | Type | Description |
---|---|---|
authorizationHeader |
string |
Access token will be transmitted in the Authorization header using Bearer schema |
query |
string |
Access token will be transmitted as query parameters. |
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
API OAuth2 Authentication settings details.
Name | Type | Description |
---|---|---|
authorizationServerId |
string |
OAuth authorization server identifier. |
scope |
string |
operations scope. |
API OAuth2 Authentication settings details.
Name | Type | Description |
---|---|---|
bearerTokenSendingMethods |
How to send token to the server. |
|
openidProviderId |
string |
OAuth authorization server identifier. |
Describes on which protocols the operations in this API can be invoked.
Name | Type | Description |
---|---|---|
http |
string |
|
https |
string |
|
ws |
string |
|
wss |
string |
Subscription key parameter names details.
Name | Type | Description |
---|---|---|
header |
string |
Subscription key header name. |
query |
string |
Subscription key query string parameter name. |
An value that determines where the API Version identifier will be located in a HTTP request.
Name | Type | Description |
---|---|---|
Header |
string |
The API Version is passed in a HTTP header. |
Query |
string |
The API Version is passed in a query parameter. |
Segment |
string |
The API Version is passed in a path segment. |