---
title: "Modifies a Model resource"
method: PUT
path: "/api/v1/models/{id}"
tags: ["Models"]
---

# Modifies a Model resource

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

## Path parameters

- `id` integer, required

## Headers

- `X-Fields` string, mask

## Request body

- ModelMutableFields
  - `name` string, required — Name of the Model resource.
  - `description` string — Description of the Model resource.

## Response `200`

Success

- ModelDump
  - `id` integer — ID for the Model resource.
  - `snapshot` integer — ID for the underlying Model 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 Model resource was created.
  - `snapshotCreatedOn` string, date-time — Timestamp when the Model resource snapshot was created.
  - `lastModifiedOn` string, date-time — Timestamp when the Model resource was last modified.
  - `latestSnapshot` boolean — Whether or not the Model resource is the latest version.
  - `hasDraft` boolean — Whether a draft exists for the Model 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.
  - `name` string, required — Name of the Model resource.
  - `description` string — Description of the Model resource.
  - `versions` ModelVersionRefDump[]
    - `versionNumber` integer — The version number of the Model.
    - `url` string — URL for accessing the full Model Version.
  - `latestVersion` ModelVersionDump
    - `description` string — Description of the Model Version.
    - `model` ModelRef
      - `id` integer — ID for the Model 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 Model resource.
      - `name` string, required — Name of the Model resource.
    - `artifact` ArtifactRefDump
      - `id` integer — ID for the Artifact 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 Artifact Resource.
    - `versionNumber` integer — The version number of the Model.
    - `createdOn` string, date-time — Timestamp when the Model Version was created.

## Changes

- **2026-07-17** `a73101579c5c` — 3 info
  - added the optional property `snapshotCreatedOn` to the response with the `200` status
  - added `#/components/schemas/ArtifactRef-dump` to the `latestVersion/allOf[#/components/schemas/ModelVersion-dump]/artifact` response property `allOf` list for the response status `200`
  - removed `#/components/schemas/ArtifactRef` from the `latestVersion/allOf[#/components/schemas/ModelVersion-dump]/artifact` response property `allOf` list for the response status `200`
- **2024-07-24** `9a36b9043379` — 1 warning, 2 info
  - removed the optional property `snapshotCreatedOn` from the response with the `200` status
  - added `#/components/schemas/ArtifactRef` to the `latestVersion/allOf[#/components/schemas/ModelVersion-dump]/artifact` response property `allOf` list for the response status `200`
  - removed `#/components/schemas/ArtifactRef-dump` from the `latestVersion/allOf[#/components/schemas/ModelVersion-dump]/artifact` response property `allOf` list for the response status `200`

[Change history](https://skmtc.dev/usnistgov/apis/dioptra-rest-api/changes/api/v1/models/:id/put.md)

---

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