Waiting for engine...
Skip to main content

Boomi Agent Garden Design APIs - Packages

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.

Packages

Package agents for versioned deployment.

List All Packages

Retrieve list of packages for a given account ID and user ID across all agents.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW.

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

search_term
string (Search Term)

Filter by a substring match in name or objective

has_active_deployments
boolean (Has Active Deployments)
Default: false

Filter to return only packages with active deployments

sort_by
string (Sort By)
Default: "created_on"

Field to sort by

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

Sort order

Responses

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

Response samples

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

List Deployments By Package Id

Retrieve list of deployments for a given package ID, account ID and user ID.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
path Parameters
deployed_package_id
required
string <uuid> (Deployed Package Id)

The unique identifier of the deployed package to list deployments for

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: "deployed_on"

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 name or agent/deployment ID

env_name_search_term
string (Env Name Search Term)

Filter by substring match in environment_name

agent_id
string <uuid> (Agent Id)

Filter by agent ID

package_id
string <uuid> (Package Id)

Filter by package ID

runtime_id
string <uuid> (Runtime Id)

Filter by runtime ID

environment_id
Array of strings <uuid> (Environment Id) [ items <uuid > ]

Filter by environment ID

deployment_status
Array of strings (Deployment Status)
Items Enum: "ACTIVE" "DISABLED"

Filter by deployment status

agent_mode
string (AgentMode)
Enum: "conversational" "structured"

Filter by agent mode

Responses

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

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Deployments for Package with ID 6b392a3c-9c6e-4f09-8b55-177d7667d7ec retrieved successfully",
  • "data": {
    • "total_items": 1,
    • "total_pages": 1,
    • "current_page": 1,
    • "page_size": 100,
    • "items": [
      ]
    }
}