Applications

The azion/applications module is the Azion Lib library for Applications. Its functions create, list, read, update, and delete applications. Inside an application, they manage its origins, cache settings, device groups, function instances, and rules. The module calls Azion API v3, and each function takes one object argument.

Install the package:

The azion package receives bug fixes only, and its maintenance ends in December 2026.

The samples on this page are ES modules that use top-level await, and they run in Node.js. Most of them are TypeScript. A sample whose payload TypeScript rejects is JavaScript, and its section names the type that rejects it.

Authentication

Functions that you import and call directly read your personal token from the AZION_TOKEN environment variable. A client from createAzionApplicationClient carries the token in its token field.

For more information, refer to How Azion Lib works.

Response envelope

The azion/applications functions report a failure in one of two ways, depending on the object they act on:

• The application-level functions createApplication, getApplications, getApplication, patchApplication, and putApplication return { data } on success. When the API answers with an error status, they throw Error: HTTP error! Status: <code> - <TEXT>, so call them inside try/catch.
• deleteApplication and the functions for origins, cache settings, device groups, function instances, and rules do not throw. They return an AzionApplicationResponse, { data?, error? }. On failure, error holds { message, operation }, where operation names the call, such as get origin.

The samples for the application-level functions destructure error as well. On a failed request, those functions throw before the sample checks it.

A delete that succeeds still returns { error: { message: 'Expected JSON response, but got: ', operation } }. The API answers a delete with an empty body, which the module reads as an error. The envelope cannot tell a successful delete from a failed one, so each delete sample on this page reads the object back. A 404 answer confirms the delete.

Functions by resource

The module groups its functions by the object they manage. An application is addressed by applicationId, which every function except createApplication and getApplications takes. Rules also take a phase, and an origin is addressed by its originKey, a UUID.

An application that createApplication or getApplication returns also carries the functions of the five sub-resources as application methods.

createAzionApplicationClient

Creates a client that holds a token and exposes the six application-level functions as methods. createAzionApplicationClient is also the default export of the module. In TypeScript with moduleResolution set to nodenext, the default import is not callable, so import the named export. With moduleResolution set to bundler, both imports type-check.

Returns an AzionApplicationsClient. Its methods take the same object as the matching function on this page. The client has no methods for origins, cache settings, device groups, function instances, or rules: call those functions directly, or use the application methods.

This sample creates a client and prints its methods:

Output:

createApplication

Creates an application.

Returns data as the created AzionApplication, with the id the API assigned. On an error status, the function throws.

The type declares application_acceleration, but API v3 refuses it in a create request as an unknown field. With it, the function throws Error: HTTP error! Status: 400 - BAD REQUEST, so leave it out.

This sample is JavaScript, because TypeScript rejects the string 'http,https' for delivery_protocol, whose type is the DeliveryProtocol enum:

Output:

getApplications

Lists the applications of the account, one page at a time.

Returns an AzionApplicationCollectionResponse: data.results holds the page, and data.count holds the number of applications in the account. On an error status, the function throws.

Output:

getApplication

Returns one application by its ID.

Returns data as an AzionApplication that carries the application methods. An ID that matches no application makes the function throw Error: HTTP error! Status: 404 - NOT FOUND.

Output:

patchApplication

Sends the application fields you pass in a PATCH request. Use it to rename an application or to change one setting, such as edge_functions: true, which createFunctionInstance requires.

Returns data as the updated AzionApplication. On an error status, the function throws.

Output:

putApplication

Sends the application settings you pass in a PUT request.

Returns data as the updated AzionApplication. On an error status, the function throws.

API v3 can refuse a delivery_protocol value that the type allows. For example, the API can answer delivery_protocol: 'https' with "https" is not a valid choice., and the function then throws.

This sample is JavaScript, because TypeScript rejects the string 'http' for delivery_protocol, whose type is the DeliveryProtocol enum:

Output:

deleteApplication

Deletes an application by its ID.

Unlike the other application-level functions, deleteApplication returns an envelope and does not throw. A successful delete returns error with the message Expected JSON response, but got: , so the sample confirms the delete with getApplication, which throws a 404 error for an application that no longer exists.

Output:

createOrigin

Creates an origin in an application. An origin is the server the application retrieves content from.

Returns data as the created AzionOrigin. The API identifies an origin by its origin_key, a UUID, which the other origin functions take as originKey.

This sample is JavaScript, because ApiCreateOriginPayload requires every origin field, including origin_key and the HMAC fields, and types origin_type as an enum:

Output:

getOrigins

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

Returns an AzionApplicationCollectionResponse whose data.results holds AzionOrigin objects.

Output:

getOrigin

Returns one origin of an application by its origin key.

Returns data as an AzionOrigin. A key that matches no origin returns error with the message HTTP error! Status: 404 - NOT FOUND and the operation get origin.

Output:

updateOrigin

Sends the origin fields you pass in a PATCH request.

Returns data as the updated AzionOrigin.

This sample is JavaScript, because ApiUpdateOriginRequest requires an id, which the request does not need:

Output:

deleteOrigin

Deletes an origin of an application by its origin key.

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

Output:

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.

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:

Output:

getCacheSettings

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

Returns an AzionApplicationCollectionResponse whose data.results holds AzionCacheSetting objects.

Output:

getCacheSetting

Returns one cache setting of an application by its ID.

Returns data as an AzionCacheSetting.

Output:

updateCacheSetting

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

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

Output:

deleteCacheSetting

Deletes a cache setting of an application by its ID.

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.

Output:

createDeviceGroup

Creates a device group in an application. A device group matches devices by a regular expression that the platform compares with the User-Agent request header.

Returns data as the created AzionDeviceGroup. The API refuses a name that contains a space or a hyphen. The function then returns error with the message HTTP error! Status: 400 - BAD REQUEST.

Output:

getDeviceGroups

Lists the device groups of an application, one page at a time.

Returns an AzionApplicationCollectionResponse whose data.results holds AzionDeviceGroup objects.

Output:

getDeviceGroup

Returns one device group of an application by its ID.

Returns data as an AzionDeviceGroup.

Output:

updateDeviceGroup

Sends the device group fields you pass in a PATCH request. The new name follows the same rule as on create: no spaces and no hyphens.

Returns data as the updated AzionDeviceGroup.

Output:

deleteDeviceGroup

Deletes a device group of an application by its ID.

A successful delete returns error with the message Expected JSON response, but got: , so the sample reads the device group back with getDeviceGroup. A 404 error confirms the delete.

Output:

createFunctionInstance

Creates a function instance in an application. An instance runs an existing function for that application, with the arguments the instance sets.

Two things must exist first. The application must have functions turned on, which patchApplication does with data: { edge_functions: true }. The function must exist too: the instance names it by its ID in edge_function_id, and the azion package has no module that creates functions.

Returns data as the created AzionFunctionInstance, with its id.

Output: