Skip to content
AppHandoff AppHandoff Docs

Recheck one recorded repository and request sync recovery

POST
/projects/{id}/github-sync-health
 
curl --request POST \
  --url https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/github-sync-health \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "repository": "example" }'

Probes repository access under the original sync principal. Missing identities stay unresolved; recovery preserves the original repository and principal and never repeats a successful local write. A missing GitHub object alone does not prove repository access has been lost. A healthy latest probe does not imply all blocked original-identity work has recovered and never authorizes replay under another principal.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Project UUID

Request Body required

Section titled “Request Body required ”
Media type application/json
object
repository
required

GitHub repository in owner/repo format.

string
/^[A-Za-z0-9_-][A-Za-z0-9_.-]*/[A-Za-z0-9_-][A-Za-z0-9_.-]*$/

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Current observation and recovery status

Media type application/json
object
health
required

Safe project repository sync observation; no sync identity, credential, or provider response body.

object
id
required
string format: uuid
projectId
required
string format: uuid
repository
required

GitHub repository in owner/repo format.

string
state
required
string
Allowed values: healthy paused degraded
errorClass
required
string
Allowed values: none repository_access_denied installation_missing rate_limit transient object_not_found unknown
firstObservedAt
required
string format: date-time
lastObservedAt
required
string format: date-time
repairUrl
required

GitHub installation or repository settings page for administrator repair.

string format: uri
blockedSyncCount
required

Complete count of access-blocked sync work for this repository under original identities.

integer
recovery
required
object
scheduled
required
boolean
unresolved
required
boolean

400

Section titled “400 ”

Invalid request

Media type application/json
object
error
required

Human-readable error message

string
code

Stable machine-readable error code for client branching

string
fieldErrors

First validation message per field path

object
key
additional properties
string
issues

Structured validation issues (Zod)

Array<object>
object
path
required
string
message
required
string
retryAfter

Seconds until rate limit resets (429 responses)

number

401

Section titled “401 ”

Not authenticated

Media type application/json
object
error
required

Human-readable error message

string
code

Stable machine-readable error code for client branching

string
fieldErrors

First validation message per field path

object
key
additional properties
string
issues

Structured validation issues (Zod)

Array<object>
object
path
required
string
message
required
string
retryAfter

Seconds until rate limit resets (429 responses)

number
reconnect

True if re-linking GitHub may fix the issue

boolean

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required

Human-readable error message

string
code

Stable machine-readable error code for client branching

string
fieldErrors

First validation message per field path

object
key
additional properties
string
issues

Structured validation issues (Zod)

Array<object>
object
path
required
string
message
required
string
retryAfter

Seconds until rate limit resets (429 responses)

number

404

Section titled “404 ”

Not found

Media type application/json
object
error
required

Human-readable error message

string
code

Stable machine-readable error code for client branching

string
fieldErrors

First validation message per field path

object
key
additional properties
string
issues

Structured validation issues (Zod)

Array<object>
object
path
required
string
message
required
string
retryAfter

Seconds until rate limit resets (429 responses)

number

503

Section titled “503 ”

GitHub sync health unavailable

Media type application/json
object
error
required

Human-readable error message

string
code

Stable machine-readable error code for client branching

string
fieldErrors

First validation message per field path

object
key
additional properties
string
issues

Structured validation issues (Zod)

Array<object>
object
path
required
string
message
required
string
retryAfter

Seconds until rate limit resets (429 responses)

number