Reference

Vercel REST API Interfaces

Shared interfaces referenced across multiple endpoints.
Table of Contents

ACLAction

1
{
2
"type": "string",
3
"enum": ["create", "delete", "read", "update", "list"],
4
"description": "Enum containing the actions that can be performed against a resource. Group operations are included."
5
}

AccessGroup

1
{
2
"properties": {
3
"name": {
4
"type": "string",
5
"description": "The name of this access group.",
6
"example": "my-access-group"
7
},
8
"createdAt": {
9
"type": "string",
10
"description": "Timestamp in milliseconds when the access group was created.",
11
"example": 1588720733602
12
},
13
"teamId": {
14
"type": "string",
15
"description": "ID of the team that this access group belongs to.",
16
"example": "team_123a6c5209bc3778245d011443644c8d27dc2c50"
17
},
18
"updatedAt": {
19
"type": "string",
20
"description": "Timestamp in milliseconds when the access group was last updated.",
21
"example": 1588720733602
22
},
23
"accessGroupId": {
24
"type": "string",
25
"description": "ID of the access group.",
26
"example": "ag_123a6c5209bc3778245d011443644c8d27dc2c50"
27
},
28
"membersCount": {
29
"type": "number",
30
"description": "Number of members in the access group.",
31
"example": 5
32
},
33
"projectsCount": {
34
"type": "number",
35
"description": "Number of projects in the access group.",
36
"example": 2
37
}
38
},
39
"required": [
40
"name",
41
"createdAt",
42
"teamId",
43
"updatedAt",
44
"accessGroupId",
45
"membersCount",
46
"projectsCount"
47
],
48
"type": "object",
49
"description": "Represents an Access Group."
50
}

AuthToken

1
{
2
"properties": {
3
"id": {
4
"type": "string",
5
"description": "The unique identifier of the token.",
6
"example": "5d9f2ebd38ddca62e5d51e9c1704c72530bdc8bfdd41e782a6687c48399e8391"
7
},
8
"name": {
9
"type": "string",
10
"description": "The human-readable name of the token."
11
},
12
"type": {
13
"type": "string",
14
"description": "The type of the token.",
15
"example": "oauth2-token"
16
},
17
"origin": {
18
"type": "string",
19
"description": "The origin of how the token was created.",
20
"example": "github"
21
},
22
"scopes": {
23
"items": {
24
"oneOf": [
25
{
26
"properties": {
27
"type": { "type": "string", "enum": ["user"] },
28
"origin": {
29
"type": "string",
30
"enum": [
31
"saml",
32
"github",
33
"gitlab",
34
"bitbucket",
35
"email",
36
"manual",
37
"passkey"
38
]
39
},
40
"createdAt": { "type": "number" },
41
"expiresAt": { "type": "number" }
42
},
43
"required": ["type", "origin", "createdAt"],
44
"type": "object",
45
"description": "The access scopes granted to the token."
46
},
47
{
48
"properties": {
49
"type": { "type": "string", "enum": ["team"] },
50
"teamId": { "type": "string" },
51
"origin": {
52
"type": "string",
53
"enum": [
54
"saml",
55
"github",
56
"gitlab",
57
"bitbucket",
58
"email",
59
"manual",
60
"passkey"
61
]
62
},
63
"createdAt": { "type": "number" },
64
"expiresAt": { "type": "number" }
65
},
66
"required": ["type", "teamId", "origin", "createdAt"],
67
"type": "object",
68
"description": "The access scopes granted to the token."
69
}
70
]
71
},
72
"type": "array",
73
"description": "The access scopes granted to the token."
74
},
75
"expiresAt": {
76
"type": "number",
77
"description": "Timestamp (in milliseconds) of when the token expires.",
78
"example": 1632816536002
79
},
80
"activeAt": {
81
"type": "number",
82
"description": "Timestamp (in milliseconds) of when the token was most recently used.",
83
"example": 1632816536002
84
},
85
"createdAt": {
86
"type": "number",
87
"description": "Timestamp (in milliseconds) of when the token was created.",
88
"example": 1632816536002
89
}
90
},
91
"required": ["id", "name", "type", "activeAt", "createdAt"],
92
"type": "object",
93
"description": "Authentication token metadata."
94
}

AuthUser

