1. REST API for the Developer Portal in Oracle API Platform Cloud Service
  2. Tasks
  3. APIs

Get APIs

get

/apiplatform/developers/v1/apis

Returns all APIs the requesting user is authorized to view.

All authenticated users can request this resource. Only APIs that are published to the Developer Portal and the requesting user is issued the Manage API, View Public Details, Register, or Request Register API grant for are returned.

Request

Query Parameters
limit
Type: integer (int32)
Requested limit for the results list.
offset
Type: integer (int32)
Requested offset in the results list.
orderBy
Type: array
Collection Format: multi
Sort criteria for the results list.
q
Type: string
{ApiRestService.getApiList.param.query}
registered
Type: string
Filter the results to include only registered APIs. A value of true returns only registered APIs; APIs of all registration states are returned otherwise or if this parameter is absent.
state
Type: array
Collection Format: multi
Filter the results to include only APIs with the states passed in this parameter. Separate multiple states with commas. Valid values are: ALPHA, BETA, RELEASED, DEPRECATED, and RETIRED.
text
Type: string
Filter text.
updated
Type: integer (int32)
Filter by the number of days updates are to be shown from. 0 means the results are not filtered.

Response

Supported Media Types
  • application/json
200 Response
JSON structure with list of all APIs.
Body
HATEOAS API collection response representation.
Root Schema : ApiCollectionResponse
Type: object
HATEOAS API collection response representation.
Nested Schema : filters
Type: array
List of filters applicable for the current API list. This is null by default.
Nested Schema : items
Type: array
Actual response items.
Nested Schema : states
Type: array
Optional list of API states. This is null by default.
Nested Schema : Api
Type: object
API resource representation.
Nested Schema : allVersions
Type: array
List of the API's available versions.
Nested Schema : deployments
Type: array
List of the API's available deployments.
Nested Schema : ApiDetailArtifact
Type: object
API detail artifact representation
Nested Schema : plans
Type: array
The API's deployment plans.
Nested Schema : ApiVersion
Type: object
API version resource representation.
Nested Schema : Deployment
Type: object
Deployment resource representation.
Nested Schema : endPoints
Type: array
A list of endpoint URLs.
Nested Schema : ApiDetailsItem
Type: object
API detail representation for overview and documentation subtypes.
Nested Schema : PlanForApi
Type: object
Plan for a given API resource representation.
Nested Schema : registeredApps
Type: array
List of applications registered to the API.
Nested Schema : RegisteredApp
Type: object
Registered application resource representation.
400 Response
Bad request: indicates a problem with the input parameters.
401 Response
Authentication required.
500 Response
Server error.

Examples

The following example shows how to return all APIs published to the API Platform Cloud Service Developer Portal that the requesting client can view by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-u apicsadmin:password
https://example.com/apiplatform/developers/v1/apis

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Server: Oracle-Traffic-Director/12.2.1.0.0
Date: Sun, 01 Jan 2017 15:41:25 GMT
Content-type: application/json
X-oracle-dms-ecid: 6^3rv0_eR00000000
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Transfer-encoding: chunked

Example of Response Body

The following example shows the contents of the response body in JSON format, including the state of each API (Released, Alpha, and Beta), which applications are registered to them, and HATEOAS links for related operations.

{
  "count": 3,
  "filters": [
    "REGISTERED"
  ],
  "hasMore": false,
  "items": [
    {
      "type": "api",
      "id": 180,
      "links": [
        {
          "href": "https://example.com/apiplatform/developers/v1/apis",
          "method": "GET",
          "rel": "canonical",
          "templated": "true"
        },
        {
          "href": "https://example.com/apiplatform/developers/v1/apis/WeatherService",
          "method": "GET",
          "rel": "canonical",
          "templated": "true"
        }
      ],
      "name": "WeatherService",
      "plans": [
        {
          "description": "default",
          "id": 168,
          "links": [],
          "name": "WeatherService",
          "registeredApps": [
            {
              "id": 345,
              "name": "WeatherApp 1",
              "state": "REGISTERED"
            }
          ]
        }
      ],
      "state": "ALPHA",
      "vanityName": "WeatherService",
      "version": "1"
    },
    {
      "type": "api",
      "description": "Credit Check",
      "id": 211,
      "links": [
        {
          "href": "https://example.com/apiplatform/developers/v1/apis",
          "method": "GET",
          "rel": "canonical",
          "templated": "true"
        },
        {
          "href": "https://example.com/apiplatform/developers/v1/apis/CreditCheck",
          "method": "GET",
          "rel": "canonical",
          "templated": "true"
        }
      ],
      "name": "CreditCheck",
      "plans": [
        {
          "description": "default",
          "id": 181,
          "links": [],
          "name": "CreditCheck 1",
          "registeredApps": []
        }
      ],
      "state": "ALPHA",
      "vanityName": "CreditCheck",
      "version": "1"
    },
    {
      "type": "api",
      "id": 152,
      "links": [
        {
          "href": "https://example.com/apiplatform/developers/v1/apis",
          "method": "GET",
          "rel": "canonical",
          "templated": "true"
        },
        {
          "href": "https://example.com/apiplatform/developers/v1/apis/SportsScores",
          "method": "GET",
          "rel": "canonical",
          "templated": "true"
        }
      ],
      "name": "SportsScores",
      "plans": [
        {
          "description": "default",
          "id": 148,
          "links": [],
          "name": "SportsScores 1",
          "registeredApps": []
        }
      ],
      "state": "BETA",
      "vanityName": "SportsScores",
      "version": "1"
    }
  ],
  "limit": 0,
  "links": [
    {
      "href": "https://example.com/apiplatform/developers/v1/apis",
      "method": "GET",
      "rel": "canonical",
      "templated": "true"
    }
  ],
  "offset": 0,
  "states": [
    "RELEASED",
    "ALPHA",
    "BETA"
  ]
}