Remove a remote file | Sample

3 body fields

Form-encoded data identifying the remote file to remove.

tokenstringoptional

Authentication token. Requires scope: `remote_files:write`

filestringoptional

Specify a file by providing its ID.

external_idstringoptional

Creator defined GUID for the file.

2 status codes

200Returns an object with `ok` set to true when the remote file is removed.

okbooleanrequired

Allowed:true

defaultReturns an object with `ok` set to false when the remote file cannot be removed or the request is invalid.

okbooleanrequired

Allowed:false

Error handling

The authentication token must have the remote_files:write scope. Provide at least one of file or external_id to identify the remote file to remove.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.filesRemoteRemove.create({
  token: "sk_live_4eC39Hq",
  file: "example",
  externalId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
});

{
  "ok": true
}

Request

Response

Errors