Azion CLI connector

Azion CLI commands that create, list, describe, update, and delete connectors, with every flag and the JSON file the commands read.

Last updated

View as Markdown Agent setup

The Azion CLI connector commands create, list, describe, update, and delete connectors, the objects that hold where and how an application reaches an origin, the server that holds your content. A connector is created and changed from a JSON file, never from one flag per setting. The options every command accepts, such as --format, --out, and -y, are on Global options.

Create

azion create connector creates a connector from a JSON file and the type you pass:

azion create connector [flags]
FlagShortTypeDefaultDescription
--file—string—Required. Path to a JSON file with the attributes of the connector. Use - to read the JSON from standard input. Without it, the command asks for the path.
--type—string—Required. Type of the connector: http, storage, or live_ingest. Without it, the command asks for the type, even when the file carries "type".

The CLI sends any --type value to the API without checking it. A value outside the three, such as ftp, fails with a server error that does not name the type:

Error: Failed to create Connector: The server could not process the request because an internal and unexpected problem occurred. Wait a few seconds and try again. For more information run the command again using the '--debug' flag. If the problem persists, contact Azion’s support. Check your settings and try again. If the error persists, contact Azion support

This file, my-connector.json, describes a connector of type http named my-connector that sends requests to httpbin.org:

JSON
01{
02 "name": "my-connector",
03 "active": true,
04 "type": "http",
05 "attributes": {
06 "addresses": [
07 {
08 "address": "httpbin.org"
09 }
10 ],
11 "connection_options": {
12 "dns_resolution": "both",
13 "transport_policy": "preserve",
14 "host": "${host}"
15 }
16 }
17}

This command creates the connector from the file:

azion create connector --type http --file my-connector.json

The command prints the ID of the connector:

Created Connector with ID 123475

List

azion list connector prints the connectors of your account, 50 on each page by default:

azion list connector [flags]
FlagShortTypeDefaultDescription
--details———Adds the LAST EDITOR and LAST MODIFIED columns to the ID, NAME, TYPE, and ACTIVE columns.
--filter—string—Name to filter the list by.
--order-by—string—Field to sort the list by, such as id or name.
--page—int1Number of the page to return.
--page-size—int50Number of connectors on each page.

This command returns the first page of a list split into pages of two connectors:

azion list connector --page 1 --page-size 2

The command prints one row per connector, with its type:

Text
01ID NAME TYPE ACTIVE
0212367 my-blog storage true
0312368 my-store storage true

Describe

azion describe connector prints the settings of one connector:

azion describe connector [flags]
FlagShortTypeDefaultDescription
--connector-id—int—ID of the connector to describe.

This command describes the connector with ID 123475:

azion describe connector --connector-id 123475

The command prints the ID, the name, the last change, the state, and the type of the connector. The Language row holds the type:

Text
01ID: 123475
02Name: my-connector
03Last Editor: you@example.com
04Modified at: "2026-01-01T12:00:00.847427Z"
05Active: true
06Language: http

With --format json, the command prints the full object: active, attributes, created_at, id, is_versioned, last_editor, last_modified, name, product_version, type, version, version_id, and version_state. On a connector of type http, attributes holds addresses, connection_options, and modules.

Update

azion update connector changes the name, the state, or the settings of a connector. The command has no flag per setting, so the changes come from a JSON file:

azion update connector [flags]
FlagShortTypeDefaultDescription
--connector-id—int—ID of the connector to update.
--file—string—Path to a JSON file with the attributes of the connector. Use - to read the JSON from standard input.
--type—string—Required. Type of the connector: http, storage, or live_ingest. Without it, the command asks for the type, even when the file carries "type".

The file carries the whole connector, as on create. A file with only the fields to change, such as name and active, is refused before any request is sent:

Error: Failed to decode the given 'json' file. Verify if the file format is JSON or fix its content according to the JSON format specification at https://www.json.org/json-en.html

This file, my-connector-update.json, renames the connector to my-connector-renamed and repeats every other attribute it was created with:

JSON
01{
02 "name": "my-connector-renamed",
03 "active": true,
04 "type": "http",
05 "attributes": {
06 "addresses": [
07 {
08 "address": "httpbin.org"
09 }
10 ],
11 "connection_options": {
12 "dns_resolution": "both",
13 "transport_policy": "preserve",
14 "host": "${host}"
15 }
16 }
17}

This command applies the file to the connector with ID 123475:

azion update connector --connector-id 123475 --type http --file my-connector-update.json

The command prints the ID of the updated connector:

Updated Connector with ID 123475

Delete

azion delete connector deletes a connector:

azion delete connector [flags]
FlagShortTypeDefaultDescription
--connector-id—int—ID of the connector to delete.

This command deletes the connector with ID 123475:

azion delete connector --connector-id 123475

The command confirms the deletion:

Connector 123475 was successfully deleted

Use a JSON file

azion create connector and azion update connector read the connector from a JSON file with --file, and both also take --type on the command line. The file holds name, active, type, and attributes. A connector of type http carries addresses and connection_options in attributes; the types storage and live_ingest carry other attributes.

The API fills every field the file leaves out with its default. A file with one address and three connection options produces this connector, as azion describe connector --connector-id 123475 --format json prints it:

JSON
01{
02 "active": true,
03 "attributes": {
04 "addresses": [
05 {
06 "active": true,
07 "address": "httpbin.org",
08 "http_port": 80,
09 "https_port": 443,
10 "modules": null
11 }
12 ],
13 "connection_options": {
14 "dns_resolution": "both",
15 "following_redirect": false,
16 "host": "${host}",
17 "http_version_policy": "http1_1",
18 "path_prefix": "",
19 "real_ip_header": "X-Real-IP",
20 "real_port_header": "X-Real-PORT",
21 "transport_policy": "preserve"
22 },
23 "modules": {
24 "load_balancer": {
25 "config": null,
26 "enabled": false
27 },
28 "origin_shield": {
29 "config": null,
30 "enabled": false
31 }
32 }
33 },
34 "created_at": "2026-01-01T12:00:00.847444Z",
35 "id": 123475,
36 "is_versioned": false,
37 "last_editor": "you@example.com",
38 "last_modified": "2026-01-01T12:00:00.847427Z",
39 "name": "my-connector",
40 "product_version": "1.0",
41 "type": "http",
42 "version": null,
43 "version_id": null,
44 "version_state": null
45}

Each address gets http_port 80 and https_port 443, and Load Balancer and Origin Shield stay off. For every field of each type, with its range and its default, refer to Connector settings.

Global options

The options every command accepts, such as --format, --out, and -y.

Connectors

What a connector holds and how an application sends requests to it.

Azion CLI application

The commands that create and manage the applications whose rules use a connector.

Azion CLI storage

The commands that create the bucket a connector of type storage reads from.