Origins

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

Last updated

View as Markdown Agent setup

An origin is the server an application retrieves content from. These azion/applications functions create, list, read, update, and delete the origins of an application. The API identifies an origin by its origin_key, a UUID, which every function except createOrigin and getOrigins takes as originKey.

createOrigin

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

TypeScript
01function createOrigin(params: {
02 applicationId: number;
03 data: ApiCreateOriginPayload;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionOrigin>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
dataApiCreateOriginPayloadYesThe settings of the origin. The sample sets name, origin_type, addresses, and host_header.
optionsAzionClientOptionsNoRequest options.

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:

JavaScript
01import { createOrigin } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04
05// Define the data for the new origin
06const newOriginData = {
07 name: 'my-origin',
08 origin_type: 'single_origin',
09 addresses: [{ address: 'example.com' }],
10 host_header: '${host}',
11};
12
13// Create a new origin
14const { data: newOrigin, error } = await createOrigin({ applicationId, data: newOriginData });
15
16if (error) {
17 console.error('Error creating origin:', error);
18} else {
19 console.log('Created origin:', newOrigin.origin_key, newOrigin.name, newOrigin.addresses);
20}

Output:

Text
01Created origin: 11111111-1111-1111-1111-111111111111 my-origin [
02 {
03 address: 'example.com',
04 weight: null,
05 server_role: 'primary',
06 is_active: true
07 }
08]

getOrigins

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

TypeScript
01function getOrigins(params: {
02 applicationId: number;
03 params?: ApiListOriginsParams;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationCollectionResponse<AzionOrigin>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
paramsApiListOriginsParamsNoPagination: page and page_size.
optionsAzionClientOptionsNoRequest options.

Returns an AzionApplicationCollectionResponse whose data.results holds AzionOrigin objects.

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

Output:

Found 1 origins: [ 'my-origin (11111111-1111-1111-1111-111111111111)' ]

getOrigin

Returns one origin of an application by its origin key.

TypeScript
01function getOrigin(params: {
02 applicationId: number;
03 originKey: string;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionOrigin>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
originKeystringYesThe origin_key of the origin, a UUID.
optionsAzionClientOptionsNoRequest options.

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.

TypeScript
01import { getOrigin } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const originKey = '11111111-1111-1111-1111-111111111111'; // Replace with the origin key (a UUID)
05
06const { data: origin, error } = await getOrigin({ applicationId, originKey });
07
08if (error) {
09 console.error('Error retrieving origin:', error);
10} else {
11 console.log('Origin details:', origin?.origin_key, origin?.name, origin?.origin_type, origin?.host_header);
12}

Output:

Origin details: 11111111-1111-1111-1111-111111111111 my-origin single_origin ${host}

updateOrigin

Sends the origin fields you pass in a PATCH request.

TypeScript
01function updateOrigin(params: {
02 applicationId: number;
03 originKey: string;
04 data: ApiUpdateOriginRequest;
05 options?: AzionClientOptions;
06}): Promise<AzionApplicationResponse<AzionOrigin>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
originKeystringYesThe origin_key of the origin to update.
dataApiUpdateOriginRequestYesThe fields to change.
optionsAzionClientOptionsNoRequest options.

Returns data as the updated AzionOrigin.

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

JavaScript
01import { updateOrigin } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const originKey = '11111111-1111-1111-1111-111111111111'; // Replace with the origin key (a UUID)
05
06const { data: updatedOrigin, error } = await updateOrigin({
07 applicationId,
08 originKey,
09 data: { name: 'my-origin-updated' },
10});
11
12if (error) {
13 console.error('Error updating origin:', error);
14} else {
15 console.log('Updated origin:', updatedOrigin.origin_key, updatedOrigin.name);
16}

Output:

Updated origin: 11111111-1111-1111-1111-111111111111 my-origin-updated

deleteOrigin

Deletes an origin of an application by its origin key.

TypeScript
01function deleteOrigin(params: {
02 applicationId: number;
03 originKey: string;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<void>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
originKeystringYesThe origin_key of the origin to delete.
optionsAzionClientOptionsNoRequest options.

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.

TypeScript
01import { deleteOrigin, getOrigin } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const originKey = '11111111-1111-1111-1111-111111111111'; // Replace with the origin key (a UUID)
05
06const { error: deleteError } = await deleteOrigin({ applicationId, originKey });
07
08// On success (HTTP 204) the envelope still carries an error, so confirm by reading the origin back
09const { error } = await getOrigin({ applicationId, originKey });
10if (error) {
11 console.log(`Origin ${originKey} deleted (read back: ${error.message})`);
12} else {
13 console.error('Error deleting origin:', deleteError);
14}

Output:

Origin 11111111-1111-1111-1111-111111111111 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.

Origins

The origin an application retrieves content from, and the settings it holds.