OpenResty Edge™ PHP SDK Manual

All of these methods will throw an exception if the client encounters errors, for example, network error, 400 and 500 level errors.

# Edge2Client

$client = Edge2Client($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

// use username and password
$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

// use api token
$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'api_token' => 'xxx-xxx-xxx-xxx'
]);

?>

# login

$ok = login()

Returns true if login success else false.

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();
?>

# useApp

$ok = useApp($appID)

Returns true if success else false.

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ok = $client->useApp(10);
?>

# newApp

$appID = newApp($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);
?>

# appendAppDomain

$ok = appendAppDomain($opts);

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$client->appendAppDomain(['domain' => 'foo.test.com']);

?>

# updateApp

$ok = updateApp($opts);

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$appID = $client->updateApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com'
]);

?>

# getApp

$ok = getApp($appID);

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$app_info = $client->getApp();

?>

# getAllApps

$ok = getAllApps($detail);

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$apps_info = $client->getAllApps();

?>

# deleteApp

$ok = deleteApp($appID);

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$ok = $client->deleteApp($appID);

?>

# searchApp

$ok = searchApp($opts);

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$app_info = $client->client->searchApp(['appDomain' => 'test']);
$app_id = $app_info[0]['id'];
?>

# newUpstream

$appID = newUpstream($opts)

Description of array $opts:

# servers

Description of array servers in $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$upstreamID = $client->newUpstream([
   'name' => 'origin-upstream',
   'servers' => [
        ['ip' => '172.22.31.1','port' => 80],
        ['ip' => '172.22.31.2','port' => 80,'weight' => 2]
    ]
]);

# updateUpstream

$ok = updateUpstream($opts)

Description of array $opts:

# servers

Description of array servers in $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$upstreamID = $client->newUpstream([
   'name' => 'origin-upstream',
   'servers' => [
            ['ip' => '172.22.31.1', 'port' => 80],
            ['ip' => '172.22.31.2', 'port' => 80, 'weight' => 2]
        ]
]);

$ok = $client->updateUpstream([
        'up_id' => $upstreamID,
        'name' => 'backup-upstream',
        'servers' => [
                ['domain' => 'test.com', 'port' => 8080, 'weight' => 3],
                ['ip' => '172.22.31.6', 'port' => 80]
        ],
        'health_checker' => [
            'type' => 'http',
            'http_req_uri' => '/status',
            'http_req_host' => 'test.com',
            'interval' => 3,
            'interval_unit' => 'sec',
            'timeout' => 1,
            'fall' => 3,
            'rise' => 2,
            'valid_statuses' => [200, 302],
            'report_interval' => 3,
            'report_interval_unit' => 'min'
        ]
    ]);

# deleteUpstream

$ok = deleteUpstream($up_id);

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$upstreamID = $client->newUpstream([
   'name' => 'origin-upstream',
   'servers' => [
            ['ip' => '172.22.31.1','port' => 80],
            ['ip' => '172.22.31.2','port' => 80, 'weight' => 2]
        ]
]);

$ok = $client->deleteUpstream($upstreamID);
?>

# newProxyRule

$ruleID = newProxyRule($opts)

Description of array $opts:

# upstreams

Description of array upstreams in $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$upstreamID = $client->newUpstream([
   'name' => 'origin-upstream',
   'servers' => [
            ['ip' => '172.22.31.1', 'port' => 80],
            ['ip' => '172.22.31.2', 'port' => 80, 'weight' => 2]
        ]
]);

$backupUpstreamID = $client->newUpstream([
   'name' => 'backup-upstream',
   'servers' => [
        ['ip' => '172.22.31.3', 'port' => 8000],
        ['ip' => '172.22.31.4', 'port' => 80, 'weight' => 3]
        ]
]);

$proxyRuleID = $client->newProxyRule([
   'upstreams' => [['upstream' => $upstreamID, 'weight' => 2]],
   'backup_upstreams' => [['upstream' => $backupUpstreamID]]
]);
?>

# newRewriteRule

$rewriteRuleID = newRewriteRule($opts)

Description of array $opts:

# condition

Description of array condition in $opts:

# conseq

