Apis - List
Returns a collection of APIs.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis?api-version=2024-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis?api-version=2024-03-01&$filter={$filter}
URI Parameters
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 Azure API Center service. Regex pattern: |
subscription
|
path | True |
string uuid |
The ID of the target subscription. The value must be an UUID. |
workspace
|
path | True |
string |
The name of the workspace. Regex pattern: |
api-version
|
query | True |
string |
The API version to use for this operation. |
$filter
|
query |
string |
OData filter parameter. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Azure operation completed successfully. |
|
Other Status Codes |
An unexpected error response. |
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
Apis_ListByWorkspace
Sample request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis?api-version=2024-03-01
Sample response
{
"value": [
{
"type": "Microsoft.ApiCenter/services/environments",
"id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api",
"name": "echo-api",
"systemData": {
"createdAt": "2023-07-03T18:27:09.128871Z",
"lastModifiedAt": "2023-07-03T18:27:09.1288716Z"
},
"properties": {
"title": "Echo API",
"description": "A simple HTTP request/response service.",
"lifecycleStage": "design",
"kind": "rest",
"termsOfService": {
"url": "https://contoso.com/terms-of-service"
},
"license": {
"url": "https://contoso.com/license"
},
"externalDocumentation": [
{
"title": "Onboarding docs",
"url": "https://docs.contoso.com"
}
],
"customProperties": {
"author": "John Doe"
}
}
}
]
}
Definitions
Name | Description |
---|---|
Api |
API entity. |
Api |
The kind of the API |
Api |
The response of a Api list operation. |
Contact |
Contact information |
created |
The type of identity that created the resource. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
External |
Additional, external documentation for the API. |
License |
The license information for the API. |
Lifecycle |
The stage of the Api development lifecycle |
system |
Metadata pertaining to creation and last modification of the resource. |
Terms |
Terms of service for the API. |
Api
API entity.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
The name of the resource |
properties.contacts |
Contact[] |
The set of contacts |
properties.customProperties |
object |
Custom Properties |
properties.description |
string |
Description of the API. |
properties.externalDocumentation |
The set of external documentation |
|
properties.kind |
Kind of API. For example, REST or GraphQL. |
|
properties.license |
The license information for the API. |
|
properties.lifecycleStage |
Current lifecycle stage of the API. |
|
properties.summary |
string |
Short description of the API. |
properties.termsOfService |
Terms of service for the API. |
|
properties.title |
string |
API title. |
systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
ApiKind
The kind of the API
Name | Type | Description |
---|---|---|
graphql |
string |
A Graph query language Api |
grpc |
string |
A gRPC Api |
rest |
string |
A Representational State Transfer Api |
soap |
string |
A SOAP Api |
webhook |
string |
Web Hook |
websocket |
string |
Web Socket |
ApiListResult
The response of a Api list operation.
Name | Type | Description |
---|---|---|
nextLink |
string |
The link to the next page of items |
value |
Api[] |
The Api items on this page |
Contact
Contact information
Name | Type | Description |
---|---|---|
string |
Email address of the contact. |
|
name |
string |
Name of the contact. |
url |
string |
URL for the contact. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
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. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
ExternalDocumentation
Additional, external documentation for the API.
Name | Type | Description |
---|---|---|
description |
string |
Description of the documentation. |
title |
string |
Title of the documentation. |
url |
string |
URL pointing to the documentation. |
License
The license information for the API.
Name | Type | Description |
---|---|---|
identifier |
string |
SPDX license information for the API. The identifier field is mutually exclusive of the URL field. |
name |
string |
Name of the license. |
url |
string |
URL pointing to the license details. The URL field is mutually exclusive of the identifier field. |
LifecycleStage
The stage of the Api development lifecycle
Name | Type | Description |
---|---|---|
deprecated |
string |
deprecated stage |
design |
string |
design stage |
development |
string |
development stage |
preview |
string |
In preview |
production |
string |
In production |
retired |
string |
Retired stage |
testing |
string |
testing stage |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
TermsOfService
Terms of service for the API.
Name | Type | Description |
---|---|---|
url |
string |
URL pointing to the terms of service. |