Boomi API Control Plane REST API - CurrentDeveloperPortal

Toggle Pane

• Current Developer Portal
  • getGet current portal page by name
  • putUpdate current portal page
  • getGet current portal content block
  • putUpdate current portal content block
  • delDelete current portal content block
  • getList current portal content blocks
  • postCreate current portal content block
  • getGet current portal welcome page
  • getGet current portal terms of use
  • getGet current portal properties
  • getList current portal pages
  • getGet current portal menu items
  • getDownload current portal file
  • getGet current portal favicon

API docs by Redocly

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

Current Developer Portal

Endpoints scoped to the active Developer Portal session.

Get current portal page by name

Get a single page by name for the current developer portal.

Authorizations:

bearerAuth

path Parameters

name required

string

Responses

Response Schema: application/json

blocks required	Array of strings Names of the content blocks included on this page.
name required	string Unique name identifying this page.
title required	string Display title of the page.
default	boolean Whether this is the default landing page of the portal.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/devPortals/current/pages/{name}

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/current/pages/{name}

Response samples

• 200
• default

Content type

application/json

{

• "name": "string",
• "title": "string",
• "blocks": [

  • "string"

  ],
• "default": true

}

Update current portal page

Update existing page.

Authorizations:

bearerAuth

path Parameters

name required

string

Request Body schema: application/json

required

blocks required	Array of strings Names of the content blocks included on this page.
name required	string Unique name identifying this page.
title required	string Display title of the page.
default	boolean Whether this is the default landing page of the portal.

Responses

Response Schema: application/json

blocks required	Array of strings Names of the content blocks included on this page.
name required	string Unique name identifying this page.
title required	string Display title of the page.
default	boolean Whether this is the default landing page of the portal.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/devPortals/current/pages/{name}

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/current/pages/{name}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "title": "string",
• "blocks": [

  • "string"

  ],
• "default": true

}

Response samples

• 200
• default

Content type

application/json

{

• "name": "string",
• "title": "string",
• "blocks": [

  • "string"

  ],
• "default": true

}

Get current portal content block

Get a single block by name for the current developer portal.

Authorizations:

bearerAuth

path Parameters

name required

string

Responses

Response Schema: application/json

content required	string HTML or markdown content of the block.
name required	string Unique name identifying this content block.
pages	Array of strings Names of the pages this block appears on.
default	boolean Whether this block appears on all pages by default.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/devPortals/current/blocks/{name}

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/current/blocks/{name}

Response samples

• 200
• default

Content type

application/json

{

• "name": "string",
• "content": "string",
• "pages": [

  • "string"

  ],
• "default": true

}

Update current portal content block

Update existing block.

Authorizations:

bearerAuth

path Parameters

name required

string

Request Body schema: application/json

required

content required	string HTML or markdown content of the block.
name required	string Unique name identifying this content block.
pages	Array of strings Names of the pages this block appears on.
default	boolean Whether this block appears on all pages by default.

Responses

Response Schema: application/json

content required	string HTML or markdown content of the block.
name required	string Unique name identifying this content block.
pages	Array of strings Names of the pages this block appears on.
default	boolean Whether this block appears on all pages by default.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/devPortals/current/blocks/{name}

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/current/blocks/{name}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "content": "string",
• "pages": [

  • "string"

  ],
• "default": true

}

Response samples

• 200
• default

Content type

application/json

{

• "name": "string",
• "content": "string",
• "pages": [

  • "string"

  ],
• "default": true

}

Delete current portal content block

Delete block by name.

Authorizations:

bearerAuth

path Parameters

name required

string

Responses

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/devPortals/current/blocks/{name}

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/current/blocks/{name}

Response samples

• default

Content type

application/json

{

• "timestamp": "string",
• "status": 0,
• "error": "string",
• "message": "string",
• "path": "string"

}

List current portal content blocks

Get all blocks for the current developer portal.

Authorizations:

bearerAuth

Responses

Response Schema: application/json

Array

content required	string HTML or markdown content of the block.
name required	string Unique name identifying this content block.
pages	Array of strings Names of the pages this block appears on.
default	boolean Whether this block appears on all pages by default.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/devPortals/current/blocks

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/current/blocks

Response samples

• 200
• default

Content type

application/json

[

• {

  • "name": "string",
  • "content": "string",
  • "pages": [

    • "string"

    ],
  • "default": true

  }

]

Create current portal content block

Create new block. Name must be unique.

Authorizations:

bearerAuth

Request Body schema: application/json

required

content required	string HTML or markdown content of the block.
name required	string Unique name identifying this content block.
pages	Array of strings Names of the pages this block appears on.
default	boolean Whether this block appears on all pages by default.

Responses

Response Schema: application/json

content required	string HTML or markdown content of the block.
name required	string Unique name identifying this content block.
pages	Array of strings Names of the pages this block appears on.
default	boolean Whether this block appears on all pages by default.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/devPortals/current/blocks

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/current/blocks

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "content": "string",
• "pages": [

  • "string"

  ],
• "default": true

}

Response samples

• 200
• default

