REST API for the Developer Portal in Oracle API Platform Cloud Service

All REST Endpoints

APIs

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

Get APIs: Method: get

Path: /v1/apis
Get details for an API's latest iteration: Method: get

Path: /v1/apis/{vanityName}/current
Get details for an API's published iteration: Method: get

Path: /v1/apis/{vanityName}

Applications

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

Get application types: Method: get

Path: /v1/applications/types
Get applications: Method: get

Path: /v1/applications
Get details for an application: Method: get

Path: /v1/applications/{applicationId}

Developer Portal Configuration

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

Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/customization/configuration/authenticated
Delete configuration: Method: delete

Path: /v1/customization/configuration
Get configuration: Method: get

Path: /v1/customization/configuration
Set configuration: Method: post

Path: /v1/customization/configuration

Developer Portal Configuration (deprecated)

Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/configuration/authenticated
Delete configuration: Method: delete

Path: /v1/configuration
Get configuration: Method: get

Path: /v1/configuration
Set configuration: Method: post

Path: /v1/configuration

Language Resources

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

Delete language resource: Method: delete

Path: /v1/customization/language/{languageCode}
Get language resource: Method: get

Path: /v1/customization/language/{languageCode}
Set language resource: Method: post

Path: /v1/customization/language/{languageCode}

Language Resources (deprecated)

Delete language resource: Method: delete

Path: /v1/language/{languageCode}
Get language resource: Method: get

Path: /v1/language/{languageCode}
Set language resource: Method: post

Path: /v1/language/{languageCode}

Public Resources

Use these resource to retrieve language resources, the current Developer Portal configuration, and whether the Developer Portal is enabled. You can also access a resource that returns whether a specified user can access the Developer Portal.

All users can access these resources; authentication is not required.

Check available saved configuration: Method: get

Path: /v1/public/customization
Check available saved configuration (deprecated): Method: get

Path: /v1/public/customdata
Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/public/authorizedlogin
Get configuration: Method: get

Path: /v1/public/customization/configuration
Get configuration (deprecated): Method: get

Path: /v1/public/configuration
Get language resource: Method: get

Path: /v1/public/customization/language/{languageCode}
Get language resource (deprecated): Method: get

Path: /v1/public/language/{languageCode}
Get state of the Developer Portal: Method: get

Path: /v1/public/enabled

User preferences

Delete user preference for current user: Method: delete

Path: /v1/preferences/{section}
Retrieve user preference for current user: Method: get

Path: /v1/preferences/{section}
Set user preference for current user: Method: post

Path: /v1/preferences/{section}

All Endpoints

Check available saved configuration: Method: get

Path: /v1/public/customization
Check available saved configuration (deprecated): Method: get

Path: /v1/public/customdata
Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/configuration/authenticated
Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/customization/configuration/authenticated
Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/public/authorizedlogin
Delete configuration: Method: delete

Path: /v1/configuration
Delete configuration: Method: delete

Path: /v1/customization/configuration
Delete language resource: Method: delete

Path: /v1/customization/language/{languageCode}
Delete language resource: Method: delete

Path: /v1/language/{languageCode}
Delete user preference for current user: Method: delete

Path: /v1/preferences/{section}
Get APIs: Method: get

Path: /v1/apis
Get application types: Method: get

Path: /v1/applications/types
Get applications: Method: get

Path: /v1/applications
Get configuration: Method: get

Path: /v1/configuration
Get configuration: Method: get

Path: /v1/customization/configuration
Get configuration: Method: get

Path: /v1/public/customization/configuration
Get configuration (deprecated): Method: get

Path: /v1/public/configuration
Get details for an API's latest iteration: Method: get

Path: /v1/apis/{vanityName}/current
Get details for an API's published iteration: Method: get

Path: /v1/apis/{vanityName}
Get details for an application: Method: get

Path: /v1/applications/{applicationId}
Get language resource: Method: get

Path: /v1/customization/language/{languageCode}
Get language resource: Method: get

Path: /v1/language/{languageCode}
Get language resource: Method: get

Path: /v1/public/customization/language/{languageCode}
Get language resource (deprecated): Method: get

Path: /v1/public/language/{languageCode}
Get state of the Developer Portal: Method: get

Path: /v1/public/enabled
Retrieve user preference for current user: Method: get

Path: /v1/preferences/{section}
Set configuration: Method: post

Path: /v1/configuration
Set configuration: Method: post

Path: /v1/customization/configuration
Set language resource: Method: post

