---
title: "Update artifact configuration"
method: PATCH
path: "/workspaces/{workspace_domain}/artifacts/{artifactId}"
tags: ["Artifact API"]
---

# Update artifact configuration

`PATCH /workspaces/{workspace_domain}/artifacts/{artifactId}`

## Path parameters

- `workspace_domain` string, required
- `artifactId` string, required

## Request body

- UpdateArtifactRequest — Update artifact fields. Restrictions: name can only be changed if artifact type is FILES, scope can only be changed to higher levels (ENVIRONMENT→PROJECT/WORKSPACE, PROJECT→WORKSPACE), type cannot be changed, BASIC authorization can only be used with FILES type artifacts.
  - `name` string — The display name of the artifact. Can only be changed if artifact type is FILES.
  - `identifier` string — The human-readable identifier of the artifact
  - `project` ProjectReferenceView — Project reference for artifact creation/update
    - `name` string, required — The name of the project
  - `environment` EnvironmentReferenceView — Environment reference for artifact creation/update
    - `id` integer, required — The ID of the environment
  - `scope` string — The scope level of the artifact. Can only be changed to a higher level: ENVIRONMENT→PROJECT or WORKSPACE, PROJECT→WORKSPACE
  - `authorization` AuthorizationView — Artifact authorization configuration. Password is only used in requests and not returned in responses. BASIC authorization can only be used with FILES type artifacts.
    - `type` 'NONE' | 'BUDDY' | 'BASIC', required — The type of authorization. BASIC can only be used with FILES type artifacts.
    - `user` string — Username for BASIC auth (required when type is BASIC)
    - `password` string — Password for BASIC auth (required when type is BASIC)
  - `permissions` ArtifactPermissionsView — Artifact permissions configuration
    - `others` 'DENIED' | 'READ_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT' — Permission level for others
    - `users` ArtifactUserPermissionView[] — List of user-specific permissions for the artifact
      - `id` integer, required — User ID
      - `access_level` 'DENIED' | 'READ_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT', required — Access level for the user
    - `groups` ArtifactGroupPermissionView[] — List of group-specific permissions for the artifact
      - `id` integer, required — Group ID
      - `access_level` 'DENIED' | 'READ_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT', required — Access level for the group
  - `allowed_pipelines` AllowedPipelineView[] — List of pipelines allowed to access this artifact
    - `project` string, required — Project name
    - `pipeline` string, required — Pipeline identifier
    - `access_level` 'DENIED' | 'READ_ONLY' | 'USE_ONLY' | 'BLIND' | 'RUN_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT' | 'ALLOWED' | 'STAGE' | 'COMMIT' — Access level for the allowed pipeline. Project repository targets: `DENIED`, `READ_ONLY`, `READ_WRITE`. Other targets: `DENIED`, `USE_ONLY`
  - `pipelines_access_level` 'DENIED' | 'READ_ONLY' | 'USE_ONLY' | 'BLIND' | 'RUN_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT' | 'ALLOWED' | 'STAGE' | 'COMMIT' — Set to `true` to allow all pipelines to use this artifact
  - `retention_rules` ArtifactRetentionRuleView[] — List of retention rules for automatic cleanup of artifact versions
    - `id` integer — The unique ID of the retention rule
    - `type` 'KEEP_ALL' | 'KEEP_BY_COUNT' | 'KEEP_BY_DATE' — The type of retention rule
    - `value` integer — The value for the retention rule (e.g., number of versions to keep or number of days)
    - `tag_filter` string — Regex pattern to filter artifact versions by tag. Only matching versions are affected by this rule.
  - `allowed_sandboxes` AllowedSandboxView[] — List of sandboxes allowed to access this package
    - `project` string, required — Project name
    - `sandbox` string, required — Sandbox identifier
    - `access_level` 'DENIED' | 'READ_ONLY' | 'USE_ONLY' | 'BLIND' | 'RUN_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT' | 'ALLOWED' | 'STAGE' | 'COMMIT' — Access level for the allowed sandbox: `DENIED`, `READ_ONLY`, `READ_WRITE`
  - `sandboxes_access_level` 'DENIED' | 'READ_ONLY' | 'USE_ONLY' | 'BLIND' | 'RUN_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT' | 'ALLOWED' | 'STAGE' | 'COMMIT' — Default access level for all sandboxes
  - `note` string — Note for this resource
  - `agent_note` string — YAML note for AI agents operating on this resource

## Response `200`

Artifact updated successfully