Content type

application/json

{

• "name": "string",
• "content": "string",
• "pages": [

  • "string"

  ],
• "default": true

}

Get current portal welcome page

Get raw content of welcome page for current developer portal. Requires DevPortalToken header!

Authorizations:

bearerAuth

Responses

Response Schema: application/octet-stream

string <binary>

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/devPortals/current/welcomePage

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/current/welcomePage

Response samples

• default

Content type

application/json

{

• "timestamp": "string",
• "status": 0,
• "error": "string",
• "message": "string",
• "path": "string"

}

Get current portal terms of use

Get all terms of use documents that are assigned to this developer portal, including documents marked as default for all developer portals.

query Parameters

active

boolean

Responses

Response Schema: application/json

Array

active required	boolean Whether this terms-of-use document is currently active.
defaultForApiProducts required	boolean Default for new API Products.
defaultForDevPortals required	boolean Default for portal registration.
name required	string Display name of the terms-of-use document.
createdAt	string <date-time> Timestamp when the document was created.
id	string <uuid> UUID of the terms-of-use document.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/devPortals/current/termsOfUse

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/current/termsOfUse

Response samples

• 200
• default

Content type

application/json

[

• {

  • "name": "string",
  • "active": true,
  • "defaultForApiProducts": true,
  • "defaultForDevPortals": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

  }

]

Get current portal properties

Get properties of current developer portal.

Responses

Response Schema: application/json

logoFile	string If present, must be the name of a file that has been uploaded to /devPortals/{id}/files.
logoFileSmall	string If present, must be the name of a file that has been uploaded to /devPortals/{id}/files.
logoFileIco	string If present, must be the name of a file that has been uploaded to /devPortals/{id}/files.
colorPrimary	string Primary brand color (hex code).
colorSecondary	string Secondary brand color (hex code).
colorMenuText	string Menu text color (hex code).
colorPrimaryButtonText	string Primary button text color (hex code).
devPortalName	string Portal display name (read-only, derived from DevPortalDTO).
showApiOwner	boolean Whether API owner is shown (read-only, derived from DevPortalDTO).
allowSubscriptionUpdate	boolean Whether plan changes are allowed (read-only, derived from DevPortalDTO).
showMenuIcons	boolean Whether to show icons in the developer portal menu.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/devPortals/current/properties

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/current/properties

Response samples

• 200
• default

Content type

application/json

{

• "logoFile": "string",
• "logoFileSmall": "string",
• "logoFileIco": "string",
• "colorPrimary": "string",
• "colorSecondary": "string",
• "colorMenuText": "string",
• "colorPrimaryButtonText": "string",
• "devPortalName": "string",
• "showApiOwner": true,
• "allowSubscriptionUpdate": true,
• "showMenuIcons": true

}

List current portal pages

Get all pages for the current developer portal.

Authorizations:

bearerAuth

Responses

Response Schema: application/json

Array

blocks required	Array of strings Names of the content blocks included on this page.
name required	string Unique name identifying this page.
title required	string Display title of the page.
default	boolean Whether this is the default landing page of the portal.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/devPortals/current/pages

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/current/pages

Response samples

• 200
• default

Content type

application/json

[

• {

  • "name": "string",
  • "title": "string",
  • "blocks": [

    • "string"

    ],
  • "default": true

  }

]

Get current portal menu items

Get menu items for the current developer portal.

Responses

Response Schema: application/json

Array

enabled required	boolean Indicates whether the menu item is enabled. If not, it will not show up in the Developer Portal.
text required	string Display label of the menu item.
type required	string Enum: "URL" "PAGE" "SYSTEM" URL (external link) or PAGE (internal portal page).
visibility required	string Enum: "ALWAYS" "LOGGED_IN" "LOGGED_OUT" Controls which users can see this menu item. Can be ALWAYS, LOGGED_IN (for authenticated users only) or LOGGED_OUT (for guest users only).
iconName	string Optional icon name to display alongside the label.
url	string Target URL, required when type is URL.
pageName	string Internal page name, required when type is PAGE.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/devPortals/current/menuItems

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/current/menuItems

Response samples

• 200
• default

Content type

application/json

[

• {

  • "type": "URL",
  • "text": "string",
  • "iconName": "string",
  • "url": "string",
  • "pageName": "string",
  • "enabled": true,
  • "visibility": "ALWAYS"

  }

]

Download current portal file

Get content of a previously uploaded documentation file for the current developer portal. Requires DevPortalToken header!

path Parameters

fileName required

string

Responses

Response Schema: application/octet-stream

string <binary>

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/devPortals/current/files/{fileName}

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/current/files/{fileName}

Response samples

• default

Content type

application/json

{

• "timestamp": "string",
• "status": 0,
• "error": "string",
• "message": "string",
• "path": "string"

}

Get current portal favicon

Get favicon (default or configured)

Responses

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/devPortals/current/favicon

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/current/favicon

Response samples

• default

Content type

application/json

{

• "timestamp": "string",
• "status": 0,
• "error": "string",
• "message": "string",
• "path": "string"

}