1
{
2
"properties": {
3
"createdAt": {
4
"type": "number",
5
"description": "UNIX timestamp (in milliseconds) when the User account was created.",
6
"example": 1630748523395
7
},
8
"softBlock": {
9
"nullable": true,
10
"properties": {
11
"blockedAt": { "type": "number" },
12
"reason": {
13
"type": "string",
14
"enum": [
15
"SUBSCRIPTION_CANCELED",
16
"SUBSCRIPTION_EXPIRED",
17
"UNPAID_INVOICE",
18
"ENTERPRISE_TRIAL_ENDED",
19
"FAIR_USE_LIMITS_EXCEEDED",
20
"BLOCKED_FOR_PLATFORM_ABUSE"
21
]
22
},
23
"blockedDueToOverageType": {
24
"type": "string",
25
"enum": [
26
"analyticsUsage",
27
"artifacts",
28
"bandwidth",
29
"blobStores",
30
"blobTotalAdvancedRequests",
31
"blobTotalAvgSizeInBytes",
32
"blobTotalGetResponseObjectSizeInBytes",
33
"blobTotalSimpleRequests",
34
"buildMinute",
35
"dataCacheRead",
36
"dataCacheRevalidation",
37
"dataCacheWrite",
38
"edgeConfigRead",
39
"edgeConfigWrite",
40
"edgeFunctionExecutionUnits",
41
"edgeMiddlewareInvocations",
42
"edgeRequest",
43
"edgeRequestAdditionalCpuDuration",
44
"fastDataTransfer",
45
"fastOriginTransfer",
46
"functionDuration",
47
"functionInvocation",
48
"logDrainsVolume",
49
"monitoringMetric",
50
"postgresComputeTime",
51
"postgresDataStorage",
52
"postgresDataTransfer",
53
"postgresDatabase",
54
"postgresWrittenData",
55
"serverlessFunctionExecution",
56
"sourceImages",
57
"storageRedisTotalBandwidthInBytes",
58
"storageRedisTotalCommands",
59
"storageRedisTotalDailyAvgStorageInBytes",
60
"storageRedisTotalDatabases",
61
"wafOwaspExcessBytes",
62
"wafOwaspRequests",
63
"wafRateLimitRequest",
64
"webAnalyticsEvent"
65
]
66
}
67
},
68
"required": ["blockedAt", "reason"],
69
"type": "object",
70
"description": "When the User account has been \"soft blocked\", this property will contain the date when the restriction was enacted, and the identifier for why."
71
},
72
"billing": {
73
"nullable": true,
74
"properties": {
75
"currency": { "type": "string", "enum": ["usd", "eur"] },
76
"cancelation": { "nullable": true, "type": "number" },
77
"period": {
78
"nullable": true,
79
"properties": {
80
"start": { "type": "number" },
81
"end": { "type": "number" }
82
},
83
"required": ["start", "end"],
84
"type": "object"
85
},
86
"contract": {
87
"nullable": true,
88
"properties": {
89
"start": { "type": "number" },
90
"end": { "type": "number" }
91
},
92
"required": ["start", "end"],
93
"type": "object"
94
},
95
"plan": { "type": "string", "enum": ["pro", "enterprise", "hobby"] },
96
"planIteration": { "type": "string" },
97
"platform": { "type": "string", "enum": ["stripe", "stripeTestMode"] },
98
"orbCustomerId": { "type": "string" },
99
"syncedAt": { "type": "number" },
100
"programType": { "type": "string", "enum": ["startup", "agency"] },
101
"trial": {
102
"nullable": true,
103
"properties": {
104
"start": { "type": "number" },
105
"end": { "type": "number" }
106
},
107
"required": ["start", "end"],
108
"type": "object"
109
},
110
"email": { "nullable": true, "type": "string" },
111
"tax": {
112
"nullable": true,
113
"properties": {
114
"type": { "type": "string" },
115
"id": { "type": "string" }
116
},
117
"required": ["type", "id"],
118
"type": "object"
119
},
120
"language": { "nullable": true, "type": "string" },
121
"address": {
122
"nullable": true,
123
"properties": {
124
"line1": { "type": "string" },
125
"line2": { "type": "string" },
126
"postalCode": { "type": "string" },
127
"city": { "type": "string" },
128
"country": { "type": "string" },
129
"state": { "type": "string" }
130
},
131
"type": "object"
132
},
133
"name": { "nullable": true, "type": "string" },
134
"invoiceItems": {
135
"nullable": true,
136
"properties": {
137
"concurrentBuilds": {
138
"properties": {
139
"tier": { "type": "number" },
140
"price": { "type": "number" },
141
"quantity": { "type": "number" },
142
"highestQuantity": {
143
"type": "number",
144
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
145
},
146
"name": { "type": "string" },
147
"hidden": { "type": "boolean" },
148
"createdAt": { "type": "number" },
149
"disabledAt": { "nullable": true, "type": "number" },
150
"frequency": {
151
"properties": {
152
"interval": { "type": "string", "enum": ["month"] },
153
"intervalCount": {
154
"type": "number",
155
"enum": [1, 3, 2, 6, 12]
156
}
157
},
158
"required": ["interval", "intervalCount"],
159
"type": "object"
160
},
161
"maxQuantity": { "type": "number" }
162
},
163
"required": ["price", "quantity", "hidden"],
164
"type": "object",
165
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
166
},
167
"webAnalytics": {
168
"properties": {
169
"tier": { "type": "number" },
170
"price": { "type": "number" },
171
"quantity": { "type": "number" },
172
"highestQuantity": {
173
"type": "number",
174
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
175
},
176
"name": { "type": "string" },
177
"hidden": { "type": "boolean" },
178
"createdAt": { "type": "number" },
179
"disabledAt": { "nullable": true, "type": "number" },
180
"frequency": {
181
"properties": {
182
"interval": { "type": "string", "enum": ["month"] },
183
"intervalCount": {
184
"type": "number",
185
"enum": [1, 3, 2, 6, 12]
186
}
187
},
188
"required": ["interval", "intervalCount"],
189
"type": "object"
190
},
191
"maxQuantity": { "type": "number" }
192
},
193
"required": ["price", "quantity", "hidden"],
194
"type": "object",
195
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
196
},
197
"pro": {
198
"properties": {
199
"tier": { "type": "number" },
200
"price": { "type": "number" },
201
"quantity": { "type": "number" },
202
"highestQuantity": {
203
"type": "number",
204
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
205
},
206
"name": { "type": "string" },
207
"hidden": { "type": "boolean" },
208
"createdAt": { "type": "number" },
209
"disabledAt": { "nullable": true, "type": "number" },
210
"frequency": {
211
"properties": {
212
"interval": { "type": "string", "enum": ["month"] },
213
"intervalCount": {
214
"type": "number",
215
"enum": [1, 3, 2, 6, 12]
216
}
217
},
218
"required": ["interval", "intervalCount"],
219
"type": "object"
220
},
221
"maxQuantity": { "type": "number" }
222
},
223
"required": ["price", "quantity", "hidden"],
224
"type": "object",
225
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
226
},
227
"enterprise": {
228
"properties": {
229
"tier": { "type": "number" },
230
"price": { "type": "number" },
231
"quantity": { "type": "number" },
232
"highestQuantity": {
233
"type": "number",
234
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
235
},
236
"name": { "type": "string" },
237
"hidden": { "type": "boolean" },
238
"createdAt": { "type": "number" },
239
"disabledAt": { "nullable": true, "type": "number" },
240
"frequency": {
241
"properties": {
242
"interval": { "type": "string", "enum": ["month"] },
243
"intervalCount": {
244
"type": "number",
245
"enum": [1, 3, 2, 6, 12]
246
}
247
},
248
"required": ["interval", "intervalCount"],
249
"type": "object"
250
},
251
"maxQuantity": { "type": "number" }
252
},
253
"required": ["price", "quantity", "hidden"],
254
"type": "object",
255
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
256
},
257
"analytics": {
258
"properties": {
259
"tier": { "type": "number" },
260
"price": { "type": "number" },
261
"quantity": { "type": "number" },
262
"highestQuantity": {
263
"type": "number",
264
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
265
},
266
"name": { "type": "string" },
267
"hidden": { "type": "boolean" },
268
"createdAt": { "type": "number" },
269
"disabledAt": { "nullable": true, "type": "number" },
270
"frequency": {
271
"properties": {
272
"interval": { "type": "string", "enum": ["month"] },
273
"intervalCount": {
274
"type": "number",
275
"enum": [1, 3, 2, 6, 12]
276
}
277
},
278
"required": ["interval", "intervalCount"],
279
"type": "object"
280
},
281
"maxQuantity": { "type": "number" }
282
},
283
"required": ["price", "quantity", "hidden"],
284
"type": "object",
285
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
286
},
287
"developerExperiencePlatform": {
288
"properties": {
289
"tier": { "type": "number" },
290
"price": { "type": "number" },
291
"quantity": { "type": "number" },
292
"highestQuantity": {
293
"type": "number",
294
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
295
},
296
"name": { "type": "string" },
297
"hidden": { "type": "boolean" },
298
"createdAt": { "type": "number" },
299
"disabledAt": { "nullable": true, "type": "number" },
300
"frequency": {
301
"properties": {
302
"interval": { "type": "string", "enum": ["month"] },
303
"intervalCount": {
304
"type": "number",
305
"enum": [1, 3, 2, 6, 12]
306
}
307
},
308
"required": ["interval", "intervalCount"],
309
"type": "object"
310
},
311
"maxQuantity": { "type": "number" }
312
},
313
"required": ["price", "quantity", "hidden"],
314
"type": "object",
315
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
316
},
317
"enhancedConcurrentBuilds": {
318
"properties": {
319
"tier": { "type": "number" },
320
"price": { "type": "number" },
321
"quantity": { "type": "number" },
322
"highestQuantity": {
323
"type": "number",
324
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
325
},
326
"name": { "type": "string" },
327
"hidden": { "type": "boolean" },
328
"createdAt": { "type": "number" },
329
"disabledAt": { "nullable": true, "type": "number" },
330
"frequency": {
331
"properties": {
332
"interval": { "type": "string", "enum": ["month"] },
333
"intervalCount": {
334
"type": "number",
335
"enum": [1, 3, 2, 6, 12]
336
}
337
},
338
"required": ["interval", "intervalCount"],
339
"type": "object"
340
},
341
"maxQuantity": { "type": "number" }
342
},
343
"required": ["price", "quantity", "hidden"],
344
"type": "object",
345
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
346
},
347
"includedAllocationMiu": {
348
"properties": {
349
"tier": { "type": "number" },
350
"price": { "type": "number" },
351
"quantity": { "type": "number" },
352
"highestQuantity": {
353
"type": "number",
354
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
355
},
356
"name": { "type": "string" },
357
"hidden": { "type": "boolean" },
358
"createdAt": { "type": "number" },
359
"disabledAt": { "nullable": true, "type": "number" },
360
"frequency": {
361
"properties": {
362
"interval": { "type": "string", "enum": ["month"] },
363
"intervalCount": {
364
"type": "number",
365
"enum": [1, 3, 2, 6, 12]
366
}
367
},
368
"required": ["interval", "intervalCount"],
369
"type": "object"
370
},
371
"maxQuantity": { "type": "number" }
372
},
373
"required": ["price", "quantity", "hidden"],
374
"type": "object",
375
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
376
},
377
"managedInfrastructureCommitment": {
378
"properties": {
379
"tier": { "type": "number" },
380
"price": { "type": "number" },
381
"quantity": { "type": "number" },
382
"highestQuantity": {
383
"type": "number",
384
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
385
},
386
"name": { "type": "string" },
387
"hidden": { "type": "boolean" },
388
"createdAt": { "type": "number" },
389
"disabledAt": { "nullable": true, "type": "number" },
390
"frequency": {
391
"properties": {
392
"interval": { "type": "string", "enum": ["month"] },
393
"intervalCount": {
394
"type": "number",
395
"enum": [1, 3, 2, 6, 12]
396
}
397
},
398
"required": ["interval", "intervalCount"],
399
"type": "object"
400
},
401
"maxQuantity": { "type": "number" }
402
},
403
"required": ["price", "quantity", "hidden"],
404
"type": "object",
405
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
406
},
407
"monitoring": {
408
"properties": {
409
"tier": { "type": "number" },
410
"price": { "type": "number" },
411
"quantity": { "type": "number" },
412
"highestQuantity": {
413
"type": "number",
414
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
415
},
416
"name": { "type": "string" },
417
"hidden": { "type": "boolean" },
418
"createdAt": { "type": "number" },
419
"disabledAt": { "nullable": true, "type": "number" },
420
"frequency": {
421
"properties": {
422
"interval": { "type": "string", "enum": ["month"] },
423
"intervalCount": {
424
"type": "number",
425
"enum": [1, 3, 2, 6, 12]
426
}
427
},
428
"required": ["interval", "intervalCount"],
429
"type": "object"
430
},
431
"maxQuantity": { "type": "number" }
432
},
433
"required": ["price", "quantity", "hidden"],
434
"type": "object",
435
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
436
},
437
"passwordProtection": {
438
"properties": {
439
"tier": { "type": "number" },
440
"price": { "type": "number" },
441
"quantity": { "type": "number" },
442
"highestQuantity": {
443
"type": "number",
444
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
445
},
446
"name": { "type": "string" },
447
"hidden": { "type": "boolean" },
448
"createdAt": { "type": "number" },
449
"disabledAt": { "nullable": true, "type": "number" },
450
"frequency": {
451
"properties": {
452
"interval": { "type": "string", "enum": ["month"] },
453
"intervalCount": {
454
"type": "number",
455
"enum": [1, 3, 2, 6, 12]
456
}
457
},
458
"required": ["interval", "intervalCount"],
459
"type": "object"
460
},
461
"maxQuantity": { "type": "number" }
462
},
463
"required": ["price", "quantity", "hidden"],
464
"type": "object",
465
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
466
},
467
"previewDeploymentSuffix": {
468
"properties": {
469
"tier": { "type": "number" },
470
"price": { "type": "number" },
471
"quantity": { "type": "number" },
472
"highestQuantity": {
473
"type": "number",
474
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
475
},
476
"name": { "type": "string" },
477
"hidden": { "type": "boolean" },
478
"createdAt": { "type": "number" },
479
"disabledAt": { "nullable": true, "type": "number" },
480
"frequency": {
481
"properties": {
482
"interval": { "type": "string", "enum": ["month"] },
483
"intervalCount": {
484
"type": "number",
485
"enum": [1, 3, 2, 6, 12]
486
}
487
},
488
"required": ["interval", "intervalCount"],
489
"type": "object"
490
},
491
"maxQuantity": { "type": "number" }
492
},
493
"required": ["price", "quantity", "hidden"],
494
"type": "object",
495
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
496
},
497
"saml": {
498
"properties": {
499
"tier": { "type": "number" },
500
"price": { "type": "number" },
501
"quantity": { "type": "number" },
502
"highestQuantity": {
503
"type": "number",
504
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
505
},
506
"name": { "type": "string" },
507
"hidden": { "type": "boolean" },
508
"createdAt": { "type": "number" },
509
"disabledAt": { "nullable": true, "type": "number" },
510
"frequency": {
511
"properties": {
512
"interval": { "type": "string", "enum": ["month"] },
513
"intervalCount": {
514
"type": "number",
515
"enum": [1, 3, 2, 6, 12]
516
}
517
},
518
"required": ["interval", "intervalCount"],
519
"type": "object"
520
},
521
"maxQuantity": { "type": "number" }
522
},
523
"required": ["price", "quantity", "hidden"],
524
"type": "object",
525
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
526
},
527
"teamSeats": {
528
"properties": {
529
"tier": { "type": "number" },
530
"price": { "type": "number" },
531
"quantity": { "type": "number" },
532
"highestQuantity": {
533
"type": "number",
534
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
535
},
536
"name": { "type": "string" },
537
"hidden": { "type": "boolean" },
538
"createdAt": { "type": "number" },
539
"disabledAt": { "nullable": true, "type": "number" },
540
"frequency": {
541
"properties": {
542
"interval": { "type": "string", "enum": ["month"] },
543
"intervalCount": {
544
"type": "number",
545
"enum": [1, 3, 2, 6, 12]
546
}
547
},
548
"required": ["interval", "intervalCount"],
549
"type": "object"
550
},
551
"maxQuantity": { "type": "number" }
552
},
553
"required": ["price", "quantity", "hidden"],
554
"type": "object",
555
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
556
},
557
"vercelMarketplace": {
558
"properties": {
559
"tier": { "type": "number" },
560
"price": { "type": "number" },
561
"quantity": { "type": "number" },
562
"highestQuantity": {
563
"type": "number",
564
"description": "The highest quantity in the current period. Used to render the correct enable/disable UI for add-ons."
565
},
566
"name": { "type": "string" },
567
"hidden": { "type": "boolean" },
568
"createdAt": { "type": "number" },
569
"disabledAt": { "nullable": true, "type": "number" },
570
"frequency": {
571
"properties": {
572
"interval": { "type": "string", "enum": ["month"] },
573
"intervalCount": {
574
"type": "number",
575
"enum": [1, 3, 2, 6, 12]
576
}
577
},
578
"required": ["interval", "intervalCount"],
579
"type": "object"
580
},
581
"maxQuantity": { "type": "number" }
582
},
583
"required": ["price", "quantity", "hidden"],
584
"type": "object",
585
"description": "Will be used to create an invoice item. The price must be in cents: 2000 for $20."
586
},
587
"analyticsUsage": {
588
"properties": {
589
"matrix": {
590
"properties": {
591
"defaultUnitPrice": { "type": "string" },
592
"dimensionPrices": {
593
"additionalProperties": { "type": "string" },
594
"type": "object"
595
}
596
},
597
"required": ["defaultUnitPrice", "dimensionPrices"],
598
"type": "object"
599
},
600
"tier": { "type": "number" },
601
"price": { "type": "number" },
602
"batch": { "type": "number" },
603
"threshold": { "type": "number" },
604
"name": { "type": "string" },
605
"hidden": { "type": "boolean" },
606
"disabledAt": { "nullable": true, "type": "number" },
607
"enabledAt": { "nullable": true, "type": "number" }
608
},
609
"required": ["price", "batch", "threshold", "hidden"],
610
"type": "object"
611
},
612
"artifacts": {
613
"properties": {
614
"matrix": {
615
"properties": {
616
"defaultUnitPrice": { "type": "string" },
617
"dimensionPrices": {
618
"additionalProperties": { "type": "string" },
619
"type": "object"
620
}
621
},
622
"required": ["defaultUnitPrice", "dimensionPrices"],
623
"type": "object"
624
},
625
"tier": { "type": "number" },
626
"price": { "type": "number" },
627
"batch": { "type": "number" },
628
"threshold": { "type": "number" },
629
"name": { "type": "string" },
630
"hidden": { "type": "boolean" },
631
"disabledAt": { "nullable": true, "type": "number" },
632
"enabledAt": { "nullable": true, "type": "number" }
633
},
634
"required": ["price", "batch", "threshold", "hidden"],
635
"type": "object"
636
},
637
"bandwidth": {
638
"properties": {
639
"matrix": {
640
"properties": {
641
"defaultUnitPrice": { "type": "string" },
642
"dimensionPrices": {
643
"additionalProperties": { "type": "string" },
644
"type": "object"
645
}
646
},
647
"required": ["defaultUnitPrice", "dimensionPrices"],
648
"type": "object"
649
},
650
"tier": { "type": "number" },
651
"price": { "type": "number" },
652
"batch": { "type": "number" },
653
"threshold": { "type": "number" },
654
"name": { "type": "string" },
655
"hidden": { "type": "boolean" },
656
"disabledAt": { "nullable": true, "type": "number" },
657
"enabledAt": { "nullable": true, "type": "number" }
658
},
659
"required": ["price", "batch", "threshold", "hidden"],
660
"type": "object"
661
},
662
"blobStores": {
663
"properties": {
664
"matrix": {
665
"properties": {
666
"defaultUnitPrice": { "type": "string" },
667
"dimensionPrices": {
668
"additionalProperties": { "type": "string" },
669
"type": "object"
670
}
671
},
672
"required": ["defaultUnitPrice", "dimensionPrices"],
673
"type": "object"
674
},
675
"tier": { "type": "number" },
676
"price": { "type": "number" },
677
"batch": { "type": "number" },
678
"threshold": { "type": "number" },
679
"name": { "type": "string" },
680
"hidden": { "type": "boolean" },
681
"disabledAt": { "nullable": true, "type": "number" },
682
"enabledAt": { "nullable": true, "type": "number" }
683
},
684
"required": ["price", "batch", "threshold", "hidden"],
685
"type": "object"
686
},
687
"blobTotalAdvancedRequests": {
688
"properties": {
689
"matrix": {
690
"properties": {
691
"defaultUnitPrice": { "type": "string" },
692
"dimensionPrices": {
693
"additionalProperties": { "type": "string" },
694
"type": "object"
695
}
696
},
697
"required": ["defaultUnitPrice", "dimensionPrices"],
698
"type": "object"
699
},
700
"tier": { "type": "number" },
701
"price": { "type": "number" },
702
"batch": { "type": "number" },
703
"threshold": { "type": "number" },
704
"name": { "type": "string" },
705
"hidden": { "type": "boolean" },
706
"disabledAt": { "nullable": true, "type": "number" },
707
"enabledAt": { "nullable": true, "type": "number" }
708
},
709
"required": ["price", "batch", "threshold", "hidden"],
710
"type": "object"
711
},
712
"blobTotalAvgSizeInBytes": {
713
"properties": {
714
"matrix": {
715
"properties": {
716
"defaultUnitPrice": { "type": "string" },
717
"dimensionPrices": {
718
"additionalProperties": { "type": "string" },
719
"type": "object"
720
}
721
},
722
"required": ["defaultUnitPrice", "dimensionPrices"],
723
"type": "object"
724
},
725
"tier": { "type": "number" },
726
"price": { "type": "number" },
727
"batch": { "type": "number" },
728
"threshold": { "type": "number" },
729
"name": { "type": "string" },
730
"hidden": { "type": "boolean" },
731
"disabledAt": { "nullable": true, "type": "number" },
732
"enabledAt": { "nullable": true, "type": "number" }
733
},
734
"required": ["price", "batch", "threshold", "hidden"],
735
"type": "object"
736
},
737
"blobTotalGetResponseObjectSizeInBytes": {
738
"properties": {
739
"matrix": {
740
"properties": {
741
"defaultUnitPrice": { "type": "string" },
742
"dimensionPrices": {
743
"additionalProperties": { "type": "string" },
744
"type": "object"
745
}
746
},
747
"required": ["defaultUnitPrice", "dimensionPrices"],
748
"type": "object"
749
},
750
"tier": { "type": "number" },
751
"price": { "type": "number" },
752
"batch": { "type": "number" },
753
"threshold": { "type": "number" },
754
"name": { "type": "string" },
755
"hidden": { "type": "boolean" },
756
"disabledAt": { "nullable": true, "type": "number" },
757
"enabledAt": { "nullable": true, "type": "number" }
758
},
759
"required": ["price", "batch", "threshold", "hidden"],
760
"type": "object"
761
},
762
"blobTotalSimpleRequests": {
763
"properties": {
764
"matrix": {
765
"properties": {
766
"defaultUnitPrice": { "type": "string" },
767
"dimensionPrices": {
768
"additionalProperties": { "type": "string" },
769
"type": "object"
770
}
771
},
772
"required": ["defaultUnitPrice", "dimensionPrices"],
773
"type": "object"
774
},
775
"tier": { "type": "number" },
776
"price": { "type": "number" },
777
"batch": { "type": "number" },
778
"threshold": { "type": "number" },
779
"name": { "type": "string" },
780
"hidden": { "type": "boolean" },
781
"disabledAt": { "nullable": true, "type": "number" },
782
"enabledAt": { "nullable": true, "type": "number" }
783
},
784
"required": ["price", "batch", "threshold", "hidden"],
785
"type": "object"
786
},
787
"buildMinute": {
788
"properties": {
789
"matrix": {
790
"properties": {
791
"defaultUnitPrice": { "type": "string" },
792
"dimensionPrices": {
793
"additionalProperties": { "type": "string" },
794
"type": "object"
795
}
796
},
797
"required": ["defaultUnitPrice", "dimensionPrices"],
798
"type": "object"
799
},
800
"tier": { "type": "number" },
801
"price": { "type": "number" },
802
"batch": { "type": "number" },
803
"threshold": { "type": "number" },
804
"name": { "type": "string" },
805
"hidden": { "type": "boolean" },
806
"disabledAt": { "nullable": true, "type": "number" },
807
"enabledAt": { "nullable": true, "type": "number" }
808
},
809
"required": ["price", "batch", "threshold", "hidden"],
810
"type": "object"
811
},
812
"dataCacheRead": {
813
"properties": {
814
"matrix": {
815
"properties": {
816
"defaultUnitPrice": { "type": "string" },
817
"dimensionPrices": {
818
"additionalProperties": { "type": "string" },
819
"type": "object"
820
}
821
},
822
"required": ["defaultUnitPrice", "dimensionPrices"],
823
"type": "object"
824
},
825
"tier": { "type": "number" },
826
"price": { "type": "number" },
827
"batch": { "type": "number" },
828
"threshold": { "type": "number" },
829
"name": { "type": "string" },
830
"hidden": { "type": "boolean" },
831
"disabledAt": { "nullable": true, "type": "number" },
832
"enabledAt": { "nullable": true, "type": "number" }
833
},
834
"required": ["price", "batch", "threshold", "hidden"],
835
"type": "object"
836
},
837
"dataCacheRevalidation": {
838
"properties": {
839
"matrix": {
840
"properties": {
841
"defaultUnitPrice": { "type": "string" },
842
"dimensionPrices": {
843
"additionalProperties": { "type": "string" },
844
"type": "object"
845
}
846
},
847
"required": ["defaultUnitPrice", "dimensionPrices"],
848
"type": "object"
849
},
850
"tier": { "type": "number" },
851
"price": { "type": "number" },
852
"batch": { "type": "number" },
853
"threshold": { "type": "number" },
854
"name": { "type": "string" },
855
"hidden": { "type": "boolean" },
856
"disabledAt": { "nullable": true, "type": "number" },
857
"enabledAt": { "nullable": true, "type": "number" }
858
},
859
"required": ["price", "batch", "threshold", "hidden"],
860
"type": "object"
861
},
862
"dataCacheWrite": {
863
"properties": {
864
"matrix": {
865
"properties": {
866
"defaultUnitPrice": { "type": "string" },
867
"dimensionPrices": {
868
"additionalProperties": { "type": "string" },
869
"type": "object"
870
}
871
},
872
"required": ["defaultUnitPrice", "dimensionPrices"],
873
"type": "object"
874
},
875
"tier": { "type": "number" },
876
"price": { "type": "number" },
877
"batch": { "type": "number" },
878
"threshold": { "type": "number" },
879
"name": { "type": "string" },
880
"hidden": { "type": "boolean" },
881
"disabledAt": { "nullable": true, "type": "number" },
882
"enabledAt": { "nullable": true, "type": "number" }
883
},
884
"required": ["price", "batch", "threshold", "hidden"],
885
"type": "object"
886
},
887
"edgeConfigRead": {
888
"properties": {
889
"matrix": {
890
"properties": {
891
"defaultUnitPrice": { "type": "string" },
892
"dimensionPrices": {
893
"additionalProperties": { "type": "string" },
894
"type": "object"
895
}
896
},
897
"required": ["defaultUnitPrice", "dimensionPrices"],
898
"type": "object"
899
},
900
"tier": { "type": "number" },
901
"price": { "type": "number" },
902
"batch": { "type": "number" },
903
"threshold": { "type": "number" },
904
"name": { "type": "string" },
905
"hidden": { "type": "boolean" },
906
"disabledAt": { "nullable": true, "type": "number" },
907
"enabledAt": { "nullable": true, "type": "number" }
908
},
909
"required": ["price", "batch", "threshold", "hidden"],
910
"type": "object"
911
},
912
"edgeConfigWrite": {
913
"properties": {
914
"matrix": {
915
"properties": {
916
"defaultUnitPrice": { "type": "string" },
917
"dimensionPrices": {
918
"additionalProperties": { "type": "string" },
919
"type": "object"
920
}
921
},
922
"required": ["defaultUnitPrice", "dimensionPrices"],
923
"type": "object"
924
},
925
"tier": { "type": "number" },
926
"price": { "type": "number" },
927
"batch": { "type": "number" },
928
"threshold": { "type": "number" },
929
"name": { "type": "string" },
930
"hidden": { "type": "boolean" },
931
"disabledAt": { "nullable": true, "type": "number" },
932
"enabledAt": { "nullable": true, "type": "number" }
933
},
934
"required": ["price", "batch", "threshold", "hidden"],
935
"type": "object"
936
},
937
"edgeFunctionExecutionUnits": {
938
"properties": {
939
"matrix": {
940
"properties": {
941
"defaultUnitPrice": { "type": "string" },
942
"dimensionPrices": {
943
"additionalProperties": { "type": "string" },
944
"type": "object"
945
}
946
},
947
"required": ["defaultUnitPrice", "dimensionPrices"],
948
"type": "object"
949
},
950
"tier": { "type": "number" },
951
"price": { "type": "number" },
952
"batch": { "type": "number" },
953
"threshold": { "type": "number" },
954
"name": { "type": "string" },
955
"hidden": { "type": "boolean" },
956
"disabledAt": { "nullable": true, "type": "number" },
957
"enabledAt": { "nullable": true, "type": "number" }
958
},
959
"required": ["price", "batch", "threshold", "hidden"],
960
"type": "object"
961
},
962
"edgeMiddlewareInvocations": {
963
"properties": {
964
"matrix": {
965
"properties": {
966
"defaultUnitPrice": { "type": "string" },
967
"dimensionPrices": {
968
"additionalProperties": { "type": "string" },
969
"type": "object"
970
}
971
},
972
"required": ["defaultUnitPrice", "dimensionPrices"],
973
"type": "object"
974
},
975
"tier": { "type": "number" },
976
"price": { "type": "number" },
977
"batch": { "type": "number" },
978
"threshold": { "type": "number" },
979
"name": { "type": "string" },
980
"hidden": { "type": "boolean" },
981
"disabledAt": { "nullable": true, "type": "number" },
982
"enabledAt": { "nullable": true, "type": "number" }
983
},
984
"required": ["price", "batch", "threshold", "hidden"],
985
"type": "object"
986
},
987
"edgeRequest": {
988
"properties": {
989
"matrix": {
990
"properties": {
991
"defaultUnitPrice": { "type": "string" },
992
"dimensionPrices": {
993
"additionalProperties": { "type": "string" },
994
"type": "object"
995
}
996
},
997
"required": ["defaultUnitPrice", "dimensionPrices"],
998
"type": "object"
999
},
1000
"tier": { "type": "number" },
1001
"price": { "type": "number" },
1002
"batch": { "type": "number" },
1003
"threshold": { "type": "number" },
1004
"name": { "type": "string" },
1005
"hidden": { "type": "boolean" },
1006
"disabledAt": { "nullable": true, "type": "number" },
1007
"enabledAt": { "nullable": true, "type": "number" }
1008
},
1009
"required": ["price", "batch", "threshold", "hidden"],
1010
"type": "object"
1011
},
1012
"edgeRequestAdditionalCpuDuration": {
1013
"properties": {
1014
"matrix": {
1015
"properties": {
1016
"defaultUnitPrice": { "type": "string" },
1017
"dimensionPrices": {
1018
"additionalProperties": { "type": "string" },
1019
"type": "object"
1020
}
1021
},
1022
"required": ["defaultUnitPrice", "dimensionPrices"],
1023
"type": "object"
1024
},
1025
"tier": { "type": "number" },
1026
"price": { "type": "number" },
1027
"batch": { "type": "number" },
1028
"threshold": { "type": "number" },
1029
"name": { "type": "string" },
1030
"hidden": { "type": "boolean" },
1031
"disabledAt": { "nullable": true, "type": "number" },
1032
"enabledAt": { "nullable": true, "type": "number" }
1033
},
1034
"required": ["price", "batch", "threshold", "hidden"],
1035
"type": "object"
1036
},
1037
"fastDataTransfer": {
1038
"properties": {
1039
"matrix": {
1040
"properties": {
1041
"defaultUnitPrice": { "type": "string" },
1042
"dimensionPrices": {
1043
"additionalProperties": { "type": "string" },
1044
"type": "object"
1045
}
1046
},
1047
"required": ["defaultUnitPrice", "dimensionPrices"],
1048
"type": "object"
1049
},
1050
"tier": { "type": "number" },
1051
"price": { "type": "number" },
1052
"batch": { "type": "number" },
1053
"threshold": { "type": "number" },
1054
"name": { "type": "string" },
1055
"hidden": { "type": "boolean" },
1056
"disabledAt": { "nullable": true, "type": "number" },
1057
"enabledAt": { "nullable": true, "type": "number" }
1058
},
1059
"required": ["price", "batch", "threshold", "hidden"],
1060
"type": "object"
1061
},
1062
"fastOriginTransfer": {
1063
"properties": {
1064
"matrix": {
1065
"properties": {
1066
"defaultUnitPrice": { "type": "string" },
1067
"dimensionPrices": {
1068
"additionalProperties": { "type": "string" },
1069
"type": "object"
1070
}
1071
},
1072
"required": ["defaultUnitPrice", "dimensionPrices"],
1073
"type": "object"
1074
},
1075
"tier": { "type": "number" },
1076
"price": { "type": "number" },
1077
"batch": { "type": "number" },
1078
"threshold": { "type": "number" },
1079
"name": { "type": "string" },
1080
"hidden": { "type": "boolean" },
1081
"disabledAt": { "nullable": true, "type": "number" },
1082
"enabledAt": { "nullable": true, "type": "number" }
1083
},
1084
"required": ["price", "batch", "threshold", "hidden"],
1085
"type": "object"
1086
},
1087
"functionDuration": {
1088
"properties": {
1089
"matrix": {
1090
"properties": {
1091
"defaultUnitPrice": { "type": "string" },
1092
"dimensionPrices": {
1093
"additionalProperties": { "type": "string" },
1094
"type": "object"
1095
}
1096
},
1097
"required": ["defaultUnitPrice", "dimensionPrices"],
1098
"type": "object"
1099
},
1100
"tier": { "type": "number" },
1101
"price": { "type": "number" },
1102
"batch": { "type": "number" },
1103
"threshold": { "type": "number" },
1104
"name": { "type": "string" },
1105
"hidden": { "type": "boolean" },
1106
"disabledAt": { "nullable": true, "type": "number" },
1107
"enabledAt": { "nullable": true, "type": "number" }
1108
},
1109
"required": ["price", "batch", "threshold", "hidden"],
1110
"type": "object"
1111
},
1112
"functionInvocation": {
1113
"properties": {
1114
"matrix": {
1115
"properties": {
1116
"defaultUnitPrice": { "type": "string" },
1117
"dimensionPrices": {
1118
"additionalProperties": { "type": "string" },
1119
"type": "object"
1120
}
1121
},
1122
"required": ["defaultUnitPrice", "dimensionPrices"],
1123
"type": "object"
1124
},
1125
"tier": { "type": "number" },
1126
"price": { "type": "number" },
1127
"batch": { "type": "number" },
1128
"threshold": { "type": "number" },
1129
"name": { "type": "string" },
1130
"hidden": { "type": "boolean" },
1131
"disabledAt": { "nullable": true, "type": "number" },
1132
"enabledAt": { "nullable": true, "type": "number" }
1133
},
1134
"required": ["price", "batch", "threshold", "hidden"],
1135
"type": "object"
1136
},
1137
"logDrainsVolume": {
1138
"properties": {
1139
"matrix": {
1140
"properties": {
1141
"defaultUnitPrice": { "type": "string" },
1142
"dimensionPrices": {
1143
"additionalProperties": { "type": "string" },
1144
"type": "object"
1145
}
1146
},
1147
"required": ["defaultUnitPrice", "dimensionPrices"],
1148
"type": "object"
1149
},
1150
"tier": { "type": "number" },
1151
"price": { "type": "number" },
1152
"batch": { "type": "number" },
1153
"threshold": { "type": "number" },
1154
"name": { "type": "string" },
1155
"hidden": { "type": "boolean" },
1156
"disabledAt": { "nullable": true, "type": "number" },
1157
"enabledAt": { "nullable": true, "type": "number" }
1158
},
1159
"required": ["price", "batch", "threshold", "hidden"],
1160
"type": "object"
1161
},
1162
"monitoringMetric": {
1163
"properties": {
1164
"matrix": {
1165
"properties": {
1166
"defaultUnitPrice": { "type": "string" },
1167
"dimensionPrices": {
1168
"additionalProperties": { "type": "string" },
1169
"type": "object"
1170
}
1171
},
1172
"required": ["defaultUnitPrice", "dimensionPrices"],
1173
"type": "object"
1174
},
1175
"tier": { "type": "number" },
1176
"price": { "type": "number" },
1177
"batch": { "type": "number" },
1178
"threshold": { "type": "number" },
1179
"name": { "type": "string" },
1180
"hidden": { "type": "boolean" },
1181
"disabledAt": { "nullable": true, "type": "number" },
1182
"enabledAt": { "nullable": true, "type": "number" }
1183
},
1184
"required": ["price", "batch", "threshold", "hidden"],
1185
"type": "object"
1186
},
1187
"postgresComputeTime": {
1188
"properties": {
1189
"matrix": {
1190
"properties": {
1191
"defaultUnitPrice": { "type": "string" },
1192
"dimensionPrices": {
1193
"additionalProperties": { "type": "string" },
1194
"type": "object"
1195
}
1196
},
1197
"required": ["defaultUnitPrice", "dimensionPrices"],
1198
"type": "object"
1199
},
1200
"tier": { "type": "number" },
1201
"price": { "type": "number" },
1202
"batch": { "type": "number" },
1203
"threshold": { "type": "number" },
1204
"name": { "type": "string" },
1205
"hidden": { "type": "boolean" },
1206
"disabledAt": { "nullable": true, "type": "number" },
1207
"enabledAt": { "nullable": true, "type": "number" }
1208
},
1209
"required": ["price", "batch", "threshold", "hidden"],
1210
"type": "object"
1211
},
1212
"postgresDataStorage": {
1213
"properties": {
1214
"matrix": {
1215
"properties": {
1216
"defaultUnitPrice": { "type": "string" },
1217
"dimensionPrices": {
1218
"additionalProperties": { "type": "string" },
1219
"type": "object"
1220
}
1221
},
1222
"required": ["defaultUnitPrice", "dimensionPrices"],
1223
"type": "object"
1224
},
1225
"tier": { "type": "number" },
1226
"price": { "type": "number" },
1227
"batch": { "type": "number" },
1228
"threshold": { "type": "number" },
1229
"name": { "type": "string" },
1230
"hidden": { "type": "boolean" },
1231
"disabledAt": { "nullable": true, "type": "number" },
1232
"enabledAt": { "nullable": true, "type": "number" }
1233
},
1234
"required": ["price", "batch", "threshold", "hidden"],
1235
"type": "object"
1236
},
1237
"postgresDataTransfer": {
1238
"properties": {
1239
"matrix": {
1240
"properties": {
1241
"defaultUnitPrice": { "type": "string" },
1242
"dimensionPrices": {
1243
"additionalProperties": { "type": "string" },
1244
"type": "object"
1245
}
1246
},
1247
"required": ["defaultUnitPrice", "dimensionPrices"],
1248
"type": "object"
1249
},
1250
"tier": { "type": "number" },
1251
"price": { "type": "number" },
1252
"batch": { "type": "number" },
1253
"threshold": { "type": "number" },
1254
"name": { "type": "string" },
1255
"hidden": { "type": "boolean" },
1256
"disabledAt": { "nullable": true, "type": "number" },
1257
"enabledAt": { "nullable": true, "type": "number" }
1258
},
1259
"required": ["price", "batch", "threshold", "hidden"],
1260
"type": "object"
1261
},
1262
"postgresDatabase": {
1263
"properties": {
1264
"matrix": {
1265
"properties": {
1266
"defaultUnitPrice": { "type": "string" },
1267
"dimensionPrices": {
1268
"additionalProperties": { "type": "string" },
1269
"type": "object"
1270
}
1271
},
1272
"required": ["defaultUnitPrice", "dimensionPrices"],
1273
"type": "object"
1274
},
1275
"tier": { "type": "number" },
1276
"price": { "type": "number" },
1277
"batch": { "type": "number" },
1278
"threshold": { "type": "number" },
1279
"name": { "type": "string" },
1280
"hidden": { "type": "boolean" },
1281
"disabledAt": { "nullable": true, "type": "number" },
1282
"enabledAt": { "nullable": true, "type": "number" }
1283
},
1284
"required": ["price", "batch", "threshold", "hidden"],
1285
"type": "object"
1286
},
1287
"postgresWrittenData": {
1288
"properties": {
1289
"matrix": {
1290
"properties": {
1291
"defaultUnitPrice": { "type": "string" },
1292
"dimensionPrices": {
1293
"additionalProperties": { "type": "string" },
1294
"type": "object"
1295
}
1296
},
1297
"required": ["defaultUnitPrice", "dimensionPrices"],
1298
"type": "object"
1299
},
1300
"tier": { "type": "number" },
1301
"price": { "type": "number" },
1302
"batch": { "type": "number" },
1303
"threshold": { "type": "number" },
1304
"name": { "type": "string" },
1305
"hidden": { "type": "boolean" },
1306
"disabledAt": { "nullable": true, "type": "number" },
1307
"enabledAt": { "nullable": true, "type": "number" }
1308
},
1309
"required": ["price", "batch", "threshold", "hidden"],
1310
"type": "object"
1311
},
1312
"serverlessFunctionExecution": {
1313
"properties": {
1314
"matrix": {
1315
"properties": {
1316
"defaultUnitPrice": { "type": "string" },
1317
"dimensionPrices": {
1318
"additionalProperties": { "type": "string" },
1319
"type": "object"
1320
}
1321
},
1322
"required": ["defaultUnitPrice", "dimensionPrices"],
1323
"type": "object"
1324
},
1325
"tier": { "type": "number" },
1326
"price": { "type": "number" },
1327
"batch": { "type": "number" },
1328
"threshold": { "type": "number" },
1329
"name": { "type": "string" },
1330
"hidden": { "type": "boolean" },
1331
"disabledAt": { "nullable": true, "type": "number" },
1332
"enabledAt": { "nullable": true, "type": "number" }
1333
},
1334
"required": ["price", "batch", "threshold", "hidden"],
1335
"type": "object"
1336
},
1337
"sourceImages": {
1338
"properties": {
1339
"matrix": {
1340
"properties": {
1341
"defaultUnitPrice": { "type": "string" },
1342
"dimensionPrices": {
1343
"additionalProperties": { "type": "string" },
1344
"type": "object"
1345
}
1346
},
1347
"required": ["defaultUnitPrice", "dimensionPrices"],
1348
"type": "object"
1349
},
1350
"tier": { "type": "number" },
1351
"price": { "type": "number" },
1352
"batch": { "type": "number" },
1353
"threshold": { "type": "number" },
1354
"name": { "type": "string" },
1355
"hidden": { "type": "boolean" },
1356
"disabledAt": { "nullable": true, "type": "number" },
1357
"enabledAt": { "nullable": true, "type": "number" }
1358
},
1359
"required": ["price", "batch", "threshold", "hidden"],
1360
"type": "object"
1361
},
1362
"storageRedisTotalBandwidthInBytes": {
1363
"properties": {
1364
"matrix": {
1365
"properties": {
1366
"defaultUnitPrice": { "type": "string" },
1367
"dimensionPrices": {
1368
"additionalProperties": { "type": "string" },
1369
"type": "object"
1370
}
1371
},
1372
"required": ["defaultUnitPrice", "dimensionPrices"],
1373
"type": "object"
1374
},
1375
"tier": { "type": "number" },
1376
"price": { "type": "number" },
1377
"batch": { "type": "number" },
1378
"threshold": { "type": "number" },
1379
"name": { "type": "string" },
1380
"hidden": { "type": "boolean" },
1381
"disabledAt": { "nullable": true, "type": "number" },
1382
"enabledAt": { "nullable": true, "type": "number" }
1383
},
1384
"required": ["price", "batch", "threshold", "hidden"],
1385
"type": "object"
1386
},
1387
"storageRedisTotalCommands": {
1388
"properties": {
1389
"matrix": {
1390
"properties": {
1391
"defaultUnitPrice": { "type": "string" },
1392
"dimensionPrices": {
1393
"additionalProperties": { "type": "string" },
1394
"type": "object"
1395
}
1396
},
1397
"required": ["defaultUnitPrice", "dimensionPrices"],
1398
"type": "object"
1399
},
1400
"tier": { "type": "number" },
1401
"price": { "type": "number" },
1402
"batch": { "type": "number" },
1403
"threshold": { "type": "number" },
1404
"name": { "type": "string" },
1405
"hidden": { "type": "boolean" },
1406
"disabledAt": { "nullable": true, "type": "number" },
1407
"enabledAt": { "nullable": true, "type": "number" }
1408
},
1409
"required": ["price", "batch", "threshold", "hidden"],
1410
"type": "object"
1411
},
1412
"storageRedisTotalDailyAvgStorageInBytes": {
1413
"properties": {
1414
"matrix": {
1415
"properties": {
1416
"defaultUnitPrice": { "type": "string" },
1417
"dimensionPrices": {
1418
"additionalProperties": { "type": "string" },
1419
"type": "object"
1420
}
1421
},
1422
"required": ["defaultUnitPrice", "dimensionPrices"],
1423
"type": "object"
1424
},
1425
"tier": { "type": "number" },
1426
"price": { "type": "number" },
1427
"batch": { "type": "number" },
1428
"threshold": { "type": "number" },
1429
"name": { "type": "string" },
1430
"hidden": { "type": "boolean" },
1431
"disabledAt": { "nullable": true, "type": "number" },
1432
"enabledAt": { "nullable": true, "type": "number" }
1433
},
1434
"required": ["price", "batch", "threshold", "hidden"],
1435
"type": "object"
1436
},
1437
"storageRedisTotalDatabases": {
1438
"properties": {
1439
"matrix": {
1440
"properties": {
1441
"defaultUnitPrice": { "type": "string" },
1442
"dimensionPrices": {
1443
"additionalProperties": { "type": "string" },
1444
"type": "object"
1445
}
1446
},
1447
"required": ["defaultUnitPrice", "dimensionPrices"],
1448
"type": "object"
1449
},
1450
"tier": { "type": "number" },
1451
"price": { "type": "number" },
1452
"batch": { "type": "number" },
1453
"threshold": { "type": "number" },
1454
"name": { "type": "string" },
1455
"hidden": { "type": "boolean" },
1456
"disabledAt": { "nullable": true, "type": "number" },
1457
"enabledAt": { "nullable": true, "type": "number" }
1458
},
1459
"required": ["price", "batch", "threshold", "hidden"],
1460
"type": "object"
1461
},
1462
"wafOwaspExcessBytes": {
1463
"properties": {
1464
"matrix": {
1465
"properties": {
1466
"defaultUnitPrice": { "type": "string" },
1467
"dimensionPrices": {
1468
"additionalProperties": { "type": "string" },
1469
"type": "object"
1470
}
1471
},
1472
"required": ["defaultUnitPrice", "dimensionPrices"],
1473
"type": "object"
1474
},
1475
"tier": { "type": "number" },
1476
"price": { "type": "number" },
1477
"batch": { "type": "number" },
1478
"threshold": { "type": "number" },
1479
"name": { "type": "string" },
1480
"hidden": { "type": "boolean" },
1481
"disabledAt": { "nullable": true, "type": "number" },
1482
"enabledAt": { "nullable": true, "type": "number" }
1483
},
1484
"required": ["price", "batch", "threshold", "hidden"],
1485
"type": "object"
1486
},
1487
"wafOwaspRequests": {
1488
"properties": {
1489
"matrix": {
1490
"properties": {
1491
"defaultUnitPrice": { "type": "string" },
1492
"dimensionPrices": {
1493
"additionalProperties": { "type": "string" },
1494
"type": "object"
1495
}
1496
},
1497
"required": ["defaultUnitPrice", "dimensionPrices"],
1498
"type": "object"
1499
},
1500
"tier": { "type": "number" },
1501
"price": { "type": "number" },
1502
"batch": { "type": "number" },
1503
"threshold": { "type": "number" },
1504
"name": { "type": "string" },
1505
"hidden": { "type": "boolean" },
1506
"disabledAt": { "nullable": true, "type": "number" },
1507
"enabledAt": { "nullable": true, "type": "number" }
1508
},
1509
"required": ["price", "batch", "threshold", "hidden"],
1510
"type": "object"
1511
},
1512
"wafRateLimitRequest": {
1513
"properties": {
1514
"matrix": {
1515
"properties": {
1516
"defaultUnitPrice": { "type": "string" },
1517
"dimensionPrices": {
1518
"additionalProperties": { "type": "string" },
1519
"type": "object"
1520
}
1521
},
1522
"required": ["defaultUnitPrice", "dimensionPrices"],
1523
"type": "object"
1524
},
1525
"tier": { "type": "number" },
1526
"price": { "type": "number" },
1527
"batch": { "type": "number" },
1528
"threshold": { "type": "number" },
1529
"name": { "type": "string" },
1530
"hidden": { "type": "boolean" },
1531
"disabledAt": { "nullable": true, "type": "number" },
1532
"enabledAt": { "nullable": true, "type": "number" }
1533
},
1534
"required": ["price", "batch", "threshold", "hidden"],
1535
"type": "object"
1536
},
1537
"webAnalyticsEvent": {
1538
"properties": {
1539
"matrix": {
1540
"properties": {
1541
"defaultUnitPrice": { "type": "string" },
1542
"dimensionPrices": {
1543
"additionalProperties": { "type": "string" },
1544
"type": "object"
1545
}
1546
},
1547
"required": ["defaultUnitPrice", "dimensionPrices"],
1548
"type": "object"
1549
},
1550
"tier": { "type": "number" },
1551
"price": { "type": "number" },
1552
"batch": { "type": "number" },
1553
"threshold": { "type": "number" },
1554
"name": { "type": "string" },
1555
"hidden": { "type": "boolean" },
1556
"disabledAt": { "nullable": true, "type": "number" },
1557
"enabledAt": { "nullable": true, "type": "number" }
1558
},
1559
"required": ["price", "batch", "threshold", "hidden"],
1560
"type": "object"
1561
}
1562
},
1563
"type": "object"
1564
},
1565
"invoiceSettings": {
1566
"properties": { "footer": { "type": "string" } },
1567
"type": "object"
1568
},
1569
"subscriptions": {
1570
"nullable": true,
1571
"items": {
1572
"properties": {
1573
"id": { "type": "string" },
1574
"trial": {
1575
"nullable": true,
1576
"properties": {
1577
"start": { "type": "number" },
1578
"end": { "type": "number" }
1579
},
1580
"required": ["start", "end"],
1581
"type": "object"
1582
},
1583
"period": {
1584
"properties": {
1585
"start": { "type": "number" },
1586
"end": { "type": "number" }
1587
},
1588
"required": ["start", "end"],
1589
"type": "object"
1590
},
1591
"frequency": {
1592
"properties": {
1593
"interval": {
1594
"type": "string",
1595
"enum": ["month", "day", "week", "year"]
1596
},
1597
"intervalCount": { "type": "number" }
1598
},
1599
"required": ["interval", "intervalCount"],
1600
"type": "object"
1601
},
1602
"discount": {
1603
"nullable": true,
1604
"properties": {
1605
"id": { "type": "string" },
1606
"coupon": {
1607
"properties": {
1608
"id": { "type": "string" },
1609
"name": { "nullable": true, "type": "string" },
1610
"amountOff": { "nullable": true, "type": "number" },
1611
"percentageOff": { "nullable": true, "type": "number" },
1612
"durationInMonths": {
1613
"nullable": true,
1614
"type": "number"
1615
},
1616
"duration": {
1617
"type": "string",
1618
"enum": ["forever", "repeating", "once"]
1619
}
1620
},
1621
"required": [
1622
"id",
1623
"name",
1624
"amountOff",
1625
"percentageOff",
1626
"durationInMonths",
1627
"duration"
1628
],
1629
"type": "object"
1630
}
1631
},
1632
"required": ["id", "coupon"],
1633
"type": "object"
1634
},
1635
"items": {
1636
"items": {
1637
"properties": {
1638
"id": { "type": "string" },
1639
"priceId": { "type": "string" },
1640
"productId": { "type": "string" },
1641
"amount": { "type": "number" },
1642
"quantity": { "type": "number" }
1643
},
1644
"required": [
1645
"id",
1646
"priceId",
1647
"productId",
1648
"amount",
1649
"quantity"
1650
],
1651
"type": "object"
1652
},
1653
"type": "array"
1654
}
1655
},
1656
"required": [
1657
"id",
1658
"trial",
1659
"period",
1660
"frequency",
1661
"discount",
1662
"items"
1663
],
1664
"type": "object"
1665
},
1666
"type": "array"
1667
},
1668
"controls": {
1669
"nullable": true,
1670
"properties": {
1671
"analyticsSampleRateInPercent": {
1672
"nullable": true,
1673
"type": "number"
1674
},
1675
"analyticsSpendLimitInDollars": {
1676
"nullable": true,
1677
"type": "number"
1678
}
1679
},
1680
"type": "object"
1681
},
1682
"purchaseOrder": { "nullable": true, "type": "string" },
1683
"status": {
1684
"type": "string",
1685
"enum": ["active", "trialing", "overdue", "expired", "canceled"]
1686
},
1687
"pricingExperiment": { "type": "string", "enum": ["august-2022"] },
1688
"orbMigrationScheduledAt": { "nullable": true, "type": "number" },
1689
"forceOrbMigration": { "nullable": true, "type": "boolean" },
1690
"awsMarketplace": {
1691
"nullable": true,
1692
"properties": {
1693
"productCode": { "type": "string" },
1694
"offerId": { "type": "string" },
1695
"customerId": { "type": "string" }
1696
},
1697
"required": ["productCode", "customerId"],
1698
"type": "object"
1699
},
1700
"reseller": { "type": "string" }
1701
},
1702
"required": ["period", "plan"],
1703
"type": "object",
1704
"description": "An object containing billing infomation associated with the User account."
1705
},
1706
"resourceConfig": {
1707
"properties": {
1708
"blobStores": {
1709
"type": "number",
1710
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1711
},
1712
"nodeType": {
1713
"type": "string",
1714
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1715
},
1716
"concurrentBuilds": {
1717
"type": "number",
1718
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1719
},
1720
"awsAccountType": {
1721
"type": "string",
1722
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1723
},
1724
"awsAccountIds": {
1725
"items": { "type": "string" },
1726
"type": "array",
1727
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1728
},
1729
"cfZoneName": {
1730
"type": "string",
1731
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1732
},
1733
"imageOptimizationType": {
1734
"type": "string",
1735
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1736
},
1737
"edgeConfigs": {
1738
"type": "number",
1739
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1740
},
1741
"edgeConfigSize": {
1742
"type": "number",
1743
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1744
},
1745
"edgeFunctionMaxSizeBytes": {
1746
"type": "number",
1747
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1748
},
1749
"edgeFunctionExecutionTimeoutMs": {
1750
"type": "number",
1751
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1752
},
1753
"serverlessFunctionDefaultMaxExecutionTime": {
1754
"type": "number",
1755
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1756
},
1757
"kvDatabases": {
1758
"type": "number",
1759
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1760
},
1761
"postgresDatabases": {
1762
"type": "number",
1763
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1764
},
1765
"integrationStores": {
1766
"type": "number",
1767
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1768
},
1769
"cronJobs": {
1770
"type": "number",
1771
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1772
},
1773
"cronJobsPerProject": {
1774
"type": "number",
1775
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1776
}
1777
},
1778
"type": "object",
1779
"description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
1780
},
1781
"stagingPrefix": {
1782
"type": "string",
1783
"description": "Prefix that will be used in the URL of \"Preview\" deployments created by the User account."
1784
},
1785
"activeDashboardViews": {
1786
"items": {
1787
"properties": {
1788
"scopeId": { "type": "string" },
1789
"viewPreference": { "type": "string", "enum": ["list", "cards"] },
1790
"favoritesViewPreference": {
1791
"type": "string",
1792
"enum": ["open", "closed"]
1793
},
1794
"recentsViewPreference": {
1795
"type": "string",
1796
"enum": ["open", "closed"]
1797
}
1798
},
1799
"required": ["scopeId"],
1800
"type": "object",
1801
"description": "set of dashboard view preferences (cards or list) per scopeId"
1802
},
1803
"type": "array",
1804
"description": "set of dashboard view preferences (cards or list) per scopeId"
1805
},
1806
"importFlowGitNamespace": {
1807
"nullable": true,
1808
"oneOf": [{ "type": "string" }, { "type": "number" }]
1809
},
1810
"importFlowGitNamespaceId": {
1811
"nullable": true,
1812
"oneOf": [{ "type": "string" }, { "type": "number" }]
1813
},
1814
"importFlowGitProvider": {
1815
"type": "string",
1816
"enum": ["github", "gitlab", "bitbucket"]
1817
},
1818
"preferredScopesAndGitNamespaces": {
1819
"items": {
1820
"properties": {
1821
"scopeId": { "type": "string" },
1822
"gitNamespaceId": {
1823
"nullable": true,
1824
"oneOf": [{ "type": "string" }, { "type": "number" }]
1825
}
1826
},
1827
"required": ["scopeId", "gitNamespaceId"],
1828
"type": "object"
1829
},
1830
"type": "array"
1831
},
1832
"dismissedToasts": {
1833
"items": {
1834
"properties": {
1835
"name": { "type": "string" },
1836
"dismissals": {
1837
"items": {
1838
"properties": {
1839
"scopeId": { "type": "string" },
1840
"createdAt": { "type": "number" }
1841
},
1842
"required": ["scopeId", "createdAt"],
1843
"type": "object"
1844
},
1845
"type": "array"
1846
}
1847
},
1848
"required": ["name", "dismissals"],
1849
"type": "object",
1850
"description": "A record of when, under a certain scopeId, a toast was dismissed"
1851
},
1852
"type": "array",
1853
"description": "A record of when, under a certain scopeId, a toast was dismissed"
1854
},
1855
"favoriteProjectsAndSpaces": {
1856
"items": {
1857
"oneOf": [
1858
{
1859
"properties": {
1860
"projectId": { "type": "string" },
1861
"scopeSlug": { "type": "string" },
1862
"scopeId": { "type": "string" }
1863
},
1864
"required": ["projectId", "scopeSlug", "scopeId"],
1865
"type": "object",
1866
"description": "A list of projects and spaces across teams that a user has marked as a favorite."
1867
},
1868
{
1869
"properties": {
1870
"spaceId": { "type": "string" },
1871
"scopeSlug": { "type": "string" },
1872
"scopeId": { "type": "string" }
1873
},
1874
"required": ["spaceId", "scopeSlug", "scopeId"],
1875
"type": "object",
1876
"description": "A list of projects and spaces across teams that a user has marked as a favorite."
1877
}
1878
]
1879
},
1880
"type": "array",
1881
"description": "A list of projects and spaces across teams that a user has marked as a favorite."
1882
},
1883
"hasTrialAvailable": {
1884
"type": "boolean",
1885
"description": "Whether the user has a trial available for a paid plan subscription."
1886
},
1887
"remoteCaching": {
1888
"properties": { "enabled": { "type": "boolean" } },
1889
"type": "object",
1890
"description": "remote caching settings"
1891
},
1892
"dataCache": {
1893
"properties": { "excessBillingEnabled": { "type": "boolean" } },
1894
"type": "object",
1895
"description": "data cache settings"
1896
},
1897
"featureBlocks": {
1898
"properties": {
1899
"webAnalytics": {
1900
"properties": {
1901
"blockedFrom": { "type": "number" },
1902
"blockedUntil": { "type": "number" },
1903
"isCurrentlyBlocked": { "type": "boolean" }
1904
},
1905
"required": ["isCurrentlyBlocked"],
1906
"type": "object"
1907
}
1908
},
1909
"type": "object",
1910
"description": "Feature blocks for the user"
1911
},
1912
"northstarMigration": {
1913
"properties": {
1914
"teamId": {
1915
"type": "string",
1916
"description": "The ID of the team we created for this user."
1917
},
1918
"projects": {
1919
"type": "number",
1920
"description": "The number of projects migrated for this user."
1921
},
1922
"stores": {
1923
"type": "number",
1924
"description": "The number of stores migrated for this user."
1925
},
1926
"integrationConfigurations": {
1927
"type": "number",
1928
"description": "The number of integration configurations migrated for this user."
1929
},
1930
"integrationClients": {
1931
"type": "number",
1932
"description": "The number of integration clients migrated for this user."
1933
},
1934
"startTime": {
1935
"type": "number",
1936
"description": "The migration start time timestamp for this user."
1937
},
1938
"endTime": {
1939
"type": "number",
1940
"description": "The migration end time timestamp for this user."
1941
}
1942
},
1943
"required": [
1944
"teamId",
1945
"projects",
1946
"stores",
1947
"integrationConfigurations",
1948
"integrationClients",
1949
"startTime",
1950
"endTime"
1951
],
1952
"type": "object"
1953
},
1954
"id": {
1955
"type": "string",
1956
"description": "The User's unique identifier.",
1957
"example": "AEIIDYVk59zbFF2Sxfyxxmua"
1958
},
1959
"email": {
1960
"type": "string",
1961
"description": "Email address associated with the User account.",
1962
"example": "me@example.com"
1963
},
1964
"name": {
1965
"nullable": true,
1966
"type": "string",
1967
"description": "Name associated with the User account, or `null` if none has been provided.",
1968
"example": "John Doe"
1969
},
1970
"username": {
1971
"type": "string",
1972
"description": "Unique username associated with the User account.",
1973
"example": "jdoe"
1974
},
1975
"avatar": {
1976
"nullable": true,
1977
"type": "string",
1978
"description": "SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.",
1979
"example": "22cb30c85ff45ac4c72de8981500006b28114aa1"
1980
},
1981
"defaultTeamId": {
1982
"nullable": true,
1983
"type": "string",
1984
"description": "The user's default team. Only applies if the user's `version` is `'northstar'`."
1985
},
1986
"version": {
1987
"nullable": true,
1988
"type": "string",
1989
"enum": ["northstar"],
1990
"description": "The user's version. Will either be unset or `northstar`."
1991
}
1992
},
1993
"required": [
1994
"createdAt",
1995
"softBlock",
1996
"billing",
1997
"resourceConfig",
1998
"stagingPrefix",
1999
"hasTrialAvailable",
2000
"id",
2001
"email",
2002
"name",
2003
"username",
2004
"avatar",
2005
"defaultTeamId",
2006
"version"
2007
],
2008
"type": "object",
2009
"description": "Data for the currently authenticated User."
2010
}

