Menu
Platform
AI
Alerts and status pages
App store purchases
Credits
Generated Assets
Knowledge
KV
Localization
Notifications
Organizations
Payments
Queues
Realtime
Sandboxes
Storage
Workflows
API reference
- Overview
- Access API keys
- Agent sessions API
- Agent versions API
- Agents API
- AI models API
- Artifact references API
- Artifacts API
- Assets API
- Auth configs API
- Bank receipts API
- Bank transfer accounts API
- Buckets API
- Builds API
- Catalogs API
- Chat profiles API
- Chat reports API
- Chat sticker packs API
- Checkout policies API
- Checkout sessions API
- Config changes API
- Config flags API
- Config segments API
- Connection providers API
- Connections API
- Connectors API
- Credit grants API
- Customer organizations API
- Customer subscriptions API
- Databases API
- Documents API
- Email domains API
- End users API
- Entities API
- Entitlement grants API
- Entries API
- Environments API
- Episodes API
- Error events API
- Error groups API
- Events API
- Exchange rates API
- Generations API
- Glossaries API
- Goals API
- Identities API
- Inbound emails API
- Inbound endpoints API
- Inbound sms API
- Invitations API
- Job runs API
- Jobs API
- Knowledge schemas API
- KV API
- KV namespaces API
- Lease events API
- Leases API
- Licence keys API
- Licence tokens API
- Mail domains API
- Mail routes API
- Mailbox connect links API
- Mailbox OAUTH apps API
- Mailboxes API
- Memberships API
- Memories API
- Memory stores API
- Merchant accounts API
- Message topics API
- Messages API
- OAUTH clients API
- Objects API
- Organization roles API
- Owner pools API
- Phone numbers API
- Portal sessions API
- Preferences API
- Price catalogs API
- Processor events API
- Projects API
- Queued executions API
- Queues API
- Realtime channels API
- Realtime members API
- Realtime messages API
- Recipients API
- Relations API
- Releases API
- Revenue API
- Revenue facts API
- Revenue sources API
- Runs API
- Sandbox shapes API
- Schedules API
- Scrubbing policies API
- Search API
- Search indexes API
- Secret versions API
- Secrets API
- Service enablements API
- Service observations API
- Services API
- Serving routes API
- Session events API
- Sessions API
- Signing key versions
- Signing keys
- Sms numbers API
- Source maps API
- Spaces API
- Store connections API
- Store purchases API
- Subscriptions API
- Suppressions API
- Tax threshold statuses API
- Templates API
- Test clocks API
- Token exchanges API
- Transfers API
- Trust policies API
- Trusted issuers API
- Uptime checks API
- Uptime manifests API
- Uptime sources API
- Usage events API
- Usage invoices API
- Usage meter prices API
- Usage meters API
- Usage reservations API
- Usage settings API
- Usage tiers API
- Volumes API
- Waits API
- Webhook deliveries API
- Webhook endpoints API
- Workflows API
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx artifacts artifact_references
Every sylphx artifacts artifact_references command: its argument, its flags and a run line.
The artifact_references commands of Sylphx Artifacts, as the CLI spells them: the same
calls as the artifact_references API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#update
Updates a holder's retention reference, or creates it with allow_missing. Existing expiry is only extended, never shortened. The exact repository and digest must have an owned Artifact receipt. Success means the registry protection tag has been written and read back; a failed pin attempt commits no reference. Concurrent updates never shorten retention.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx artifacts artifact-references update orgs/acme/projects/shop/envs/production/artifact_references/artifact-referencePATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/artifact_references/artifact-reference · scope artifacts:retain · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--expires-at | timestamp | Keep this image until this instant. Repeating Update only extends it. Required. |
--allow-missing | bool | Create this reference when absent, after verifying ownership and pinning. |
#list
Lists this environment's holder references, including expired references.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx artifacts artifact-references list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/artifact_references · scope artifacts:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | Maximum results; defaults to 50 and is capped at 1000. |
--page-token | string | The next_page_token of the preceding page with the same parameters. |
--filter | string | A filter on repository, digest or holder_kind, using the List filter grammar. |
#get
Gets an exact holder reference, including its current expiry.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx artifacts artifact-references get orgs/acme/projects/shop/envs/production/artifact_references/artifact-referenceGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/artifact_references/artifact-reference · scope artifacts:read · effect read · Request, response and examples
#delete
Releases this holder's reference. Other holders keep their protection; registry reconciliation removes a stale tag only after every root expires. Releasing an already absent reference succeeds.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx artifacts artifact-references delete orgs/acme/projects/shop/envs/production/artifact_references/artifact-reference --yesDELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/artifact_references/artifact-reference · scope artifacts:retain · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--yes | bool | Do not ask before this destructive call. |