Asset Management

Rename a collection

Moves every one of your assets in from to to, in one statement — the way to rename a collection, or with to: "" to take its assets out of any collection. Renaming onto a name that is already in use merges the two. updated is how many assets moved; a name nothing is in moves nothing and is not an error. Both names are checked like any other collection name, and a chain job's job: collections cannot be renamed.

USE THIS WHEN:

  • Renaming, merging or dissolving a collection

DO NOT USE WHEN:

  • Moving some assets, not all of a collection → use POST /api/v1/assets/update with collection
post/api/v1/assets/collections/rename

Request

  • Base URL: https://api.imagestep.dev
  • URL: https://api.imagestep.dev/api/v1/assets/collections/rename
  • Auth: API key in header Authorization

Headers

Idempotency-Keystring

Optional. A client-generated unique key (typically a UUID). Same key + the same request (method, path, query string and body) replays the first response verbatim with Idempotency-Replayed: true, without executing again. Same key + a different one returns 409 idempotency_key_reuse. A repeat that arrives while the first is still running returns 409 request_in_progress, which is retryable. Keys are retained 24 hours. At most 255 characters; a longer one is a 400 invalid_param with param: "Idempotency-Key".

Request body

fromstring required

The collection as it is named now

tostring required

Its new name; "" takes the assets out of any collection (at most 200 characters; names starting with job: are reserved)

Example request

{
  "from": "shoot-01",
  "to": "shoot-2026-09"
}

Response

What moved

Changes

No recorded changes to this operation across all 1 revision of this API.