AuthUserLimited

1
{
2
"properties": {
3
"limited": {
4
"type": "boolean",
5
"description": "Property indicating that this User data contains only limited information, due to the authentication token missing privileges to read the full User data. Re-login with email, GitHub, GitLab or Bitbucket in order to upgrade the authentication token with the necessary privileges."
6
},
7
"id": {
8
"type": "string",
9
"description": "The User's unique identifier.",
10
"example": "AEIIDYVk59zbFF2Sxfyxxmua"
11
},
12
"email": {
13
"type": "string",
14
"description": "Email address associated with the User account.",
15
"example": "me@example.com"
16
},
17
"name": {
18
"nullable": true,
19
"type": "string",
20
"description": "Name associated with the User account, or `null` if none has been provided.",
21
"example": "John Doe"
22
},
23
"username": {
24
"type": "string",
25
"description": "Unique username associated with the User account.",
26
"example": "jdoe"
27
},
28
"avatar": {
29
"nullable": true,
30
"type": "string",
31
"description": "SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.",
32
"example": "22cb30c85ff45ac4c72de8981500006b28114aa1"
33
},
34
"defaultTeamId": {
35
"nullable": true,
36
"type": "string",
37
"description": "The user's default team. Only applies if the user's `version` is `'northstar'`."
38
},
39
"version": {
40
"nullable": true,
41
"type": "string",
42
"enum": ["northstar"],
43
"description": "The user's version. Will either be unset or `northstar`."
44
}
45
},
46
"required": [
47
"limited",
48
"id",
49
"email",
50
"name",
51
"username",
52
"avatar",
53
"defaultTeamId",
54
"version"
55
],
56
"type": "object",
57
"description": "A limited form of data for the currently authenticated User, due to the authentication token missing privileges to read the full User data."
58
}

