Projects

Update a project

Updates project properties. Changing the display name also changes the project name used in URLs.

patch/api/projects/{owner}/{project}

Request

  • Base URL
    https://platform.ultralytics.com
  • Auth
    HTTP bearer

Path parameters

ownerstring required
Example:ultralytics

Project owner

projectstring required
Example:yolo26

Project name

Request body

starredboolean
namestring
descriptionstring
metadataobject

Custom JSON metadata with keys limited to 128 characters and at most 500,000 serialized characters.

visibility'public' | 'private'

Resource visibility

tagsstring[]
license'None' | 'Apache-2.0' | 'MIT' | 'BSD-3-Clause' | 'AGPL-3.0' | 'GPL-3.0' | 'LGPL-3.0' | 'MPL-2.0' | 'EUPL-1.1' | 'Unlicense' | 'CC0-1.0' | 'Ultralytics-Enterprise' | 'Other'

Project/model license identifier

archivedboolean
iconColorstring

Response

Project updated

OR

Changes

No recorded changes to this operation across all 43 revisions of this API.