Skip to content
General Augment Docs

Get Project Summary

GET
/api/v3/projects/{project_id}/summary
curl --request GET \
  --url https://example.com/api/v3/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/summary

Return Project authority and health without loading every operational tab.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project_id
required
Project Id
string format: uuid

Header Parameters

Section titled “Header Parameters”
X-Admin-Key
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ProjectSummaryResponseV3

One request needed to render Project health beside desired state.

object
api_version
Api Version
string
default: genaug.project-summary/v3
Allowed value: genaug.project-summary/v3
blockers
Blockers
Array<object>
ProjectBlockerV3

Actionable, secret-free reason a Project is not ready.

object
code
required
Code
string
message
required
Message
string
next_action
Any of:
string
resource
Any of:
string
target
Any of:
string
Allowed values: candidate live
candidate
Any of:
ProjectTargetSummaryV3

Desired and observed authority for Candidate or Live.

object
desired_generation
required
Desired Generation
integer
desired_release_id
required
Desired Release Id
string format: uuid
last_ready_at
Any of:
string format: date-time
observed_generation
Any of:
integer
observed_release_id
Any of:
string format: uuid
operation
required
ProjectOperationSummaryV3

Current durable operation attached to one target pointer.

object
blocker_reason
Any of:
string
id
required
Id
string format: uuid
last_error_code
Any of:
string
next_action
Any of:
string
phase
required
Phase
string
release_fingerprint
required
Release Fingerprint
string
status
required
Status
string
status
required
Status
string
target
required
Target
string
Allowed values: candidate live
connections
required
ProjectResourceHealthV3

Bounded aggregate health for one Project-owned resource family.

object
by_kind
By Kind
object
key
additional properties
integer
by_status
By Status
object
key
additional properties
integer
total
Total
integer
0
credentials
required
ProjectResourceHealthV3

Bounded aggregate health for one Project-owned resource family.

object
by_kind
By Kind
object
key
additional properties
integer
by_status
By Status
object
key
additional properties
integer
total
Total
integer
0
head
Any of:
ProjectRevisionSummaryV3

The exact server-versioned desired-state head.

object
generation
required
Generation
integer
revision_id
required
Revision Id
string format: uuid
source_fingerprint
required
Source Fingerprint
string
updated_at
required
Updated At
string format: date-time
live
Any of:
ProjectTargetSummaryV3

Desired and observed authority for Candidate or Live.

object
desired_generation
required
Desired Generation
integer
desired_release_id
required
Desired Release Id
string format: uuid
last_ready_at
Any of:
string format: date-time
observed_generation
Any of:
integer
observed_release_id
Any of:
string format: uuid
operation
required
ProjectOperationSummaryV3

Current durable operation attached to one target pointer.

object
blocker_reason
Any of:
string
id
required
Id
string format: uuid
last_error_code
Any of:
string
next_action
Any of:
string
phase
required
Phase
string
release_fingerprint
required
Release Fingerprint
string
status
required
Status
string
status
required
Status
string
target
required
Target
string
Allowed values: candidate live
next_actions
Next Actions
Array<string>
outbox
Outbox
object
key
additional properties
integer
project_id
required
Project Id
string format: uuid
reconciliation
required
ProjectResourceHealthV3

Bounded aggregate health for one Project-owned resource family.

object
by_kind
By Kind
object
key
additional properties
integer
by_status
By Status
object
key
additional properties
integer
total
Total
integer
0
review_url
required
Review Url
string
runs
required
ProjectResourceHealthV3

Bounded aggregate health for one Project-owned resource family.

object
by_kind
By Kind
object
key
additional properties
integer
by_status
By Status
object
key
additional properties
integer
total
Total
integer
0
runtime_keys
Runtime Keys
object
key
additional properties
boolean
state
required
State
string
Allowed values: unconfigured converging ready degraded blocked
workspace_id
required
Workspace Id
string format: uuid
Example
{
  "api_version": "genaug.project-summary/v3",
  "blockers": [
    {
      "target": "candidate"
    }
  ],
  "candidate": {
    "target": "candidate"
  },
  "connections": {
    "total": 0
  },
  "credentials": {
    "total": 0
  },
  "live": {
    "target": "candidate"
  },
  "reconciliation": {
    "total": 0
  },
  "runs": {
    "total": 0
  },
  "state": "unconfigured"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}