EdgeConfigItem

1
{
2
"properties": {
3
"key": { "type": "string" },
4
"value": { "$ref": "#/components/schemas/EdgeConfigItemValue" },
5
"description": { "type": "string" },
6
"edgeConfigId": { "type": "string" },
7
"createdAt": { "type": "number" },
8
"updatedAt": { "type": "number" }
9
},
10
"required": ["key", "value", "edgeConfigId", "createdAt", "updatedAt"],
11
"type": "object",
12
"description": "The EdgeConfig."
13
}

EdgeConfigItemValue

1
{
2
"nullable": true,
3
"oneOf": [
4
{ "type": "string" },
5
{ "type": "number" },
6
{ "type": "boolean" },
7
{
8
"additionalProperties": {
9
"$ref": "#/components/schemas/EdgeConfigItemValue"
10
},
11
"type": "object"
12
},
13
{
14
"items": { "$ref": "#/components/schemas/EdgeConfigItemValue" },
15
"type": "array"
16
}
17
]
18
}

EdgeConfigToken

1
{
2
"properties": {
3
"token": { "type": "string" },
4
"label": { "type": "string" },
5
"id": {
6
"type": "string",
7
"description": "This is not the token itself, but rather an id to identify the token by"
8
},
9
"edgeConfigId": { "type": "string" },
10
"createdAt": { "type": "number" }
11
},
12
"required": ["token", "label", "id", "edgeConfigId", "createdAt"],
13
"type": "object",
14
"description": "The EdgeConfig."
15
}

