GET /v2/apps/{app_id}/jobs/{job_name}/invocations/{job_invocation_id}/logs

Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. If deployment is omitted the active deployment will be selected (if available). The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.

Servers

Path parameters

Name Type Required Description
job_invocation_id String Yes

The ID of the job invocation to retrieve.

app_id String Yes

The app ID

job_name String Yes

The job name to list job invocations for.

Query parameters

Name Type Required Description
deployment_id String No

The deployment ID

tail_lines String No

The number of lines from the end of the logs to retrieve.

type String Yes

The type of logs to retrieve

Valid values:

  • "JOB_INVOCATION"
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.