Get APIs
/developers/services/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
-
limit(optional): integer(int32)
Requested limit for the results list.Default Value:
0
-
offset(optional): integer(int32)
Requested offset in the results list.
- orderBy(optional): array
-
q(optional): string
{ApiRestService.getApiList.param.query}
-
registered(optional): 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(optional): 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
, andRETIRED
. -
text(optional): string
Filter text.
-
updated(optional): integer(int32)
Filter by the number of days updates are to be shown from.
0
means the results are not filtered.Default Value:0
Response
- application/json
200 Response
object
-
count(optional):
integer(int32)
Item count in this response.
-
filters(optional):
array filters
List of filters applicable for the current API list. This is
null
by default. -
hasMore(optional):
boolean
Default Value:
false
Indicates if there are more results after the current batch. -
items:
array items
Actual response items.
-
limit(optional):
integer(int32)
Paging limit.
-
links(optional):
array links
HATEOAS links.
-
offset(optional):
integer(int32)
Paging offset.
-
states(optional):
array states
Optional list of API states. This is
null
by default. -
totalResults(optional):
integer(int32)
Response item count (excluding the paging parameters).
array
null
by default.array
-
Array of:
object PortalApi
API resource representation.
array
-
Array of:
object GenericLink
HATEOAS generic link representation.
array
null
by default.object
-
allVersions(optional):
array allVersions
List of the API's available versions.
-
createdAt(optional):
string
The date and time the API was created.
-
createdBy(optional):
string
The name of the user who created the API.
-
description(optional):
string
The API's description.
-
details(optional):
object ApiDetailArtifact
API detail artifact representation
-
icon(optional):
string
Artifact containing the API's icon, if changed.
-
id:
integer(int32)
The API's ID.
-
iterationId(optional):
integer(int32)
The API's iteration ID.
-
links(optional):
array links
HATEOAS links for the API.
-
name:
string
The API's name.
-
plans(optional):
array plans
The API's deployment plans.
-
state(optional):
string
Allowed Values:
[ "ALPHA", "BETA", "RETIRED", "RELEASED", "DEPRECATED" ]
The API's state. Valid values:ALPHA
,BETA
,RELEASED
,DEPRECATED
, andRETIRED
. -
vanityName:
string
The API's vanity name.
-
version:
string
The API's version.
-
visibility(optional):
string
Allowed Values:
[ "PROTECTED", "INTERNAL", "PUBLIC" ]
{dto.Api.visibility}
array
-
Array of:
object ApiVersion
API version resource representation.
object
-
documentation(optional):
object ApiDetailsItem
API detail representation for overview and documentation subtypes.
-
overview(optional):
object ApiDetailsItem
API detail representation for overview and documentation subtypes.
array
-
Array of:
object GenericLink
HATEOAS generic link representation.
array
-
Array of:
object PlanForApi
Plan for a given API resource representation.
object
-
vanityName:
string
The API's vanity name.
-
version:
string
The API's version.
object
-
data(optional):
string
The documentation data as a string.
-
dataType(optional):
string
The documentation data type.
-
docType(optional):
string
The documentation type.
object
-
href:
string
Link reference string.
-
method(optional):
string
HTTP method used with the link.
-
rel:
string
Link relation string Value is either
canonical
or a specific string value. -
templated(optional):
string
Allowed Values:
[ "true", "false" ]
Indicates if the link has templated parts.
object
-
constraints(optional):
object Constraints
Plan subscription constraints.
-
description(optional):
string
The plan's description.
-
icon(optional):
string
The plan's icon.
-
id:
integer(int32)
The plan's ID.
-
links(optional):
array links
HATEOAS links.
-
name:
string
The plan's name.
-
publicationSettings(optional):
object PublicationSettings
Publication settings for the given plan.
-
subscriptions(optional):
array subscriptions
List of applications registered to the API.
-
vanityName:
string
{dto.PlanForApi.vanityName}
object
-
rate(optional):
object Rate
Rate for plan subscription constraints.
array
-
Array of:
object GenericLink
HATEOAS generic link representation.
object
-
constraints(optional):
object ConstraintSettings
Plan publication setting's constraint display options.
-
description(optional):
object DescriptionSettings
Plan publication setting's description display options.
-
icon(optional):
object IconSettings
Plan publication setting's plan icon options.
-
recommended(optional):
boolean
Default Value:
false
Flag whether the plan should be listed as recommended.
object
-
invocations(optional):
array invocations
Invocation constraint parameters list.
array
-
Array of:
object Invocation
Plan constraint - invocation parameters.
object
-
limit:
string
Maximum number of invocations for the given period.
-
period:
string
Time period, such as minutes, days, months, etc.
object
-
rate(optional):
object RateSettings
Plan publication setting's invocation rate display options flag.
object
-
displayed(optional):
boolean
Default Value:
false
Display flag (boolean).
object
-
displayed(optional):
boolean
Default Value:
false
Display flag (boolean).
object
-
invocations(optional):
object InvocationSettings
Plan invocation's display options.
object
-
displayed(optional):
boolean
Default Value:
false
Display flag (boolean). -
displayText(optional):
string
Text to display.
object
-
state(optional):
string
The subscription's state.
-
stateComments(optional):
string
Comments regarding the subscription's state.
-
stateUpdatedAt(optional):
string
The date and time the subscription's state was last updated.
-
stateUpdatedBy(optional):
string
The user who last updated the subscription's state.
object
-
createdAt(optional):
string
The date and time the subscription was created.
-
createdBy(optional):
string
The user who created the subscription.
-
updatedAt(optional):
string
The date and time the subscription was last updated.
-
updatedBy(optional):
string
The user who last updated the subscription.
object
object
400 Response
401 Response
500 Response
Examples
The following example shows how to return all APIs published to the Oracle API Platform Cloud Service - Classic 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 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
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" ] }