---
title: "Modifies an Artifact resource"
method: PUT
path: "/api/v1/artifacts/{id}"
tags: ["Artifacts"]
---

# Modifies an Artifact resource

`PUT /api/v1/artifacts/{id}`

## Path parameters

- `id` integer, required

## Headers

- `X-Fields` string, mask

## Request body

- ArtifactMutableFieldsLoad
  - `description` string — Description of the Artifact resource.
  - `pluginSnapshotId` integer — The Snapshot ID of the plugin containing the plugin file that performs serializing/deserializing of this Artifact.
  - `taskId` integer — The id of the plugin artifact task that performs theserializing/deserializing of this Artifact.

## Response `200`

Success

- ArtifactDump
  - `id` integer — ID for the Artifact resource.
  - `snapshot` integer — ID for the underlying Artifact snapshot.
  - `group` GroupRef
    - `id` integer — ID for the Group resource.
    - `name` string — Name of the Group resource.
    - `url` string — URL for accessing the full Group resource.
  - `user` UserRefDump
    - `id` integer — ID for the User resource.
    - `username` string — Username of the User resource.
    - `url` string — URL for accessing the full User resource.
  - `createdOn` string, date-time — Timestamp when the Artifact resource was created.
  - `snapshotCreatedOn` string, date-time — Timestamp when the Artifact resource snapshot was created.
  - `lastModifiedOn` string, date-time — Timestamp when the Artifact resource was last modified.
  - `latestSnapshot` boolean — Whether or not the Artifact resource is the latest version.
  - `hasDraft` boolean — Whether a draft exists for the Artifact resource.
  - `tags` TagRefDump[]
    - `id` integer — ID for the Tag.
    - `name` string — Name of the Tag.
    - `group` GroupRef
      - `id` integer — ID for the Group resource.
      - `name` string — Name of the Group resource.
      - `url` string — URL for accessing the full Group resource.
    - `url` string — URL for accessing the full Tag.
  - `description` string — Description of the Artifact resource.
  - `isDir` boolean — Whether the file denotes a directory or not.
  - `fileSize` integer — The size in bytes of the file.
  - `fileUrl` string — URL for accessing the contents of the Artifact.
  - `artifactUri` string — URL pointing to the location of the Artifact resource.
  - `job` integer, required — id of the job that produced this Artifact
  - `task` ArtifactArtifactTaskDump
    - `id` integer — Id of the PluginTask.
    - `name` string, required — Name of the PluginTask.
    - `outputParams` PluginTaskOutputParameterDump[]
      - `name` string, required — Name of the PluginTaskParameter.
      - `parameterType` PluginParameterTypeRef
        - `id` integer — ID for the PluginParameterType resource.
        - `group` GroupRef
          - `id` integer — ID for the Group resource.
          - `name` string — Name of the Group resource.
          - `url` string — URL for accessing the full Group resource.
        - `url` string — URL for accessing the full PluginParameterType resource.
        - `name` string — Name of the PluginParameterType resource.
    - `pluginResourceId` integer — resource id of the plugin containing the Artifact Task
    - `pluginResourceSnapshotId` integer — snapshot resource id of the plugin containing the Artifact Task
    - `pluginFileResourceId` integer — resource id of the plugin file containing the Artifact Task
    - `pluginFileResourceSnapshotId` integer — snapshot resource id of the plugin file containing the Artifact Task

---

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