Apis - Get
Get an API.
GET https://{serviceName}.data.azure-apicenter.net/workspaces/{workspaceName}/apis/{apiName}?api-version=2024-02-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
api
|
path | True |
string |
Api identifier. |
service
|
path | True |
string |
Region-unique API Center service name |
workspace
|
path | True |
string |
Workspace identifier. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request has succeeded. |
|
Other Status Codes |
An unexpected error response. Headers x-ms-error-code: string |
Security
AadOauth2Auth
The Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Token URL:
https://login.microsoftonline.com/common/oauth2/token
Scopes
Name | Description |
---|---|
https://azure-apicenter.net/user_impersonation |
Examples
Apis_Get
Sample request
GET https://{serviceName}.data.azure-apicenter.net/workspaces/default/apis/echo-api?api-version=2024-02-01-preview
Sample response
{
"name": "echo-api",
"title": "Echo API",
"kind": "rest",
"lastUpdated": "2023-12-18T18:49:11.878Z",
"description": "A simple HTTP request/response service.",
"lifecycleStage": "design",
"termsOfService": {
"url": "https://contoso.com/terms-of-service"
},
"license": {
"name": "default",
"url": "https://contoso.com/license"
},
"externalDocumentation": [
{
"title": "Onboarding docs",
"description": "Learn how to onboard to the Echo API.",
"url": "https://docs.contoso.com"
}
],
"contacts": [
{
"name": "Contoso support",
"url": "https://support.contoso.com",
"email": "support@contoso.com"
}
]
}
Definitions
Name | Description |
---|---|
Api |
API resource model. |
Api |
API kind |
Azure. |
The error object. |
Azure. |
A response containing error details. |
Azure. |
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Contact |
API contact information |
External |
Api External Documentation Model |
License |
API License Model |
Lifecycle |
API Lifecycle Stage |
Terms |
API Terms of Service |
Api
API resource model.
Name | Type | Description |
---|---|---|
contacts |
Contact[] |
Points of contact for the API. |
customProperties |
object |
The custom metadata defined for API entities. |
description |
string |
The description of the API |
externalDocumentation |
External documentation |
|
kind |
Kind of API. For example, REST or GraphQL. |
|
lastUpdated |
string |
Last updated date and time. |
license |
The license information for the API. |
|
lifecycleStage |
Current lifecycle stage of the API. |
|
name |
string |
Api identifier. |
summary |
string |
Short description of the API. |
termsOfService |
Terms of service for the API. |
|
title |
string |
The name of the API. |
ApiKind
API kind
Name | Type | Description |
---|---|---|
graphql |
string |
GraphQL API |
grpc |
string |
GRPC API |
rest |
string |
REST API |
soap |
string |
SOAP API |
webhook |
string |
Webhook API |
websocket |
string |
Websocket API |
Azure.Core.Foundations.Error
The error object.
Name | Type | Description |
---|---|---|
code |
string |
One of a server-defined set of error codes. |
details |
An array of details about specific errors that led to this reported error. |
|
innererror |
An object containing more specific information than the current object about the error. |
|
message |
string |
A human-readable representation of the error. |
target |
string |
The target of the error. |
Azure.Core.Foundations.ErrorResponse
A response containing error details.
Name | Type | Description |
---|---|---|
error |
The error object. |
Azure.Core.Foundations.InnerError
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Type | Description |
---|---|---|
code |
string |
One of a server-defined set of error codes. |
innererror |
Inner error. |
Contact
API contact information
Name | Type | Description |
---|---|---|
string |
Email address for the contact. |
|
name |
string |
Name of the contact. |
url |
string |
URL for the contact. |
ExternalDocumentation
Api External Documentation Model
Name | Type | Description |
---|---|---|
description |
string |
Description of the documentation. |
title |
string |
Title of the documentation. |
url |
string |
URL pointing to the documentation. |
License
API License Model
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
API Lifecycle Stage
Name | Type | Description |
---|---|---|
deprecated |
string |
API is in the deprecated stage |
design |
string |
API is in the design stage |
development |
string |
API is in the development stage |
preview |
string |
API is in the preview stage |
production |
string |
API is in the production stage |
retired |
string |
API is in the retired stage |
testing |
string |
API is in the testing stage |
TermsOfService
API Terms of Service
Name | Type | Description |
---|---|---|
url |
string |
URL pointing to the terms of service. |