GET https://apis.wso2.com/api/am/publisher/v0.16/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.
Not required
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 |
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". "status:PUBLISHED" will match an API if the API is in PUBLISHED state. "label:external" will match an API if it contains a Microgateway label called "external". 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, label**] If no advanced attribute modifier has been specified, the API names containing the search term will be returned as a result. |
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 (Will be supported in future). |
String | |
Query |
expand optional |
Defines whether the returned response should contain full details of API |
Boolean | |
Query |
tenantDomain optional |
Tenant domain, whose APIs should be retrieved. If not specified, the logged in user's tenant domain will be considered for this. |
String |
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 |
GET https://apis.wso2.com/api/am/publisher/v0.16/search
This operation provides you a list of available APIs and API Documents qualifying the given keyword match.
Not required
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 |
Query |
query optional |
**Search**. You can search by proving a keyword. |
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 (Will be supported in future). |
String |
HTTP Code | Description | Schema |
---|---|---|
200 |
OK. List of qualifying APIs and API documents is returned. |
SearchResultList |
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 |