- ArtifactView — Full artifact representation
  - `url` string — API endpoint to GET this object
  - `html_url` string — Web URL to view this object in Buddy.works
  - `id` integer — The unique ID of the artifact
  - `type` 'CONTAINER' | 'BUCKET' | 'NPM' | 'COMPOSER' — The type of artifact
  - `name` string — The display name of the artifact
  - `identifier` string — The human-readable identifier of the artifact
  - `scope` 'WORKSPACE' | 'PROJECT' | 'ENVIRONMENT' — The scope level of the artifact
  - `size` integer — Total size of all artifact versions in bytes
  - `project` ShortProjectView — Short representation of a project
    - `url` string — API endpoint to GET this object
    - `html_url` string — Web URL to view this object in Buddy.works
    - `name` string — The human-readable ID of the project
    - `display_name` string, required — The Name of the project
    - `status` string — The status of the project
    - `access` 'PRIVATE' | 'PUBLIC' — Indicates if this is a public project
    - `create_date` string, date-time — The creation date of the project
  - `environment` ShortEnvironmentView — Short representation of an environment object
    - `url` string — API endpoint to GET this object
    - `html_url` string — Web URL to view this object in Buddy.works
    - `name` string — The name of the environment
    - `identifier` string — The human-readable identifier of the environment
    - `id` integer — The ID of the environment
    - `scope` 'PROJECT' | 'WORKSPACE' | 'ANY' — The scope level of the environment
  - `authorization` AuthorizationView — Artifact authorization configuration. Password is only used in requests and not returned in responses. BASIC authorization can only be used with FILES type artifacts.
    - `type` 'NONE' | 'BUDDY' | 'BASIC', required — The type of authorization. BASIC can only be used with FILES type artifacts.
    - `user` string — Username for BASIC auth (required when type is BASIC)
    - `password` string — Password for BASIC auth (required when type is BASIC)
  - `permissions` ArtifactPermissionsView — Artifact permissions configuration
    - `others` 'DENIED' | 'READ_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT' — Permission level for others
    - `users` ArtifactUserPermissionView[] — List of user-specific permissions for the artifact
      - `id` integer, required — User ID
      - `access_level` 'DENIED' | 'READ_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT', required — Access level for the user
    - `groups` ArtifactGroupPermissionView[] — List of group-specific permissions for the artifact
      - `id` integer, required — Group ID
      - `access_level` 'DENIED' | 'READ_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT', required — Access level for the group
  - `allowed_pipelines` AllowedPipelineView[] — List of pipelines allowed to access this artifact
    - `project` string, required — Project name
    - `pipeline` string, required — Pipeline identifier
    - `access_level` 'DENIED' | 'READ_ONLY' | 'USE_ONLY' | 'BLIND' | 'RUN_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT' | 'ALLOWED' | 'STAGE' | 'COMMIT' — Access level for the allowed pipeline. Project repository targets: `DENIED`, `READ_ONLY`, `READ_WRITE`. Other targets: `DENIED`, `USE_ONLY`
  - `pipelines_access_level` 'DENIED' | 'READ_ONLY' | 'USE_ONLY' | 'BLIND' | 'RUN_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT' | 'ALLOWED' | 'STAGE' | 'COMMIT' — Set to `true` to allow all pipelines to use this artifact
  - `allowed_sandboxes` AllowedSandboxView[] — List of sandboxes allowed to access this package
    - `project` string, required — Project name
    - `sandbox` string, required — Sandbox identifier
    - `access_level` 'DENIED' | 'READ_ONLY' | 'USE_ONLY' | 'BLIND' | 'RUN_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT' | 'ALLOWED' | 'STAGE' | 'COMMIT' — Access level for the allowed sandbox: `DENIED`, `READ_ONLY`, `READ_WRITE`
  - `sandboxes_access_level` 'DENIED' | 'READ_ONLY' | 'USE_ONLY' | 'BLIND' | 'RUN_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT' | 'ALLOWED' | 'STAGE' | 'COMMIT' — Default access level for all sandboxes
  - `created_date` string, date-time — Artifact creation timestamp
  - `retention_rules` ArtifactRetentionRuleView[] — List of retention rules for automatic cleanup of artifact versions
    - `id` integer — The unique ID of the retention rule
    - `type` 'KEEP_ALL' | 'KEEP_BY_COUNT' | 'KEEP_BY_DATE' — The type of retention rule
    - `value` integer — The value for the retention rule (e.g., number of versions to keep or number of days)
    - `tag_filter` string — Regex pattern to filter artifact versions by tag. Only matching versions are affected by this rule.
  - `note` string — Note for this resource
  - `agent_note` string — YAML note for AI agents operating on this resource

---

[API](https://skmtc.net/buddy/apis/buddy-api.md) · [All operations](https://skmtc.net/buddy/apis/buddy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/buddy/buddy-api/versions/2426d67c249a/schema)