RenderIO
API referenceCommands

Delete Command Files API

Delete RenderIO-managed output files for a command while preserving command metadata and customer-owned BYOB objects.

Delete Command Files

DELETE /api/v1/commands/:commandId/files

Delete every RenderIO-managed output associated with a command. This permanently removes those files from RenderIO storage and marks them as deleted. The command metadata itself is preserved.

External BYOB outputs are customer-owned and are intentionally not deleted or marked as deleted. Remove them with your own S3-compatible API or bucket lifecycle policy.

Authentication

Requires API key via X-API-KEY header.

Request

Headers

HeaderTypeRequiredDescription
X-API-KEYstringYesYour API key with ffsk_ prefix

Path parameters

ParameterTypeRequiredDescription
commandIdstringYesThe unique identifier of the command whose files should be deleted.

Response

200 OK

{
  deleted: true;
  files_deleted: number;
}
FieldTypeDescription
deletedbooleanAlways true on success.
files_deletednumberNumber of RenderIO-managed files deleted. External BYOB outputs are excluded.

For a command containing only external outputs, the successful response is:

{
  "deleted": true,
  "files_deleted": 0
}

The external object and its persisted external_object_key remain unchanged. See Bring Your Own Bucket for lifecycle details.

Error responses

StatusErrorDescription
401UNAUTHORIZEDMissing or invalid API key.
404NOT_FOUNDNo command found with the given ID, or the command belongs to a different account.
429RATE_LIMITEDToo many requests. Retry after the period indicated in the Retry-After header.

Examples

curl

curl -X DELETE https://renderio.dev/api/v1/commands/a1b2c3d4-e5f6-7890-abcd-ef1234567890/files \
  -H "X-API-KEY: ffsk_your_api_key_here"

JavaScript (fetch)

const commandId = "a1b2c3d4-e5f6-7890-abcd-ef1234567890";

const response = await fetch(
  `https://renderio.dev/api/v1/commands/${commandId}/files`,
  {
    method: "DELETE",
    headers: {
      "X-API-KEY": "ffsk_your_api_key_here",
    },
  },
);

const { deleted, files_deleted } = await response.json();
console.log(`Deleted: ${deleted}, Files removed: ${files_deleted}`);

Python (requests)

import requests

command_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

response = requests.delete(
    f"https://renderio.dev/api/v1/commands/{command_id}/files",
    headers={
        "X-API-KEY": "ffsk_your_api_key_here",
    },
)

data = response.json()
print(f"Deleted: {data['deleted']}, Files removed: {data['files_deleted']}")

On this page