REST API for the Consumer Service in Oracle API Platform Cloud Service - Classic

All REST Endpoints

APIs

Use these resources to retrieve details about specific APIs and all APIs published to the Developer Portal.

Get API's plans: Method: get
Path: /developers/services/v1/apis/{vanityName}/plans
Get APIs: Method: get
Path: /developers/services/v1/apis
Get details for an API's latest iteration: Method: get
Path: /developers/services/v1/apis/{vanityName}/current
Get details for an API's published iteration: Method: get
Path: /developers/services/v1/apis/{vanityName}
Return the Apiary project: Method: get
Path: /developers/services/v1/apis/{apiId}/iterations/{iterId}/apiary

Analytics/Categorical

Query APIs returning Categorical data

Get http response code analytics as categorical data for failures.: Method: get
Path: /developers/services/v1/analytics/categorical/failures

Analytics/Time Series

Query APIs returning Time Series data

Get payload size analytics as time series data: Method: get
Path: /developers/services/v1/analytics/timeSeries/payloadSizes/{category}
Get request analytics as time series data: Method: get
Path: /developers/services/v1/analytics/timeSeries/requests/{category}
Get response time analytics as time series data: Method: get
Path: /developers/services/v1/analytics/timeSeries/responseTimes/totals

Analytics/Totals

Query APIs returning Totals data

Get number of failures as a total value: Method: get
Path: /developers/services/v1/analytics/totals/failures
Get number of requests as a total value: Method: get
Path: /developers/services/v1/analytics/totals/requests

Applications

Use these resources to retrieve valid application types, details about specific applications, and all your applications in the Developer Portal.

Create an application: Method: post
Path: /developers/services/v1/applications
Delete an application: Method: delete
Path: /developers/services/v1/applications/{id}
Get application types: Method: get
Path: /developers/services/v1/applications/types
Get applications: Method: get
Path: /developers/services/v1/applications
Get details for an application: Method: get
Path: /developers/services/v1/applications/{id}
Update an application: Method: put
Path: /developers/services/v1/applications/{id}

Applications/Grants

View details about and manage application grants.

Get application grants: Method: get
Path: /developers/services/v1/applications/grants/types
Get grants issued for an application: Method: get
Path: /developers/services/v1/applications/{id}/grants
Issue an application grant: Method: post
Path: /developers/services/v1/applications/{id}/grants
Revoke an application grant from a group: Method: delete
Path: /developers/services/v1/applications/{id}/grants/{grantType}/groups/{groupId}
Revoke an application grant from a user: Method: delete
Path: /developers/services/v1/applications/{id}/grants/{grantType}/users/{userId}

Applications/Key

Update an application's key.

Update application key: Method: put
Path: /developers/services/v1/applications/{id}/key

Plans

The operations from the Plans category.

Get details for a plan: Method: get
Path: /developers/services/v1/plans/{vanityName}

Plans/Entitlements

The operations from the Plans/Entitlements category.

Get entitlement details: Method: get
Path: /developers/services/v1/plans/{planId}/entitlements/{entitlementId}

Portal/Customization

The operations from the Portal/Customization category.

Check available saved configuration: Method: get
Path: /developers/services/v1/portal/customization

Portal/Customization/Developer Portal Configuration

Use these resources to retrieve, set, or delete Developer Portal configuration data.

Delete configuration: Method: delete
Path: /developers/services/v1/portal/customization/configuration
Get configuration: Method: get
Path: /developers/services/v1/portal/customization/configuration
Patch configuration: Method: patch
Path: /developers/services/v1/portal/customization/configuration
Set configuration: Method: put
Path: /developers/services/v1/portal/customization/configuration

Portal/Customization/Language Resources

Use these resources to retrieve, set, or delete language resources.

Delete language resource: Method: delete
Path: /developers/services/v1/portal/customization/languages/{languageCode}
Get language resource: Method: get
Path: /developers/services/v1/portal/customization/languages/{languageCode}
Patch language resource: Method: patch
Path: /developers/services/v1/portal/customization/languages/{languageCode}
Set language resource: Method: put
Path: /developers/services/v1/portal/customization/languages/{languageCode}

Portal/Miscellaneous

The operations from the Portal/Miscellaneous category.

Check if the current user can sign in to the Developer Portal: Method: get
Path: /developers/services/v1/portal/authorized
Get APICS version information: Method: get
Path: /developers/services/v1/portal/version
Get state of the Developer Portal: Method: get
Path: /developers/services/v1/portal/enabled

Portal/User preferences

Delete all user preferences for current user: Method: delete
Path: /developers/services/v1/portal/preferences
Delete user preference for current user: Method: delete
Path: /developers/services/v1/portal/preferences/{preferenceStorage}
Retrieve all the user preferences for current user: Method: get
Path: /developers/services/v1/portal/preferences
Retrieve user preference for current user: Method: get
Path: /developers/services/v1/portal/preferences/{preferenceStorage}
Set user preference for current user: Method: put
Path: /developers/services/v1/portal/preferences/{preferenceStorage}

Subscriptions/Applications

View details about and manage registrations to applications.

Delete a subscription: Method: delete
Path: /developers/services/v1/applications/{id}/subscriptions/{subscriptionId}
Subscribe to an application: Method: post
Path: /developers/services/v1/applications/{id}/subscriptions

Subscriptions/Plans

View details about and manage registrations to plans.

Delete a subscription: Method: delete
Path: /developers/services/v1/plans/{planId}/subscriptions/{subscriptionId}
Subscribe to an application: Method: post
Path: /developers/services/v1/plans/{planId}/subscriptions