Sign in

v1

latestOpenAPI 3.0.02026-07-145965251.1 KB
Resources

Rename a resource.

Update the specified file or folder resource record's "name" parameter. The resource is identified by the numeric resource ID that is passed in as the last segment of the URI.

patch/resources/{id}

Headers

ev-access-tokenstring required

Access token required to make the API call.

ev-api-keystring required

API key required to make the API call.

Request body

namestring

The new name for the resource (file or folder).

Example request

{
  "name": "my-renamed-file.txt"
}

Response

Successful operation

responseStatusinteger

Http status code of the response.

Example response

{
  "data": {
    "attributes": {
      "accessedAt": "2011-03-21T00:18:56-07:00",
      "createdAt": "2011-03-21T00:18:56-07:00",
      "createdBy": "exampleuser",
      "hash": "ec4aa9a91be282666a165899a14f29b1",
      "name": "examplefolder",
      "path": "/examplefolder",
      "previewable": true,
      "updatedAt": "2011-03-21T00:18:56-07:00",
      "uploadDate": "2011-03-21T00:18:56-07:00"
    },
    "id": 1,
    "relationships": {
      "directFile": {
        "data": {
          "id": 2,
          "type": "directFile"
        }
      },
      "notifications": [
        {
          "data": {
            "id": 2,
            "type": "notification"
          }
        }
      ],
      "parentResource": {
        "data": {
          "id": 2,
          "type": "resource"
        }
      },
      "share": {
        "data": {
          "id": 2345,
          "type": "share"
        }
      }
    },
    "type": "resource"
  },
  "included": [
    {
      "attributes": {
        "accessTimestamp": "2011-03-21T00:18:56-07:00",
        "accountName": "exampleaccount",
        "created": "2018-07-27T15:43:55-07:00",
        "email": "example@exavault.mail",
        "expiration": "2020-06-30T13:33:30-07:00",
        "homePath": "/",
        "modified": "2018-07-29T15:43:55-07:00",
        "nickname": "exampleuser",
        "role": "user",
        "status": 1,
        "timeZone": "America/Chicago",
        "username": "exampleuser"
      },
      "id": 655621,
      "relationships": {
        "homeResource": {
          "data": {
            "type": "resource"
          }
        },
        "ownerAccount": {
          "data": {
            "type": "account"
          }
        }
      },
      "type": "user"
    }
  ],
  "responseStatus": 200
}