space.highport.manage.getIndexStatus

Per-blob progress of a publish. Give exactly one of uri or domain. The top level describes the active revision, or the prepared record if nothing is active yet. A newer record prepared while another is active appears under preparation.

Details · query
Kindquery
Authoritymanage.highport.space
Indexed

Query

query · GET

Parameters

query string

domain

string

The site's hostname. Mutually exclusive with uri.

  • maxLength: 253

uri

string · at-uri

The record's AT-URI, in public or space form. Mutually exclusive with domain.

Output

application/json

activatedAt

string · datetime

cid

string · cid

edge

ref

Whether the edge routes this site's hostname to bard. Present only for a domain-backed record. An active index state says nothing about routing: a fully indexed site can still have its requests answered by something else. Treat unknown as no opinion.

entryCount

integer

errors

requiredarray

failed

requiredarray

Blobs that could not be fetched. Each includes sourceDid and role, which makes it clear when re-uploading will not help, such as a BlobUnavailable on a tile blob.

itemsref

fetched

integer

Blobs fetched and checked against their CIDs so far.

pending

integer

Blobs still to fetch.

A validated record waiting to be committed, while the domain still serves an earlier revision.

rev

string

The commit revision of the indexed record.

state

requiredref

Errors

RecordNotFound

Bard has no record at that URI or domain.

NotOwner

The record does not belong to the caller. For a tile URI, the caller must be the tile's repo.

SpaceNotFound

The URI is in space form and names a space bard does not serve, or one the caller is not in. Both cases get the same error, so it cannot be used to probe membership.