Boomi API Control Plane REST API - RuleSets

Toggle Pane

• Rule Sets
  • getGet ruleset by ID
  • putUpdate a ruleset
  • delDelete a ruleset
  • putAssign a ruleset to an organization
  • delRemove a ruleset from an organization
  • getDownload ruleset file
  • putUpload ruleset file
  • getList all rulesets
  • postCreate a new ruleset
  • postRe-validate all API specs against rulesets
  • postRe-validate all API specs asynchronously
  • getList rules in a ruleset
  • getList organizations assigned to a ruleset
  • delRemove all organizations from a ruleset
  • getList organizations available to assign

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.

Rule Sets

Spectral governance rulesets for spec validation.

Get ruleset by ID

Get a single rule set.

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

enabled required	boolean Active for validation.
name required	string Name of the ruleset.
description	string <= 1000 characters Optional description of the ruleset.
defaultRuleSet	boolean Built-in default (cannot delete).
fileName	string Uploaded ruleset filename.
id	string <uuid> System-assigned ID (read-only).

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets/{id}

GB Production

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

Response samples

• 200
• default

Content type

application/json

{

• "name": "Advanced Security",
• "description": "some text...",
• "enabled": true,
• "defaultRuleSet": true,
• "fileName": "string",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

Update a ruleset

Update a rule set.

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

enabled required	boolean Active for validation.
name required	string Name of the ruleset.
description	string <= 1000 characters Optional description of the ruleset.
defaultRuleSet	boolean Built-in default (cannot delete).
fileName	string Uploaded ruleset filename.
id	string <uuid> System-assigned ID (read-only).

Responses

Response Schema: application/json

enabled required	boolean Active for validation.
name required	string Name of the ruleset.
description	string <= 1000 characters Optional description of the ruleset.
defaultRuleSet	boolean Built-in default (cannot delete).
fileName	string Uploaded ruleset filename.
id	string <uuid> System-assigned ID (read-only).

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets/{id}

GB Production

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

Request samples

• Payload

Content type

application/json

{

• "name": "Advanced Security",
• "description": "some text...",
• "enabled": true,
• "defaultRuleSet": true,
• "fileName": "string",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

Response samples

• 200
• default

Content type

application/json

{

• "name": "Advanced Security",
• "description": "some text...",
• "enabled": true,
• "defaultRuleSet": true,
• "fileName": "string",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

Delete a ruleset

Delete a rule set.

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

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets/{id}

GB Production

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

Response samples

• default

Content type

application/json

{

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

}

Assign a ruleset to an organization

Add an organization to a rule set. The rule set will be applied to APIs from that organization.

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.
org 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

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets/{id}/organizations/{org}

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/ruleSets/{id}/organizations/{org}

Response samples

• default

Content type

application/json

{

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

}

Remove a ruleset from an organization

Remove an organization from a rule set. The rule set will no longer be applied to APIs from that organization. If no more organizations are assigned to this rule set afte the removal, the rule set will be applied to all organizations.

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.
org 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

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets/{id}/organizations/{org}

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/ruleSets/{id}/organizations/{org}

Response samples

• default

Content type

application/json

{

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

}

Download ruleset file

Get rule set file for a rule set.

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/octet-stream

string <binary>

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets/{id}/file

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/ruleSets/{id}/file

Response samples

• 404
• default

Content type

application/json

{

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

}

Upload ruleset file

Upload rule set file, overwriting any existing file for that rule set.

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: multipart/form-data

file required

string <binary>

Responses

Response Schema: application/json

errors required

Array of strings List of validation errors found in the ruleset file.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets/{id}/file

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/ruleSets/{id}/file

Response samples

• 200
• default

Content type

application/json

{

• "errors": [

  • "string"

  ]

}

List all rulesets

Get filtered and paged list of all rule sets.

Authorizations:

bearerAuth

query Parameters

text	string
name	string
enabled	boolean
defaultRuleSet	boolean
global	boolean
page	integer Default: 1 One-based page index (1..N)
size	integer Default: 10 The size of the page to be returned
sort	Array of arrays Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response Schema: application/json

required	Array of objects (RuleSetDTO) List of RuleSetDTO results for the current page.
last required	boolean Whether this is the last page.
number required	integer <int32> Current page number (1-based).
size required	integer <int32> Requested page size.
totalElements required	integer <int64> Total number of matching results across all pages.
totalPages required	integer <int32> Total number of pages.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/ruleSets

Response samples

• 200
• default

Content type

application/json

{

• "content": [

  • {

    • "name": "Advanced Security",
    • "description": "some text...",
    • "enabled": true,
    • "defaultRuleSet": true,
    • "fileName": "string",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

    }

  ],
• "size": 0,
• "number": 0,
• "last": true,
• "totalPages": 0,
• "totalElements": 0

}

Create a new ruleset

Create a new rule set.

Authorizations:

bearerAuth

Request Body schema: application/json

required

enabled required	boolean Active for validation.
name required	string Name of the ruleset.
description	string <= 1000 characters Optional description of the ruleset.
defaultRuleSet	boolean Built-in default (cannot delete).
fileName	string Uploaded ruleset filename.
id	string <uuid> System-assigned ID (read-only).

Responses

Response Schema: application/json

enabled required	boolean Active for validation.
name required	string Name of the ruleset.
description	string <= 1000 characters Optional description of the ruleset.
defaultRuleSet	boolean Built-in default (cannot delete).
fileName	string Uploaded ruleset filename.
id	string <uuid> System-assigned ID (read-only).

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/ruleSets

Request samples

• Payload

Content type

application/json

{

• "name": "Advanced Security",
• "description": "some text...",
• "enabled": true,
• "defaultRuleSet": true,
• "fileName": "string",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

Response samples

• 200
• default

Content type

application/json

{

• "name": "Advanced Security",
• "description": "some text...",
• "enabled": true,
• "defaultRuleSet": true,
• "fileName": "string",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

Re-validate all API specs against rulesets

Update lint results for all APIs. This may take a very long time! While this process is running, any further calls to this endpoint will return an error!

Authorizations:

bearerAuth

Responses

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets/lintUpdateAllApis

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/ruleSets/lintUpdateAllApis

Response samples

• default

Content type

application/json

{

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

}

Re-validate all API specs asynchronously

Asynchronously update lint results for all APIs. This may take a very long time! While this process is running, any further calls to this endpoint will return an error!

Authorizations:

bearerAuth

Responses

Response Schema: application/json

id required

string <uuid> UUID of the async job.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets/lintUpdateAllApis/async

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/ruleSets/lintUpdateAllApis/async

Response samples

• 200
• default

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

List rules in a ruleset

Get infos about each rule in a rule set, including rules from extended rule sets.

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

active required	boolean Whether the rule is currently active.
description required	string Human-readable description of what the rule checks.
name required	string Identifier of the rule.
severity required	string Enum: "ERROR" "WARNING" "INFO" "HINT" Severity of the rule: ERROR, WARNING, or INFO.
type required	string Enum: "SECURITY" "QUALITY" Category of the rule: SECURITY or QUALITY.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets/{id}/ruleInfos

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/ruleSets/{id}/ruleInfos

Response samples

• 200
• default

Content type

application/json

[

• {

  • "name": "string",
  • "active": true,
  • "description": "string",
  • "severity": "ERROR",
  • "type": "SECURITY"

  }

]

List organizations assigned to a ruleset

Get all organizations assigned to a rule set.

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.

query Parameters

page	integer Default: 1 One-based page index (1..N)
size	integer Default: 10 The size of the page to be returned
sort	Array of arrays Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response Schema: application/json

required	Array of objects (OrganizationDTO) List of OrganizationDTO results for the current page.
last required	boolean Whether this is the last page.
number required	integer <int32> Current page number (1-based).
size required	integer <int32> Requested page size.
totalElements required	integer <int64> Total number of matching results across all pages.
totalPages required	integer <int32> Total number of pages.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets/{id}/organizations

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/ruleSets/{id}/organizations

Response samples

• 200
• default

Content type

application/json

{

• "content": [

  • {

    • "name": "Default Organization",
    • "displayName": "Default Organization",
    • "email": "max.mustermann@apiida.com",
    • "description": "This is very cool Developer Portal",
    • "parent": 1,
    • "type": "BOTH",
    • "status": "ACTIVE",
    • "defaultOwner": true,
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "hasImage": false,
    • "parentDisplayName": "string"

    }

  ],
• "size": 0,
• "number": 0,
• "last": true,
• "totalPages": 0,
• "totalElements": 0

}

Remove all organizations from a ruleset

Remove all organizations from a rule set, making it apply to all organizations instead.

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

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets/{id}/organizations

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/ruleSets/{id}/organizations

Response samples

• default

Content type

application/json

{

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

}

List organizations available to assign

Get all organizations that may be added to a rule set. This list will contain all publishing organizations that have not been added, yet.

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.

query Parameters

text	string
type	string Enum: "BOTH" "CONSUMER" "PUBLISHER"
page	integer Default: 1 One-based page index (1..N)
size	integer Default: 10 The size of the page to be returned
sort	Array of arrays Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response Schema: application/json

required	Array of objects (OrganizationDTO) List of OrganizationDTO results for the current page.
last required	boolean Whether this is the last page.
number required	integer <int32> Current page number (1-based).
size required	integer <int32> Requested page size.
totalElements required	integer <int64> Total number of matching results across all pages.
totalPages required	integer <int32> Total number of pages.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/ruleSets/{id}/organizations/available

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/ruleSets/{id}/organizations/available

Response samples

• 200
• default

Content type

application/json

{

• "content": [

  • {

    • "name": "Default Organization",
    • "displayName": "Default Organization",
    • "email": "max.mustermann@apiida.com",
    • "description": "This is very cool Developer Portal",
    • "parent": 1,
    • "type": "BOTH",
    • "status": "ACTIVE",
    • "defaultOwner": true,
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "hasImage": false,
    • "parentDisplayName": "string"

    }

  ],
• "size": 0,
• "number": 0,
• "last": true,
• "totalPages": 0,
• "totalElements": 0

}