Waiting for engine...
Skip to main content

Boomi Agent Garden Design APIs - Environments

Toggle Pane
API docs by Redocly

Download OpenAPI Specification: Download

Run In Postman

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

Environments

Query runtime environments available for deployment.

List All Environments

Retrieve list of environments for a given account ID and user ID.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW, AGENT_EDIT, AGENT_CREATE.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
query Parameters
page
integer (Page) >= 1
Default: 1

Page number to retrieve

page_size
integer (Page Size) [ 1 .. 100 ]
Default: 100

Number of records per page

sort_by
string (Sort By)
Default: "deployment_count"

Field to sort by

sort_order
string (Sort Order) ^(asc|desc)$
Default: "desc"

Sort order (default: desc)

search_term
string (Search Term)

Filter by a substring match in env ID or name

classification
string (EnvironmentClassification)
Enum: "PRODUCTION" "TEST"

Filter by a environment classification

source
string (EnvironmentSource)
Enum: "INTEGRATION" "AGENT_GARDEN"

Filter by a environment source

env_status
Array of strings (Env Status)
Items Enum: "ATTACHED" "DETACHED"

Filter by a environment status

runtime_id
Array of strings <uuid> (Runtime Id) [ items <uuid > ]

Filter by a runtime IDs

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
PaginationResponse[Union[EnvironmentResponse, IntegrationEnvironmentResponse]] (object) or null

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Environments retrieved successfully",
  • "data": {
    • "total_items": 2,
    • "total_pages": 1,
    • "current_page": 1,
    • "page_size": 100,
    • "items": [
      ]
    }
}