Application types

The types the azion/applications module exports, with the payloads each function takes and the list parameters each collection accepts.

Last updated

View as Markdown Agent setup

The azion/applications module exports these types, except where a type says otherwise. Import them with import type.

AzionApplicationsClient

The client that createAzionApplicationClient returns. Each method takes one object.

MethodArgumentReturns
createApplication{ data: ApiCreateApplicationPayload; options?: AzionClientOptions }Promise<AzionApplicationResponse<AzionApplication>>
getApplication{ applicationId: number; options?: AzionClientOptions }Promise<AzionApplicationResponse<AzionApplication>>
getApplications{ params?: AzionApplicationCollectionOptions; options?: AzionClientOptions }Promise<AzionApplicationCollectionResponse<AzionApplication>>
putApplication{ applicationId: number; data: ApiUpdateApplicationPayload; options?: AzionClientOptions }Promise<AzionApplicationResponse<AzionApplication>>
patchApplication{ applicationId: number; data: Partial<ApiUpdateApplicationPayload>; options?: AzionClientOptions }Promise<AzionApplicationResponse<AzionApplication>>
deleteApplication{ applicationId: number; options?: AzionClientOptions }Promise<AzionApplicationResponse<void>>

CreateAzionApplicationClient

The type of createAzionApplicationClient.

TypeScript
01type CreateAzionApplicationClient = (config?: Partial<{
02 token: string;
03 options?: AzionClientOptions;
04}>) => AzionApplicationsClient;

AzionClientOptions

Request options that every function takes in options.

PropertyTypeRequiredDescription
debugbooleanNoTurns on debug mode.
forcebooleanNoDeclared by the type. No sample on this page uses it.

AzionApplicationResponse

The envelope that every function except the list functions returns. For how to read it, refer to Response envelope.

PropertyTypeRequiredDescription
dataTNoThe result of the call.
error{ message: string; operation: string }NoThe error message and the operation that failed. A successful delete also fills it.

AzionApplicationCollectionResponse

The envelope that the list functions return.

PropertyTypeRequiredDescription
data{ count; total_pages; schema_version; links; results }NoThe page of results.
data.countnumberYesThe number of objects in the whole list, not on the page.
data.total_pagesnumberYesThe number of pages.
data.schema_versionnumberYesThe schema version of the API response.
data.links{ previous: string | null; next: string | null }YesThe previous and next pages.
data.resultsT[]YesThe objects on the page.
error{ message: string; operation: string }NoThe error message and the operation that failed.

AzionApplication

An application: the fields of ApiBaseApplicationPayload, plus the ID and the application methods. AzionApplicationSettings is the same shape without the methods.

PropertyTypeRequiredDescription
idnumberYesThe ID of the application.
originsOriginOperationsYesThe origin methods.
cacheCacheOperationsYesThe cache setting methods.
devicesDeviceGroupOperationsYesThe device group methods.
functionsFunctionOperationsYesThe function instance methods.
rules{ request: RuleOperations; response: RuleOperations }YesThe rule methods, one set per phase.

ApiBaseApplicationPayload

The settings of an application. name is required and every other field is optional. ApiCreateApplicationPayload, which the module does not export, has the same shape, and ApiUpdateApplicationPayload makes every field optional. API v3 refuses application_acceleration in a create request.

TypeScript
01interface ApiBaseApplicationPayload {
02 name: string;
03 delivery_protocol?: DeliveryProtocol;
04 http3?: boolean;
05 http_port?: HttpPort[];
06 https_port?: HttpsPort[];
07 minimum_tls_version?: TlsVersion;
08 active?: boolean;
09 debug_rules?: boolean;
10 application_acceleration?: boolean;
11 caching?: boolean;
12 device_detection?: boolean;
13 edge_firewall?: boolean;
14 edge_functions?: boolean;
15 image_optimization?: boolean;
16 l2_caching?: boolean;
17 load_balancer?: boolean;
18 raw_logs?: boolean;
19 web_application_firewall?: boolean;
20 supported_ciphers?: SupportedCiphers;
21}

The enums of the application settings, which the module exports:

