Update a function

patch/v1/projects/{ref}/functions/{function_slug}

Updates a function with the specified slug and project.

OAuth scopes

edge_functions:write

The fine-grained token must include the following permissions to access this endpoint:

edge_functions_write

Path parameters

ref
Required
string
Project ref
function_slug
Required
string
Function slug

Query parameters

slug
Optional
string
name
Optional
string
verify_jwt
Optional
string
import_map
Optional
string
entrypoint_path
Optional
string
import_map_path
Optional
string
ezbr_sha256
Optional
string

Body

string

Raw Brotli-compressed ESZIP binary file.

Validation requirements - The file must start with the four magic bytes EZBR (hex: 45 5A 42 52).

The ezbr_sha256 query parameter must contain the SHA-256 hash of the uploaded ESZIP payload.

Example

1
import { readFile } from 'node:fs/promises';
2
import { brotliCompress } from 'node:zlib';
3
import { promisify } from 'node:util';
4
import { createHash } from 'node:crypto';
5
6
const compress = promisify(brotliCompress);
7
const marker = Buffer.from('EZBR', 'ascii');
8
9
const file = await readFile('./function.eszip');
10
const compressed = await compress(file);
11
12
const payload = Buffer.concat([marker, compressed]);
13
14
const ezbr_sha256 = createHash('sha256')
15
  .update(payload)
16
  .digest('hex');
17
18
console.log(ezbr_sha256);

Response codes

Response (200)

1
{
2
  "id": "lorem",
3
  "slug": "lorem",
4
  "name": "lorem",
5
  "status": "ACTIVE",
6
  "version": -9007199254740991,
7
  "created_at": -9007199254740991,
8
  "updated_at": -9007199254740991,
9
  "verify_jwt": true,
10
  "import_map": true,
11
  "entrypoint_path": "lorem",
12
  "import_map_path": "lorem",
13
  "ezbr_sha256": "lorem"
14
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "id": {
5
      "type": "string"
6
    },
7
    "slug": {
8
      "type": "string"
9
    },
10
    "name": {
11
      "type": "string"
12
    },
13
    "status": {
14
      "type": "string",
15
      "enum": [
16
        "ACTIVE",
17
        "REMOVED",
18
        "THROTTLED"
19
      ]
20
    },
21
    "version": {
22
      "type": "integer",
23
      "minimum": -9007199254740991,
24
      "maximum": 9007199254740991
25
    },
26
    "created_at": {
27
      "type": "integer",
28
      "minimum": -9007199254740991,
29
      "maximum": 9007199254740991,
30
      "format": "int64"
31
    },
32
    "updated_at": {
33
      "type": "integer",
34
      "minimum": -9007199254740991,
35
      "maximum": 9007199254740991,
36
      "format": "int64"
37
    },
38
    "verify_jwt": {
39
      "type": "boolean"
40
    },
41
    "import_map": {
42
      "type": "boolean"
43
    },
44
    "entrypoint_path": {
45
      "type": "string"
46
    },
47
    "import_map_path": {
48
      "type": "string"
49
    },
50
    "ezbr_sha256": {
51
      "type": "string"
52
    }
53
  },
54
  "required": [
55
    "id",
56
    "slug",
57
    "name",
58
    "status",
59
    "version",
60
    "created_at",
61
    "updated_at"
62
  ]
63
}