Files

Rename a file.

Changed on

This endpoint updates the name of an existing File, identified by its assetId. This operation is only permitted if the requester has appropriate write-level permissions on the file.

NOTE:

  • Only the name of the file can be modified using this endpoint.
  • All other file metadata remains unchanged.
  • If the requester lacks the required permissions or the file does not exist, an appropriate error response will be returned.
post/files/{assetId}/rename

Request

  • Base URL: https://cloudstorage.adobe.io/v1
  • URL: https://cloudstorage.adobe.io/v1/files/{assetId}/rename
  • Auth: HTTP bearer

Path parameters

assetIdstring required

A globally unique identifier for the asset

Example:urn:aaid:sc:US:4f2fc15c-c062-4951-b37b-1f65ed62a174

The ID of the asset to get.

Headers

x-request-idstring
Example:1234567890

The X-Request-Id header is used to identify a request.
It can be used to correlate logs and other resources and is intended to be a non-persistent identifier.

Request body

namestring required

The name of the asset (including the extension, in case of a file)

The name must not be a

  • reserved Windows name
    • CON
    • PRN
    • AUX
    • NUL
    • COM1 through COM9
    • LPT1 through LPT9
  • contain any of the following characters:
    • \
    • /
    • :
    • *
    • ?
    • "
    • |
    • >
    • <

Example request

{
  "options": {
    "autorename": true
  }
}

Response

Updated - The file was renamed successfully.

assetIdstring required

A globally unique identifier for the asset

namestring required

Human-readable name of the asset

createdDatestring date-time
modifiedDatestring date-time
createdBystring

The Unique ID for the principal in the system

modifiedBystring

The Unique ID for the principal in the system

pathstring

The path of the asset from the parent collection.

ancestorsAssetId[]

Ordered list of ancestor asset IDs (first is immediate parent).

state'active' | 'deleted' | 'deleted_parent'

Current state of the asset

assetTypestring required
mediaTypestring required

The MIME type of the file

sizeinteger required

Size of the file in bytes

Example response

{
  "assetId": "urn:aaid:sc:US:4f2fc15c-c062-4951-b37b-1f65ed62a174",
  "name": "My Asset",
  "createdDate": "2021-01-01T00:00:00Z",
  "modifiedDate": "2021-01-01T00:00:00Z",
  "createdBy": "08D81E3B665BE5640A495C2C@AdobeOrg",
  "modifiedBy": "08D81E3B665BE5640A495C2C@AdobeOrg",
  "path": "/My Project/My Folder/My Asset",
  "ancestors": [
    "urn:aaid:sc:US:4f2fc15c-c062-4951-b37b-1f65ed62a174",
    "urn:aaid:sc:US:4f2fc15c-c062-4951-b37b-1f65ed62a175",
    "urn:aaid:sc:US:4f2fc15c-c062-4951-b37b-1f65ed62a176"
  ],
  "mediaType": "image/jpeg",
  "size": 1048576
}

Changes

  • 240b6278279cRevision changes
    • breaking

      added the pattern ^(?!^([Cc][Oo][Nn]|[Pp][Rr][Nn]|[Aa][Uu][Xx]|[Nn][Uu][Ll]|[Cc][Oo][Mm][1-9]|[Ll][Pp][Tt][1-9])$)[^\\\/:*?"|><]+$ to the request property

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • info

      the request property's minLength was decreased from 1 to 0

  • 01600f5358e9Revision changes
    • info

      endpoint added