v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB
DigitalOcean-public.v2-new_Apps

Retrieve Job Invocation 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.

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

Path parameters

app_idstring required

The app ID

job_namestring required

The job name to list job invocations for.

job_invocation_idstring required

The ID of the job invocation to retrieve.

Query parameters

deployment_idstring

The deployment ID

followboolean

Whether the logs should follow live updates.

type'JOB_INVOCATION' required

The type of logs to retrieve

pod_connection_timeoutstring

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

tail_linesstring int64

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

Response

A JSON object with urls that point to Job Invocation logs

historic_urlsstring[]
live_urlstring

A URL of the real-time live logs. This URL may use either the https:// or wss:// protocols and will keep pushing live logs as they become available.

Example response

{
  "historic_urls": [
    "https://logs/build.log"
  ],
  "live_url": "ws://logs/build"
}