Applications

O módulo azion/applications é a biblioteca da Azion Lib para Applications. Suas funções criam, listam, leem, atualizam e excluem applications. Dentro de uma application, elas gerenciam as origens, os cache settings, os device groups, as instâncias de function e as regras dela. O módulo chama a Azion API v3, e cada função recebe um único objeto como argumento.

Instale o pacote:

O pacote azion recebe apenas correções de bugs, e a manutenção dele termina em dezembro de 2026.

Os exemplos desta página são módulos ES que usam await de nível superior e rodam no Node.js. A maioria deles é em TypeScript. Um exemplo cujo payload o TypeScript rejeita é em JavaScript, e a seção dele nomeia o tipo que o rejeita.

Autenticação

As funções que você importa e chama diretamente leem o seu personal token da variável de ambiente AZION_TOKEN. Um client criado com createAzionApplicationClient carrega o token no campo token dele.

Para mais informações, consulte Como a Azion Lib funciona.

Envelope de resposta

As funções de azion/applications informam uma falha de uma de duas formas, conforme o objeto sobre o qual agem:

• As funções de nível de application createApplication, getApplications, getApplication, patchApplication e putApplication retornam { data } em caso de sucesso. Quando a API responde com um status de erro, elas lançam Error: HTTP error! Status: <code> - <TEXT>, então chame-as dentro de try/catch.
• deleteApplication e as funções de origens, cache settings, device groups, instâncias de function e regras não lançam erros. Elas retornam um AzionApplicationResponse, { data?, error? }. Em caso de falha, error contém { message, operation }, em que operation nomeia a chamada, como get origin.

Os exemplos das funções de nível de application também desestruturam error. Em uma requisição com falha, essas funções lançam o erro antes que o exemplo o verifique.

Uma exclusão bem-sucedida ainda retorna { error: { message: 'Expected JSON response, but got: ', operation } }. A API responde a uma exclusão com um corpo vazio, que o módulo lê como um erro. O envelope não distingue uma exclusão bem-sucedida de uma que falhou, por isso cada exemplo de exclusão desta página lê o objeto de volta. Uma resposta 404 confirma a exclusão.

Funções por recurso

O módulo agrupa as funções pelo objeto que elas gerenciam. Uma application é identificada por applicationId, que toda função recebe, exceto createApplication e getApplications. As regras também recebem uma phase, e uma origem é identificada pela originKey dela, um UUID.

Uma application que createApplication ou getApplication retorna também carrega as funções dos cinco sub-recursos como métodos da application.

createAzionApplicationClient

Cria um client que guarda um token e expõe as seis funções de nível de application como métodos. createAzionApplicationClient também é o export padrão do módulo. Em TypeScript com moduleResolution definido como nodenext, o import padrão não pode ser chamado, então importe o export nomeado. Com moduleResolution definido como bundler, os dois imports passam na verificação de tipos.

Retorna um AzionApplicationsClient. Os métodos dele recebem o mesmo objeto que a função correspondente desta página. O client não tem métodos para origens, cache settings, device groups, instâncias de function ou regras: chame essas funções diretamente ou use os métodos da application.

Este exemplo cria um client e imprime os métodos dele:

Saída:

createApplication

Cria uma application.

Retorna data como a AzionApplication criada, com o id que a API atribuiu. Em caso de status de erro, a função lança um erro.

O tipo declara application_acceleration, mas a API v3 o recusa em uma requisição de criação como um campo desconhecido. Com ele, a função lança Error: HTTP error! Status: 400 - BAD REQUEST, então deixe-o de fora.

Este exemplo é em JavaScript, porque o TypeScript rejeita a string 'http,https' para delivery_protocol, cujo tipo é o enum DeliveryProtocol:

Saída:

getApplications

Lista as applications da conta, uma página por vez.

Retorna um AzionApplicationCollectionResponse: data.results contém a página, e data.count contém o número de applications da conta. Em caso de status de erro, a função lança um erro.

Saída:

getApplication

Retorna uma application pelo ID dela.

Retorna data como uma AzionApplication que carrega os métodos da application. Um ID que não corresponde a nenhuma application faz a função lançar Error: HTTP error! Status: 404 - NOT FOUND.

Saída:

patchApplication

Envia em uma requisição PATCH os campos da application que você passa. Use-a para renomear uma application ou para mudar uma configuração, como edge_functions: true, que createFunctionInstance exige.

Retorna data como a AzionApplication atualizada. Em caso de status de erro, a função lança um erro.

Saída:

putApplication

Envia em uma requisição PUT as configurações da application que você passa.

Retorna data como a AzionApplication atualizada. Em caso de status de erro, a função lança um erro.

A API v3 pode recusar um valor de delivery_protocol que o tipo permite. Por exemplo, a API pode responder a delivery_protocol: 'https' com "https" is not a valid choice., e a função então lança um erro.

Este exemplo é em JavaScript, porque o TypeScript rejeita a string 'http' para delivery_protocol, cujo tipo é o enum DeliveryProtocol:

Saída:

deleteApplication

