Function rename

rename(
    endpoint_xid: string,
    options:
        | undefined
        | {
            payload: Omit<
                { DATA_TYPE: "rename"; new_path: string; old_path: string },
                "DATA_TYPE",
            >;
        } & {
            headers?: Headers;
            query?: {
                [key: string]: | undefined
                | null
                | string
                | number
                | boolean
                | (undefined | null | string | number)[];
            };
        },
    sdkOptions?: SDKOptions,
): Promise<Response>
Rename or move a file, directory, or symlink on an endpoint filesystem. If the object is a symlink, the symlink itself is renamed, not its target The endpoint must be activated before performing this operation. When moving to a different parent directory, the parent directory of the new path must already exist.
Parameters
- endpoint_xid: string
- options:
      | undefined
      | {
          payload: Omit<
              { DATA_TYPE: "rename"; new_path: string; old_path: string },
              "DATA_TYPE",
          >;
      } & {
          headers?: Headers;
          query?: {
              [key: string]: | undefined
              | null
              | string
              | number
              | boolean
              | (undefined | null | string | number)[];
          };
      }
- OptionalsdkOptions: SDKOptions
Returns Promise<Response>
See
https://docs.globus.org/api/transfer/file_operations/#rename
- Defined in src/services/transfer/service/file-operations.ts:137

Function rename

Parameters

Returns Promise<Response>

See

Settings