HThtmlcsstoimage
Storage Destinations

Update a storage destination

Changed on

Replaces the configuration. Omitted optional settings are cleared or reset, except a secret explicitly retained using retain_secret_access_key: true with unchanged provider and access key ID. Changed connections and re-enabling trigger a write test; an enabled request is not saved if that test fails. Metadata-only changes do not require a test. After a plan downgrade, only disabling is accepted and other submitted changes are ignored.

Rate limit: 20 requests per minute per organization, shared across all operations in the storage-destination:write group and all API keys belonging to that organization.

post/v1/storage-destinations/{id}

Request

  • Base URL
    https://hcti.io
  • URL
    https://hcti.io/v1/storage-destinations/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

Request body

namestring required

Display name for the destination, between 3 and 255 characters.

disabledboolean

Whether this destination is disabled. Defaults to false. Enabling requires a successful connection test.

hcti_storage_disabledboolean

Whether to disable HCTI storage for images saved to this destination. When true, rendered files have no public HCTI URL and are not cached by the HCTI CDN. Defaults to false.

Response

OK

idstring required

Storage destination ID.

namestring required

Display name for the destination.

enabledboolean

Whether the destination is enabled.

hcti_storage_disabledboolean

Whether rendered files saved here are excluded from HCTI storage and the HCTI CDN, with no public HCTI image URL.

providerstring

Display name of the storage provider, retained for compatibility. Use connection_info.provider for the provider's machine-readable identifier.

last_tested_atstring date-time nullable

UTC timestamp of the most recent connection test, or null if it has not been tested.

last_test_succeededboolean nullable

Whether the most recent write test succeeded, or null if it has not been tested. This does not verify read access or guarantee future availability.

last_test_errorstring nullable

Sanitized error from the most recent failed connection test, or null when no failure is recorded.

created_atstring date-time

UTC timestamp when the destination was created.

updated_atstring date-time

UTC timestamp when the destination was last updated.

Changes