FileTree

1
{
2
"properties": {
3
"name": {
4
"type": "string",
5
"description": "The name of the file tree entry",
6
"example": "my-file.json"
7
},
8
"type": {
9
"type": "string",
10
"enum": [
11
"directory",
12
"file",
13
"symlink",
14
"lambda",
15
"middleware",
16
"invalid"
17
],
18
"description": "String indicating the type of file tree entry.",
19
"example": "file"
20
},
21
"uid": {
22
"type": "string",
23
"description": "The unique identifier of the file (only valid for the `file` type)",
24
"example": "2d4aad419917f15b1146e9e03ddc9bb31747e4d0"
25
},
26
"children": {
27
"items": { "$ref": "#/components/schemas/FileTree" },
28
"type": "array",
29
"description": "The list of children files of the directory (only valid for the `directory` type)"
30
},
31
"contentType": {
32
"type": "string",
33
"description": "The content-type of the file (only valid for the `file` type)",
34
"example": "application/json"
35
},
36
"mode": {
37
"type": "number",
38
"description": "The file \"mode\" indicating file type and permissions."
39
},
40
"symlink": {
41
"type": "string",
42
"description": "Not currently used. See `file-list-to-tree.ts`."
43
}
44
},
45
"required": ["name", "type", "mode"],
46
"type": "object",
47
"description": "A deployment file tree entry"
48
}

