Cache settings

The azion/applications functions that create, list, read, update, and delete the cache settings of an application.

Last updated

View as Markdown Agent setup

These azion/applications functions create, list, read, update, and delete the cache settings of an application. The application must have an origin first: on an application with none, the API refuses the cache setting with HTTP error! Status: 400 - BAD REQUEST.

createCacheSetting

Creates a cache setting in an application. The application must have an origin first. On an application with none, the API refuses the cache setting, and the function returns error with the message HTTP error! Status: 400 - BAD REQUEST.

TypeScript
01function createCacheSetting(params: {
02 applicationId: number;
03 data: ApiBaseCacheSettingPayload;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionCacheSetting>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
dataApiBaseCacheSettingPayloadYesThe settings of the cache setting. name is required.
optionsAzionClientOptionsNoRequest options.

browser_cache_settings takes honor, override, or ignore, and cdn_cache_settings takes honor or override. With override, the sample also sets the matching maximum TTL field, browser_cache_settings_maximum_ttl or cdn_cache_settings_maximum_ttl.

Returns data as the created AzionCacheSetting, with its id.

This sample is JavaScript, because TypeScript rejects string values for browser_cache_settings and cdn_cache_settings, whose types are enums the module does not export:

JavaScript
01import { createCacheSetting } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04
05// Create a new cache setting
06const cacheSettingData = {
07 name: 'my-cache-setting',
08 browser_cache_settings: 'override',
09 browser_cache_settings_maximum_ttl: 3600,
10 cdn_cache_settings: 'override',
11 cdn_cache_settings_maximum_ttl: 7200,
12};
13
14const { data: newCacheSetting, error } = await createCacheSetting({ applicationId, data: cacheSettingData });
15
16if (error) {
17 console.error('Error creating cache setting:', error);
18} else {
19 console.log('Cache setting created successfully:', newCacheSetting.id, newCacheSetting.name, newCacheSetting.cdn_cache_settings_maximum_ttl);
20}

Output:

Cache setting created successfully: 234567 my-cache-setting 7200

getCacheSettings

Lists the cache settings of an application, one page at a time.

TypeScript
01function getCacheSettings(params: {
02 applicationId: number;
03 params?: ApiListCacheSettingsParams;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationCollectionResponse<AzionCacheSetting>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
paramsApiListCacheSettingsParamsNoPagination: page and page_size. Leave out sort and order: the API refuses the values the type declares for them with a 400 error.
optionsAzionClientOptionsNoRequest options.

Returns an AzionApplicationCollectionResponse whose data.results holds AzionCacheSetting objects.

TypeScript
01import { getCacheSettings } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04
05const { data: cacheSettings, error } = await getCacheSettings({
06 applicationId,
07 params: { page: 1, page_size: 20 },
08});
09
10if (error) {
11 console.error('Error listing cache settings:', error);
12} else {
13 console.log(`Found ${cacheSettings?.count} cache settings:`, cacheSettings?.results.map((c) => `${c.id} ${c.name}`));
14}

Output:

Found 1 cache settings: [ '234568 my-other-cache-setting' ]

getCacheSetting

Returns one cache setting of an application by its ID.

TypeScript
01function getCacheSetting(params: {
02 applicationId: number;
03 cacheSettingId: number;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionCacheSetting>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
cacheSettingIdnumberYesThe ID of the cache setting.
optionsAzionClientOptionsNoRequest options.

Returns data as an AzionCacheSetting.

TypeScript
01import { getCacheSetting } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const cacheSettingId = 234567; // Replace with the actual cache setting ID
05
06const { data: cacheSetting, error } = await getCacheSetting({ applicationId, cacheSettingId });
07
08if (error) {
09 console.error('Error retrieving cache setting:', error);
10} else {
11 console.log('Cache setting details:', cacheSetting?.id, cacheSetting?.name, cacheSetting?.browser_cache_settings, cacheSetting?.cdn_cache_settings);
12}

Output:

Cache setting details: 234567 my-cache-setting override override

updateCacheSetting

Sends the cache setting fields you pass in a PATCH request.

TypeScript
01function updateCacheSetting(params: {
02 applicationId: number;
03 cacheSettingId: number;
04 data: ApiUpdateCacheSettingPayload;
05 options?: AzionClientOptions;
06}): Promise<AzionApplicationResponse<AzionCacheSetting>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
cacheSettingIdnumberYesThe ID of the cache setting to update.
dataApiUpdateCacheSettingPayloadYesThe fields to change. Every field is optional.
optionsAzionClientOptionsNoRequest options.

Returns data as the updated AzionCacheSetting. A payload without enum fields, such as name and a TTL, type-checks in TypeScript.

TypeScript
01import { updateCacheSetting } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const cacheSettingId = 234567; // Replace with the actual cache setting ID
05
06const { data: updatedCacheSetting, error } = await updateCacheSetting({
07 applicationId,
08 cacheSettingId,
09 data: { name: 'my-cache-setting-updated', cdn_cache_settings_maximum_ttl: 3600 },
10});
11
12if (error) {
13 console.error('Error updating cache setting:', error);
14} else {
15 console.log('Cache setting updated:', updatedCacheSetting?.name, updatedCacheSetting?.cdn_cache_settings_maximum_ttl);
16}

Output:

Cache setting updated: my-cache-setting-updated 3600

deleteCacheSetting

Deletes a cache setting of an application by its ID.

TypeScript
01function deleteCacheSetting(params: {
02 applicationId: number;
03 cacheSettingId: number;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<void>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
cacheSettingIdnumberYesThe ID of the cache setting to delete.
optionsAzionClientOptionsNoRequest options.

A successful delete returns error with the message Expected JSON response, but got: , so the sample reads the cache setting back with getCacheSetting. A 404 error confirms the delete.

TypeScript
01import { deleteCacheSetting, getCacheSetting } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const cacheSettingId = 234567; // Replace with the actual cache setting ID
05
06const { error: deleteError } = await deleteCacheSetting({ applicationId, cacheSettingId });
07
08// On success (HTTP 204) the envelope still carries an error, so confirm by reading it back
09const { error } = await getCacheSetting({ applicationId, cacheSettingId });
10if (error) {
11 console.log(`Cache setting ${cacheSettingId} deleted (read back: ${error.message})`);
12} else {
13 console.error('Error deleting cache setting:', deleteError);
14}

Output:

Cache setting 234567 deleted (read back: HTTP error! Status: 404 - NOT FOUND)
Azion Lib

The Azion Lib modules and the npm package each one ships in.

Applications

The module’s authentication, its response envelope, and the errors its functions report.

Application types

The payload and response types these functions take and return.

Cache settings

The cache setting an application applies, with its TTLs and cache key.