Exclui uma application pelo ID dela.

Ao contrário das outras funções de nível de application, deleteApplication retorna um envelope e não lança erros. Uma exclusão bem-sucedida retorna error com a mensagem Expected JSON response, but got: , por isso o exemplo confirma a exclusão com getApplication, que lança um erro 404 para uma application que não existe mais.

Saída:

createOrigin

Cria uma origem em uma application. Uma origem é o servidor do qual a application obtém o conteúdo.

Retorna data como a AzionOrigin criada. A API identifica uma origem pela origin_key dela, um UUID, que as outras funções de origem recebem como originKey.

Este exemplo é em JavaScript, porque ApiCreateOriginPayload exige todos os campos da origem, incluindo origin_key e os campos de HMAC, e tipa origin_type como um enum:

Saída:

getOrigins

Lista as origens de uma application, uma página por vez.

Retorna um AzionApplicationCollectionResponse cujo data.results contém objetos AzionOrigin.

Saída:

getOrigin

Retorna uma origem de uma application pela chave de origem dela.

Retorna data como uma AzionOrigin. Uma chave que não corresponde a nenhuma origem retorna error com a mensagem HTTP error! Status: 404 - NOT FOUND e a operação get origin.

Saída:

updateOrigin

Envia em uma requisição PATCH os campos da origem que você passa.

Retorna data como a AzionOrigin atualizada.

Este exemplo é em JavaScript, porque ApiUpdateOriginRequest exige um id, de que a requisição não precisa:

Saída:

deleteOrigin

Exclui uma origem de uma application pela chave de origem dela.

Uma exclusão bem-sucedida retorna error com a mensagem Expected JSON response, but got: , por isso o exemplo lê a origem de volta com getOrigin. Um erro 404 confirma a exclusão.

Saída:

createCacheSetting

Cria um cache setting em uma application. A application precisa ter uma origem antes. Em uma application sem nenhuma, a API recusa o cache setting, e a função retorna error com a mensagem HTTP error! Status: 400 - BAD REQUEST.

browser_cache_settings recebe honor, override ou ignore, e cdn_cache_settings recebe honor ou override. Com override, o exemplo também define o campo de TTL máximo correspondente, browser_cache_settings_maximum_ttl ou cdn_cache_settings_maximum_ttl.

Retorna data como o AzionCacheSetting criado, com o id dele.

Este exemplo é em JavaScript, porque o TypeScript rejeita valores de string para browser_cache_settings e cdn_cache_settings, cujos tipos são enums que o módulo não exporta:

Saída:

getCacheSettings

Lista os cache settings de uma application, uma página por vez.

Retorna um AzionApplicationCollectionResponse cujo data.results contém objetos AzionCacheSetting.

Saída:

getCacheSetting

Retorna um cache setting de uma application pelo ID dele.

Retorna data como um AzionCacheSetting.

Saída:

updateCacheSetting

Envia em uma requisição PATCH os campos do cache setting que você passa.

Retorna data como o AzionCacheSetting atualizado. Um payload sem campos de enum, como name e um TTL, passa na verificação de tipos do TypeScript.

Saída:

deleteCacheSetting

Exclui um cache setting de uma application pelo ID dele.

Uma exclusão bem-sucedida retorna error com a mensagem Expected JSON response, but got: , por isso o exemplo lê o cache setting de volta com getCacheSetting. Um erro 404 confirma a exclusão.

Saída:

createDeviceGroup

Cria um device group em uma application. Um device group identifica dispositivos por uma expressão regular que a plataforma compara com o header de requisição User-Agent.

Retorna data como o AzionDeviceGroup criado. A API recusa um name que contenha um espaço ou um hífen. A função então retorna error com a mensagem HTTP error! Status: 400 - BAD REQUEST.

Saída:

getDeviceGroups

Lista os device groups de uma application, uma página por vez.

Retorna um AzionApplicationCollectionResponse cujo data.results contém objetos AzionDeviceGroup.

Saída:

getDeviceGroup

Retorna um device group de uma application pelo ID dele.

Retorna data como um AzionDeviceGroup.

Saída:

updateDeviceGroup

Envia em uma requisição PATCH os campos do device group que você passa. O novo name segue a mesma regra da criação: sem espaços e sem hífens.

Retorna data como o AzionDeviceGroup atualizado.

Saída:

deleteDeviceGroup

Exclui um device group de uma application pelo ID dele.

Uma exclusão bem-sucedida retorna error com a mensagem Expected JSON response, but got: , por isso o exemplo lê o device group de volta com getDeviceGroup. Um erro 404 confirma a exclusão.

Saída:

createFunctionInstance

Cria uma instância de function em uma application. Uma instância executa uma function existente para essa application, com os argumentos que a instância define.

Duas coisas precisam existir antes. A application precisa ter functions ativadas, o que patchApplication faz com data: { edge_functions: true }. A function também precisa existir: a instância a identifica pelo ID dela em edge_function_id, e o pacote azion não tem um módulo que crie functions.

Retorna data como a AzionFunctionInstance criada, com o id dela.

Saída: