GET /v2/apps/{app_id}/components/{component_name}/logs

Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id.

Servers

Path parameters

Name Type Required Description
component_name String Yes

An optional component name. If set, logs will be limited to this component only.

app_id String Yes

The app ID

Query parameters

Name Type Required Description
type String Yes

The type of logs to retrieve

  • BUILD: Build-time logs
  • DEPLOY: Deploy-time logs
  • RUN: Live run-time logs
  • RUN_RESTARTED: Logs of crashed/restarted instances during runtime

Possible values:

  • "DEPLOY"
  • "RUN_RESTARTED"
  • "BUILD"
  • "UNSPECIFIED"
  • "RUN"

Default value: "UNSPECIFIED"

follow Boolean No

Whether the logs should follow live updates.

pod_connection_timeout String No

An optional time duration to wait if the underlying component instance is not immediately available. Default: 3m.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.