List all compute instances

experimental

get/v2/projects/{ref}/compute

Returns all compute instances you've previously deployed to the specified project.

This endpoint is currently in its Alpha stage.

OAuth scopes

edge_functions:read

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

workers_read

Path parameters

ref
Required
string
Project ref

Response codes

Response (200)

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

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

List all compute instancesexperimental

OAuth scopes

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

Path parameters

Response codes

Response (200)

List all compute instances
experimental