Description of array conseq in $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$condition = [
    ['var' => 'host', 'op' => 'eq', 'val' => "con.foo.com"],
    ['var' => ['req-header', 'Referer'], 'vals' => [['foo\d+','rx'], 'foo.com']]
];

$conseq = [
    'print' => ['msg' => 'hello'],
    enable-'websocket' => [],
   'redirect' => ['url' => '/cn/2017/', 'code' => 302]
];

$rewriteRuleID = $client->newRewriteRule([
   'condition' => $condition,
   'conseq' => $conseq
]);
?>

# waf

Description of array waf:

Example: of waf rule

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$condition = [['var' => 'uri', 'op' => 'prefix', 'val' => "/foo"]];

$waf = ['robots' => true, 'generic' => true, 'inject' => true,
        'action' => '403 Forbidden', 'threshold' => 'high'];

$rewrite_waf_rule_id = $client->newRewriteRule(['waf' => $waf, 'condition' => $condition]);
?>

# proxy

Description of array proxy:

# upstreams

Description of array upstreams and backup_upstreams:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$upstream_id = $client->newUpstream([
                        'name' => 'origin-upstream',
                        'servers' => [
                                ['ip' => '172.22.31.1', 'port' => 80],
                                ['ip' => '172.22.31.2', 'port' => 80, 'weight' => 2]
                            ]
                        ]);

$backup_upstream_id = $client->newUpstream([
                              'name' => 'backup-upstream',
                              'servers' => [
                                    ['ip' => '172.22.31.3', 'port' => 8000],
                                    ['ip' => '172.22.31.4', 'port' => 80, 'weight' => 3]
                                 ]
                            ]);

$ok = $client->updateUpstream([
                        'up_id' => $backup_upstream_id,
                        'name' => 'backup-upstream',
                        'servers' => [
                                ['ip' => '172.22.31.5', 'port' => 80, 'weight' => 3],
                                ['ip' => '172.22.31.6', 'port' => 80]
                            ]
                        ]);

$proxy = [
            'upstreams' => [['upstream' => $upstream_id, 'weight' => 2]],
            'backup_upstreams' => [['upstream' => $backup_upstream_id]]
        ];

$proxy_rule_id = $client->newRewriteRule(['proxy' => $proxy]);
?>

# cache

Description of array cache:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$condition = [['var' => 'client-country', 'op' => 'eq', 'val' => 'CN']];
$cache_key = ['uri', 'query-string', 'client-city'];
$cache_rule = ['cache_key' => $cache_key, 'cluster_hash' => true ];

$cache_rule_id = $client->newRewriteRule(['cache' => $cache_rule, 'condition' => $condition]);
?>

# content

Description of array content:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$condition = [
            ['var' => 'uri', 'op' => 'prefix', 'val' => '/foo']
        ];
$file_id = $client->uploadFavicon($name = 'test', $faviconContent = content);

$rule_id = $client->newRewriteRule(['condition' => $condition, 'content' => ['favicon' => $file_id]]);

?>

# updateRewriteRule