TypeScript
01enum DeliveryProtocol {
02 HTTP = "http",
03 HTTPS = "https",
04 HTTP_HTTPS = "http,https"
05}
06enum HttpPort {
07 PORT_80 = 80,
08 PORT_8008 = 8008,
09 PORT_8080 = 8080
10}
11enum HttpsPort {
12 PORT_443 = 443,
13 PORT_8443 = 8443,
14 PORT_9440 = 9440,
15 PORT_9441 = 9441,
16 PORT_9442 = 9442,
17 PORT_9443 = 9443
18}
19enum TlsVersion {
20 TLS_1_0 = "tls_1_0",
21 TLS_1_1 = "tls_1_1",
22 TLS_1_2 = "tls_1_2",
23 TLS_1_3 = "tls_1_3"
24}
25enum SupportedCiphers {
26 ALL = "all",
27 TLSv1_2_2018 = "TLSv1.2_2018",
28 TLSv1_2_2019 = "TLSv1.2_2019",
29 TLSv1_2_2021 = "TLSv1.2_2021",
30 TLSv1_3_2022 = "TLSv1.3_2022"
31}

ApiListApplicationsParams

Pagination and ordering for getApplications. AzionApplicationCollectionOptions, which the client method takes, has the same keys.

PropertyTypeRequiredDescription
pagenumberNoThe page number.
page_sizenumberNoThe number of applications per page.
sort'name' | 'id'NoDeclared by the type. No sample on this page uses it.
order_bystringNoDeclared by the type. No sample on this page uses it.

AzionOrigin

An origin, with its origin_key. ApiCreateOriginPayload takes every field below except id and method, all required, plus optional origin_path, hmac_authentication, hmac_region_name, hmac_access_key, hmac_secret_key, connection_timeout, and timeout_between_bytes. ApiUpdateOriginRequest makes every field optional and requires id.

TypeScript
01interface AzionOrigin {
02 id: number;
03 origin_key: string;
04 name: string;
05 origin_type: OriginType;
06 addresses: Address[];
07 origin_protocol_policy: OriginProtocolPolicy;
08 is_origin_redirection_enabled: boolean;
09 host_header: string;
10 method: string;
11 origin_path: string;
12 connection_timeout: number;
13 timeout_between_bytes: number;
14 hmac_authentication: boolean;
15 hmac_region_name: string;
16 hmac_access_key: string;
17 hmac_secret_key: string;
18}
19interface Address {
20 address: string;
21 weight?: number | null;
22 server_role?: ServerRole;
23 is_active?: boolean;
24}

The enums of an origin, which the module does not export:

TypeScript
01enum OriginType {
02 SINGLE_ORIGIN = "single_origin",
03 LOAD_BALANCER = "load_balancer"
04}
05enum OriginProtocolPolicy {
06 PRESERVE = "preserve",
07 HTTP = "http",
08 HTTPS = "https"
09}
10enum ServerRole {
11 PRIMARY = "primary",
12 BACKUP = "backup"
13}

AzionCacheSetting

A cache setting: the fields of ApiBaseCacheSettingPayload, plus its id (number).

ApiBaseCacheSettingPayload

The settings of a cache setting. name is required and every other field is optional. ApiUpdateCacheSettingPayload makes every field optional.

TypeScript
01interface ApiBaseCacheSettingPayload {
02 name: string;
03 browser_cache_settings?: BrowserCacheSettings;
04 browser_cache_settings_maximum_ttl?: number;
05 cdn_cache_settings?: CdnCacheSettings;
06 cdn_cache_settings_maximum_ttl?: number;
07 cache_by_query_string?: CacheByQueryString;
08 query_string_fields?: string[];
09 enable_query_string_sort?: boolean;
10 cache_by_cookies?: CacheByCookies;
11 cookie_names?: string[];
12 adaptive_delivery_action?: AdaptiveDeliveryAction;
13 device_group?: string[];
14 enable_caching_for_post?: boolean;
15 l2_caching_enabled?: boolean;
16 is_slice_configuration_enabled?: boolean;
17 is_slice_edge_caching_enabled?: boolean;
18 is_slice_l2_caching_enabled?: boolean;
19 slice_configuration_range?: number;
20 enable_caching_for_options?: boolean;
21 enable_stale_cache?: boolean;
22 l2_region?: string | null;
23}

