Api Revision - List By Service
Lists all revisions of an API.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/revisions?api-version=2021-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/revisions?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-08-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
api
|
path | True |
string |
API identifier. Must be unique in the current API Management service instance. |
resource
|
path | True |
string |
The name of the resource group. |
service
|
path | True |
string |
The name of the API Management service. Regex pattern: |
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Version of the API to be used with the client request. |
$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. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The operation returns a list of revision details. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
ApiManagementListApiRevisions
Sample request
Sample response
{
"value": [
{
"apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1;rev=1",
"apiRevision": "1",
"createdDateTime": "2018-02-01T22:21:20.467Z",
"updatedDateTime": "2018-02-01T22:21:20.467Z",
"isOnline": true,
"isCurrent": true
}
],
"count": 1,
"nextLink": ""
}
Definitions
Name | Description |
---|---|
Api |
Paged API Revision list representation. |
Api |
Summary of revision metadata. |
Error |
Error Field contract. |
Error |
Error Response. |
ApiRevisionCollection
Paged API Revision list representation.
Name | Type | Description |
---|---|---|
count |
integer |
Total record count number across all pages. |
nextLink |
string |
Next page link if any. |
value |
Page values. |
ApiRevisionContract
Summary of revision metadata.
Name | Type | Description |
---|---|---|
apiId |
string |
Identifier of the API Revision. |
apiRevision |
string |
Revision number of API. |
createdDateTime |
string |
The time the API Revision was created. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. |
description |
string |
Description of the API Revision. |
isCurrent |
boolean |
Indicates if API revision is accessible via the gateway. |
isOnline |
boolean |
Indicates if API revision is the current api revision. |
privateUrl |
string |
Gateway URL for accessing the non-current API Revision. |
updatedDateTime |
string |
The time the API Revision were updated. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. |
ErrorFieldContract
Error Field contract.
Name | Type | Description |
---|---|---|
code |
string |
Property level error code. |
message |
string |
Human-readable representation of property-level error. |
target |
string |
Property name. |
ErrorResponse
Error Response.
Name | Type | Description |
---|---|---|
error.code |
string |
Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. |
error.details |
The list of invalid fields send in request, in case of validation error. |
|
error.message |
string |
Human-readable representation of the error. |