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

Set configuration

post

/apiplatform/developers/v1/customization/configuration

Customizes the Developer Portal configuration based on the provided JSON. You can post a partial JSON file as long as it retains the same structure as the original resource file.

Users requesting this resource must be assigned the Administrator role.

Request

Supported Media Types
  • application/json
Query Parameters
portalName
Type: string
Optional portal name query parameter, for site-specific settings
Body Parameter
Configuration JSON
Root Schema : config
Type: object
Developer Portal configuration.
Nested Schema : _remove_
Type: array
Specifies entries to be removed from the default configuration. The entries must specify the path to the JSON property to be removed from the root down to the actual property. Separate property names with slashes.
Nested Schema : branding
Type: object
Company and product names, logos, copyright, etc.
Nested Schema : css
Type: object
Collection of CSS rules.
Nested Schema : layout
Type: object
Developer Portal UI layout definitions.
Nested Schema : modules
Type: object
Developer Portal module configuration.
Nested Schema : services
Type: object
URLs of services used by the Developer Portal.
Nested Schema : session
Type: object
Session management configuration.
Nested Schema : branding_about
Type: object
About box branding configuration.
Nested Schema : branding_login
Type: object
Login screen branding properties.
Nested Schema : branding_login_background
Type: object
Branded login screen background image configuration.
Nested Schema : branding_login_background_mobile
Type: object
Background image configuration for mobile devices.
Nested Schema : css_properties
Type: object
Collection of CSS properties.
Nested Schema : layout_home
Type: object
Specifies the home module.
Nested Schema : layout_navigation
Type: object
Controls how navigation works in the Developer Portal.
Nested Schema : layout_panels
Type: object
Associates modules with elements (panels) in the page's HTML structure.
Nested Schema : layout_panel
Type: object
Specifies an association between a module and an HTML element.
Nested Schema : modules_inventory
Type: object
The list of the modules configured in the system.
Nested Schema : modules_redirect
Type: object
Collection of module redirection definitions.
Nested Schema : module
Type: object
The definition of a single Developer Portal module.
Nested Schema : module_data
Type: object
Module data configuration. The layout of this object depends upon the module. The properties defined here are named by the module and apply to the data object itself.
Nested Schema : module_page_id
Type: object
The context identifier of a module.
Nested Schema : module_data_api_details
Type: object
Data for the api.details module.
Nested Schema : module_data_application_analytics
Type: object
Module data for the application analytics module.
Nested Schema : apiary_theme
Type: object
Apiary theme properties. A complex object that specifies the theme properties to be used for embedded Apiary documentation. The theme properties structure is documented here: http://embed.apiary.io/api-reference.html.
Nested Schema : analytics_ranges
Type: object
Analytics time range definitions.
Nested Schema : analytics_range_group
Type: object
A group of analytics ranges.
Nested Schema : analytics_range
Type: object
An analytics time range definition.
Nested Schema : analytics_range_granularity
Type: object
Defines the length of the time buckets analytics data is aggregated in.
Nested Schema : analytics_range_interval
Type: object
Defines the time interval for the range.
Nested Schema : module_page_id_deep
Type: object
Collection of page IDs of subpanels or tabs.

Response

200 Response
None
401 Response
Authentication required.
403 Response
Not allowed to set.

Examples

The following example shows how to customize the Oracle API Platform Cloud Service Developer Portal by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X POST 
-u apicsadmin:password
-H "Content-Type: application/json"
-d @config.json
https://example.com/apiplatform/developers/v1/customization/configuration

Example of Request Body

The following shows an example of the request body in JSON format that updates the Developer Portal logo.

{
	"branding": {
		"vendor": "${i18n.branding.vendor}",
		"product": "${i18n.branding.product}",
		"product_short": "${i18n.branding.product_short}",
		"title": "${i18n.branding.title}",
		"logo": {
			"url": "http://example.com/assets/dev-portal-logo.png",
			"width": "auto",
			"height": "17px",
			"alignment": "baseline"
		}
	}
}

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 16:13:46 GMT
Content-length: 0
X-oracle-dms-ecid: 7Gs7D0PnR00000000
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0