$ok = updateRewriteRule($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$condition = [
    ['var' => 'host', 'op' => 'eq', 'val' => "con.foo.com"],
    ['var' => ['req-header', 'Referer'], 'vals' => [['foo\d+','rx'], 'foo.com']]
];

$conseq = [
    'print' => ['msg' => 'hello'],
    enable-'websocket' => [],
    'redirect' => ['url' => '/cn/2017/', 'code' => 302]
];

$rewriteRuleID = $client->newRewriteRule([
   'condition' => $condition,
   'conseq' => $conseq
]);

$conseq['redirect']['url'] = '/cn/2018/';

$ok = $client->updateRewriteRule([
   'rule_id' => $rewriteRuleID,
   'conseq' => $conseq
]);

?>

# deleteRewriteRule

$ok = deleteRewriteRule($ruleID);

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$condition = [
    ['var' => 'host', 'op' => 'eq', 'val' => "con.foo.com"],
    ['var' => ['req-header', 'Referer'], 'vals' => [['foo\d+','rx'], 'foo.com']]
];

$conseq = [
    'print' => ['msg' => 'hello'],
    enable-'websocket' => [],
    'redirect' => ['url' => '/cn/2017/', 'code' => 302]
];

$rewriteRuleID = $client->newRewriteRule([
   'condition' => $condition,
   'conseq' => $conseq
]);

$ok = $client->deleteRewriteRule($rewriteRuleID);

?>

# newAppDymetrics

$metric = newAppDymetrics($opts);

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$dymetric = [
   'name' => 'test',
   'interval' => 60,
   'sql' => 'select status, count(*) from reqs group by status'
];

$metric = $client->newAppDymetrics($dymetric);

?>

# deleteAppDymetrics

$ok = deleteAppDymetrics($metricID);

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$opts = [
   'name' => 'test',
   'interval' => 60,
   'sql' => 'select status, count(*) from reqs group by status'
];

$metric = $client->newAppDymetrics($opts);

$ok = $client->deleteAppDymetrics($metric)
?>

# getAppDymetrics

$metrics = getAppDymetrics();

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$opts = [
   'name' => 'test',
   'interval' => 60,
   'sql' => 'select status, count(*) from reqs group by status'
];

$metric = $client->newAppDymetrics($opts);

$metrics = $client->getAppDymetrics();

?>

# getAppDymetricsData

$data = getAppDymetricsData($opts);

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$opts = [
   'name' => 'test',
   'interval' => 60,
   'sql' => 'select status, count(*) from reqs group by status'
];

$metric = $client->newAppDymetrics($opts);

$opts = [
   'id' => $metric['id'],
   'chart_type' => 'line',
   'start_time' => 1619014008,
   'end_time' => 1619015008
];
data = $client->getAppDymetricsData($opts);

?>

# newAppIPList

$appIPListID = newAppIPList($opts)

Description of object $opts:

Description of object $item:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

// use username and password
$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$appIPListID = $client->newAppIPList([
    'name' => 'app-iplist-1',
    'type' => 'ipv4',
    'items' => [
        [ 'ip' => '127.0.0.1' ],
        [ 'ip' => '192.168.1.0/24' ]
    ]
]);

?>

# deleteAppIPList

$ok = deleteAppIPList($appIPListID)

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

// use username and password
$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$appIPListID = $client->newGlobalIPList([
    'name' => 'iplist-1',
    'type' => 'ipv4',
    'items' => [
        [ 'ip' => '127.0.0.2' ],
        [ 'ip' => '192.168.1.0/24' ]
    ]
]);

$ok = $client->deleteAppIPList($appIPListID);

?>

# updateAppIPList

Update the application-level IP list, which will overwrite the original data.

$ok = updateAppIPList($opts)

Description of object $opts:

Description of object $item:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

// use username and password
$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$ok = $client->updateAppIPList([
    'appIPListID' => 1,
    'items' => [
        [ 'ip' => '127.0.0.2' ],
        [ 'ip' => '192.168.1.0/24' ]
    ]
]);

?>

# appendToAppIPList

Update the application-level IP list, which will not overwrite the original data.

$ok = appendToAppIPList($opts)

Description of object $opts:

Description of object $item:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

// use username and password
$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$ok = $client->appendToAppIPList([
    'appIPListID' => 1,
    'items' => [
        [ 'ip' => '127.0.0.3' ]
    ]
]);

?>

# removeFromAppIPList

Remove IPs from application-level IP list, which will not overwrite the original data.

$ok = removeFromAppIPList($opts)

Description of object $opts:

Description of object $item:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

// use username and password
$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$ok = $client->removeFromAppIPList([
    'appIPListID' => 1,
    'items' => [
        [ 'ip' => '127.0.0.3' ]
    ]
]);

?>

# getAppIPList

$data = getAppIPList($appIPListID)

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$ipList = $client->getAppIPList($appIPListID);

?>

# getAllAppIPList

$data = getAllAppIPList()

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$ipList = $client->getAllAppIPList();

?>

# setCertKey

$certID = setCertKey($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$key = file_get_contents('tests/key.pem');
$cert = file_get_contents('tests/cert.pem');

$certID = $client->setCertKey([
   'key' => $key,
   'cert' => $cert
]);

?>

# updateCertKey

$certID = updateCertKey($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$key = file_get_contents('tests/key.pem');
$cert = file_get_contents('tests/cert.pem');

$certID = $client->setCertKey([
   'key' => $key,
   'cert' => $cert
]);

$ok = $client->updateCertKey(['cert_id' => $certID, 'key' => $key, 'cert' => $cert]);

?>

# getCertKey

$data = getCertKey($certID)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$key = file_get_contents('tests/key.pem');
$cert = file_get_contents('tests/cert.pem');

$certID = $client->setCertKey([
   'key' => $key,
   'cert' => $cert
]);

$data = $client->getCertKey($certID);

?>

# getAllCertKeys

$data = getAllCertKeys($appID)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$key = file_get_contents('tests/key.pem');
$cert = file_get_contents('tests/cert.pem');

$certID = $client->setCertKey([
   'key' => $key,
   'cert' => $cert
]);

$data = $client->getAllCertKeys();

?>

# deleteCertKey

$ok = deleteCertKey($certID);

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$key = file_get_contents('tests/key.pem');
$cert = file_get_contents('tests/cert.pem');
$certID = $client->setCertKey([
   'key' => $key,
   'cert' => $cert
]);

$ok = $client->deleteCertKey($certID);

?>

# setGlobalCertKey

$certID = setGlobalCertKey($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$key = file_get_contents('tests/key.pem');
$cert = file_get_contents('tests/cert.pem');

$certID = $client->setGlobalCertKey([
   'key' => $key,
   'cert' => $cert
]);

?>

# updateGlobalCertKey

$ok = updateGlobalCertKey($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$key = file_get_contents('tests/key.pem');
$cert = file_get_contents('tests/cert.pem');

$certID = $client->setGlobalCertKey([
   'key' => $key,
   'cert' => $cert
]);

$ok = $client->updateGlobalCertKey(['cert_id' => $certID, 'key' => $key, 'cert' => $cert]);

?>

# getGlobalCertKey

$data = getGlobalCertKey($certID)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$key = file_get_contents('tests/key.pem');
$cert = file_get_contents('tests/cert.pem');

$certID = $client->setGlobalCertKey([
   'key' => $key,
   'cert' => $cert
]);

$data = $client->getGlobalCertKey($certID);

?>

# getAllGlobalCertKeys

$data = getAllGlobalCertKeys()

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$key = file_get_contents('tests/key.pem');
$cert = file_get_contents('tests/cert.pem');

$certID = $client->setGlobalCertKey([
   'key' => $key,
   'cert' => $cert
]);

$data = $client->getAllGlobalCertKeys();

?>

# deleteGlobalCertKey

$ok = deleteGlobalCertKey($certID);

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$key = file_get_contents('tests/key.pem');
$cert = file_get_contents('tests/cert.pem');

$certID = $client->setGlobalCertKey([
   'key' => $key,
   'cert' => $cert
]);

$ok = $client->deleteGlobalCertKey($certID);

?>

# newCachePurgeTask

$taskID = newCachePurgeTask($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['test.com'],
   'label' => 'origin site for test.com',
]);

$condition = [
            ['var' => 'uri', 'op' => 'prefix', 'val' => '/foo']
        ];

$task_id = $client->newCachePurgeTask(['condition' => $condition]);

$task_id = $client->newCachePurgeTask(['type' => 'urls', 'urls' => array('http://test.com/foo', 'http://test.com/bar', 'http://test.com/abc/ddd')]);

?>

# getCachePurgeTask

$data = getCachePurgeTask($taskID)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$condition = [
            ['var' => 'uri', 'op' => 'prefix', 'val' => '/foo']
        ];

$task_id = $client->newCachePurgeTask(['condition' => $condition]);

$data = $client->getCachePurgeTask($task_id);
?>

# getAllCachePurgeTasks

$data = getAllCachePurgeTasks()

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$condition = [
            ['var' => 'uri', 'op' => 'prefix', 'val' => '/foo']
        ];

$task_id = $client->newCachePurgeTask(['condition' => $condition]);
$data = $client->getAllCachePurgeTasks();
?>

# deleteCachePurgeTask

$ok = deleteCachePurgeTask($taskID);

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$condition = [
            ['var' => 'uri', 'op' => 'prefix', 'val' => '/foo']
        ];

$task_id = $client->newCachePurgeTask(['condition' => $condition]);

$ok = $client->deleteCachePurgeTask($task_id);
?>

# newEL

$certID = newEL($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$code = "'true' => print('hello, foo.com');";
$ok = $client->newEL([
   'phase' => 'req-rewrite',
   'code' => $code,
   'post' => false
]);

?>

# newRelease

$ok = newRelease()

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$code = "'true' => print('hello, foo.com');";
$ok = $client->newEL([
   'phase' => 'req-rewrite',
   'code' => $code,
   'post' => false
]);

$ok = $client->newRelease();
?>

# pendingChanges

$changes = pendingChanges()

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$code = "'true' => print('hello, foo.com');";
$ok = $client->newEL([
   'phase' => 'req-rewrite',
   'code' => $code,
   'post' => false
]);

$beforeChanges = $client->pendingChanges();

$ok = $client->newRelease();

$afterChanges = $client->pendingChanges();

?>

# setWorker

$ok = setWorker($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ok = $client->setWorker([
   'connections' => 20480,
   'processes' => '8',
   'enable_http2' => true
]);

?>

# setSSL

$ok = setSSL($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ok = $client->setSSL([
   'session_ttl' => 60,
   'session_cache' => 100,
   'protocols' => ["TLSv1","TLSv1.1","TLSv1.2"],
   'prefer_server_ciphers' => false
]);

?>

# setProxy

$ok = setProxy($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ok = $client->setProxy([
   'intercept_errors' => true,
   'buffer_size' => 100
]);

?>

# setClientReq

$ok = setClientReq($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ok = $client->setClientReq([
   'body_timeout' => 30,
   'header_timeout' => 100
]);

?>

# setFileBuffer

$ok = setFileBuffer($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ok = $client->setFileBuffer([
   'max_cache' => 2000,
   'inactive_ttl' => 30
]);

?>

# setLog

$ok = setLog($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ok = $client->setLog([
   'no_errLog' => false,
   'log_level' => 'error',
   'max_log_files' => 100
]);

?>

# setDNS

$ok = setDNS($opts)

global config of DNS.

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ok = $client->setDNS([
   'timeout' => 10,
   'resolvers' => ['114.114.114.114']
]);

?>

# setGzip

$ok = setGzip($opts)

global config of DNS.

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ok = $client->setGzip([
   'enable_gzip' => true,
   'buffers' => 64,
   'compression_level' => 6
]);

?>

# newDNS

$appID = newDNS($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$authority = [
    ['domain' => "ns1.foo.com",'ttl' => '2 hour'],
    ['domain' => "ns2.foo.com",'ttl' => '1 day'],
];

$dnsID = $client->newDNS([
   'authority' => $authority,
   'soa_email' => 'admin.foo.com',
   'zone' => 'foo.com'
]);

?>

# updateDNS

$ok = updateDNS($opts);

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$authority = [
    ['domain' => "ns1.foo.com", 'ttl' => '2 hour'],
    ['domain' => "ns2.foo.com", 'ttl' => '1 day'],
];

$dnsID = $client->newDNS([
   'authority' => $authority,
   'soa_email' => 'admin.foo.com',
   'zone' => 'foo.com'
]);

$data = self::$client->getDNS(self::$dns_id);

$authority = [
    ['domain' => "ns1.foo.com", 'ttl' => '1 hour', 'id' => $data['nameserver'][0]'id'],
    ['domain' => "ns2.foo.com", 'ttl' => '1 hour', 'id' =>  $data['nameserver'][1]['id']],
    ['domain' => "ns3.foo.com", 'ttl' => '1 hour']
];

$ok = $client->updateDNS(['dns_id' => $dnsID,
                       'authority' => $authority,'zone' => 'foo.com']);
?>

# deleteDNS

$ok = deleteDNS($dnsID);

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$authority = [
    ['domain' => "ns1.foo.com", 'ttl' => '2 hour'],
    ['domain' => "ns2.foo.com", 'ttl' => '1 day'],
];

$dnsID = $client->newDNS([
   'authority' => $authority,
   'soa_email' => 'admin.foo.com',
   'zone' => 'foo.com'
]);

$ok = $client->deleteDNS($dnsID);

?>

# newDnsRecord

$appID = newDnsRecord($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$authority = [
    ['domain' => "ns1.foo.com",'ttl' => '2 hour'],
    ['domain' => "ns2.foo.com",'ttl' => '1 day'],
];

$dnsID = $client->newDNS([
   'authority' => $authority,
   'soa_email' => 'admin.foo.com',
   'zone' => 'foo.com'
]);

$record_id = $client->newDnsRecord([
   'dns_id' => $dnsID,
   'sub_domain' => 'bar',
   'line' => 0,
   'type' => 'TXT',
   'text' => 'text string'
]);

?>

# updateDnsRecord

$appID = updateDnsRecord($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$authority = [
    ['domain' => "ns1.foo.com",'ttl' => '2 hour'],
    ['domain' => "ns2.foo.com",'ttl' => '1 day'],
];

$dnsID = $client->newDNS([
   'authority' => $authority,
   'soa_email' => 'admin.foo.com',
   'zone' => 'foo.com'
]);

$record_id = $client->newDnsRecord([
   'dns_id' => $dnsID,
   'sub_domain' => 'bar',
   'line' => 0,
   'type' => 'TXT',
   'text' => 'text string'
]);

$ok = $client->updateDnsRecord([
   'dns_id' => $dnsID,
   'record_id' => $record_id,
   'sub_domain' => 'a.bar',
   'line' => 0,
   'type' => 'TXT',
   'text' => 'text string'
]);

?>

# deleteDnsRecord

$appID = deleteDnsRecord($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$authority = [
    ['domain' => "ns1.foo.com",'ttl' => '2 hour'],
    ['domain' => "ns2.foo.com",'ttl' => '1 day'],
];

$dnsID = $client->newDNS([
   'authority' => $authority,
   'soa_email' => 'admin.foo.com',
   'zone' => 'foo.com'
]);

$record_id = $client->newDnsRecord([
   'dns_id' => $dnsID,
   'sub_domain' => 'bar',
   'line' => 0,
   'type' => 'TXT',
   'text' => 'text string'
]);

$ok = $client->deleteDnsRecord([
   'dns_id' => $dnsID,
   'record_id' => $record_id
]);

?>

# disabledDnsRecord

$appID = disabledDnsRecord($opts)

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$authority = [
    ['domain' => "ns1.foo.com",'ttl' => '2 hour'],
    ['domain' => "ns2.foo.com",'ttl' => '1 day'],
];

$dnsID = $client->newDNS([
   'authority' => $authority,
   'soa_email' => 'admin.foo.com',
   'zone' => 'foo.com'
]);

$record_id = $client->newDnsRecord([
   'dns_id' => $dnsID,
   'sub_domain' => 'bar',
   'line' => 0,
   'type' => 'TXT',
   'text' => 'text string'
]);

$ok = $client->disabledDnsRecord([
   'dns_id' => $dnsID,
   'record_id' => $record_id
]);

?>

# newGlobalDymetrics

$metric = newGlobalDymetrics($opts);

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$opts = [
   'name' => 'test',
   'interval' => 60,
   'sql' => 'select status, count(*) from reqs group by status'
];

$metric = $client->newGlobalDymetrics($opts);

?>

# deleteGlobalDymetrics

$ok = deleteGlobalDymetrics($metricID);

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$opts = [
   'name' => 'test',
   'interval' => 60,
   'sql' => 'select status, count(*) from reqs group by status'
];

$metric = $client->newGlobalDymetrics($opts);

$ok = $client->deleteGlobalDymetrics($metric)
?>

# getGlobalDymetrics

$metrics = getGlobalDymetrics();

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$opts = [
   'name' => 'test',
   'interval' => 60,
   'sql' => 'select status, count(*) from reqs group by status'
];

$metric = $client->newGlobalDymetrics($opts);

$metrics = $client->getGlobalDymetrics();

?>

# getGlobalDymetricsData

$data = getGlobalDymetricsData($opts);

Description of array $opts:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$opts = [
   'name' => 'test',
   'interval' => 60,
   'sql' => 'select status, count(*) from reqs group by status'
];

$metric = $client->newGlobalDymetrics($opts);

$opts = [
   'id' => $metric['id'],
   'chart_type' => 'line',
   'start_time' => 1619014008,
   'end_time' => 1619015008
];
data = $client->getGlobalDymetricsData($opts);

?>

# getMetricData

$data = getMetricData($appID)

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$appID = $client->newApp([
   'domains' => ['orig.foo.com'],
   'label' => 'origin site for foo.com',
]);

$data = $client->getMetricData();
?>

# newLayerPolicy

$policyID = newLayerPolicy($opts)

Description of array $opts:

Description of array $rule:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$policyID = $client->newLayerPolicy([
   'name' => 'policy_1',
   'rules' => [
      [
         "gateway" => 3,
         "upstream" => 2,
         "backup" => 1
      ]
   ]
]);
?>

# deleteLayerPolicy

$ok = deleteLayerPolicy($policyID)

Description of $policyID:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ok = $client->deleteLayerPolicy(1);
?>

# updateLayerPolicy

$ok = updateLayerPolicy($opts)

Description of array $opts:

Description of array $rule:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ok = $client->updateLayerPolicy([
   'policy_id' => 1,
   'name' => 'policy_2',
   'rules' => [
      [
         "gateway" => 3,
         "upstream" => 2,
         "backup" => 1
      ]
   ]
]);
?>

# getLayerPolicies

$data = getLayerPolicies()

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$policies = $client->getLayerPolicies();
?>

# newGlobalIPList

$GlobalIPListID = newGlobalIPList($opts)

Description of object $opts:

Description of object $item:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

// use username and password
$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$globalIPListID = $client->newGlobalIPList([
    'name' => 'iplist-1',
    'type' => 'ipv4',
    'items' => [
        [ 'ip' => '127.0.0.1' ],
        [ 'ip' => '192.168.0.0/16' ]
    ]
]);

?>

# deleteGlobalIPList

$ok = deleteGlobalIPList($globalIPListID)

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

// use username and password
$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$globalIPListID = $client->newGlobalIPList([
    'name' => 'iplist-1',
    'type' => 'ipv4',
    'items' => [
        [ 'ip' => '127.0.0.1' ],
        [ 'ip' => '192.168.0.0/16' ]
    ]
]);

$ok = $client->deleteGlobalIPList($globalIPListID);

?>

# updateGlobalIPList

Update the global IP list, which will overwrite the original data.

$ok = updateGlobalIPList($opts)

Description of object $opts:

Description of object $item:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

// use username and password
$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ok = $client->updateGlobalIPList([
    'globalIPListID' => 1,
    'items' => [
        [ 'ip' => '127.0.0.1' ],
        [ 'ip' => '192.168.0.0/16' ]
    ]
]);

?>

# appendToGlobalIPList

Update the global IP list, which will not overwrite the original data.

$ok = appendToGlobalIPList($opts)

Description of object $opts:

Description of object $item:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

// use username and password
$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ok = $client->appendToGlobalIPList([
    'globalIPListID' => 1,
    'items' => [
        [ 'ip' => '127.0.0.3' ],
    ]
]);

?>

# removeFromGlobalIPList

Remove IPs from global IP list, which will not overwrite the original data.

$ok = removeFromGlobalIPList($opts)

Description of object $opts:

Description of object $item:

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

// use username and password
$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ok = $client->removeFromGlobalIPList([
    'globalIPListID' => 1,
    'items' => [
        [ 'ip' => '127.0.0.3' ],
    ]
]);

?>

# getGlobalIPList

$data = getGlobalIPList($globalIPListID)

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ipList = $client->getGlobalIPList($globalIPListID);

?>

# getAllGlobalIPList

$data = getAllGlobalIPList()

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$ok = $client->login();

$ipList = $client->getAllGlobalIPList();

?>

# convCrlToLuaModule

$data = convCrlToLuaModule($crlFiles)

Example:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use OpenResty\Edge2Client;

$client = new Edge2Client([
   'edge_admin_addr' => 'https://admin.openresty.com',
   'username' => 'admin',
   'password' => '123456'
]);

$crlFiles = array('test.crl');

$ok = $client->login();
$code = $client->convCrlToLuaModule($crlFiles)

?>