Path: /v1/customization/language/{languageCode}
Set language resource: Method: post

Path: /v1/language/{languageCode}
Set user preference for current user: Method: post

Path: /v1/preferences/{section}

APIs

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

Get APIs: Method: get

Path: /v1/apis
Get details for an API's published iteration: Method: get

Path: /v1/apis/{vanityName}
Get details for an API's latest iteration: Method: get

Path: /v1/apis/{vanityName}/current

Applications

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

Get applications: Method: get

Path: /v1/applications
Get application types: Method: get

Path: /v1/applications/types
Get details for an application: Method: get

Path: /v1/applications/{applicationId}

Developer Portal Configuration

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

Delete configuration: Method: delete

Path: /v1/customization/configuration
Get configuration: Method: get

Path: /v1/customization/configuration
Set configuration: Method: post

Path: /v1/customization/configuration
Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/customization/configuration/authenticated

Developer Portal Configuration (deprecated)

Delete configuration: Method: delete

Path: /v1/configuration
Get configuration: Method: get

Path: /v1/configuration
Set configuration: Method: post

Path: /v1/configuration
Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/configuration/authenticated

Language Resources

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

Delete language resource: Method: delete

Path: /v1/customization/language/{languageCode}
Get language resource: Method: get

Path: /v1/customization/language/{languageCode}
Set language resource: Method: post

Path: /v1/customization/language/{languageCode}

Language Resources (deprecated)

Delete language resource: Method: delete

Path: /v1/language/{languageCode}
Get language resource: Method: get

Path: /v1/language/{languageCode}
Set language resource: Method: post

Path: /v1/language/{languageCode}

Public Resources

All users can access these resources; authentication is not required.

Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/public/authorizedlogin
Get configuration (deprecated): Method: get

Path: /v1/public/configuration
Check available saved configuration (deprecated): Method: get

Path: /v1/public/customdata
Check available saved configuration: Method: get

Path: /v1/public/customization
Get configuration: Method: get

Path: /v1/public/customization/configuration
Get language resource: Method: get

Path: /v1/public/customization/language/{languageCode}
Get state of the Developer Portal: Method: get

Path: /v1/public/enabled
Get language resource (deprecated): Method: get

Path: /v1/public/language/{languageCode}

User preferences

Delete user preference for current user: Method: delete

Path: /v1/preferences/{section}
Retrieve user preference for current user: Method: get

Path: /v1/preferences/{section}
Set user preference for current user: Method: post

Path: /v1/preferences/{section}

All Endpoints

Get APIs: Method: get

Path: /v1/apis
Get details for an API's published iteration: Method: get

Path: /v1/apis/{vanityName}
Get details for an API's latest iteration: Method: get

Path: /v1/apis/{vanityName}/current
Get applications: Method: get

Path: /v1/applications
Get application types: Method: get

Path: /v1/applications/types
Get details for an application: Method: get

Path: /v1/applications/{applicationId}
Delete configuration: Method: delete

Path: /v1/configuration
Get configuration: Method: get

Path: /v1/configuration
Set configuration: Method: post

Path: /v1/configuration
Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/configuration/authenticated
Delete configuration: Method: delete

Path: /v1/customization/configuration
Get configuration: Method: get

Path: /v1/customization/configuration
Set configuration: Method: post

Path: /v1/customization/configuration
Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/customization/configuration/authenticated
Delete language resource: Method: delete

Path: /v1/customization/language/{languageCode}
Get language resource: Method: get

Path: /v1/customization/language/{languageCode}
Set language resource: Method: post

Path: /v1/customization/language/{languageCode}
Delete language resource: Method: delete

Path: /v1/language/{languageCode}
Get language resource: Method: get

Path: /v1/language/{languageCode}
Set language resource: Method: post

Path: /v1/language/{languageCode}
Delete user preference for current user: Method: delete

Path: /v1/preferences/{section}
Retrieve user preference for current user: Method: get

Path: /v1/preferences/{section}
Set user preference for current user: Method: post

Path: /v1/preferences/{section}
Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/public/authorizedlogin
Get configuration (deprecated): Method: get

Path: /v1/public/configuration
Check available saved configuration (deprecated): Method: get

Path: /v1/public/customdata
Check available saved configuration: Method: get

Path: /v1/public/customization
Get configuration: Method: get

Path: /v1/public/customization/configuration
Get language resource: Method: get

Path: /v1/public/customization/language/{languageCode}
Get state of the Developer Portal: Method: get

Path: /v1/public/enabled
Get language resource (deprecated): Method: get

