Skip to content

Inspect authenticated contact, session ownership, maintenance, authority and retained work. Optionally select one context for read-only setup readiness and corrective guidance; this never requests host checks. Maintenance completes only after assigned work, uploads and configured archives settle; queued work remains for resume.

GET
/api/v1/connectors/{connector_id}/diagnostics
connector_id
required
string
context_id
string
<= 64 characters /^[a-z][a-z0-9_-]{0,63}$/

Select one context belonging to this connector for setup readiness. Stored evidence only; request fresh host checks explicitly through preflight.

Inspect authenticated contact, session ownership, maintenance, authority and retained work. Optionally select one context for read-only setup readiness and corrective guidance; this never requests host checks. Maintenance completes only after assigned work, uploads and configured archives settle; queued work remains for resume.

Media typeapplication/json
object
archived_at
required
string | null
authority_withdrawn
required
boolean
configuration_capacity
required
object
counts
required
object
historical_publications
required
integer format: int64
retained_publications
required
integer format: int64
retired_publications
required
integer format: int64
retirement_requested
required
integer format: int64
desired_bytes
required
integer
maximum_connector_cache_bytes
required
integer
maximum_desired_bytes
required
integer
maximum_retained_publications
required
integer
configuration_pending
required
boolean
connector_id
required
string
draining
required
boolean
failed_publications
required
integer format: int64
generation
required
integer format: int64
maintenance_complete
required
boolean
observed_generation
required
integer format: int64
owner_id
required
string format: uuid
ownership_generation
required
integer format: int64
work
required

Counts describe durable service evidence, never scientific inputs or results.

object
assignment_phases
required
object
collecting_results
required
integer format: int64
executing
required
integer format: int64
preparing
required
integer format: int64
uploading_results
required
integer format: int64
waiting_for_backend
required
integer format: int64
pending_delivery_assignments
required
integer format: int64
pending_log_archives
required
integer format: int64
pending_uploads
required
integer format: int64
retained_queued_runs
required
integer format: int64
unconfirmed_assignments
required

A subset of unfinished assignments; stale contact cannot prove completion.

integer format: int64
unfinished_assignments
required
integer format: int64
build_observation
One of:
null
contact
One of:
null
preflight
object
current_blocked
required
integer format: int64
current_ready
required
integer format: int64
pending
required
integer format: int64
stale_or_unavailable
required
integer format: int64
session
One of:
null
setup
One of:
null
unfinished_assignments
required
integer format: int64
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Malformed request.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Valid active credential required; connector and user credentials are separate.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

The token does not permit this operation.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Resource absent or outside the caller’s authority.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Concurrent generation/publication change, conflicting retry, or a publication awaiting connector validation.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

413: the request body exceeds the configured size limit.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Request fields, manifest, installation policy, or limits are invalid.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Authentication, identity provider, or management state is temporarily unavailable.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

An HTTP request failed; inspect the stable error code and request ID.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Documentation 205dcb3116ea · public sources 8c70356d340f · built .Download documentation identity.