List agents built but not deployed

client.Build.ListUndeployed(ctx) (*[]BuildListUndeployedResponse, error)

GET/v5/builds/undeployed

List agents that exist only as cloud builds and have no healthy deployment yet.

Unlike listing builds, this aggregates by agent: it returns one entry per distinct agent name whose builds have never reached a healthy deploy, each carrying that agent’s most recent build and its total build count. The result is a plain list (not paginated) and is limited to builds the caller is permitted to read. Use this to surface agents that were built but still need to be deployed; use GET /v5/builds when you need the individual build records instead.

ReturnsExpand Collapse

type BuildListUndeployedResponse []BuildListUndeployedResponse

AgentName string

The agent name from cloud builds

LatestBuild AgentexCloudBuild

The most recent cloud build for this agent

ID string

The unique identifier of the entity.

AccountID string

The ID of the account that owns the given entity.

AgentName string

The name of the agent that this build belongs to

BuildStatus AgentexCloudBuildBuildStatus

The current build lifecycle status

One of the following:

const AgentexCloudBuildBuildStatusQueued AgentexCloudBuildBuildStatus = "queued"

const AgentexCloudBuildBuildStatusRunning AgentexCloudBuildBuildStatus = "running"

const AgentexCloudBuildBuildStatusSuccess AgentexCloudBuildBuildStatus = "success"

const AgentexCloudBuildBuildStatusFailed AgentexCloudBuildBuildStatus = "failed"

const AgentexCloudBuildBuildStatusCancelling AgentexCloudBuildBuildStatus = "cancelling"

const AgentexCloudBuildBuildStatusCancelled AgentexCloudBuildBuildStatus = "cancelled"

const AgentexCloudBuildBuildStatusDeleting AgentexCloudBuildBuildStatus = "deleting"

const AgentexCloudBuildBuildStatusDeleteFailed AgentexCloudBuildBuildStatus = "delete_failed"

const AgentexCloudBuildBuildStatusTimedOut AgentexCloudBuildBuildStatus = "timed_out"

const AgentexCloudBuildBuildStatusError AgentexCloudBuildBuildStatus = "error"

const AgentexCloudBuildBuildStatusUnknown AgentexCloudBuildBuildStatus = "unknown"

CloudProviderBuildID string

The unique identifier of the build from the cloud provider, or an internal UUID when an existing image is copied without a provider build.

CreatedAt Time

The date and time when the entity was created in ISO format.

formatdate-time

CreatedBy Identity

The identity that created the entity.

ID string

Type IdentityType

One of the following:

const IdentityTypeUser IdentityType = "user"

const IdentityTypeServiceAccount IdentityType = "service_account"

Object IdentityObjectOptional

ImageName string

The name of the container image to build.

ImageTag string

The tag for the container image.

SourceCommit string

Git commit the build context was at, when a git work tree.

SourceDirty bool

Whether the work tree had uncommitted changes at build time (null outside git).

SourceRef string

Git branch or tag for source_commit, when resolvable.

SourceRepo string

Normalized git remote the build context came from (host/path, no credentials).

SourceSubpath string

Build-context path relative to the repo root (which agent, in a monorepo).

WorkingTreeHash string

Deterministic SHA-256 content hash of the build inputs (not the tarball).

AgentID stringOptional

The UUID of the agent that this build belongs to

BuildEndTime TimeOptional

When the cloud provider finished the build

formatdate-time

BuildStartTime TimeOptional

When the cloud provider started the build

formatdate-time

ImageURL stringOptional

The URL of the container image. This is not guaranteed to be present until the build is complete.

Object AgentexCloudBuildObjectOptional

TotalBuilds int64

Total number of builds for this agent

List agents built but not deployed

package main

import (
  "context"
  "fmt"

  "github.com/scaleapi/sgp-dev-go"
  "github.com/scaleapi/sgp-dev-go/option"
)

func main() {
  client := sgpdev.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithAccountID("My Account ID"),
  )
  response, err := client.Build.ListUndeployed(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}

[
  {
    "agent_name": "agent_name",
    "latest_build": {
      "id": "id",
      "account_id": "account_id",
      "agent_name": "agent_name",
      "build_status": "queued",
      "cloud_provider_build_id": "cloud_provider_build_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "image_name": "image_name",
      "image_tag": "image_tag",
      "source_commit": "source_commit",
      "source_dirty": true,
      "source_ref": "source_ref",
      "source_repo": "source_repo",
      "source_subpath": "source_subpath",
      "working_tree_hash": "working_tree_hash",
      "agent_id": "agent_id",
      "build_end_time": "2019-12-27T18:11:19.117Z",
      "build_start_time": "2019-12-27T18:11:19.117Z",
      "image_url": "image_url",
      "object": "agentex_cloud_build"
    },
    "total_builds": 0
  }
]

Returns Examples

[
  {
    "agent_name": "agent_name",
    "latest_build": {
      "id": "id",
      "account_id": "account_id",
      "agent_name": "agent_name",
      "build_status": "queued",
      "cloud_provider_build_id": "cloud_provider_build_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "image_name": "image_name",
      "image_tag": "image_tag",
      "source_commit": "source_commit",
      "source_dirty": true,
      "source_ref": "source_ref",
      "source_repo": "source_repo",
      "source_subpath": "source_subpath",
      "working_tree_hash": "working_tree_hash",
      "agent_id": "agent_id",
      "build_end_time": "2019-12-27T18:11:19.117Z",
      "build_start_time": "2019-12-27T18:11:19.117Z",
      "image_url": "image_url",
      "object": "agentex_cloud_build"
    },
    "total_builds": 0
  }
]