Edge Scripting API

Edge Scripting is a serverless JavaScript platform built on top of Deno, designed to help developers build, deploy, and run JavaScript applications on our massive global network without worrying about hardware, scaling, or load balancing ever again.

Setup

<?php

require 'vendor/autoload.php';

use ToshY\BunnyNet\EdgeScriptingAPI;
use ToshY\BunnyNet\Client\BunnyClient;

$bunnyClient = new BunnyClient(
    client: new \Symfony\Component\HttpClient\Psr18Client(),
);

// Provide the account API key.
$edgeScriptingApi = new EdgeScriptingAPI(
    apiKey: '2cebf4f8-4bff-429f-86f6-bce2c2163d7e89fb0a86-a1b2-463c-a142-11eba8811989',
    client: $bunnyClient,
);

Usage

Code

Get Code

$edgeScriptingApi->getCode(
    id: 1,
);

Set Code

$edgeScriptingApi->setCode(
    id: 1,
    body: [
        'Code' => "import * as BunnySDK from \"https://esm.sh/@bunny.net/edgescript-sdk@0.11.2\";\n\n/**\n * Returns an HTTP response.\n * @param {Request} request - The Fetch API Request object.\n * @return {Response} The HTTP response or string.\n */\nBunnySDK.net.http.serve(async (request: Request): Response | Promise<Response> => {\n  const url = new URL(request.url);\n  return new Response(\"Hello again from \" + url.pathname);\n});\n",
    ],
);

Edge Script

List Edge Scripts

$edgeScriptingApi->listEdgeScripts(
    query: [
        'page' => 1,
        'perPage' => 1000,
        'search' => 'Test',
        'includeLinkedPullzones' => false,
        'integrationId' => 1234,
    ],
);

Add Edge Script

$edgeScriptingApi->addEdgeScript(
    body: [
        'Name' => 'Test Script',
        'Code' => "import * as BunnySDK from \"https://esm.sh/@bunny.net/edgescript-sdk@0.11.2\";\n\n/**\n * Returns an HTTP response.\n * @param {Request} request - The Fetch API Request object.\n * @return {Response} The HTTP response or string.\n */\nBunnySDK.net.http.serve(async (request: Request): Response | Promise<Response> => {\n  const url = new URL(request.url);\n  return new Response(\"Hello from \" + url.pathname);\n});\n",
        'ScriptType' => 1,
        'CreateLinkedPullZone' => true,
        'LinkedPullZoneName' => 'MyPullZone',
        'Integration' => [
            'IntegrationId' => 1234,
            'RepositorySettings' => [
                'Id' => 1234,
                'Name' => 'my-cool-es-return-repo',
                'Private' => true,
                'TemplateUrl' => 'https://github.com/BunnyWay/es-return-json',
            ],
            'DeployConfiguration' => [
                'Branch' => 'main',
                'InstallCommand' => 'curl -fsSL https://deno.land/install.sh | sh -s v1.0.0',
                'BuildCommand' => 'deno task build',
                'EntryFile' => 'dist/main.js',
                'CreateWorkflow' => true,
            ],
        ],
    ],
);

Note

• The key ScriptType has the following possible values:
  • 1 = Standalone (Standalone scripts are ideal for a wide range of applications, such as building RESTful APIs, delivering UI applications, and processing data at the edge.)
  • 2 = Middleware (Middleware scripts common use cases include user authentication, error handling, logging, security enhancements, A/B testing, HTML manipulation, and more.)
• The key RepositorySettings is not required when creating, editing and deploying on Bunny.net.
• The key Id (under RepositorySettings) and DeployConfiguration are not required when creating a new GitHub repository.
• The key IntegrationId is required when creating and deploying through GitHub. It can be retrieved from the Get GitHub Integration endpoint.

Info

The Edge Scripting API can also be used for creating DNS scripts.

$edgeScriptingApi->addEdgeScript(
    body: [
        'Name' => 'DNS Script',
        'ScriptType' => 0,
    ],
);

Example

Examples for DeployConfiguration payloads.

Basic Deno

'DeployConfiguration' => [
    'Branch' => 'main',
    'InstallCommand' => 'curl -fsSL https://deno.land/install.sh | sh -s v1.0.0',
    'BuildCommand' => 'deno task build',
    'EntryFile' => 'dist/main.js',
    'CreateWorkflow' => true,
],

Basic Node.js

'DeployConfiguration' => [
    'Branch' => 'main',
    'InstallCommand' => 'npm install',
    'BuildCommand' => 'npm run build',
    'EntryFile' => 'dist/index.js',
    'CreateWorkflow' => true,
],

Question

If you want to create a workflow file yourself, check out the BunnyWay Github action deploy script.

Get Edge Script

$edgeScriptingApi->getEdgeScript(
    id: 1,
);

Get Edge Script Statistics