FlagJSONValue

1
{
2
"nullable": true,
3
"oneOf": [
4
{ "type": "string" },
5
{ "type": "number" },
6
{ "type": "boolean" },
7
{
8
"items": { "$ref": "#/components/schemas/FlagJSONValue" },
9
"type": "array",
10
"description": "TODO: The following types will eventually be exported by a more relevant package."
11
},
12
{
13
"additionalProperties": { "$ref": "#/components/schemas/FlagJSONValue" },
14
"type": "object"
15
}
16
]
17
}

Pagination

1
{
2
"properties": {
3
"count": {
4
"type": "number",
5
"description": "Amount of items in the current page.",
6
"example": 20
7
},
8
"next": {
9
"nullable": true,
10
"type": "number",
11
"description": "Timestamp that must be used to request the next page.",
12
"example": 1540095775951
13
},
14
"prev": {
15
"nullable": true,
16
"type": "number",
17
"description": "Timestamp that must be used to request the previous page.",
18
"example": 1540095775951
19
}
20
},
21
"required": ["count", "next", "prev"],
22
"type": "object",
23
"description": "This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data."
24
}

Team

1
{ "type": "object", "description": "Data representing a Team." }

TeamLimited

1
{
2
"properties": {
3
"limited": {
4
"type": "boolean",
5
"description": "Property indicating that this Team data contains only limited information, due to the authentication token missing privileges to read the full Team data. Re-login with the Team's configured SAML Single Sign-On provider in order to upgrade the authentication token with the necessary privileges."
6
},
7
"saml": {
8
"properties": {
9
"connection": {
10
"properties": {
11
"type": {
12
"type": "string",
13
"description": "The Identity Provider \"type\", for example Okta.",
14
"example": "OktaSAML"
15
},
16
"status": {
17
"type": "string",
18
"description": "Current status of the connection.",
19
"example": "linked"
20
},
21
"state": {
22
"type": "string",
23
"description": "Current state of the connection.",
24
"example": "active"
25
},
26
"connectedAt": {
27
"type": "number",
28
"description": "Timestamp (in milliseconds) of when the configuration was connected.",
29
"example": 1611796915677
30
},
31
"lastReceivedWebhookEvent": {
32
"type": "number",
33
"description": "Timestamp (in milliseconds) of when the last webhook event was received from WorkOS.",
34
"example": 1611796915677
35
}
36
},
37
"required": ["type", "status", "state", "connectedAt"],
38
"type": "object",
39
"description": "Information for the SAML Single Sign-On configuration."
40
},
41
"directory": {
42
"properties": {
43
"type": {
44
"type": "string",
45
"description": "The Identity Provider \"type\", for example Okta.",
46
"example": "OktaSAML"
47
},
48
"state": {
49
"type": "string",
50
"description": "Current state of the connection.",
51
"example": "active"
52
},
53
"connectedAt": {
54
"type": "number",
55
"description": "Timestamp (in milliseconds) of when the configuration was connected.",
56
"example": 1611796915677
57
},
58
"lastReceivedWebhookEvent": {
59
"type": "number",
60
"description": "Timestamp (in milliseconds) of when the last webhook event was received from WorkOS.",
61
"example": 1611796915677
62
}
63
},
64
"required": ["type", "state", "connectedAt"],
65
"type": "object",
66
"description": "Information for the Directory Sync configuration."
67
},
68
"enforced": {
69
"type": "boolean",
70
"description": "When `true`, interactions with the Team **must** be done with an authentication token that has been authenticated with the Team's SAML Single Sign-On provider."
71
}
72
},
73
"required": ["enforced"],
74
"type": "object",
75
"description": "When \"Single Sign-On (SAML)\" is configured, this object contains information that allows the client-side to identify whether or not this Team has SAML enforced."
76
},
77
"id": {
78
"type": "string",
79
"description": "The Team's unique identifier.",
80
"example": "team_nllPyCtREAqxxdyFKbbMDlxd"
81
},
82
"slug": {
83
"type": "string",
84
"description": "The Team's slug, which is unique across the Vercel platform.",
85
"example": "my-team"
86
},
87
"name": {
88
"nullable": true,
89
"type": "string",
90
"description": "Name associated with the Team account, or `null` if none has been provided.",
91
"example": "My Team"
92
},
93
"avatar": {
94
"nullable": true,
95
"type": "string",
96
"description": "The ID of the file used as avatar for this Team.",
97
"example": "6eb07268bcfadd309905ffb1579354084c24655c"
98
},
99
"membership": {
100
"properties": {
101
"confirmed": { "type": "boolean" },
102
"confirmedAt": { "type": "number" },
103
"accessRequestedAt": { "type": "number" },
104
"role": {
105
"type": "string",
106
"enum": [
107
"OWNER",
108
"MEMBER",
109
"DEVELOPER",
110
"BILLING",
111
"VIEWER",
112
"CONTRIBUTOR"
113
]
114
},
115
"teamId": { "type": "string" },
116
"createdAt": { "type": "number" },
117
"created": { "type": "number" },
118
"joinedFrom": {
119
"properties": {
120
"origin": {
121
"type": "string",
122
"enum": [
123
"link",
124
"saml",
125
"mail",
126
"import",
127
"teams",
128
"github",
129
"gitlab",
130
"bitbucket",
131
"dsync",
132
"feedback",
133
"organization-teams"
134
]
135
},
136
"commitId": { "type": "string" },
137
"repoId": { "type": "string" },
138
"repoPath": { "type": "string" },
139
"gitUserId": {
140
"oneOf": [{ "type": "string" }, { "type": "number" }]
141
},
142
"gitUserLogin": { "type": "string" },
143
"ssoUserId": { "type": "string" },
144
"ssoConnectedAt": { "type": "number" },
145
"idpUserId": { "type": "string" },
146
"dsyncUserId": { "type": "string" },
147
"dsyncConnectedAt": { "type": "number" }
148
},
149
"required": ["origin"],
150
"type": "object"
151
},
152
"uid": { "type": "string" }
153
},
154
"type": "object",
155
"description": "The membership of the authenticated User in relation to the Team."
156
},
157
"created": {
158
"type": "string",
159
"description": "Will remain undocumented. Remove in v3 API."
160
},
161
"createdAt": {
162
"type": "number",
163
"description": "UNIX timestamp (in milliseconds) when the Team was created.",
164
"example": 1630748523395
165
}
166
},
167
"required": [
168
"limited",
169
"id",
170
"slug",
171
"name",
172
"avatar",
173
"membership",
174
"created",
175
"createdAt"
176
],
177
"type": "object",
178
"description": "A limited form of data representing a Team, due to the authentication token missing privileges to read the full Team data."
179
}