The enums of a cache setting, which the module does not export:

TypeScript
01enum BrowserCacheSettings {
02 HONOR = "honor",
03 OVERRIDE = "override",
04 IGNORE = "ignore"
05}
06enum CdnCacheSettings {
07 HONOR = "honor",
08 OVERRIDE = "override"
09}
10enum CacheByQueryString {
11 IGNORE = "ignore",
12 WHITELIST = "whitelist",
13 BLACKLIST = "blacklist",
14 ALL = "all"
15}
16enum CacheByCookies {
17 IGNORE = "ignore",
18 WHITELIST = "whitelist",
19 BLACKLIST = "blacklist",
20 ALL = "all"
21}
22enum AdaptiveDeliveryAction {
23 IGNORE = "ignore",
24 OPTIMIZE = "optimize"
25}

AzionDeviceGroup

A device group. ApiCreateDeviceGroupPayload and ApiUpdateDeviceGroupPayload, which the module does not export, take name and user_agent, both required on create and optional on update.

PropertyTypeRequiredDescription
idnumberYesThe ID of the device group.
namestringYesThe name of the group, with no spaces and no hyphens.
user_agentstringYesThe regular expression compared with the User-Agent request header.

AzionFunctionInstance

A function instance. The API returns the four fields below, as the samples show.

PropertyTypeDescription
idnumberThe ID of the function instance.
edge_function_idnumberThe ID of the function the instance runs.
namestringThe name of the function instance.
argsRecord<string, unknown>The arguments the function receives.

The type declares other fields: id plus the fields of ApiBaseFunctionInstancePayload, which are name, code, language ('JavaScript'), initiator_type ('edge_application' \| 'edge_firewall'), active, and json_args. ApiUpdateFunctionInstancePayload makes those fields optional.

ApiCreateFunctionInstancePayload

The payload of createFunctionInstance. The module does not export this type.

PropertyTypeRequiredDescription
namestringYesThe name of the function instance.
edge_function_idnumberYesThe ID of the function the instance runs.
argsRecord<string, unknown>YesThe arguments the function receives.
activebooleanNoDeclared by the type. No sample on this page uses it.

AzionRule

A rule: the fields of ApiCreateRulePayload, plus id (number). AzionRule declares is_active and order as required, and every rule in the samples carries both.

ApiCreateRulePayload

The payload of createRule. ApiUpdateRulePayload makes every field optional.

PropertyTypeRequiredDescription
namestringYesThe name of the rule.
phase'request' | 'response'YesThe phase of the rule.
criteriaCriterion[][]YesThe condition groups. Each Criterion holds variable (string), operator (string), conditional ('if' | 'and' | 'or'), and input_value (string).
behaviorsBehavior[]YesThe actions. Each Behavior holds name (string) and an optional target: a string, null, or { captured_array: string; subject: string; regex: string }.
is_activebooleanNoWhether the rule is active. A rule created without it is active.
ordernumberNoThe position of the rule in its phase.
descriptionstringNoThe description of the rule.

List parameters

The params object of each sub-resource list function declares these keys. The samples send only page and page_size. ApiListDeviceGroupsParams is not exported.

TypeDeclared keys
ApiListOriginsParamspage, page_size, sort ('name' | 'id'), order ('asc' | 'desc'), filter
ApiListCacheSettingsParamspage, page_size, sort ('name' | 'id'), order ('asc' | 'desc')
ApiListDeviceGroupsParamspage, page_size, sort ('name' | 'id'), order ('asc' | 'desc')
ApiListFunctionInstancesParamspage, page_size, sort ('name' | 'id'), order ('asc' | 'desc'), order_by, filter
ApiListRulesParamspage, page_size, sort (string), order ('asc' | 'desc'), filter
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 functions

The functions that create, read, and update the application these types describe.

Client

The client that exposes Applications next to Storage, SQL, Purge, Domains, and AI.