Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Prepare upload on an artifact

Mints one short-lived registry credential and the unique image reference for an upload of this project.

Mints one short-lived registry credential and the unique image reference for an upload of this project. The repository is derived from the caller's grant and this parent, never from the caller; the tag is unique per call, so uploads of the same project never collide. Push to the reference, then register the pushed digest with CreateArtifact.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/artifacts:prepareUpload
  • Scope artifacts:write
  • Effect write — a successful call changes state.
  • Collection artifacts

#Request

FieldTypeWhat it is
parentstringThe project the image is uploaded to. Required.

#Response

FieldTypeWhat it is
image_referencestringThe repository and tag to push, <registry>/<org>/<project>-image:<upload>; the tag is unique per call. Output only.
registry_authstringA Docker config JSON whose identitytoken for the registry authenticates this upload; a push credential, never stored or logged. Output only. Never returned again.
expires_attimestampWhen the credential stops authenticating. expires_at names the issuer credential's expiry, the credential protocol's field. Output only.

#Errors

  • UNAUTHENTICATED — No valid key or token was presented.
  • PERMISSION_DENIED — The key lacks the method's permission.
  • INVALID_FIELD — A field failed validation.
  • UNAVAILABLE — The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/artifacts:prepareUpload" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'