Boomi API Control Plane REST API - Agents

Toggle Pane

• Agents
  • getGet agent status for an environment
  • putRegister or reset agent for an environment
  • delDelete agent from an environment
  • putGenerate new agent token for a gateway
  • postRefresh gateway info for an environment
  • postRefresh gateway info asynchronously
  • postRefresh all gateway info asynchronously
  • postRefresh all gateway info asynchronously
  • postRefresh all gateway info
  • postRefresh all gateway info
  • postRefresh gateway info for a specific gateway
  • postRefresh gateway info for a gateway 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.

Agents

Agent registration and gateway communication.

Get agent status for an environment

Get agent status for an environment.

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

status required	string Enum: "NOT_CONNECTED" "CONNECTED" "NOT_CONFIGURED" "CONNECTING" NOT_CONNECTED, CONNECTED, NOT_CONFIGURED, or CONNECTING.
	object (GatewayInfo) Gateway connection status and diagnostic info.
remoteIp	string Remote IP address of the agent.
lastSeen	string <date-time> Last heartbeat.
	Array of objects (AgentCapability) unique Supported capabilities (discovery, deployment, metrics).
	object (AgentBuildInfo) Agent build version and commit info.

NA Production

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

GB Production

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

Response samples

• 200
• default

Content type

application/json

{

• "status": "NOT_CONNECTED",
• "gateway": {

  • "status": "UNKNOWN",
  • "errors": [

    • "string"

    ]

  },
• "remoteIp": "string",
• "lastSeen": "2019-08-24T14:15:22Z",
• "capabilities": [

  • {

    • "capability": "string",
    • "version": "string"

    }

  ],
• "buildInfo": {

  • "version": "string",
  • "commit": "string",
  • "buildTime": "2019-08-24T14:15:22Z"

  }

}

Register or reset agent for an environment

Request new agent token for an environment. Any existing token will be overwritten, which means agents can no longer connect with that token.

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

token required

string Bearer token used by the agent to authenticate with the Control Plane.

NA Production

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

GB Production

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

Response samples

• 200
• default

Content type

application/json

{

• "token": "string"

}

Delete agent from an environment

Delete the agent token. Agents will no longer be able to use that token to connect.

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

GB Production

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

Response samples

• default

Content type

application/json

{

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

}

Generate new agent token for a gateway

Generate a new agent token for an API gateway. Any existing token will be overwritten, which means agents can no longer connect with the previous token.

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

token required

string Bearer token used by the agent to authenticate with the Control Plane.

NA Production

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

GB Production

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

Response samples

• 200
• default

Content type

application/json

{

• "token": "string"

}

Refresh gateway info for an environment

Refresh agent status for an environment.

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

status required	string Enum: "NOT_CONNECTED" "CONNECTED" "NOT_CONFIGURED" "CONNECTING" NOT_CONNECTED, CONNECTED, NOT_CONFIGURED, or CONNECTING.
	object (GatewayInfo) Gateway connection status and diagnostic info.
remoteIp	string Remote IP address of the agent.
lastSeen	string <date-time> Last heartbeat.
	Array of objects (AgentCapability) unique Supported capabilities (discovery, deployment, metrics).
	object (AgentBuildInfo) Agent build version and commit info.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/environments/{id}/agent/refreshGatewayInfo

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/environments/{id}/agent/refreshGatewayInfo

Response samples

• 200
• default

Content type

application/json

{

• "status": "NOT_CONNECTED",
• "gateway": {

  • "status": "UNKNOWN",
  • "errors": [

    • "string"

    ]

  },
• "remoteIp": "string",
• "lastSeen": "2019-08-24T14:15:22Z",
• "capabilities": [

  • {

    • "capability": "string",
    • "version": "string"

    }

  ],
• "buildInfo": {

  • "version": "string",
  • "commit": "string",
  • "buildTime": "2019-08-24T14:15:22Z"

  }

}

Refresh gateway info asynchronously

Asynchronously refresh agent status for an environment.

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

id required

string <uuid> UUID of the async job.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/environments/{id}/agent/refreshGatewayInfo/async

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/environments/{id}/agent/refreshGatewayInfo/async

Response samples

• 200
• default

Content type

application/json

{

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

}

Refresh all gateway info asynchronously

Asynchronously refresh status for all agents.

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/environments/refreshAllGatewayInfo/async

GB Production

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

Response samples

• 200
• default

Content type

application/json

{

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

}

Refresh all gateway info asynchronously

Asynchronously refresh status for all agents.

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/apiGateways/refreshAllGatewayInfo/async

GB Production

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

Response samples

• 200
• default

Content type

application/json

{

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

}

Refresh all gateway info

Refresh status for all agents.

Authorizations:

bearerAuth

Responses

NA Production

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

GB Production

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

Response samples

• default

Content type

application/json

{

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

}

Refresh all gateway info

Refresh status for all agents.

Authorizations:

bearerAuth

Responses

NA Production

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

GB Production

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

Response samples

• default

Content type

application/json

{

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

}

Refresh gateway info for a specific gateway

Refresh agent status for an API gateway.

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

status required	string Enum: "NOT_CONNECTED" "CONNECTED" "NOT_CONFIGURED" "CONNECTING" NOT_CONNECTED, CONNECTED, NOT_CONFIGURED, or CONNECTING.
	object (GatewayInfo) Gateway connection status and diagnostic info.
remoteIp	string Remote IP address of the agent.
lastSeen	string <date-time> Last heartbeat.
	Array of objects (AgentCapability) unique Supported capabilities (discovery, deployment, metrics).
	object (AgentBuildInfo) Agent build version and commit info.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/apiGateways/{id}/agent/refreshGatewayInfo

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/apiGateways/{id}/agent/refreshGatewayInfo

Response samples

• 200
• default

Content type

application/json

{

• "status": "NOT_CONNECTED",
• "gateway": {

  • "status": "UNKNOWN",
  • "errors": [

    • "string"

    ]

  },
• "remoteIp": "string",
• "lastSeen": "2019-08-24T14:15:22Z",
• "capabilities": [

  • {

    • "capability": "string",
    • "version": "string"

    }

  ],
• "buildInfo": {

  • "version": "string",
  • "commit": "string",
  • "buildTime": "2019-08-24T14:15:22Z"

  }

}

Refresh gateway info for a gateway asynchronously

Asynchronously refresh agent status for an API gateway.

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

id required

string <uuid> UUID of the async job.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/apiGateways/{id}/agent/refreshGatewayInfo/async

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/apiGateways/{id}/agent/refreshGatewayInfo/async

Response samples

• 200
• default

Content type

application/json

{

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

}