Boomi API Control Plane REST API - DeveloperPortalBlocks

Toggle Pane

• Developer Portal Blocks
  • getGet Developer Portal content block
  • putUpdate a Developer Portal content block
  • delDelete a Developer Portal content block
  • getList Developer Portal content blocks
  • postCreate a Developer Portal content block

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 Blocks

Content blocks within Developer Portal pages.

Get Developer Portal content block

Get one block 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

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

GB Production

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

Response samples

• 200
• default

Content type

application/json

{

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

  • "string"

  ],
• "default": true

}

Update a Developer Portal content block

Update existing block.

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

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

GB Production

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

Delete block 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}/blocks/{name}

GB Production

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

Response samples

• default

Content type

application/json

{

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

}

List Developer Portal content blocks

Get all blocks 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

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

GB Production

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

Response samples

• 200
• default

Content type

application/json

[

• {

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

    • "string"

    ],
  • "default": true

  }

]

Create a Developer Portal content block

Create new block. 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

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

GB Production

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

}