Boomi API Control Plane REST API - DeveloperPortalPages

Toggle Pane

• Developer Portal Pages
  • getGet Developer Portal page by name
  • putUpdate a Developer Portal page
  • delDelete a Developer Portal page
  • getList Developer Portal pages
  • postCreate a Developer Portal page

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.

Developer Portal Pages

Custom content pages within Developer Portals.

Get Developer Portal page by name

Get one page by name.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.
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/{id}/pages/{name}

GB Production

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

Response samples

• 200
• default

Content type

application/json

{

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

  • "string"

  ],
• "default": true

}

Update a Developer Portal page

Update existing page.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.
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/{id}/pages/{name}

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/devPortals/{id}/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

}

Delete a Developer Portal page

Delete page by name.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.
name required	string

Responses

NA Production

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

GB Production

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

Response samples

• default

Content type

application/json

{

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

}

List Developer Portal pages

Get all pages for developer portal.

Authorizations:

bearerAuth

path Parameters

id required

string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.

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/{id}/pages

GB Production

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

Response samples

• 200
• default

Content type

application/json

[

• {

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

    • "string"

    ],
  • "default": true

  }

]

Create a Developer Portal page

Create new page. Name must be unique.

Authorizations:

bearerAuth

path Parameters

id required

string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.

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/{id}/pages

GB Production

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

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

}