Update

View as Markdown

PATCH
/workspaces
/:workspace
/artifacts
/:artifact_Id

Update artifact configuration

Request

REQUIRED SCOPES

ARTIFACT_WRITE

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

artifact_Idrequiredstring

The Artifact ID

Example: "x5169jL2"

BODY PARAMETERS

namestring

The display name of the artifact. Can only be changed if artifact type is FILES.

identifierstring

The human-readable identifier of the artifact

projectProjectReferenceView

Project reference for artifact creation/update

environmentEnvironmentReferenceView

Environment reference for artifact creation/update

scopestring

The scope level of the artifact. Can only be changed to a higher level: ENVIRONMENT→PROJECT or WORKSPACE, PROJECT→WORKSPACE

authorizationAuthorizationView

Artifact authorization configuration. Password is only used in requests and not returned in responses. BASIC authorization can only be used with FILES type artifacts.

permissionsArtifactPermissionsView

Artifact permissions configuration

allowed_pipelinesAllowedPipelineView[]

List of pipelines allowed to access this artifact

pipelines_access_levelstring enum

Set to true to allow all pipelines to use this artifact

Allowed enum:

DENIED,

READ_ONLY,

USE_ONLY,

BLIND,

RUN_ONLY,

READ_WRITE,

MANAGE,

DEFAULT,

ALLOWED,

STAGE,

COMMIT

retention_rulesArtifactRetentionRuleView[]

List of retention rules for automatic cleanup of artifact versions

allowed_sandboxesAllowedSandboxView[]

List of sandboxes allowed to access this package

sandboxes_access_levelstring enum

Default access level for all sandboxes

Allowed enum:

DENIED,

READ_ONLY,

USE_ONLY,

BLIND,

RUN_ONLY,

READ_WRITE,

MANAGE,

DEFAULT,

ALLOWED,

STAGE,

COMMIT

Response

RESPONSE BODY

typestring enum

The type of artifact

Allowed enum:

CONTAINER,

BUCKET,

NPM,

COMPOSER

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

idinteger

The unique ID of the artifact

namestring

The display name of the artifact

identifierstring

The human-readable identifier of the artifact

scopestring enum

The scope level of the artifact

Allowed enum:

WORKSPACE,

PROJECT,

ENVIRONMENT

sizeinteger

Total size of all artifact versions in bytes

projectShortProjectView

Short representation of a project

environmentShortEnvironmentView

Short representation of an environment object

authorizationAuthorizationView

Artifact authorization configuration. Password is only used in requests and not returned in responses. BASIC authorization can only be used with FILES type artifacts.

permissionsArtifactPermissionsView

Artifact permissions configuration

allowed_pipelinesAllowedPipelineView[]

List of pipelines allowed to access this artifact

pipelines_access_levelstring enum

Set to true to allow all pipelines to use this artifact

Allowed enum:

DENIED,

READ_ONLY,

USE_ONLY,

BLIND,

RUN_ONLY,

READ_WRITE,

MANAGE,

DEFAULT,

ALLOWED,

STAGE,

COMMIT

allowed_sandboxesAllowedSandboxView[]

List of sandboxes allowed to access this package

sandboxes_access_levelstring enum

Default access level for all sandboxes

Allowed enum:

DENIED,

READ_ONLY,

USE_ONLY,

BLIND,

RUN_ONLY,

READ_WRITE,

MANAGE,

DEFAULT,

ALLOWED,

STAGE,

COMMIT

created_datestring

Artifact creation timestamp

retention_rulesArtifactRetentionRuleView[]

List of retention rules for automatic cleanup of artifact versions

Last modified on Jun 29, 2026

Get Artifacts Delete Artifacts

Examples

update-name update-scope update-auth

Example: update-name


curl -X PATCH "https://api.buddy.works/workspaces/:workspace/artifacts/:artifact_Id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "updated-artifact-name"
}'

Example: update-scope


curl -X PATCH "https://api.buddy.works/workspaces/:workspace/artifacts/:artifact_Id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "scope": "WORKSPACE"
}'

Example: update-auth


curl -X PATCH "https://api.buddy.works/workspaces/:workspace/artifacts/:artifact_Id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "authorization": {
    "type": "NONE"
  }
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2",
  "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions",
  "id": "x5169jL2",
  "name": "Updated Artifact Name",
  "identifier": "my-app-artifact",
  "type": "BUCKET",
  "project": {
    "url": "https://api.buddy.works/workspaces/ttests/projects/my-project",
    "html_url": "https://app.buddy.works/ttests/projects/my-project",
    "name": "my-project",
    "display_name": "My Project"
  },
  "environment": {
    "url": "https://api.buddy.works/workspaces/ttests/projects/my-project/environments/nZrnl40Y",
    "html_url": "https://app.buddy.works/ttests/projects/my-project/environments/nZrnl40Y",
    "name": "staging",
    "identifier": "my-staging",
    "id": "nZrnl40Y",
    "scope": "PROJECT"
  },
  "scope": "WORKSPACE",
  "authorization": {
    "type": "NONE"
  },
  "permissions": {
    "others": "READ_ONLY",
    "users": [
      {
        "id": 42,
        "access_level": "READ_WRITE"
      }
    ],
    "groups": [
      {
        "id": 15,
        "access_level": "READ_ONLY"
      }
    ]
  },
  "size": 524288000,
  "created_date": "2024-01-15T10:30:00Z"
}

STATUS
200 Artifact updated successfully