Path: /v1/public/language/{languageCode}

APIs

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

Get APIs: Method: get

Path: /v1/apis
Get details for an API's published iteration: Method: get

Path: /v1/apis/{vanityName}
Get details for an API's latest iteration: Method: get

Path: /v1/apis/{vanityName}/current

Applications

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

Get applications: Method: get

Path: /v1/applications
Get application types: Method: get

Path: /v1/applications/types
Get details for an application: Method: get

Path: /v1/applications/{applicationId}

Developer Portal Configuration

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

Delete configuration: Method: delete

Path: /v1/customization/configuration
Get configuration: Method: get

Path: /v1/customization/configuration
Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/customization/configuration/authenticated
Set configuration: Method: post

Path: /v1/customization/configuration

Developer Portal Configuration (deprecated)

Delete configuration: Method: delete

Path: /v1/configuration
Get configuration: Method: get

Path: /v1/configuration
Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/configuration/authenticated
Set configuration: Method: post

Path: /v1/configuration

Language Resources

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

Delete language resource: Method: delete

Path: /v1/customization/language/{languageCode}
Get language resource: Method: get

Path: /v1/customization/language/{languageCode}
Set language resource: Method: post

Path: /v1/customization/language/{languageCode}

Language Resources (deprecated)

Delete language resource: Method: delete

Path: /v1/language/{languageCode}
Get language resource: Method: get

Path: /v1/language/{languageCode}
Set language resource: Method: post

Path: /v1/language/{languageCode}

Public Resources

All users can access these resources; authentication is not required.

Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/public/authorizedlogin
Get configuration (deprecated): Method: get

Path: /v1/public/configuration
Check available saved configuration (deprecated): Method: get

Path: /v1/public/customdata
Check available saved configuration: Method: get

Path: /v1/public/customization
Get configuration: Method: get

Path: /v1/public/customization/configuration
Get language resource: Method: get

Path: /v1/public/customization/language/{languageCode}
Get state of the Developer Portal: Method: get

Path: /v1/public/enabled
Get language resource (deprecated): Method: get

Path: /v1/public/language/{languageCode}

User preferences

Delete user preference for current user: Method: delete

Path: /v1/preferences/{section}
Retrieve user preference for current user: Method: get

Path: /v1/preferences/{section}
Set user preference for current user: Method: post

Path: /v1/preferences/{section}

All Endpoints

Delete configuration: Method: delete

Path: /v1/configuration
Delete configuration: Method: delete

Path: /v1/customization/configuration
Delete language resource: Method: delete

Path: /v1/customization/language/{languageCode}
Delete language resource: Method: delete

Path: /v1/language/{languageCode}
Delete user preference for current user: Method: delete

Path: /v1/preferences/{section}
Get APIs: Method: get

Path: /v1/apis
Get details for an API's published iteration: Method: get

Path: /v1/apis/{vanityName}
Get details for an API's latest iteration: Method: get

Path: /v1/apis/{vanityName}/current
Get applications: Method: get

Path: /v1/applications
Get application types: Method: get

Path: /v1/applications/types
Get details for an application: Method: get

Path: /v1/applications/{applicationId}
Get configuration: Method: get

Path: /v1/configuration
Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/configuration/authenticated
Get configuration: Method: get

Path: /v1/customization/configuration
Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/customization/configuration/authenticated
Get language resource: Method: get

Path: /v1/customization/language/{languageCode}
Get language resource: Method: get

Path: /v1/language/{languageCode}
Retrieve user preference for current user: Method: get

Path: /v1/preferences/{section}
Check if the current user can sign in to the Developer Portal: Method: get

Path: /v1/public/authorizedlogin
Get configuration (deprecated): Method: get

Path: /v1/public/configuration
Check available saved configuration (deprecated): Method: get

Path: /v1/public/customdata
Check available saved configuration: Method: get

Path: /v1/public/customization
Get configuration: Method: get

Path: /v1/public/customization/configuration
Get language resource: Method: get

Path: /v1/public/customization/language/{languageCode}
Get state of the Developer Portal: Method: get

Path: /v1/public/enabled
Get language resource (deprecated): Method: get

Path: /v1/public/language/{languageCode}
Set configuration: Method: post

Path: /v1/configuration
Set configuration: Method: post

Path: /v1/customization/configuration
Set language resource: Method: post

Path: /v1/customization/language/{languageCode}
Set language resource: Method: post

Path: /v1/language/{languageCode}
Set user preference for current user: Method: post

Path: /v1/preferences/{section}