Give Feedback

godo.Apps.GetJobInvocation()

Generated on 5 Nov 2026 from godo version v1.236.0

Copy page as Markdown View page as Markdown

Usage

client.Apps.GetJobInvocation(ctx context.Context, appID string, jobInvocationId string, opts *godo.GetJobInvocationOptions) (*godo.JobInvocation, *godo.Response, error)

Description

GetJobInvocation gets a specific job invocation for a given app.

This method sends a GET request to /v2/apps/{}/job-invocations/{}.

Parameters

appID string required
jobInvocationId string required
opts *godo.GetJobInvocationOptions

Fields of `godo.GetJobInvocationOptions`

JobName string

Returns

*godo.JobInvocation
*godo.Response: The HTTP response, with pagination Links, Meta, and Rate limit information.
error: Non-nil when the request fails. API errors are returned as *godo.ErrorResponse.

Fields of `godo.JobInvocation`

JobInvocation struct for JobInvocation

ID string: Omitted from JSON when empty. JSON key: id
JobName string: Omitted from JSON when empty. JSON key: job_name
DeploymentID string: Omitted from JSON when empty. JSON key: deployment_id
Phase godo.JobInvocationPhase: Omitted from JSON when empty. JSON key: phase
Trigger *godo.JobInvocationTrigger: Omitted from JSON when empty. JSON key: trigger
CreatedAt time.Time: Omitted from JSON when empty. JSON key: created_at
StartedAt time.Time: Omitted from JSON when empty. JSON key: started_at
CompletedAt time.Time: Omitted from JSON when empty. JSON key: completed_at

Request Sample

Show Request Sample

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	"github.com/digitalocean/godo"
)

func main() {
	client := godo.NewFromToken(os.Getenv("DIGITALOCEAN_TOKEN"))
	ctx := context.TODO()

	result, _, err := client.Apps.GetJobInvocation(ctx, "<your-app-id>", "<your-job-invocation-id>", &godo.GetJobInvocationOptions{
		JobName: "<your-job-name>",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", result)
}

Response Example

Show Response Example

{
  "job_invocation": [
    {
      "id": "ba32b134-569c-4c0c-ba02-8ffdb0492ece",
      "job_name": "good-job",
      "deployment_id": "c020763f-ddb7-4112-a0df-7f01c69fc00b",
      "phase": "SUCCEEDED",
      "created_at": "2025-09-11T11:04:05Z",
      "started_at": "2025-09-11T11:04:10Z",
      "completed_at": "2025-09-11T11:04:40Z",
      "trigger": [
        {
          "type": "SCHEDULED",
          "scheduled": [
            {
              "schedule": {
                "cron": "*/2 * * * *",
                "time_zone": "UTC"
              }
            }
          ]
        }
      ]
    }
  ]
}