Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - AtomLog

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Download Atom log

You can use this operation to request and download Runtime logs. Because large Runtime logs can take some time to download, the Platform API provides an asynchronous technique for downloading Runtime logs:

  1. You send a Runtime Log request to the Boomi Enterprise Platform API that specifies the Runtime ID and the date of the logged events.
  2. The Enterprise platform returns a Log Download object that contains a URL with a unique Runtime log ID.
  3. You open the URL to download the log.

    Note: Runtime logs purge 30 days after creation.

You must have the Runtime Management privilege to download Runtime logs. If you have the Runtime Management Read Access privilege, you cannot perform this action.

Required Privileges

You need these privileges in the target environment:

Write access

  • N/A

Read access

  • API — Use the Boomi Platform API to access account data.
  • ATOM_MANAGEMENT — Configure and administer integration runtimes.
  • User should have access to the container.

Creates an AtomLog object

You can use the Download Atom Log operation to request and download Runtime logs.

Authorizations:
basicAuth
Request Body schema:
optional
atomId
string

The ID of the Runtime.

includeBin
boolean

If true, binary files are included in the download. The default is false.

logDate
string

The date of the logged events.

Responses

Response Schema:
statusCode
string

The status code as one of the following:

  • 202 — status message: Beginning download.
  • 504 — status message: Runtime is unavailable.
message
string

The status message.

url
string

(statusCode 202 only) The URL for the download.

Request samples

Content type
{
  • "atomId": "3456789a-bcde-f012-3456-789abcdef012",
  • "logDate": "2016-02-05",
  • "includeBin": true
}

Response samples

Content type
{}