$edgeScriptingApi->getEdgeScriptStatistics(
    id: 1,
    query: [
        'dateFrom' => 'm-d-Y',
        'dateTo' => 'm-d-Y',
        'loadLatest' => false,
        'hourly' => false,
    ],
);

Update Edge Script

$edgeScriptingApi->updateEdgeScript(
    id: 1,
    body: [
        'Name' => 'Test Script',
        'ScriptType' => 1,
    ],
);

Note

• The key ScriptType has the following possible values:
  • 0 = DNS (DNS scripts)
  • 1 = Standalone (Standalone scripts are ideal for a wide range of applications, such as building RESTful APIs, delivering UI applications, and processing data at the edge.)
  • 2 = Middleware (Middleware scripts common use cases include user authentication, error handling, logging, security enhancements, A/B testing, HTML manipulation, and more.)

Delete Edge Script

$edgeScriptingApi->deleteEdgeScript(
    id: 1,
    query: [
        'deleteLinkedPullZones' => false,
    ],
);

Variable

Info

There is no "List Variables" endpoint to retrieve all variables for a specific script. Instead, you can retrieve this information from the Get Edge Script endpoint.

Get Variable

$edgeScriptingApi->getVariable(
    id: 1,
    variableId: 2,
);

Add Variable

$edgeScriptingApi->addVariable(
    id: 1,
    body: [
        'Name' => 'NEW_VARIABLE',
        'Required' => true,
        'DefaultValue' => 'Hello World',
    ],
);

Update Variable

$edgeScriptingApi->updateVariable(
    id: 1,
    variableId: 2,
    body: [
        'Required' => false,
        'DefaultValue' => 'Hello World the Sequel',
    ],
);

Upsert Variable

$edgeScriptingApi->upsertVariable(
    id: 1,
    body: [
        'Name' => 'NEW_VARIABLE',
        'Required' => true,
        'DefaultValue' => 'Hello World the Third',
    ],
);

Delete Variable

$edgeScriptingApi->deleteVariable(
    id: 1,
    variableId: 2,
);

Secret

List Secrets

$edgeScriptingApi->listSecrets(
    id: 1,
);

Add Secret

$edgeScriptingApi->addSecret(
    id: 1,
    body: [
        'Name' => 'SECRET_KEY',
        'Secret' => 'V2UncmUgbm8gc3RyYW5nZXJzIHRvIGxvdmUKWW91IGtub3cgdGhlIHJ1bGVzIGFuZCBzbyBkbyBJIChEbyBJKQpBIGZ1bGwgY29tbWl0bWVudCdzIHdoYXQgSSdtIHRoaW5raW5nIG9mCllvdSB3b3VsZG4ndCBnZXQgdGhpcyBmcm9tIGFueSBvdGhlciBndXk=',
    ],
);

Update Secret

$edgeScriptingApi->updateSecret(
    id: 1,
    secretId: 2,
    body: [
        'Secret' => 'TmV2ZXIgZ29ubmEgZ2l2ZSB5b3UgdXAKTmV2ZXIgZ29ubmEgbGV0IHlvdSBkb3duCk5ldmVyIGdvbm5hIHJ1biBhcm91bmQgYW5kIGRlc2VydCB5b3UKTmV2ZXIgZ29ubmEgbWFrZSB5b3UgY3J5Ck5ldmVyIGdvbm5hIHNheSBnb29kYnllCk5ldmVyIGdvbm5hIHRlbGwgYSBsaWUgYW5kIGh1cnQgeW91',
    ],
);

Upsert Secret

$edgeScriptingApi->upsertSecret(
    id: 1,
    body: [
        'Name' => 'SECRET_KEY',
        'Secret' => 'SSBqdXN0IHdhbm5hIHRlbGwgeW91IGhvdyBJJ20gZmVlbGluZwpHb3R0YSBtYWtlIHlvdSB1bmRlcnN0YW5k',
    ],
);

Delete Secret

$edgeScriptingApi->deleteSecret(
    id: 1,
    secretId: 2,
);

Release

Get Releases

$edgeScriptingApi->getReleases(
    id: 1,
    query: [
        'page' => 1,
        'perPage' => 1000,
    ],
);

Get Active Release

$edgeScriptingApi->getActiveRelease(
    id: 1,
);

Publish Release

$edgeScriptingApi->publishRelease(
    id: 1,
    body: [
        'Note' => 'Initial release',
    ],
);

Publish Release (by path parameter)

$edgeScriptingApi->publishReleaseByUuid(
    id: 1,
    uuid: 'Ab0CdE1F',
    body: [
        'Note' => 'Initial release',
    ],
);

Note

• The key uuid denotes an 8 character alphanumeric string (and not an "UUID"), which can be retrieved from the Get Releases or Get Active Release endpoints. It can also be retrieved from the Bunny dashboard in the "Release ID" column of the deployments.

Reference

• Edge Scripting API
• Blog "Introducing Edge Scripting: A better way to build and run applications at the edge!" (07-11-2024)