Boomi API Control Plane REST API - Discovery

Toggle Pane

• Discovery
  • postDiscover APIs and components
  • postDiscover environments
  • postDiscover environments asynchronously
  • postDiscover APIs and components asynchronously

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.

Discovery

API and environment discovery in connected gateways.

Discover APIs and components

Discover APIs and/or components (applications, plans and subscriptions) in one or more environments.

Authorizations:

bearerAuth

Request Body schema: application/json

required

discoverApiPolicyTemplates required	boolean Whether to discover API policy templates. Requires discoverApis to be true.
discoverApis required	boolean Whether to discover APIs and their specifications.
discoverComponents required	boolean Whether to discover applications and subscriptions.
discoverCustomFields required	boolean Whether to discover custom field definitions.
ignoreExclusions required	boolean Whether to ignore previously configured discovery exclusions.
environments	Array of strings <uuid> [ items <uuid > ] UUIDs of specific environments to scan, or null to scan all environments.
stage	string Enum: "DEVELOPMENT" "PRODUCTION" Lifecycle stage filter: only scan environments matching this stage.

Responses

NA Production

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

GB Production

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

Request samples

• Payload

Content type

application/json

{

• "discoverApis": true,
• "discoverComponents": true,
• "discoverCustomFields": true,
• "environments": [

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

  ],
• "stage": "DEVELOPMENT",
• "discoverApiPolicyTemplates": true,
• "ignoreExclusions": true

}

Response samples

• default

Content type

application/json

{

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

}

Discover environments

Discover environments in a multi-environment API gateway.

Authorizations:

bearerAuth

Request Body schema: application/json

required

apiGateway required	string Identifier of the API gateway to discover APIs from.
ignoreExclusions required	boolean Whether to ignore configured exclusion rules during discovery.

Responses

NA Production

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

GB Production

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

Request samples

• Payload

Content type

application/json

{

• "apiGateway": "string",
• "ignoreExclusions": true

}

Response samples

• default

Content type

application/json

{

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

}

Discover environments asynchronously

Asynchronously discover environments in a multi-environment API gateway.

Authorizations:

bearerAuth

Request Body schema: application/json

required

apiGateway required	string Identifier of the API gateway to discover APIs from.
ignoreExclusions required	boolean Whether to ignore configured exclusion rules during discovery.

Responses

Response Schema: application/json

id required

string <uuid> UUID of the async job.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/discovery/environments/async

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/discovery/environments/async

Request samples

• Payload

Content type

application/json

{

• "apiGateway": "string",
• "ignoreExclusions": true

}

Response samples

• 200
• default

Content type

application/json

{

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

}

Discover APIs and components asynchronously

Asynchronously discover APIs and/or components (applications, plans and subscriptions) in one or more environments.

Authorizations:

bearerAuth

Request Body schema: application/json

required

discoverApiPolicyTemplates required	boolean Whether to discover API policy templates. Requires discoverApis to be true.
discoverApis required	boolean Whether to discover APIs and their specifications.
discoverComponents required	boolean Whether to discover applications and subscriptions.
discoverCustomFields required	boolean Whether to discover custom field definitions.
ignoreExclusions required	boolean Whether to ignore previously configured discovery exclusions.
environments	Array of strings <uuid> [ items <uuid > ] UUIDs of specific environments to scan, or null to scan all environments.
stage	string Enum: "DEVELOPMENT" "PRODUCTION" Lifecycle stage filter: only scan environments matching this stage.

Responses

Response Schema: application/json

id required

string <uuid> UUID of the async job.

NA Production

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

GB Production

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

Request samples

• Payload

Content type

application/json

{

• "discoverApis": true,
• "discoverComponents": true,
• "discoverCustomFields": true,
• "environments": [

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

  ],
• "stage": "DEVELOPMENT",
• "discoverApiPolicyTemplates": true,
• "ignoreExclusions": true

}

Response samples

• 200
• default

Content type

application/json

{

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

}