List objects

Preview

Lists objects in your environment. You can define a prefix to list a subset of your objects. If you do not set a prefix, Lattice returns all available objects. By default this endpoint will list local objects only.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

prefixstringOptional
Filters the objects based on the specified prefix path. If no path is specified, all objects are returned.
sinceTimestampdatetimeOptional

Filters out objects whose last_updated_at is earlier than this timestamp.

last_updated_at records when an object arrived on the node that holds it, so this filter selects objects that arrived since the given time. It is not the time the object was authored: a copy that reaches a node later carries the later arrival time.

pageTokenstringOptionalformat: "string"
Opaque cursor for continuing the same list request. Start a new listing without the previous cursor if any query parameter or listing scope changes.
allObjectsInMeshbooleanOptional
Lists objects across all environment nodes in a Lattice Mesh. When false or unset, only objects held by the local node are returned.
maxPageSizeintegerOptional
Sets the maximum number of items that should be returned on a single page.

Response

Successful operation
path_metadataslist of objects
next_page_tokenstringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error