List all artifacts

GET

/api/v1/artifacts

const url = 'http://localhost:11044/api/v1/artifacts';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/artifacts \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Returns artifacts grouped by type.

Authorizations

apiKeyAuth
basicAuth

Responses

200

Every artifact, grouped by lower-case type name

*/*

Every artifact in the world, grouped by type

object

artifacts

required

Artifacts by lower-case ArtifactType name. Every type is present, carrying an empty list when it holds nothing

object

key

additional properties

Array<object>

One artifact as the listings describe it: its identity, size, provenance and, for an app, where it is served

object

createdAt

When it was created, ISO-8601. Null where the filesystem does not expose creation time

string

createdBy

Who or what created it. Null for artifacts older than change tracking

string

description

The artifact’s own description where it declares one, null where it does not

string

iconUrl

Where this app’s icon is served from. Null for non-apps and for the many apps that declare no icon — a client keeps whatever it drew before

string

lastModified

required

When this artifact was last written, ISO-8601

string

lastModifiedBy

required

Who or what most recently wrote it

string

name

required

The artifact’s name, unique within its type

string

readOnly

required

True for an artifact from a read-only source — a world template or an installed realm — which cannot be edited or deleted here

boolean

scope

required

The URL scope an app is served under: the workspace, the world, or a realm name. Non-app artifacts carry the default

string

servable

required

True when this artifact’s TYPE can be served as files, which is a property of the type and not of this artifact

boolean

sizeBytes

required

File size in bytes

integer format: int64

type

required

The ArtifactType name, upper case

string

url

Where an app is served from. Null for every artifact that is not an app

string