UserEvent

1
{
2
"properties": {
3
"id": {
4
"type": "string",
5
"description": "The unique identifier of the Event.",
6
"example": "uev_bfmMjiMnXfnPbT97dGdpJbCN"
7
},
8
"text": {
9
"type": "string",
10
"description": "The human-readable text of the Event.",
11
"example": "You logged in via GitHub"
12
},
13
"entities": {
14
"items": {
15
"properties": {
16
"type": {
17
"type": "string",
18
"enum": [
19
"author",
20
"bitbucket_login",
21
"bold",
22
"deployment_host",
23
"dns_record",
24
"git_link",
25
"github_login",
26
"gitlab_login",
27
"hook_name",
28
"integration",
29
"edge-config",
30
"flag",
31
"flags-segment",
32
"flags-settings",
33
"link",
34
"project_name",
35
"scaling_rules",
36
"env_var_name",
37
"target",
38
"store",
39
"system"
40
],
41
"description": "The type of entity.",
42
"example": "author"
43
},
44
"start": {
45
"type": "number",
46
"description": "The index of where the entity begins within the `text` (inclusive).",
47
"example": 0
48
},
49
"end": {
50
"type": "number",
51
"description": "The index of where the entity ends within the `text` (non-inclusive).",
52
"example": 3
53
}
54
},
55
"required": ["type", "start", "end"],
56
"type": "object",
57
"description": "A list of \"entities\" within the event `text`. Useful for enhancing the displayed text with additional styling and links."
58
},
59
"type": "array",
60
"description": "A list of \"entities\" within the event `text`. Useful for enhancing the displayed text with additional styling and links."
61
},
62
"createdAt": {
63
"type": "number",
64
"description": "Timestamp (in milliseconds) of when the event was generated.",
65
"example": 1632859321020
66
},
67
"user": {
68
"properties": {
69
"avatar": { "type": "string" },
70
"email": { "type": "string" },
71
"slug": { "type": "string" },
72
"uid": { "type": "string" },
73
"username": { "type": "string" }
74
},
75
"required": ["avatar", "email", "uid", "username"],
76
"type": "object",
77
"description": "Metadata for the User who generated the event."
78
},
79
"userId": {
80
"type": "string",
81
"description": "The unique identifier of the User who generated the event.",
82
"example": "zTuNVUXEAvvnNN3IaqinkyMw"
83
}
84
},
85
"required": ["id", "text", "entities", "createdAt", "userId"],
86
"type": "object",
87
"description": "Array of events generated by the User."
88
}
Last updated on September 19, 2024