Apis - List All

Service:

API Center

API Version:

2024-02-01-preview

List a collection of APIs across workspaces.

GET https://{serviceName}.data.azure-apicenter.net/apis?api-version=2024-02-01-preview

With optional parameters:

GET https://{serviceName}.data.azure-apicenter.net/apis?api-version=2024-02-01-preview&top={top}&skip={skip}&maxpagesize={maxpagesize}

URI Parameters

Name	In	Required	Type	Description
serviceName	path	True	string	Region-unique API Center service name
api-version	query	True	string	The API version to use for this operation.
maxpagesize	query		integer int32	The maximum number of result items per page.
skip	query		integer int32	The number of result items to skip.
top	query		integer int32	The number of result items to return.

Responses

Name	Type	Description
200 OK	PagedApiAll	The request has succeeded.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	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_ListAll

Sample request

HTTP

GET https://{serviceName}.data.azure-apicenter.net/apis?api-version=2024-02-01-preview

Sample response

Status code:

200

{
  "value": [
    {
      "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"
        }
      ]
    }
  ],
  "nextLink": "https://microsoft.com/a"
}

Definitions

Name	Description
Api	API resource model.
ApiKind	API kind
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
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.
Contact	API contact information
ExternalDocumentation	Api External Documentation Model
License	API License Model
LifecycleStage	API Lifecycle Stage
PagedApiAll	Paged collection of API items across workspaces.
TermsOfService	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	ExternalDocumentation[]	External documentation
kind	ApiKind	Kind of API. For example, REST or GraphQL.
lastUpdated	string	Last updated date and time.
license	License	The license information for the API.
lifecycleStage	LifecycleStage	Current lifecycle stage of the API.
name	string	Api identifier.
summary	string	Short description of the API.
termsOfService	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	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.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	Azure.Core.Foundations.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	Azure.Core.Foundations.InnerError	Inner error.

Contact

API contact information

Name	Type	Description
email	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

PagedApiAll

Paged collection of API items across workspaces.

Name	Type	Description
nextLink	string	The link to the next page of items
value	Api[]	The Api items on this page

TermsOfService

API Terms of Service

Name	Type	Description
url	string	URL pointing to the terms of service.