Skip to content
Console
Menu

Getting Started

Authentication

KV Store

sylphx artifacts artifacts

Every sylphx artifacts artifacts command: its argument, its flags and a run line.

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

The artifacts commands of Sylphx Artifacts, as the CLI spells them: the same calls as the artifacts API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

Not available yet. Sylphx Artifacts is declared in the registry but no backend serves it: every command answers 501 with the problem code UNIMPLEMENTED.

#get

Gets an artifact.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx artifacts artifacts get orgs/acme/projects/shop/artifacts/artifact

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/artifacts/artifact · scope artifacts:read · effect read · Request, response and examples

#list

Lists a project's artifacts; filter by digest, kind, or subject.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell
sylphx artifacts artifacts list orgs/acme/projects/shop

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/artifacts · scope artifacts:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--page-sizeintAt most this many; default 50, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.
--filterstringAIP-160 filter over labels and filterable fields.
--order-bystringAIP-132 ordering over filterable fields.

#create

Registers an artifact whose bytes were pushed by digest; verification runs after.

ID — The id segment of the new Resource's name; the server assigns one when omitted.

CLI

Shell
sylphx artifacts artifacts create --parent orgs/acme/projects/shop --digest … --kind image --media-type … --size-bytes 1

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/artifacts · scope artifacts:write · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--parentstringThe parent to create in; defaults to the linked project or the key's scope.
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--digeststringThe algorithm-qualified digest of the stored bytes, for example sha256:4f1c…. Required.
--kindenumWhat the Artifact is. Required. One of image, sbom, provenance, signature, bundle.
--media-typestringThe media type, for example application/vnd.oci.image.manifest.v1+json. Required.
--size-bytesintThe size of the stored bytes. Required.
--subjectstringThe Artifact this one describes, for an SBOM, provenance, or signature.
--source-digestsstringDigests of the sources and inputs that produced it. Repeat the flag for each value.
--retentionenumHow long the Artifact is kept. One of standard, referenced.
--dry-runboolValidate and print the result without writing (validate_only).

#delete

Deletes an artifact; fails while a Release references it or a legal hold is active.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx artifacts artifacts delete orgs/acme/projects/shop/artifacts/artifact --yes

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/artifacts/artifact · scope artifacts:write · effect destructive · Request, response and examples

Flags

FlagTypeWhat it does
--etagstringDelete only if the current etag matches.
--dry-runboolValidate and print the result without writing (validate_only).
--yesboolDo not ask before this destructive call.