Storage

Create an S3-compatible output destination

Stores the credentials encrypted and never returns their secret values. Available on the Business plan.

post/storage-destinations

Request

  • Base URL: https://renderio.dev/api/v1
  • URL: https://renderio.dev/api/v1/storage-destinations
  • Auth: API key in header X-API-KEY

Request body

namestring required
endpoint_urlstring uri required

HTTPS endpoint for AWS S3 or an S3-compatible provider.

regionstring required
bucketstring required
prefixstring

Optional key prefix. RenderIO appends {command_id}/{filename}.

public_base_urlstring uri nullable

Optional public or CDN base URL used to construct storage_url.

path_styleboolean

Use path-style bucket addressing. Commonly required by S3-compatible providers.

Response

Storage destination created

storage_destination_idstring required

Business-plan S3-compatible destination that receives this command's outputs.

namestring required
endpoint_urlstring uri required
regionstring required
bucketstring required
prefixstring required
public_base_urlstring uri nullable required
path_styleboolean required
access_key_id_maskedstring required
disabledboolean required
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "access_key_id_masked": "****MPLE"
}

Changes

No recorded changes to this operation across all 1 revision of this API.