API (Collection)


Retrieve/Search APIs

GET https://apis.wso2.com/api/am/store/v0.13/apis

This operation provides you a list of available APIs qualifying under a given search condition. Each retrieved API is represented with a minimal amount of attributes. If you want to get complete details of an API, you need to use **Get details of an API** operation. This operation supports retriving APIs of other tenants. The required tenant domain need to be specified as a header `X-WSO2-Tenant`. If not specified super tenant's APIs will be retrieved. If you used an Authorization header, the user's tenant associated with the access token will be used. **NOTE:** * By default, this operation retrieves Published APIs. In order to retrieve Prototyped APIs, you need to use **query** parameter and specify **status:PROTOTYPED**. * This operation does not require an Authorization header by default. But if it is provided, it will be validated and checked for permissions of the user, hence you may be able to see APIs which are restricted for special permissions/roles.

OAuth 2.0 Scope

Not required

Request

GET https://localhost:9443/api/am/store/v0.13/apis

Response

HTTP/1.1 200 OK Content-Type: application/json { "previous": "", "list": [ { "provider": "admin", "version": "1.0.0", "description": "This API provide Account Status Validation.", "status": "PUBLISHED", "name": "AccountVal", "context": "/account/1.0.0", "id": "2e81f147-c8a8-4f68-b4f0-69e0e7510b01" }, { "provider": "admin", "version": "1.0.0", "description": null, "status": "PUBLISHED", "name": "api1", "context": "/api1/1.0.0", "id": "3e22d2fb-277a-4e9e-8c7e-1c0f7f73960e" }, { "provider": "admin", "version": "2.0.0", "description": "Verify a phone number", "status": "PUBLISHED", "name": "PhoneVerification", "context": "/phoneverify/2.0.0", "id": "c43a325c-260b-4302-81cb-768eafaa3aed" } ], "count": 3, "next": "" }

Sample CURL

curl https://localhost:9443/api/am/store/v0.13/apis

Sample CURL - for tenant

curl -k -H "X-WSO2-Tenant:test.com" https://localhost:9443/api/am/store/v0.13/apis

Parameters

Type Name Description Schema Default
Query

limit

optional

Maximum size of resource array to return.

Integer

25

Query

offset

optional

Starting point within the complete list of items qualified.

Integer

0

Header

X-WSO2-Tenant

optional

For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from.

String

Query

query

optional

**Search condition**. You can search in attributes by using an **"<attribute>:"** modifier. Eg. "provider:wso2" will match an API if the provider of the API is exactly "wso2". Additionally you can use wildcards. Eg. "provider:wso2*" will match an API if the provider of the API starts with "wso2". Supported attribute modifiers are [**version, context, status, description, subcontext, doc, provider, tag**] If no advanced attribute modifier has been specified, search will match the given query string against API Name.

String

Header

Accept

optional

Media types acceptable for the response. Default is application/json.

String

application/json

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource.

String

Responses

HTTP Code Description Schema

200

OK. List of qualifying APIs is returned.

APIList

304

Not Modified. Empty body because the client has already the latest version of the requested resource (Will be supported in future).

406

Not Acceptable. The requested media type is not supported

Error