Function remove

Delete a Globus Connect Personal entity by its UUID. As of 2024-01-08, this method (and the Transfer API) only supports deleting Globus Connect Personal entities.

All GCSv5 endpoints and collections should be deleted (and managed) using Globus Connect Server (i.e. gcs.collections.remove).

See

https://docs.globus.org/api/transfer/gcp_management/#delete_endpoint_by_id

  • remove(
        endpoint_xid: string,
        options?: { payload?: undefined; query?: undefined } & {
            headers?: Headers;
            query?: {
                [key: string]:
                    | undefined
                    | null
                    | string
                    | number
                    | boolean
                    | (undefined | null | string | number)[];
            };
        },
        sdkOptions?: SDKOptions,
    ): Promise<
        JSONFetchResponse<
            {
                code: "Deleted";
                DATA_TYPE: "result";
                message: string;
                request_id: string;
                resource: `/endpoint/${string}`;
            },
        >,
    >

  • Parameters

    • endpoint_xid: string
    • Optionaloptions: { payload?: undefined; query?: undefined } & {
          headers?: Headers;
          query?: {
              [key: string]:
                  | undefined
                  | null
                  | string
                  | number
                  | boolean
                  | (undefined | null | string | number)[];
          };
      }
    • OptionalsdkOptions: SDKOptions

    Returns Promise<
        JSONFetchResponse<
            {
                code: "Deleted";
                DATA_TYPE: "result";
                message: string;
                request_id: string;
                resource: `/endpoint/${string}`;
            },
        >,
    >

Settings

Member Visibility