Deploy a compute instance

experimental

post/v2/projects/{ref}/compute/{name}/deploy

Creates the compute instance if it does not exist, building from a context staged through the uploads endpoint. The build runs asynchronously: this answers 202 and the compute instance reaches build_state active or failed later.

This endpoint is currently in its Alpha stage.

OAuth scopes

edge_functions:write

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

workers_write

Path parameters

ref
Required
string
Project ref
name
Required
string

Body

data
Required
object

Response codes

Response (202)

1
{
2
  "data": {
3
    "type": "project_compute_instance",
4
    "id": "hello-world",
5
    "attributes": {
6
      "spec": {
7
        "runtime": "node",
8
        "size": "2gb-1vcpu",
9
        "exposure": "public",
10
        "instances": 1
11
      },
12
      "build_state": "building",
13
      "secret_generation": "lorem",
14
      "state_reason": "lorem",
15
      "image_version": "lorem",
16
      "deleting": true,
17
      "instances": {
18
        "declared": -9007199254740991,
19
        "live": -9007199254740991,
20
        "ready": -9007199254740991,
21
        "stale": -9007199254740991
22
      },
23
      "instances_error": "lorem"
24
    }
25
  }
26
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "data": {
5
      "type": "object",
6
      "properties": {
7
        "type": {
8
          "type": "string",
9
          "description": "Resource type.",
10
          "enum": [
11
            "project_compute_instance"
12
          ]
13
        },
14
        "id": {
15
          "type": "string",
16
          "description": "Compute instance name.",
17
          "example": "hello-world"
18
        },
19
        "attributes": {
20
          "type": "object",
21
          "properties": {
22
            "spec": {
23
              "type": "object",
24
              "properties": {
25
                "runtime": {
26
                  "example": "node",
27
                  "type": "string"
28
                },
29
                "size": {
30
                  "type": "string",
31
                  "example": "2gb-1vcpu"
32
                },
33
                "exposure": {
34
                  "type": "string",
35
                  "example": "public"
36
                },
37
                "instances": {
38
                  "type": "integer",
39
                  "minimum": -9007199254740991,
40
                  "maximum": 9007199254740991,
41
                  "example": 1
42
                }
43
              },
44
              "required": [
45
                "size",
46
                "exposure",
47
                "instances"
48
              ]
49
            },
50
            "build_state": {
51
              "type": "string",
52
              "enum": [
53
                "building",
54
                "active",
55
                "failed"
56
              ]
57
            },
58
            "secret_generation": {
59
              "type": "string"
60
            },
61
            "state_reason": {
62
              "type": "string"
63
            },
64
            "image_version": {
65
              "type": "string"
66
            },
67
            "deleting": {
68
              "type": "boolean"
69
            },
70
            "instances": {
71
              "type": "object",
72
              "properties": {
73
                "declared": {
74
                  "type": "integer",
75
                  "minimum": -9007199254740991,
76
                  "maximum": 9007199254740991
77
                },
78
                "live": {
79
                  "type": "integer",
80
                  "minimum": -9007199254740991,
81
                  "maximum": 9007199254740991
82
                },
83
                "ready": {
84
                  "type": "integer",
85
                  "minimum": -9007199254740991,
86
                  "maximum": 9007199254740991
87
                },
88
                "stale": {
89
                  "type": "integer",
90
                  "minimum": -9007199254740991,
91
                  "maximum": 9007199254740991
92
                }
93
              },
94
              "required": [
95
                "declared",
96
                "live",
97
                "ready",
98
                "stale"
99
              ]
100
            },
101
            "instances_error": {
102
              "type": "string"
103
            }
104
          },
105
          "required": [
106
            "spec",
107
            "build_state",
108
            "secret_generation"
109
          ]
110
        }
111
      },
112
      "required": [
113
        "type",
114
        "id",
115
        "attributes"
116
      ]
117
    }
118
  },
119
  "required": [
120
    "data"
121
  ]
122
}

Deploy a compute instanceexperimental