Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Artifact API

Create a new artifact

post/workspaces/{workspace_domain}/artifacts

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

Request body

namestring required

The display name of the artifact

identifierstring

The human-readable identifier of the artifact

type'CONTAINER' | 'BUCKET' | 'NPM' | 'COMPOSER' required

The type of artifact

scope'WORKSPACE' | 'PROJECT' | 'ENVIRONMENT' required

The scope level of the artifact

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

sandboxes_access_level'DENIED' | 'READ_ONLY' | 'USE_ONLY' | 'BLIND' | 'RUN_ONLY' | 'READ_WRITE' | 'MANAGE' | 'DEFAULT' | 'ALLOWED' | 'STAGE' | 'COMMIT'

Default access level for all sandboxes

Example request

{
  "name": "my_project_artifact",
  "identifier": "my-project-artifact",
  "type": "CONTAINER",
  "scope": "PROJECT",
  "project": {
    "name": "my-project"
  },
  "authorization": {
    "user": "myuser",
    "password": "secret123"
  },
  "permissions": {
    "others": "READ_ONLY",
    "users": [
      {
        "id": 42,
        "access_level": "MANAGE"
      }
    ],
    "groups": [
      {
        "id": 15,
        "access_level": "READ_ONLY"
      }
    ]
  },
  "allowed_pipelines": [
    {
      "project": "my-project",
      "pipeline": "deploy-pipeline",
      "access_level": "READ_WRITE"
    }
  ],
  "pipelines_access_level": "READ_ONLY",
  "allowed_sandboxes": [
    {
      "project": "my-project",
      "sandbox": "my-sandbox",
      "access_level": "READ_WRITE"
    }
  ],
  "sandboxes_access_level": "DENIED"
}

Response

Artifact created successfully

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

idinteger

The unique ID of the artifact

type'CONTAINER' | 'BUCKET' | 'NPM' | 'COMPOSER'

The type of artifact

namestring

The display name of the artifact

identifierstring

The human-readable identifier of the artifact

scope'WORKSPACE' | 'PROJECT' | 'ENVIRONMENT'

The scope level of the artifact

sizeinteger

Total size of all artifact versions in bytes

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

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_datestring date-time

Artifact creation timestamp

Example response

{
  "type": "CONTAINER",
  "name": "My Application Artifact",
  "identifier": "my-app-artifact",
  "scope": "WORKSPACE",
  "size": 1048576000,
  "project": {
    "name": "my-project",
    "display_name": "My Project"
  },
  "environment": {
    "name": "staging",
    "identifier": "my-staging",
    "scope": "PROJECT"
  },
  "authorization": {
    "user": "myuser",
    "password": "secret123"
  },
  "permissions": {
    "others": "READ_ONLY",
    "users": [
      {
        "id": 42,
        "access_level": "MANAGE"
      }
    ],
    "groups": [
      {
        "id": 15,
        "access_level": "READ_ONLY"
      }
    ]
  },
  "allowed_pipelines": [
    {
      "project": "my-project",
      "pipeline": "deploy-pipeline",
      "access_level": "READ_WRITE"
    }
  ],
  "pipelines_access_level": "READ_ONLY",
  "allowed_sandboxes": [
    {
      "project": "my-project",
      "sandbox": "my-sandbox",
      "access_level": "READ_WRITE"
    }
  ],
  "sandboxes_access_level": "DENIED",
  "created_date": "2024-01-22T09:15:00Z",
  "retention_rules": [
    {
      "id": 1,
      "type": "KEEP_BY_COUNT",
      "value": 10,
      "tag_filter": "^v\\d+\\.\\d+\\.\\d+$"
    }
  ]
}